Class Navigation

Navigation

Objet d'assistance qui contrôle la navigation dans les cartes. Pour en savoir plus, consultez le guide de navigation par cartes.

Exemple d'utilisation : 

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

Méthodes

MéthodeType renvoyéBrève description
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()StringAffiche la représentation JSON de cet objet.
pushCard(card)NavigationTransfère la carte donnée sur la pile.
setEndNavigation(endNavigation)NavigationDéfinit l'action de navigation de fin.
updateCard(card)NavigationRemplace la carte actuelle.

Documentation détaillée

popCard()

Disponible pour les modules complémentaires Google Workspace qui étendent Google Chat.

Supprime une carte de la pile de navigation. Peut être enchaîné avec d'autres actions de navigation dans les fiches.

Renvois

Navigation : cet objet, pour le chaînage.

popToNamedCard(cardName)

Disponible pour les modules complémentaires Google Workspace qui étendent Google Chat.

Affiche la fiche spécifiée par son nom. Peut être enchaîné avec d'autres actions de navigation dans les fiches.

Paramètres

NomTypeDescription
cardNameStringNom de la fiche vers laquelle accéder.

Renvois

Navigation : cet objet, pour le chaînage.

popToRoot()

Disponible pour les modules complémentaires Google Workspace qui étendent Google Chat.

Fait passer la pile de cartes à la carte racine. Peut être enchaîné avec d'autres actions de navigation dans les fiches.

Renvois

Navigation : cet objet, pour le chaînage.

printJson()

Affiche la représentation JSON de cet objet. Ceci n'est destiné qu'au débogage.

Renvois

String

pushCard(card)

Transfère la carte donnée sur la pile. Peut être enchaîné avec d'autres actions de navigation dans les fiches. 

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

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

Paramètres

NomTypeDescription
cardCardCarte à ajouter à la pile.

Renvois

Navigation : cet objet, pour le chaînage.

setEndNavigation(endNavigation)

Définit l'action de navigation de fin. 

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

Paramètres

NomTypeDescription
endNavigationEndNavigationLe EndNavigation à utiliser.

Renvois

Navigation : cet objet, pour le chaînage.

updateCard(card)

Remplace la carte actuelle. Peut être enchaîné avec d'autres actions de navigation dans les fiches. 

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

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

Paramètres

NomTypeDescription
cardCardCarte à utiliser pour remplacer la carte actuelle.

Renvois

Navigation : cet objet, pour le chaînage.