Class Navigation
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Documentation détaillée
popCard()
Fait apparaître une fiche 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)
Accédez à la fiche spécifiée par son nom. Peut être enchaîné avec d'autres actions de navigation dans les fiches.
Paramètres
| Nom | Type | Description |
cardName | String | Nom de la fiche à laquelle accéder. |
Renvois
Navigation : cet objet, pour le chaînage.
popToRoot()
Fait apparaître la pile de cartes sur 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()
Imprime la représentation JSON de cet objet. Cette option est réservée 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.
Paramètres
| Nom | Type | Description |
card | Card | Carte à ajouter à la pile. |
Renvois
Navigation : cet objet, pour le chaînage.
updateCard(card)
Remplace la fiche actuelle sur place. Peut être enchaîné avec d'autres actions de navigation dans les fiches.
Paramètres
| Nom | Type | Description |
card | Card | Carte à remplacer par la carte actuelle. |
Renvois
Navigation : cet objet, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eThe Navigation object facilitates card navigation within Google Workspace add-ons, allowing developers to control the flow and presentation of user interfaces.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods like \u003ccode\u003epushCard()\u003c/code\u003e, \u003ccode\u003epopCard()\u003c/code\u003e, and \u003ccode\u003eupdateCard()\u003c/code\u003e to manage the card stack, enabling dynamic and interactive user experiences.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use \u003ccode\u003epopToNamedCard()\u003c/code\u003e or \u003ccode\u003epopToRoot()\u003c/code\u003e for direct navigation to specific cards within the stack, enhancing user control and flexibility.\u003c/p\u003e\n"],["\u003cp\u003eAll navigation methods are chainable, providing a streamlined and efficient way to sequence multiple actions and create complex navigation flows within the add-on.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprintJson()\u003c/code\u003e method aids debugging by outputting the object's JSON representation, allowing developers to inspect its structure and state.\u003c/p\u003e\n"]]],[],null,["# Class Navigation\n\nNavigation\n\nA helper object that controls card navigation. See the [card navigation guide](/gmail/add-ons/how-tos/navigation) for more details. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------|-----------------|---------------------------------------------------|\n| [popCard()](#popCard()) | [Navigation](#) | Pops a card from the navigation stack. |\n| [popToNamedCard(cardName)](#popToNamedCard(String)) | [Navigation](#) | Pops to the specified card by its card name. |\n| [popToRoot()](#popToRoot()) | [Navigation](#) | Pops the card stack to the root card. |\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [pushCard(card)](#pushCard(Card)) | [Navigation](#) | Pushes the given card onto the stack. |\n| [updateCard(card)](#updateCard(Card)) | [Navigation](#) | Does an in-place replacement of the current card. |\n\nDetailed documentation\n----------------------\n\n### `pop``Card()`\n\nPops a card from the navigation stack. Can be chained with other card navigation actions.\n\n#### Return\n\n\n[Navigation](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `pop``To``Named``Card(cardName)`\n\nPops to the specified card by its card name. Can be chained with other card navigation actions.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|--------------------------------------|\n| `card``Name` | `String` | The name of the card to navigate to. |\n\n#### Return\n\n\n[Navigation](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `pop``To``Root()`\n\nPops the card stack to the root card. Can be chained with other card navigation actions.\n\n#### Return\n\n\n[Navigation](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `push``Card(card)`\n\nPushes the given card onto the stack. Can be chained with other card navigation actions.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|--------------------------------------------------|-----------------------------|\n| `card` | [Card](/apps-script/reference/card-service/card) | A card to add to the stack. |\n\n#### Return\n\n\n[Navigation](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `update``Card(card)`\n\nDoes an in-place replacement of the current card. Can be chained with other card navigation\nactions.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|--------------------------------------------------|------------------------------------------|\n| `card` | [Card](/apps-script/reference/card-service/card) | A card to replace the current card with. |\n\n#### Return\n\n\n[Navigation](#) --- This object, for chaining."]]
