Class ActionResponseBuilder

ActionResponseBuilder

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

Um builder para objetos ActionResponse.

Disponível para complementos do Google Workspace.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

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

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .setNotification(notification)
    .build();

Métodos

Método	Tipo de retorno	Breve descrição
addModifyCard(modifyCard)	ActionResponseBuilder	Define a operação de modificação do card para a ação.
build()	ActionResponse	Cria e valida a resposta da ação atual.
setLinkPreview(linkPreview)	ActionResponseBuilder	Define o LinkPreview para a ação.
setNavigation(navigation)	ActionResponseBuilder	Define a resposta para uma ação Navigation.
setNotification(notification)	ActionResponseBuilder	Define a notificação a ser exibida quando a ação é ativada.
setOpenLink(openLink)	ActionResponseBuilder	Define o URL para navegar quando a ação é ativada.
setStateChanged(stateChanged)	ActionResponseBuilder	Define uma flag para indicar que essa ação mudou o estado dos dados atuais.

Documentação detalhada

addModifyCard(modifyCard)

Define a operação de modificação do card para a ação.

Parâmetros

Nome	Tipo	Descrição
modifyCard	ModifyCard	O ModifyCard a ser usado.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.

---

build()

Cria e valida a resposta da ação atual.

Retornar

ActionResponse: um ActionResponse validado.

Gera

Error: se a resposta de ação construída não for válida.

---

setLinkPreview(linkPreview)

Define o LinkPreview para a ação.

Parâmetros

Nome	Tipo	Descrição
linkPreview	LinkPreview	O LinkPreview a ser usado.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.

---

setNavigation(navigation)

Define a resposta para uma ação Navigation.

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

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .build();

Parâmetros

Nome	Tipo	Descrição
navigation	Navigation	O Navigation a ser usado.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.

---

setNotification(notification)

Define a notificação a ser exibida quando a ação é ativada.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNotification(notification)
    .build();

Parâmetros

Nome	Tipo	Descrição
notification	Notification	O Notification a ser usado.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.

---

setOpenLink(openLink)

Define o URL para navegar quando a ação é ativada.

Parâmetros

Nome	Tipo	Descrição
openLink	OpenLink	O OpenLink a ser usado.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.

---

setStateChanged(stateChanged)

Define uma flag para indicar que essa ação mudou o estado dos dados atuais. Por exemplo, se a ação criou uma tarefa ou atualizou informações de contato. Quando essa flag é definida como true, serviços como o Gmail podem tentar limpar todos os dados de estado armazenados em cache associados a essa ação.

Parâmetros

Nome	Tipo	Descrição
stateChanged	Boolean	Se essa ação mudou os dados de estado atuais. O valor padrão é false.

Retornar

ActionResponseBuilder: este objeto, para encadeamento.