Class Navigation

Navigation

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

Methods

MethodReturn typeBrief description
popCard()NavigationPops a card from the navigation stack.
popToNamedCard(cardName)NavigationPops to the specified card by its card name.
popToRoot()NavigationPops the card stack to the root card.
printJson()StringPrints the JSON representation of this object.
pushCard(card)NavigationPushes the given card onto the stack.
updateCard(card)NavigationDoes 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

NameTypeDescription
cardNameStringthe 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

NameTypeDescription
cardCarda 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

NameTypeDescription
cardCarda card to replace the current card with.

Return

Navigation — this object, for chaining.

Send feedback about...

Apps Script
Apps Script