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)	ActionResponseBuilder	LinkPreview をアクションに設定します。
setNavigation(navigation)	ActionResponseBuilder	Navigation アクションに対するレスポンスを設定します。
setNotification(notification)	ActionResponseBuilder	アクションが有効になったときに表示する通知を設定します。
setOpenLink(openLink)	ActionResponseBuilder	アクションが有効になったときに移動する URL を設定します。
setStateChanged(stateChanged)	ActionResponseBuilder	このアクションによって既存のデータ状態が変更されたことを示すフラグを設定します。

詳細なドキュメント

addModifyCard(modifyCard)

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

パラメータ

名前	タイプ	説明
modifyCard	ModifyCard	使用する ModifyCard。

戻る

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

---

build()

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

戻る

ActionResponse - 検証済みの ActionResponse。

例外

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

---

setLinkPreview(linkPreview)

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

パラメータ

名前	タイプ	説明
linkPreview	LinkPreview	使用する LinkPreview。

戻る

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

---

setNavigation(navigation)

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

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

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

パラメータ

名前	タイプ	説明
navigation	Navigation	使用する Navigation。

戻る

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

---

setNotification(notification)

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

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

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

パラメータ

名前	タイプ	説明
notification	Notification	使用する Notification。

戻る

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

---

setOpenLink(openLink)

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

パラメータ

名前	タイプ	説明
openLink	OpenLink	使用する OpenLink。

戻る

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

---

setStateChanged(stateChanged)

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

パラメータ

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

戻る

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