Class ChatResponseBuilder

سازنده‌ی پاسخ چت

یک سازنده برای اشیاء ChatResponse .

فقط برای برنامه‌های Google Chat در دسترس است. برای افزونه‌های 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();

روش‌ها

روش نوع بازگشتی شرح مختصر
add Cards V2(cardWithId) Chat Response Builder فیلد کارت پیام را تنظیم می‌کند.
build() Chat Response پاسخ اقدام فعلی را می‌سازد و آن را اعتبارسنجی می‌کند.
set Action Response(actionResponse) Chat Response Builder فیلد پاسخ به اقدام پیام را تنظیم می‌کند.
set Text(text) Chat Response Builder متن پیام چت را تنظیم می‌کند.

مستندات دقیق

addCardsV2(cardWithId)

فیلد کارت پیام را تنظیم می‌کند. این برای ارسال کارت در پیام چت گوگل استفاده می‌شود. هر کارت با یک شناسه منحصر به فرد مرتبط است، شیء CardWithId باید ساخته شود و با این متد استفاده شود.

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

پارامترها

نام نوع توضیحات
card With Id Card With Id Card With Id برای استفاده.

بازگشت

ChatResponseBuilder - این شیء، برای زنجیره‌سازی.


build()

پاسخ اقدام فعلی را می‌سازد و آن را اعتبارسنجی می‌کند.

بازگشت

ChatResponse - یک ChatResponse معتبر.


setActionResponse(actionResponse)

فیلد پاسخ به اقدام پیام را تنظیم می‌کند.

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

پارامترها

نام نوع توضیحات
action Response Chat Action Response Chat Action Response برای استفاده.

بازگشت

ChatResponseBuilder - این شیء، برای زنجیره‌سازی.


setText(text)

متن پیام چت را تنظیم می‌کند.

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

پارامترها

نام نوع توضیحات
text String متنی که باید استفاده شود.

بازگشت

ChatResponseBuilder - این شیء، برای زنجیره‌سازی.