Class ActionResponseBuilder

ActionResponseBuilder

Ein Builder für ActionResponse-Objekte.

Für Google Workspace-Add‑ons verfügbar.

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 fest, welche Benachrichtigung 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 durch diese Aktion der vorhandene Datenstatus geändert wurde.

Detaillierte Dokumentation

addModifyCard(modifyCard)

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

Parameter

NameTypBeschreibung
modifyCardModifyCardDer zu verwendende ModifyCard.

Rückflug

ActionResponseBuilder: Dieses Objekt zur 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
linkPreviewLinkPreviewDer 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
navigationNavigationDer zu verwendende Navigation.

Rückflug

ActionResponseBuilder – Dieses Objekt für die Verkettung.


setNotification(notification)

Legt fest, welche Benachrichtigung 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
notificationNotificationDer 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
openLinkOpenLinkDer zu verwendende OpenLink.

Rückflug

ActionResponseBuilder – Dieses Objekt für die Verkettung.


setStateChanged(stateChanged)

Legt ein Flag fest, um anzugeben, dass durch diese Aktion der vorhandene Datenstatus geändert wurde. Zum Beispiel, 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 mit dieser Aktion verknüpften zwischengespeicherten Statusdaten zu löschen.

Parameter

NameTypBeschreibung
stateChangedBooleanGibt an, ob durch diese Aktion die vorhandenen Zustandsdaten geändert wurden. Die Standardeinstellung ist false.

Rückflug

ActionResponseBuilder – Dieses Objekt für die Verkettung.