Class ActionResponseBuilder
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
مستندات دقیق
build()
پاسخ اقدام فعلی را می سازد و آن را تأیید می کند.
بازگشت
Action Response
- یک ActionResponse معتبر.
پرتاب می کند
Error
- اگر پاسخ اقدام ساخته شده معتبر نباشد.
set Navigation(navigation)
set Notification(notification)
اعلان را تنظیم می کند تا هنگام فعال شدن عملکرد نمایش داده شود.
پارامترها
بازگشت
Action Response Builder
- این شیء، برای زنجیره زدن.
set Open Link(openLink)
URL را تنظیم می کند تا زمانی که عملکرد فعال می شود به آن پیمایش شود.
پارامترها
بازگشت
Action Response Builder
- این شیء، برای زنجیره زدن.
set State Changed(stateChanged)
یک پرچم تنظیم می کند تا نشان دهد که این عملکرد وضعیت داده موجود را تغییر داده است. به عنوان مثال، اگر این اقدام یک کار ایجاد کرد یا اطلاعات تماس را به روز کرد. وقتی این پرچم روی درست تنظیم میشود، سرویسهایی مانند Gmail میتوانند تمام دادههای حالت حافظه پنهان مرتبط با این عملکرد را پاک کنند.
پارامترها
نام | تایپ کنید | توضیحات |
---|
state Changed | Boolean | آیا این اقدام دادههای وضعیت موجود را تغییر داده است یا خیر. پیش فرض به نادرست. |
بازگشت
Action Response Builder
- این شیء، برای زنجیره زدن.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003e\u003ccode\u003eActionResponseBuilder\u003c/code\u003e helps create responses for actions within Google Apps Script cards.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to define navigation, notifications, open links, and signal state changes when an action is performed.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes the response and ensures its validity before execution.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003esetNavigation()\u003c/code\u003e, \u003ccode\u003esetNotification()\u003c/code\u003e, \u003ccode\u003esetOpenLink()\u003c/code\u003e, and \u003ccode\u003esetStateChanged()\u003c/code\u003e allow customization of the action's outcome.\u003c/p\u003e\n"],["\u003cp\u003eUsing an \u003ccode\u003eActionResponseBuilder\u003c/code\u003e streamlines the process of defining how user interactions within a card trigger specific application behaviors.\u003c/p\u003e\n"]]],["The `ActionResponseBuilder` constructs `ActionResponse` objects. Key actions include: `build()`, which creates and validates the response; `setNavigation()`, which sets a navigation action; `setNotification()`, which sets a notification to display; `setOpenLink()`, which sets a URL for navigation; and `setStateChanged()`, which flags if the action modifies existing data. Each setter method allows for chaining and accepts specific object types like `Navigation`, `Notification`, or `OpenLink` to define the response.\n"],null,["# Class ActionResponseBuilder\n\nActionResponseBuilder\n\nA builder for [ActionResponse](/apps-script/reference/card-service/action-response) objects. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------|\n| [build()](#build()) | [ActionResponse](/apps-script/reference/card-service/action-response) | Builds the current action response and validates it. |\n| [setNavigation(navigation)](#setNavigation(Navigation)) | [ActionResponseBuilder](#) | Sets the response to a [Navigation](/apps-script/reference/card-service/navigation) action. |\n| [setNotification(notification)](#setNotification(Notification)) | [ActionResponseBuilder](#) | Sets the notification to display when the action is activated. |\n| [setOpenLink(openLink)](#setOpenLink(OpenLink)) | [ActionResponseBuilder](#) | Sets the URL to navigate to when the action is activated. |\n| [setStateChanged(stateChanged)](#setStateChanged(Boolean)) | [ActionResponseBuilder](#) | Sets a flag to indicate that this action changed the existing data state. |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nBuilds the current action response and validates it.\n\n#### Return\n\n\n[ActionResponse](/apps-script/reference/card-service/action-response) --- A validated ActionResponse.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed action response isn't valid.\n\n*** ** * ** ***\n\n### `set``Navigation(navigation)`\n\nSets the response to a [Navigation](/apps-script/reference/card-service/navigation) action.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|--------------------------------------------------------------|--------------------------------------------------------------------------|\n| `navigation` | [Navigation](/apps-script/reference/card-service/navigation) | The [Navigation](/apps-script/reference/card-service/navigation) to use. |\n\n#### Return\n\n\n[ActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Notification(notification)`\n\nSets the notification to display when the action is activated.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|------------------------------------------------------------------|------------------------------------------------------------------------------|\n| `notification` | [Notification](/apps-script/reference/card-service/notification) | The [Notification](/apps-script/reference/card-service/notification) to use. |\n\n#### Return\n\n\n[ActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Open``Link(openLink)`\n\nSets the URL to navigate to when the action is activated.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|-----------------------------------------------------------|-----------------------------------------------------------------------|\n| `open``Link` | [OpenLink](/apps-script/reference/card-service/open-link) | The [OpenLink](/apps-script/reference/card-service/open-link) to use. |\n\n#### Return\n\n\n[ActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``State``Changed(stateChanged)`\n\nSets a flag to indicate that this action changed the existing data state. For example, if the\naction created a task or updated contact information. When this flag is set to true, services\nsuch as Gmail can attempt to clear any cached state data associated with this action.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------|-----------|-----------------------------------------------------------------------------|\n| `state``Changed` | `Boolean` | Whether this action has changed the existing state data. Defaults to false. |\n\n#### Return\n\n\n[ActionResponseBuilder](#) --- This object, for chaining."]]