Class TextButton

Establece el texto alternativo del botón para la accesibilidad. Si no se configura, se establece de forma predeterminada el texto que se muestra en el botón.

Parámetros

Volver

TextButton: 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 siguientes 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

TextButton: Este objeto, para encadenar.

Establece el color de fondo del botón TextButtonStyle.FILLED. Si no se configura para un botón TextButtonStyle.FILLED, el botón usa el color secundario definido en el manifiesto del complemento. Este método no realiza ninguna operación para los botones TextButtonStyle.OUTLINED.

Parámetros

Volver

TextButton: 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

TextButton: Este objeto, para encadenar.

Establece si el botón está inhabilitado. Un botón inhabilitado aparece en gris y no se puede hacer clic en él.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

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

Parámetros

Volver

TextButton: Este objeto, para encadenar.

Establece la URL de una imagen para usarla como ícono de este botón. Se debe usar este parámetro o setIcon(icon) para definir la imagen del botón.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

Establece el ícono de Material Design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parámetros

Volver

TextButton: 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

TextButton: 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

TextButton: 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 la 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

TextButton: Este objeto, para encadenar.

Establece un menú emergente para que se abra 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 los menús anidados, y las acciones para los elementos de menú no deben especificar un menú ampliado.

Disponible para las apps de Google Chat. En la versión preliminar para desarrolladores de los 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

Volver

TextButton: Este objeto, para encadenar.

Establece el texto que se muestra en el botón.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

Establece el estilo del botón. Si no se configura, el botón predeterminado es TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parámetros

Volver

TextButton: Este objeto, para encadenar.