Class CardAction
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
CardAction represents a clickable menu item added to a card's header.
-
It provides methods to set actions like opening URLs, composing emails, or triggering custom functions when clicked.
-
You can define the action's behavior using
setOnClickAction,setOpenLink,setAuthorizationAction,setComposeAction, orsetOnClickOpenLinkAction. -
Each CardAction object can have only one action type set at a time.
-
setTextcustomizes the displayed text for the action in the card header menu.
A clickable menu item that is added to the card header menu.
constaction=CardService.newAction(); // Finish building the action... constcardAction= CardService.newCardAction().setText('Card action').setOnClickAction(action);
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Card | Sets an authorization action that opens a URL to the authorization flow when the object is clicked. |
set | Card | Sets an action that composes a draft email when the object is clicked. |
set | Card | Sets an action that executes when the object is clicked. |
set | Card | Sets an action that opens a URL in a tab when the object is clicked. |
set | Card | Sets a URL to be opened when the object is clicked. |
set | Card | Sets the menu text for this action. |
Detailed documentation
setAuthorizationAction(action)
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. This opens the URL in a new window. When the user finishes the authorization flow and returns to the application, the add-on reloads.
A UI object can only have one of set, set, set, set, or set set.
// ... constaction=CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameters
| Name | Type | Description |
|---|---|---|
action | Authorization | The object that specifies the authorization action to take when this element is clicked. |
Return
Card — This object, for chaining.
setComposeAction(action, composedEmailType)
Sets an action that composes a draft email when the object is clicked. A UI object can only
have one of set, set, set,
set, or set set.
The Action parameter must specify a callback function that returns a Compose object configured using Compose.
// ... constaction=CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action,CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... functioncomposeEmailCallback(e){ constthread=GmailApp.getThreadById(e.threadId); constdraft=thread.createDraftReply('This is a reply'); returnCardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The object that specifies the compose action to take when this element is clicked. |
composed | Composed | An enum value that specifies whether the composed draft is a standalone or reply draft. |
Return
Card — This object, for chaining.
setOnClickAction(action)
Sets an action that executes when the object is clicked. A UI object can only have one of
set, set, set, set, or set set.
The Action parameter must specify a callback function that returns a Action object.
// ... constaction=CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... functionnotificationCallback(){ returnCardService.newActionResponseBuilder() .setNotification( CardService.newNotification().setText('Some info to display to user'), ) .build(); }
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The action to take when this element is clicked. |
Return
Card — This object, for chaining.
setOnClickOpenLinkAction(action)
Sets an action that opens a URL in a tab when the object is clicked. Use this function when the
URL needs to be built or when you need to take other actions in addition to creating the Open object. A UI object can only have one of set, set, set, set, or
set set.
The Action parameter must specify a callback function that returns a Action object configured using Action.
// ... constaction=CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... functionopenLinkCallback(){ returnCardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')) .build(); }
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The object that specifies the open link action to take when this element is clicked. |
Return
Card — This object, for chaining.
setOpenLink(openLink)
Sets a URL to be opened when the object is clicked. Use this function when the URL is already
known and only needs to be opened. A UI object can only have one of set,
set, set, set,
or set set.
Parameters
| Name | Type | Description |
|---|---|---|
open | Open | An Open object describing the URL to open. |
Return
Card — This object, for chaining.
setText(text)
Sets the menu text for this action.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The menu item text. |
Return
Card — This object, for chaining.