Class Image

Image

A widget that shows a single image.


 var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");
 

Methods

MethodReturn typeBrief description
setAltText(altText)ImageSets the alternative text of the image for accessibility.
setAuthorizationAction(action)ImageSets an authorization action that opens a URL to the authorization flow when the object is clicked.
setComposeAction(action, composedEmailType)ImageSets an action that composes a draft email when the object is clicked.
setImageUrl(url)ImageSets the URL of the image.
setOnClickAction(action)ImageSets an action that executes when the object is clicked.
setOnClickOpenLinkAction(action)ImageSets an action that opens a URL in a tab when the object is clicked.
setOpenLink(openLink)ImageSets a URL to be opened when the object is clicked.

Detailed documentation

setAltText(altText)

Sets the alternative text of the image for accessibility. Required.

Parameters

NameTypeDescription
altTextStringthe alternative text to assign to this image.

Return

Image — this object, for chaining.


setAuthorizationAction(action)

Sets an authorization action that opens a URL to the authorization flow when the object is clicked. This will open the URL in a new window and when the user finishes the authorization flow and returns to the application, the addon will reload.

A UI object can only have one of setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), or setComposeAction(action, composedEmailType) set.


 // ...

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

 

Parameters

NameTypeDescription
actionAuthorizationActionthe object that specifies the authorization action to take when this element is clicked.

Return

Image — 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).


 // ...

 var action = CardService.newAction().setFunctionName('composeEmailCallback'));
 CardService.newTextButton()
     .setText('Compose Email')
     .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

 // ...

 function composeEmailCallback() {
   var thread = GmailApp.getThreadById(e.threadId);
   var draft = thread.createDraftReply('This is a reply');
   return CardService.newComposeActionResponseBuilder()
       .setGmailDraft(draft)
       .build();
 }
 

Parameters

NameTypeDescription
actionActionthe object that specifies the compose action to take when this element is clicked.
composedEmailTypeComposedEmailTypean enum value that specifies whether the composed draft is a standalone or reply draft.

Return

Image — this object, for chaining.


setImageUrl(url)

Sets the URL of the image. Required.

Parameters

NameTypeDescription
urlStringthe URL address of a hosted image to use.

Return

Image — 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.


 // ...

 var action = CardService.newAction().setFunctionName('notificationCallback'));
 CardService.newTextButton().setText('Create notification').setOnClickAction(action);

 // ...

 function notificationCallback() {
   return CardService.newActionResponseBuilder()
       .setNotification(CardService.newNotification()
           .setType(CardService.Notification.INFO)
           .setText("Some info to display to user"))
       .build();
 }
 

Parameters

NameTypeDescription
actionActionthe action to take when this element is clicked.

Return

Image — 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 addiiton 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).


 // ...

 var 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

NameTypeDescription
actionActionthe object that specifies the open link action to take when this element is clicked.

Return

Image — 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

NameTypeDescription
openLinkOpenLinkan OpenLink object describing the URL to open.

Return

Image — this object, for chaining.

Send feedback about...

Apps Script
Apps Script