Class Navigation

Navegação

Um objeto auxiliar que controla a navegação por cards. Consulte o guia de navegação por cards para mais detalhes.

Exemplo de uso:

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

Métodos

Método	Tipo de retorno	Breve descrição
popCard()	Navigation	Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.
popToNamedCard(cardName)	Navigation	Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.
popToRoot()	Navigation	Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.
printJson()	String	Imprime a representação JSON deste objeto.
pushCard(card)	Navigation	Envia o card especificado para a pilha.
setEndNavigation(endNavigation)	Navigation	Define a ação de navegação final.
updateCard(card)	Navigation	Faz uma substituição no lugar do cartão atual.

Documentação detalhada

popCard()

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Disponível para complementos do Google Workspace que estendem o Google Chat.

Extrai um card da pilha de navegação. Pode ser encadeado com outras ações de navegação de cards.

Retornar

Navigation: este objeto, para encadeamento.

---

popToNamedCard(cardName)

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Disponível para complementos do Google Workspace que estendem o Google Chat.

Mostra o card especificado pelo nome. Pode ser encadeado com outras ações de navegação de cards.

Parâmetros

Nome	Tipo	Descrição
cardName	String	O nome do card para navegar.

Retornar

Navigation: este objeto, para encadeamento.

---

popToRoot()

Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Disponível para complementos do Google Workspace que estendem o Google Chat.

Remove a pilha de cards até o card raiz. Pode ser encadeado com outras ações de navegação de cards.

Retornar

Navigation: este objeto, para encadeamento.

---

printJson()

Imprime a representação JSON deste objeto. Isso é apenas para depuração.

Retornar

String

---

pushCard(card)

Envia o card especificado para a pilha. Pode ser encadeado com outras ações de navegação de cards.

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

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

Parâmetros

Nome	Tipo	Descrição
card	Card	Um cartão para adicionar à pilha.

Retornar

Navigation: este objeto, para encadeamento.

---

setEndNavigation(endNavigation)

Define a ação de navegação final.

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

Parâmetros

Nome	Tipo	Descrição
endNavigation	EndNavigation	O EndNavigation a ser usado.

Retornar

Navigation: este objeto, para encadeamento.

---

updateCard(card)

Faz uma substituição no lugar do cartão atual. Pode ser encadeado com outras ações de navegação de cards.

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

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

Parâmetros

Nome	Tipo	Descrição
card	Card	Um card para substituir o atual.

Retornar

Navigation: este objeto, para encadeamento.