Deprecated. This class is deprecated and should not be used in new scripts.
This class is deprecated. Instead, use Decorated
.
Methods
Method | Return type | Brief description |
---|---|---|
set |
| Sets an authorization action that opens a URL to the authorization flow when the object is clicked. |
set |
| Sets an action that composes a draft email when the object is clicked. |
set |
| Sets an action that executes when the object is clicked. |
set |
| Sets an action that opens a URL in a tab when the object is clicked. |
set |
| Sets a URL to be opened when the object is clicked. |
Deprecated methods
Method | Return type | Brief description |
---|---|---|
|
| Sets the label text to be used as the key. |
|
| Sets the Button that is displayed to the right of the context. |
|
| Sets the text to be used as the value. |
|
| Sets the icon to be used as the key. |
|
| Sets the alternative text for the icon. |
|
| Sets the URL of the icon to be used as the key. |
|
| Sets whether the value text should be displayed on a single line or multiple lines. |
|
| Sets the Switch that is displayed to the right of the content. |
|
| Sets the label text to be used as the key. |
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.
// ... const action = 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
— This object, for chaining.Key
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
.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.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
— This object, for chaining.Key
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.
// ... const action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... function notificationCallback() { return CardService.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
— This object, for chaining.Key
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
.
// ... const action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.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
— This object, for chaining.Key
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
Return
— This object, for chaining.Key
Deprecated methods
setBottomLabel(text)
setBottomLabel(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the label text to be used as the key. Displayed below the text-content.
Parameters
Name | Type | Description |
---|---|---|
text | String | The label text. Note: It doesn't support basic HTML formatting. |
Return
— This object, for chaining.Key
setButton(button)
setButton(button)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the Button
that is displayed to the right of the context. A
can
only support one button, one switch or one icon.Key
Parameters
Name | Type | Description |
---|---|---|
button | Button | The button to add. |
Return
— This object, for chaining.Key
setContent(text)
setContent(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the text to be used as the value. Supports basic HTML formatting. Required.
Parameters
Name | Type | Description |
---|---|---|
text | String | The text content for this widget. |
Return
— This object, for chaining.Key
setIcon(icon)
setIcon(icon)
setIconAltText(altText)
setIconAltText(altText)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the alternative text for the icon.
Parameters
Name | Type | Description |
---|---|---|
alt | String | The alternative text for the icon. |
Return
— This object, for chaining.Key
setIconUrl(url)
setIconUrl(url)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the URL of the icon to be used as the key.
Parameters
Name | Type | Description |
---|---|---|
url | String | The URL address of a hosted image to use as an icon. |
Return
— This object, for chaining.Key
setMultiline(multiline)
setMultiline(multiline)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the value text should be displayed on a single line or multiple lines.
Parameters
Name | Type | Description |
---|---|---|
multiline | Boolean | The multiline setting. |
Return
— This object, for chaining.Key
setSwitch(switchToSet)
setSwitch(switchToSet)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the Switch
that is displayed to the right of the content. A
can
only support one button, one switch or one icon.Key
Parameters
Name | Type | Description |
---|---|---|
switch | Switch | The switch to add. |
Return
— This object, for chaining.Key
setTopLabel(text)
setTopLabel(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the label text to be used as the key. Displayed above the text-content.
Parameters
Name | Type | Description |
---|---|---|
text | String | The label text. Note: It doesn't support basic HTML formatting. |
Return
— This object, for chaining.Key