Un Image
con una imagen en él.
Disponible para los complementos de Google Workspace y las apps de Google Chat.
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
set | Image | Establece el texto alternativo del botón para la accesibilidad. |
set | Image | Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. |
set | Image | Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto. |
set | Image | Establece un Icon predefinido para que se muestre en el botón. |
set | Image | Establece la URL de una imagen para usarla como ícono de este botón. |
set | Image | Establece el estilo del botón. |
set | Image | Establece el ícono de material design. |
set | Image | Establece una acción que se ejecuta cuando se hace clic en el objeto. |
set | Image | Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. |
set | Image | Establece una URL que se abrirá cuando se haga clic en el objeto. |
set | Image | Establece un menú emergente que se abrirá cuando se haga clic en el objeto. |
Documentación detallada
setAltText(altText)
Establece el texto alternativo del botón para la accesibilidad. Obligatorio.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
alt | String | Es el texto alternativo que se asignará a este botón. |
Volver
Image
: Este objeto, para encadenar.
setAuthorizationAction(action)
Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y vuelve a la aplicación, se vuelve a cargar el complemento.
Un objeto de IU solo puede tener uno de set
, set
, set
, set
o set
establecido.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
action | Authorization | Es el objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento. |
Volver
Image
: Este objeto, para encadenar.
setComposeAction(action, composedEmailType)
Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto. Un objeto de IU solo puede tener uno de los siguientes elementos configurados: set
, set
, set
, set
o set
.
El parámetro Action
debe especificar una función de devolución de llamada que muestre un objeto Compose
configurado con 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(); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
action | Action | Es el objeto que especifica la acción de composición que se debe realizar cuando se hace clic en este elemento. |
composed | Composed | Un valor de enumeración que especifica si el borrador compuesto es independiente o de respuesta. |
Volver
Image
: Este objeto, para encadenar.
setIcon(icon)
Establece un Icon
predefinido para que se muestre en el botón. Se debe usar esto o set
para definir la imagen del botón.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
icon | Icon | Uno de los valores Icon predefinidos. |
Volver
Image
: Este objeto, para encadenar.
setIconUrl(url)
Establece la URL de una imagen para usarla como ícono de este botón. Se debe usar esto o set
para definir la imagen del botón.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
url | String | Es la dirección URL de una imagen alojada que se usará como ícono de este botón. |
Volver
Image
: Este objeto, para encadenar.
setImageButtonStyle(imageButtonStyle)
Establece el estilo del botón. Si no se establece, el valor predeterminado es el botón Image
.
Solo está disponible para las apps de Google Chat. No está disponible para complementos de Google Workspace.
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | Image | Es el estilo del botón. |
Volver
Image
: Este objeto, para encadenar.
setMaterialIcon(icon)
Establece el ícono de material design.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
icon | Material | El ícono de Material Design. |
Volver
Image
: Este objeto, para encadenar.
setOnClickAction(action)
Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de set
, set
, set
, set
o set
establecido.
El parámetro Action
debe especificar una función de devolución de llamada que muestre un objeto Action
.
// ... 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(); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
action | Action | Es la acción que se debe realizar cuando se hace clic en este elemento. |
Volver
Image
: Este objeto, para encadenar.
setOnClickOpenLinkAction(action)
Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. Usa esta función cuando se deba compilar la URL o cuando debas realizar otras acciones además de crear el objeto Open
. Un objeto de IU solo puede tener uno de set
, set
, set
, set
o set
configurado.
El parámetro Action
debe especificar una función de devolución de llamada que muestre un objeto Action
configurado con 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(); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
action | Action | Es el objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento. |
Volver
Image
: Este objeto, para encadenar.
setOpenLink(openLink)
Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando ya se conoce la URL y solo se necesita abrirla. Un objeto de IU solo puede tener uno de set
, set
, set
, set
o set
configurado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
open | Open | Un objeto Open que describe la URL que se abrirá. |
Volver
Image
: Este objeto, para encadenar.
setOverflowMenu(menu)
Establece un menú emergente que se abrirá cuando se haga clic en el objeto. Cada elemento del menú puede especificar una acción que se activará cuando se haga clic en él. No se admiten menús anidados, las acciones de los elementos de menú no deben especificar un menú ampliado.
Solo está disponible para las apps de Google Chat. No está disponible para complementos de Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
menu | Overflow | Es el objeto que especifica el menú ampliado que se mostrará cuando se haga clic en este elemento. |
Volver
Image
: Este objeto, para encadenar.