Class ChatResponseBuilder

Antwort-Tool für Google Chat

Ein Builder für ChatResponse-Objekte.

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.

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();

Methoden

MethodeRückgabetypKurzbeschreibung
addCardsV2(cardWithId)ChatResponseBuilderLegt das Kartenfeld der Nachricht fest.
build()ChatResponseDie aktuelle Aktionsantwort wird erstellt und validiert.
setActionResponse(actionResponse)ChatResponseBuilderLegt das Feld „action_response“ der Nachricht fest.
setText(text)ChatResponseBuilderLegt den Text der Chatnachricht fest.

Detaillierte Dokumentation

addCardsV2(cardWithId)

Legt das Kartenfeld der Nachricht fest. Damit können Sie eine Karte in einer Google Chat-Nachricht senden. Jede Karte ist mit einer eindeutigen ID verknüpft. Das CardWithId-Objekt sollte mit dieser Methode erstellt und verwendet werden.

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();

Parameter

NameTypBeschreibung
cardWithIdCardWithIdDer zu verwendende CardWithId.

Rückflug

ChatResponseBuilder – dieses Objekt, zur Verkettung


build()

Die aktuelle Aktionsantwort wird erstellt und validiert.

Rückflug

ChatResponse – eine validierte ChatResponse.


setActionResponse(actionResponse)

Legt das Feld „action_response“ der Nachricht fest.

// 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();

Parameter

NameTypBeschreibung
actionResponseChatActionResponseDer zu verwendende ChatActionResponse.

Rückflug

ChatResponseBuilder – dieses Objekt, zur Verkettung


setText(text)

Legt den Text der Chatnachricht fest.

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

Parameter

NameTypBeschreibung
textStringDer zu verwendende Text.

Rückflug

ChatResponseBuilder – dieses Objekt, zur Verkettung