Class Navigation
Stay organized with collections
Save and categorize content based on your preferences.
Navigation
A helper object that controls card navigation. See the card navigation guide for more details.
Detailed documentation
popCard()
Pops a card from the navigation stack. Can be chained with other card navigation actions.
Return
Navigation — This object, for chaining.
popToNamedCard(cardName)
Pops to the specified card by its card name. Can be chained with other card navigation actions.
Parameters
| Name | Type | Description |
cardName | String | The name of the card to navigate to. |
Return
Navigation — This object, for chaining.
popToRoot()
Pops the card stack to the root card. Can be chained with other card navigation actions.
Return
Navigation — This object, for chaining.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
pushCard(card)
Pushes the given card onto the stack. Can be chained with other card navigation actions.
Parameters
| Name | Type | Description |
card | Card | A card to add to the stack. |
Return
Navigation — This object, for chaining.
updateCard(card)
Does an in-place replacement of the current card. Can be chained with other card navigation
actions.
Parameters
| Name | Type | Description |
card | Card | A card to replace the current card with. |
Return
Navigation — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 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."]]
