Esta página foi traduzida pela API Cloud Translation.

Class ChatResponseBuilder

Um builder para objetos ChatResponse.

Disponível apenas para 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étodo	Tipo de retorno	Breve descrição
`addCardsV2(cardWithId)`	`ChatResponseBuilder`	Define o campo do cartão da mensagem.
`build()`	`ChatResponse`	Cria e valida a resposta de ação atual.
`setActionResponse(actionResponse)`	`ChatResponseBuilder`	Define o campo de resposta de ação da mensagem.
`setText(text)`	`ChatResponseBuilder`	Define o texto da mensagem do Chat.

Documentação detalhada

`addCardsV2(cardWithId)`

Define o campo do cartão da mensagem. É usado para enviar um card em uma mensagem do Google Chat. Cada card é associado a um ID exclusivo. O objeto CardWithId precisa 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

Nome	Tipo	Descrição
`cardWithId`	`CardWithId`	O `CardWithId` a ser usado.

Retornar

ChatResponseBuilder: este objeto, para encadeamento.

`build()`

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

Retornar

ChatResponse: uma ChatResponse validada.

`setActionResponse(actionResponse)`

Define o campo de resposta de 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

Nome	Tipo	Descrição
`actionResponse`	`ChatActionResponse`	O `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

Nome	Tipo	Descrição
`text`	`String`	O texto a ser usado.

Retornar

ChatResponseBuilder: este objeto, para encadeamento.