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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addCardsV2(cardWithId) | ChatResponseBuilder | Legt das Kartenfeld der Nachricht fest. |
build() | ChatResponse | Erstellt die aktuelle Aktionsantwort und validiert sie. |
setActionResponse(actionResponse) | ChatResponseBuilder | Legt das Aktionsantwortfeld der Nachricht fest. |
setText(text) | ChatResponseBuilder | Legt den Text der Chat-Nachricht fest. |
Detaillierte Dokumentation
addCardsV2(cardWithId)
Legt das Kartenfeld der Nachricht fest. Hiermit wird eine Karte in einer Google Chat-Nachricht gesendet. Jedes
Karte einer eindeutigen ID zugeordnet ist, sollte das CardWithId
-Objekt erstellt und mit
diese Methode verwenden.
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
Name | Typ | Beschreibung |
---|---|---|
cardWithId | CardWithId | Der zu verwendende CardWithId . |
Rückflug
ChatResponseBuilder
: Dieses Objekt zur Verkettung.
build()
Erstellt die aktuelle Aktionsantwort und validiert sie.
Rückflug
ChatResponse
: Eine validierte ChatResponse.
setActionResponse(actionResponse)
Legt das Aktionsantwortfeld 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
Name | Typ | Beschreibung |
---|---|---|
actionResponse | ChatActionResponse | Der zu verwendende ChatActionResponse . |
Rückflug
ChatResponseBuilder
: Dieses Objekt zur Verkettung.
setText(text)
Legt den Text der Chat-Nachricht fest.
const chatResponse = CardService.newChatResponseBuilder() .setText('Example text') .build();
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der zu verwendende Text. |
Rückflug
ChatResponseBuilder
: Dieses Objekt zur Verkettung.