Um widget que mostra uma única imagem. Para saber mais sobre como cortar imagens, consulte ImageCropStyle
.
var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | Image | Define o texto alternativo da imagem para acessibilidade. |
setAuthorizationAction(action) | Image | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) | Image | Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. |
setImageUrl(url) | Image | Define a imagem a ser usada fornecendo seu URL ou string de dados. |
setOnClickAction(action) | Image | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | Image | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | Image | Define um URL que será aberto quando o objeto for clicado. |
Documentação detalhada
setAltText(altText)
Define o texto alternativo da imagem para acessibilidade. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
altText | String | O texto alternativo a ser atribuído a esta imagem. |
Retornar
Image
: este objeto, para encadeamento.
setAuthorizationAction(action)
Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. O URL é aberto em uma nova janela. Quando o usuário conclui o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.
Um objeto de IU só pode ter um entre setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
definido.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | AuthorizationAction | O objeto que especifica a ação de autorização a ser realizada quando esse elemento é clicado. |
Retornar
Image
: este objeto, para encadeamento.
setComposeAction(action, composedEmailType)
Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. Um objeto de IU só pode
ter um dos conjuntos setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
definidos.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto ComposeActionResponse
configurado usando 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(); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | Action | O objeto que especifica a ação de composição a ser realizada quando esse elemento é clicado. |
composedEmailType | ComposedEmailType | Um valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta. |
Retornar
Image
: este objeto, para encadeamento.
setImageUrl(url)
Define a imagem a ser usada fornecendo seu URL ou string de dados. Obrigatório.
O URL fornecido pode ser acessível publicamente ou uma string de imagem codificada em base64.
Para conseguir o último, você pode usar o código a seguir para criar uma string de imagem codificada de uma
imagem no Google Drive e, em seguida, armazenar essa string para uso posterior com setImageUrl(url)
. Esse método impede que o complemento acesse um URL de
imagem disponível publicamente:
// The following assumes you have the image to use in Google Drive and have its ID. var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes(); var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes); // You can store encodeImageURL and use it as a parameter to Image.setImageUrl(url).
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | O endereço do URL de uma imagem hospedada a ser usada ou uma string de imagem codificada. |
Retornar
Image
: este objeto, para encadeamento.
setOnClickAction(action)
Define uma ação que é executada quando o objeto é clicado. Um objeto de IU só pode ter um dos conjuntos
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto ActionResponse
.
// ... var 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(); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | Action | A ação a ser realizada quando esse elemento for clicado. |
Retornar
Image
: este objeto, para encadeamento.
setOnClickOpenLinkAction(action)
Define uma ação que abre um URL em uma guia quando o objeto é clicado. Use essa função quando o
URL precisar ser criado ou quando você precisar realizar outras ações além da criação do objeto OpenLink
. Um objeto de IU só pode ter um dos conjuntos setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou
setComposeAction(action, composedEmailType)
definidos.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto ActionResponse
configurado usando 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(); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | Action | O objeto que especifica a ação de link aberto a ser realizada quando esse elemento é clicado. |
Retornar
Image
: este objeto, para encadeamento.
setOpenLink(openLink)
Define um URL que será aberto quando o objeto for clicado. Use essa função quando o URL já for conhecido e precisar ser aberto apenas. Um objeto de IU pode ter apenas um dos conjuntos setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
definidos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
openLink | OpenLink | Um objeto OpenLink que descreve o URL a ser aberto. |
Retornar
Image
: este objeto, para encadeamento.