Class ActionResponseBuilder

ActionResponseBuilder

ActionResponse オブジェクトのビルダー。

Google Workspace アドオンで利用できます。 

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .setNotification(notification)
    .build();

メソッド

メソッド戻り値の型概要
addModifyCard(modifyCard)ActionResponseBuilderカード変更オペレーションをアクションに設定します。
build()ActionResponse現在のアクション レスポンスをビルドして検証します。
setLinkPreview(linkPreview)ActionResponseBuilderLinkPreview をアクションに設定します。
setNavigation(navigation)ActionResponseBuilderNavigation アクションに対するレスポンスを設定します。
setNotification(notification)ActionResponseBuilderアクションが有効になったときに表示する通知を設定します。
setOpenLink(openLink)ActionResponseBuilderアクションが有効になったときに移動する URL を設定します。
setStateChanged(stateChanged)ActionResponseBuilderこのアクションが既存のデータ状態を変更したことを示すフラグを設定します。

詳細なドキュメント

addModifyCard(modifyCard)

カード変更オペレーションをアクションに設定します。

パラメータ

名前型説明
modifyCardModifyCard使用する ModifyCard。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。

build()

現在のアクション レスポンスをビルドして検証します。

戻る

ActionResponse - 検証済みの ActionResponse。

例外

Error - 構築されたアクション レスポンスが無効な場合。

setLinkPreview(linkPreview)

LinkPreview をアクションに設定します。

パラメータ

名前型説明
linkPreviewLinkPreview使用する LinkPreview。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。

setNavigation(navigation)

Navigation アクションへのレスポンスを設定します。

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .build();

パラメータ

名前型説明
navigationNavigation使用する Navigation。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。

setNotification(notification)

アクションが有効になったときに表示する通知を設定します。

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNotification(notification)
    .build();

パラメータ

名前型説明
notificationNotification使用する Notification。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。

アクションが有効になったときに移動する URL を設定します。

パラメータ

名前型説明
openLinkOpenLink使用する OpenLink。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。

setStateChanged(stateChanged)

このアクションによって既存のデータ状態が変更されたことを示すフラグを設定します。たとえば、アクションでタスクが作成されたり、連絡先情報が更新されたりした場合などです。このフラグが true に設定されている場合、Gmail などのサービスは、このアクションに関連付けられたキャッシュに保存された状態データのクリアを試みることができます。

パラメータ

名前型説明
stateChangedBooleanこのアクションによって既存の状態データが変更されたかどうか。デフォルトは false です。

戻る

ActionResponseBuilder - チェーン用のこのオブジェクト。