Class ChatResponseBuilder

أداةإنشاء الردود في Chat

أداة إنشاء لكائنات 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();

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
addCardsV2(cardWithId)ChatResponseBuilderلضبط حقل البطاقة في الرسالة.
build()ChatResponseتُنشئ هذه الوظيفة ردّ الإجراء الحالي وتتحقّق من صحته.
setActionResponse(actionResponse)ChatResponseBuilderتُستخدَم لضبط حقل الردّ على الإجراء في الرسالة.
setText(text)ChatResponseBuilderلضبط نص رسالة Chat

مستندات تفصيلية

addCardsV2(cardWithId)

لضبط حقل البطاقة في الرسالة. يُستخدَم هذا الإجراء لإرسال بطاقة في رسالة على Google Chat. كل بطاقة مرتبطة بمعرّف فريد، ويجب إنشاء عنصر 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();

المعلمات

الاسمالنوعالوصف
cardWithIdCardWithIdCardWithId المطلوب استخدامه

الإرجاع

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

المعلمات

الاسمالنوعالوصف
actionResponseChatActionResponseChatActionResponse المطلوب استخدامه

الإرجاع

ChatResponseBuilder: هذا العنصر، لإنشاء سلسلة.


setText(text)

لضبط نص رسالة Chat

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

المعلمات

الاسمالنوعالوصف
textStringالنص المطلوب استخدامه.

الإرجاع

ChatResponseBuilder: هذا العنصر، لإنشاء سلسلة.