Se usó la API de Cloud Translation para traducir esta página.

Class ImageButton

Un objeto ImageButton con una imagen.

var 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
`setAltText(altText)`	`ImageButton`	Establece el texto alternativo del botón con fines de accesibilidad.
`setAuthorizationAction(action)`	`ImageButton`	Configura una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
`setComposeAction(action, composedEmailType)`	`ImageButton`	Configura una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
`setIcon(icon)`	`ImageButton`	Establece un `Icon` predefinido para mostrar en el botón.
`setIconUrl(url)`	`ImageButton`	Configura la URL de una imagen que se usará como ícono de este botón.
`setOnClickAction(action)`	`ImageButton`	Establece una acción que se ejecuta cuando se hace clic en el objeto.
`setOnClickOpenLinkAction(action)`	`ImageButton`	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
`setOpenLink(openLink)`	`ImageButton`	Configura una URL que se abrirá cuando se haga clic en el objeto.

Documentación detallada

`setAltText(altText)`

Establece el texto alternativo del botón con fines de accesibilidad. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
`altText`	`String`	El texto alternativo que se asignará a este botón.

Devolvedor

ImageButton: Este objeto se usa para encadenar.

`setAuthorizationAction(action)`

Configura 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 regresa a la aplicación, el complemento se vuelve a cargar.

Un objeto de IU solo puede tener configurado setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

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

Parámetros

Nombre	Tipo	Descripción
`action`	`AuthorizationAction`	Es el objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Devolvedor

ImageButton: Este objeto se usa para encadenar.

`setComposeAction(action, composedEmailType)`

Configura una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de IU solo puede tener configurado setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ComposeActionResponse configurado con ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: Este método no establece una acción de redacción que se use para extender la IU de redacción. En cambio, este método conecta este elemento de la IU a un Action que redacta mensajes en borrador en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de composición que se realizará cuando se haga clic en este elemento.
`composedEmailType`	`ComposedEmailType`	Un valor enum que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Devolvedor

ImageButton: Este objeto se usa para encadenar.

`setIcon(icon)`

Establece un Icon predefinido para mostrar en el botón. Se debe usar este elemento o setIconUrl(url) para definir la imagen del botón.

Parámetros

Nombre	Tipo	Descripción
`icon`	`Icon`	Es uno de los valores `Icon` predefinidos.

Devolvedor

ImageButton: Este objeto se usa para encadenar.

`setIconUrl(url)`

Configura la URL de una imagen que se usará como ícono de este botón. Se debe usar este elemento o setIcon(icon) 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.

Devolvedor

ImageButton: Este objeto se usa 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 configurado setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un 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

Nombre	Tipo	Descripción
`action`	`Action`	La acción que se realiza cuando se hace clic en este elemento.

Devolvedor

ImageButton: Este objeto se usa 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 necesites realizar otras acciones adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener configurado setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse configurado con 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

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Devolvedor

ImageButton: Este objeto se usa para encadenar.

`setOpenLink(openLink)`

Configura una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya sea conocida y solo se deba abrir. Un objeto de IU solo puede tener configurado setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

Nombre	Tipo	Descripción
`openLink`	`OpenLink`	Un objeto `OpenLink` que describe la URL que se abrirá

Devolvedor

ImageButton: Este objeto se usa para encadenar.