Class KeyValue

Spark icon

Page Summary

This class is deprecated and should not be used in new scripts; instead, use DecoratedText.
You can set an authorization action that opens a URL to the authorization flow when the object is clicked.
You can set an action that composes a draft email when the object is clicked.
You can set an action that executes or opens a URL in a tab when the object is clicked.
You can set a URL to be opened directly when the object is clicked.

KeyValue

Deprecated. This class is deprecated and should not be used in new scripts.

This class is deprecated. Instead, use DecoratedText .

Methods

Method	Return type	Brief description
`addEventAction(eventAction)`	`Widget`	Adds the event action that can be performed on the widget.
`setAuthorizationAction(action)`	`(削除) KeyValue (削除ここまで)`	Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
`setComposeAction(action, composedEmailType)`	`(削除) KeyValue (削除ここまで)`	Sets an action that composes a draft email when the object is clicked.
`setId(id)`	`Widget`	Sets the unique ID assigned that's used to identify the widget to be mutated.
`setOnClickAction(action)`	`(削除) KeyValue (削除ここまで)`	Sets an action that executes when the object is clicked.
`setOnClickOpenLinkAction(action)`	`(削除) KeyValue (削除ここまで)`	Sets an action that opens a URL in a tab when the object is clicked.
`setOpenLink(openLink)`	`(削除) KeyValue (削除ここまで)`	Sets a URL to be opened when the object is clicked.
`setVisibility(visibility)`	`Widget`	Sets the visibility of the widget.

Deprecated methods

Method	Return type	Brief description
`(削除) setBottomLabel(text) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the label text to be used as the key.
`(削除) setButton(button) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the `Button` that is displayed to the right of the context.
`(削除) setContent(text) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the text to be used as the value.
`(削除) setIcon(icon) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the icon to be used as the key.
`(削除) setIconAltText(altText) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the alternative text for the icon.
`(削除) setIconUrl(url) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the URL of the icon to be used as the key.
`(削除) setMultiline(multiline) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets whether the value text should be displayed on a single line or multiple lines.
`(削除) setSwitch(switchToSet) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the `Switch` that is displayed to the right of the content.
`(削除) setTopLabel(text) (削除ここまで)`	`(削除) KeyValue (削除ここまで)`	Sets the label text to be used as the key.

Detailed documentation

`addEventAction(eventAction)`

Adds the event action that can be performed on the widget.

Parameters

Name	Type	Description
`eventAction`	`EventAction`	The `EventAction` to be added.

Return

Widget — The Object, for chaining.

`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 setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) , or setComposeAction(action, composedEmailType) set.

// ...
constaction=CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parameters

Name	Type	Description
`action`	`AuthorizationAction`	The object that specifies the authorization action to take when this element is clicked.

Return

(削除) KeyValue (削除ここまで) — 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 setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) , or setComposeAction(action, composedEmailType) set.

The Action parameter must specify a callback function that returns a ComposeActionResponse object configured using ComposeActionResponseBuilder.setGmailDraft(draft) .

Note: This method doesn't set a compose action that is used to extend the compose UI. Rather, this method connects this UI element to an Action that composes draft messages in Apps Script that are opened in Gmail when the action completes.

// ...
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.
`composedEmailType`	`ComposedEmailType`	An enum value that specifies whether the composed draft is a standalone or reply draft.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

`setId(id)`

Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutation is only supported in Add-Ons.

Parameters

Name	Type	Description
`id`	`String`	The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`.

Return

Widget — This object, for chaining.

`setOnClickAction(action)`

Sets an action that executes when the object is clicked. A UI object can only have one of setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) , or setComposeAction(action, composedEmailType) set.

The Action parameter must specify a callback function that returns a ActionResponse 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

(削除) KeyValue (削除ここまで) — 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 OpenLink object. A UI object can only have one of setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) , or setComposeAction(action, composedEmailType) set.

The Action parameter must specify a callback function that returns a ActionResponse object configured using ActionResponseBuilder.setOpenLink(openLink) .

// ...
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

(削除) KeyValue (削除ここまで) — 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 setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) , or setComposeAction(action, composedEmailType) set.

Parameters

Name	Type	Description
`openLink`	`OpenLink`	An `OpenLink` object describing the URL to open.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

`setVisibility(visibility)`

Sets the visibility of the widget. The default value is `VISIBLE`.

Parameters

Name	Type	Description
`visibility`	`Visibility`	The `Visibility` of the widget.

Return

Widget — The Object, for chaining.

Deprecated methods

(削除) `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

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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 (削除) KeyValue (削除ここまで) can only support one button, one switch or one icon.

Parameters

Name	Type	Description
`button`	`Button`	The button to add.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `setIcon(icon)` (削除ここまで)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the icon to be used as the key.

Parameters

Name	Type	Description
`icon`	`Icon`	One of the predefined `Icon` values.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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
`altText`	`String`	The alternative text for the icon.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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 (削除) KeyValue (削除ここまで) can only support one button, one switch or one icon.

Parameters

Name	Type	Description
`switchToSet`	`Switch`	The switch to add.

Return

(削除) KeyValue (削除ここまで) — This object, for chaining.

(削除) `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

(削除) KeyValue (削除ここまで) — This object, for chaining.

Class KeyValue Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Methods

Deprecated methods

Detailed documentation

addEventAction(eventAction)

Parameters

Return

setAuthorizationAction(action)

Parameters

Return

setComposeAction(action, composedEmailType)

Parameters

Return

setId(id)

Parameters

Return

setOnClickAction(action)

Parameters

Return

setOnClickOpenLinkAction(action)

Parameters

Return

setOpenLink(openLink)

Parameters

Return

setVisibility(visibility)

Parameters

Return

Deprecated methods

(削除) setBottomLabel(text) (削除ここまで)

Parameters

Return

(削除) setButton(button) (削除ここまで)

Parameters

Return

(削除) setContent(text) (削除ここまで)

Parameters

Return

(削除) setIcon(icon) (削除ここまで)

Parameters

Return

(削除) setIconAltText(altText) (削除ここまで)

Parameters

Return

(削除) setIconUrl(url) (削除ここまで)

Parameters

Return

(削除) setMultiline(multiline) (削除ここまで)

Parameters

Return

(削除) setSwitch(switchToSet) (削除ここまで)

Parameters

Return

(削除) setTopLabel(text) (削除ここまで)

Parameters

Return

Class KeyValue

`addEventAction(eventAction)`

`setAuthorizationAction(action)`

`setComposeAction(action, composedEmailType)`

`setId(id)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setVisibility(visibility)`

(削除) `setBottomLabel(text)` (削除ここまで)

(削除) `setButton(button)` (削除ここまで)

(削除) `setContent(text)` (削除ここまで)

(削除) `setIcon(icon)` (削除ここまで)

(削除) `setIconAltText(altText)` (削除ここまで)

(削除) `setIconUrl(url)` (削除ここまで)

(削除) `setMultiline(multiline)` (削除ここまで)

(削除) `setSwitch(switchToSet)` (削除ここまで)

(削除) `setTopLabel(text)` (削除ここまで)