Class Navigation

AI-generated Key Takeaways

• The Navigation object facilitates card navigation within Google Workspace add-ons, allowing developers to control the flow and presentation of user interfaces.

• It offers methods like pushCard(), popCard(), and updateCard() to manage the card stack, enabling dynamic and interactive user experiences.

• Developers can use popToNamedCard() or popToRoot() for direct navigation to specific cards within the stack, enhancing user control and flexibility.

• All navigation methods are chainable, providing a streamlined and efficient way to sequence multiple actions and create complex navigation flows within the add-on.

• The printJson() method aids debugging by outputting the object's JSON representation, allowing developers to inspect its structure and state.

Navigation

A helper object that controls card navigation. See the card navigation guide for more details.

Methods

Method	Return type	Brief description
popCard()	Navigation	Pops a card from the navigation stack.
popToNamedCard(cardName)	Navigation	Pops to the specified card by its card name.
popToRoot()	Navigation	Pops the card stack to the root card.
printJson()	String	Prints the JSON representation of this object.
pushCard(card)	Navigation	Pushes the given card onto the stack.
updateCard(card)	Navigation	Does an in-place replacement of the current card.

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.