Class Image

Agrega la acción del evento que se puede realizar en el widget.

Parámetros

Volver

Widget: El objeto, para encadenar.

Establece el texto alternativo de la imagen para la accesibilidad. Obligatorio.

Parámetros

Volver

Image: Este objeto, para encadenar.

Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. Esto abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.

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

// ...

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

Parámetros

Volver

Image: Este objeto, para encadenar.

Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de la IU solo puede tener establecido uno de los 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 ComposeActionResponse configurado con ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

Volver

Image: Este objeto, para encadenar.

Establece el ID único asignado que se usa para identificar el widget que se modificará. La mutación de widgets solo se admite en complementos.

Parámetros

Volver

Widget: Este objeto, para encadenar.

Establece la imagen que se usará proporcionando su URL o cadena de datos. Obligatorio.

La URL proporcionada puede ser una URL de acceso público o una cadena de imagen codificada en base64. Para obtener este último, puedes usar el siguiente código para crear una cadena de imagen codificada a partir de una imagen en tu Google Drive y, luego, almacenar esa cadena para usarla más adelante con setImageUrl(url). Este método evita que tu complemento necesite acceder a una URL de imagen disponible públicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

Parámetros

Volver

Image: Este objeto, para encadenar.

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener establecido 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.

// ...

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

Volver

Image: Este objeto, para encadenar.

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 además de crear el objeto OpenLink. Un objeto de IU solo puede tener establecido 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).

// ...

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

Volver

Image: Este objeto, para encadenar.

Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya se conoce y solo se necesita abrir. Un objeto de IU solo puede tener establecido uno de los siguientes atributos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

Volver

Image: Este objeto, para encadenar.

Establece la visibilidad del widget. El valor predeterminado es "VISIBLE".

Parámetros

Volver

Widget: El objeto, para encadenar.