Class ActionResponseBuilder

ActionResponseBuilder

Ein Builder für ActionResponse-Objekte.

Verfügbar für Google Workspace-Add-ons.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .setNotification(notification)
    .build();

Methoden

MethodeRückgabetypKurzbeschreibung
addModifyCard(modifyCard)ActionResponseBuilderLegt den Vorgang zum Ändern der Karte für die Aktion fest.
build()ActionResponseErstellt die aktuelle Aktionsantwort und validiert sie.
setLinkPreview(linkPreview)ActionResponseBuilderLegt die Linkvorschau für die Aktion fest.
setNavigation(navigation)ActionResponseBuilderLegt die Antwort auf eine Navigation-Aktion fest.
setNotification(notification)ActionResponseBuilderLegt die Benachrichtigung fest, die angezeigt werden soll, wenn die Aktion aktiviert wird.
setOpenLink(openLink)ActionResponseBuilderLegt die URL fest, zu der navigiert werden soll, wenn die Aktion aktiviert wird.
setStateChanged(stateChanged)ActionResponseBuilderLegt ein Flag fest, um anzugeben, dass diese Aktion den vorhandenen Datenstatus geändert hat.

Detaillierte Dokumentation

addModifyCard(modifyCard)

Legt den Vorgang zum Ändern der Karte für die Aktion fest.

Parameter

NameTypBeschreibung
modifyCardModifyCardDie zu verwendende ModifyCard.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.


build()

Erstellt die aktuelle Aktionsantwort und validiert sie.

Rückflug

ActionResponse : Eine validierte ActionResponse.

Löst

Error : Wenn die erstellte Aktionsantwort ungültig ist.


setLinkPreview(linkPreview)

Legt die Linkvorschau für die Aktion fest.

Parameter

NameTypBeschreibung
linkPreviewLinkPreviewDie zu verwendende LinkPreview.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.


setNavigation(navigation)

Legt die Antwort auf eine Navigation-Aktion fest.

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .build();

Parameter

NameTypBeschreibung
navigationNavigationDie zu verwendende Navigation.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.


setNotification(notification)

Legt die Benachrichtigung fest, die angezeigt werden soll, wenn die Aktion aktiviert wird.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNotification(notification)
    .build();

Parameter

NameTypBeschreibung
notificationNotificationDie zu verwendende Notification.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.


Legt die URL fest, zu der navigiert werden soll, wenn die Aktion aktiviert wird.

Parameter

NameTypBeschreibung
openLinkOpenLinkDie zu verwendende OpenLink.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.


setStateChanged(stateChanged)

Legt ein Flag fest, um anzugeben, dass diese Aktion den vorhandenen Datenstatus geändert hat. Dies ist beispielsweise der Fall, wenn durch die Aktion eine Aufgabe erstellt oder Kontaktinformationen aktualisiert wurden. Wenn dieses Flag auf true gesetzt ist, können Dienste wie Gmail versuchen, alle im Cache gespeicherten Statusdaten zu löschen, die mit dieser Aktion verknüpft sind.

Parameter

NameTypBeschreibung
stateChangedBooleanGibt an, ob diese Aktion die vorhandenen Statusdaten geändert hat. Die Standardeinstellung ist false.

Rückflug

ActionResponseBuilder : Dieses Objekt für die Verkettung.