Class ImageButton

ImageButton.

Un objeto ImageButton con una imagen visible.

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étodoTipo de datos que se muestraDescripción breve
setAltText(altText)ImageButtonEstablece el texto alternativo del botón para mejorar la accesibilidad.
setAuthorizationAction(action)ImageButtonConfigura 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)ImageButtonEstablece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setIcon(icon)ImageButtonEstablece un Icon predefinido para mostrar en el botón.
setIconUrl(url)ImageButtonEstablece la URL de una imagen para utilizar como ícono de este botón.
setOnClickAction(action)ImageButtonEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)ImageButtonEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)ImageButtonConfigura una URL que se abrirá cuando se haga clic en el objeto.

Documentación detallada

setAltText(altText)

Establece el texto alternativo del botón para mejorar la accesibilidad. Obligatorio.

Parámetros

NombreTipoDescripción
altTextStringEl texto alternativo que se asignará a este botón.

Volver

ImageButton: Este objeto, 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 vuelve a la aplicación, el complemento se vuelve a cargar.

Un objeto de IU solo puede tener uno de estos valores: 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

NombreTipoDescripción
actionAuthorizationActionEl objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Volver

ImageButton: Este objeto, para encadenar.


setComposeAction(action, composedEmailType)

Establece 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 uno de los siguientes tipos: 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).

// ...

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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de redacción que se realizará cuando se haga clic en este elemento.
composedEmailTypeComposedEmailTypeEs un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Volver

ImageButton: Este objeto, para encadenar.


setIcon(icon)

Establece un Icon predefinido para mostrar en el botón. Para definir la imagen del botón, se debe usar setIconUrl(url).

Parámetros

NombreTipoDescripción
iconIconUno de los valores Icon predefinidos.

Volver

ImageButton: Este objeto, para encadenar.


setIconUrl(url)

Establece la URL de una imagen para utilizar como ícono de este botón. Para definir la imagen del botón, se debe usar setIcon(icon).

Parámetros

NombreTipoDescripción
urlStringLa dirección URL de una imagen alojada para usar como ícono de este botón.

Volver

ImageButton: 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 estos valores: 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

NombreTipoDescripción
actionActionLa acción que se debe realizar cuando se hace clic en este elemento.

Volver

ImageButton: 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 adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener uno de los siguientes valores: 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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Volver

ImageButton: Este objeto, para encadenar.


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 deba abrirse. Un objeto de IU solo puede tener uno de los siguientes tipos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

NombreTipoDescripción
openLinkOpenLinkUn objeto OpenLink que describe la URL que se abrirá.

Volver

ImageButton: Este objeto, para encadenar.