Class ChatActionResponse

聊天操作响应

一个类,表示 Chat 应用可以使用这些参数来配置其响应的发布方式。

仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

const card = CardService.newCardBuilder()
                 .setHeader(CardService.newCardHeader().setTitle('Card title'))
                 .build();
const dialog = CardService.newDialog().setBody(card);

const dialogAction = CardService.newDialogAction().setDialog(dialog);

const chatActionResponse = CardService.newChatActionResponse()
                               .setResponseType(CardService.Type.DIALOG)
                               .setDialogAction(dialogAction);

方法

方法返回类型简介
setDialogAction(dialogAction)ChatActionResponse将对话框操作设置为与对话框相关的事件。
setResponseType(responseType)ChatActionResponseChat 应用响应的类型。
setUpdatedWidget(updatedWidget)ChatActionResponse设置更新后的 widget,用于为 widget 提供自动补全选项。
setUrl(url)ChatActionResponse供用户进行身份验证或配置的网址。

详细文档

setDialogAction(dialogAction)

将对话框操作设置为与对话框相关的事件。

const card = CardService.newCardBuilder()
                 .setHeader(CardService.newCardHeader().setTitle('Card title'))
                 .build();
const dialog = CardService.newDialog().setBody(card);

const dialogAction = CardService.newDialogAction().setDialog(dialog);

const chatActionResponse = CardService.newChatActionResponse()
                               .setResponseType(CardService.Type.DIALOG)
                               .setDialogAction(dialogAction);

参数

名称类型说明
dialogActionDialogAction要设置的对话框操作。

返回

ChatActionResponse - 此对象,用于链式调用。


setResponseType(responseType)

Chat 应用响应的类型。

const chatActionResponse = CardService.newChatActionResponse().setResponseType(
    CardService.Type.DIALOG,
);

参数

名称类型说明
responseTypeResponseType响应类型。

返回

ChatActionResponse - 此对象,用于链式调用。


setUpdatedWidget(updatedWidget)

设置更新后的 widget,用于为 widget 提供自动补全选项。

const updatedWidget =
    CardService.newUpdatedWidget()
        .addItem(
            'Contact 1',
            'contact-1',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact one description',
            )
        .addItem(
            'Contact 2',
            'contact-2',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact two description',
            )
        .addItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .addItem(
            'Contact 4',
            'contact-4',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact four description',
            )
        .addItem(
            'Contact 5',
            'contact-5',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact five description',
        );

const actionResponse =
    CardService.newChatActionResponse()
        .setUpdatedWidget(updatedWidget)
        .setResponseType(CardService.ResponseType.UPDATE_WIDGET);
仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

参数

名称类型说明
updatedWidgetUpdatedWidget要设置的更新版微件。

返回

ChatActionResponse - 此对象,用于链式调用。


setUrl(url)

供用户进行身份验证或配置的网址。仅适用于 REQUEST_CONFIG 响应类型。

const chatActionResponse = CardService.newChatActionResponse()
                               .setResponseType(CardService.Type.REQUEST_CONFIG)
                               .setUrl('https://www.google.com');

参数

名称类型说明
urlString要发送的网址。

返回

ChatActionResponse - 此对象,用于链式调用。