Class ChatResponseBuilder

ChatResponseBuilder

Um builder para objetos ChatResponse.

Disponível apenas nos apps do Google Chat. Não disponível para complementos do Google Workspace.

const cardSection = CardService.newCardSection();
cardSection.addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget.'));

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

const cardWithId = CardService.newCardWithId()
    .setCardId('card_id')
    .setCard(card);

const chatResponse = CardService.newChatResponseBuilder()
       .addCardsV2(cardWithId)
       .setText('Example text')
    .build();

Métodos

MétodoTipo de retornoBreve descrição
addCardsV2(cardWithId)ChatResponseBuilderDefine o campo do cartão da mensagem.
build()ChatResponseCria a resposta da ação atual e a valida.
setActionResponse(actionResponse)ChatResponseBuilderDefine o campo de resposta da ação da mensagem.
setText(text)ChatResponseBuilderDefine o texto da mensagem do Chat.

Documentação detalhada

addCardsV2(cardWithId)

Define o campo do cartão da mensagem. Isso é usado para enviar um card em uma mensagem do Google Chat. Cada é associado a um ID exclusivo, o objeto CardWithId deve ser criado e usado com esse método.

const cardSection = CardService.newCardSection();
cardSection.addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget.'));

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

const cardWithId = CardService.newCardWithId()
    .setCardId('card_id')
    .setCard(card);

const chatResponse = CardService.newChatResponseBuilder()
    .addCardsV2(cardWithId)
    .build();

Parâmetros

NomeTipoDescrição
cardWithIdCardWithIdO CardWithId a ser usado.

Retornar

ChatResponseBuilder: este objeto, para encadeamento.


build()

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

Retornar

ChatResponse: uma ChatResponse validada.


setActionResponse(actionResponse)

Define o campo de resposta da ação da mensagem.

// Build the card.
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('card title')).build();

// Creates the dialog.
const dialog = CardService.newDialog()
    .setBody(card);

// Creates the dialog action.
const dialogAction = CardService.newDialogAction()
   .setDialog(dialog)

// Creates the action response and sets the type to DIALOG.
const actionResponse = CardService.newChatActionResponse()
       .setDialogAction(dialogAction).setResponseType(CardService.Type.DIALOG);

// Creates the Chat response and sets the action response.
const chatResponse = CardService.newChatResponseBuilder()
       .setActionResponse(actionResponse)
    .build();

Parâmetros

NomeTipoDescrição
actionResponseChatActionResponseO ChatActionResponse a ser usado.

Retornar

ChatResponseBuilder: este objeto, para encadeamento.


setText(text)

Define o texto da mensagem do Chat.

const chatResponse = CardService.newChatResponseBuilder()
       .setText('Example text')
    .build();

Parâmetros

NomeTipoDescrição
textStringO texto a ser usado.

Retornar

ChatResponseBuilder: este objeto, para encadeamento.