Represents an action to open a link with some options.
Available for Google Workspace Add-ons and Google Chat apps.
// A button that opens as a link in an overlay and // requires a reload when closed. var button = CardService.newTextButton() .setText("This button opens a link in an overlay window") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com") .setOpenAs(CardService.OpenAs.OVERLAY) .setOnClose(CardService.OnClose.RELOAD_ADD_ON)); // An action response that opens a link in full screen and // requires no action when closed. var actionResponse = CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com") .setOpenAs(CardService.OpenAs.FULL_SIZE) .setOnClose(CardService.OnClose.NOTHING)) .build();
Note: To reload add-ons after closing a link, don't use a link with Cross-Origin-Opener-Policy (COOP) header enabled. If COOP is enabled in a link, add-ons can't detect the window state, and the add-on card doesn't update.
Methods
Method | Return type | Brief description |
---|---|---|
setOnClose(onClose) | OpenLink | Sets the behavior of the URL action when the URL window or tab is closed. |
setOpenAs(openAs) | OpenLink | Sets the behavior of URL when it is opened. |
setUrl(url) | OpenLink | Sets the URL to be opened. |
Detailed documentation
setOnClose(onClose)
setOpenAs(openAs)
setUrl(url)
Sets the URL to be opened. The URL must match a prefix whitelisted in the manifest.
Parameters
Name | Type | Description |
---|---|---|
url | String | The URL to open. |
Return
OpenLink
— This object, for chaining.