Class Navigation

Navigation

Ein Hilfsobjekt, mit dem die Kartennavigation gesteuert wird. Weitere Informationen finden Sie im Leitfaden zur Kartennavigation.

Verwendungsbeispiel: 

function myFunction() {
  return AddOnsResponseService.newChatDataActionBuilder();
}

Methoden

MethodeRückgabetypKurzbeschreibung
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
pushCard(card)NavigationVerschiebt die angegebene Karte in den Stack.
setEndNavigation(endNavigation)NavigationLegt die Aktion zum Beenden der Navigation fest.
updateCard(card)NavigationErsetzt die aktuelle Karte direkt.

Detaillierte Dokumentation

popCard()

Verfügbar für Google Workspace-Add-ons, die Google Chat erweitern.

Entfernt eine Karte aus dem Navigationsstack. Kann mit anderen Aktionen zur Kartennavigation verkettet werden.

Rückflug

Navigation – Dieses Objekt zum Verketten.

popToNamedCard(cardName)

Verfügbar für Google Workspace-Add-ons, die Google Chat erweitern.

Entfernt Karten aus dem Stack bis zur angegebenen Karte. Kann mit anderen Aktionen zur Kartennavigation verkettet werden.

Parameter

NameTypBeschreibung
cardNameStringDer Name der Karte, zu der navigiert werden soll.

Rückflug

Navigation – Dieses Objekt zum Verketten.

popToRoot()

Verfügbar für Google Workspace-Add-ons, die Google Chat erweitern.

Entfernt Karten aus dem Stack bis zur Stammkarte. Kann mit anderen Aktionen zur Kartennavigation verkettet werden.

Rückflug

Navigation – Dieses Objekt zum Verketten.

printJson()

Gibt die JSON-Darstellung dieses Objekts aus. Nur für das Debugging vorgesehen.

Rückflug

String

pushCard(card)

Verschiebt die angegebene Karte in den Stack. Kann mit anderen Aktionen zur Kartennavigation verkettet werden. 

const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('Card title'))
    .addSection(cardSection)
    .build();

const navigation = AddOnsResponseService.newNavigation()
    .pushCard(card);

Parameter

NameTypBeschreibung
cardCardEine Karte, die dem Stack hinzugefügt werden soll.

Rückflug

Navigation – Dieses Objekt zum Verketten.

setEndNavigation(endNavigation)

Legt die Aktion zum Beenden der Navigation fest. 

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

Parameter

NameTypBeschreibung
endNavigationEndNavigationDie zu verwendende EndNavigation.

Rückflug

Navigation – Dieses Objekt zum Verketten.

updateCard(card)

Ersetzt die aktuelle Karte direkt. Kann mit anderen Aktionen zur Kartennavigation verkettet werden. 

const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('Card title'))
    .addSection(cardSection)
    .build();

const navigation = AddOnsResponseService.newNavigation()
    .updateCard(card);

Parameter

NameTypBeschreibung
cardCardEine Karte, die die aktuelle Karte ersetzen soll.

Rückflug

Navigation – Dieses Objekt zum Verketten.