Class ChatResponseBuilder

ChatResponseBuilder

Un compilador para objetos ChatResponse.

Solo está disponible para las apps de Google Chat. No está disponible para los complementos de 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 datos que se muestraDescripción breve
addCardsV2(cardWithId)ChatResponseBuilderEstablece el campo de tarjeta del mensaje.
build()ChatResponseCompila la respuesta de acción actual y la valida.
setActionResponse(actionResponse)ChatResponseBuilderEstablece el campo de respuesta de acción del mensaje.
setText(text)ChatResponseBuilderEstablece el texto del mensaje de Chat.

Documentación detallada

addCardsV2(cardWithId)

Establece el campo de tarjeta del mensaje. Se usa para enviar una tarjeta en un mensaje de Google Chat. Cada tarjeta se asocia con un ID único. Se debe compilar el objeto CardWithId y usarse con este 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

NombreTipoDescripción
cardWithIdCardWithIdEl CardWithId que se debe usar.

Devolvedor

ChatResponseBuilder: Este objeto se usa para encadenar.


build()

Compila la respuesta de acción actual y la valida.

Devolvedor

ChatResponse: Es una ChatResponse validada.


setActionResponse(actionResponse)

Establece el campo de respuesta de acción del mensaje.

// 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

NombreTipoDescripción
actionResponseChatActionResponseEl ChatActionResponse que se debe usar.

Devolvedor

ChatResponseBuilder: Este objeto se usa para encadenar.


setText(text)

Establece el texto del mensaje de Chat.

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

Parámetros

NombreTipoDescripción
textStringEl texto que se usará.

Devolvedor

ChatResponseBuilder: Este objeto se usa para encadenar.