Class TextButton

Establece el texto alternativo del botón para la accesibilidad. Si no se configura, el valor predeterminado es 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. 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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) establecido.

// ...

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 establece para un botón TextButtonStyle.FILLED, el botón usa el color secundario definido en el manifest del complemento. Este método no realiza ninguna acción para los botones TextButtonStyle.OUTLINED.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

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: 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 se muestra de color gris y no se puede hacer clic en él.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

Establece un Icon predefinido para que se muestre en el botón. Se debe usar esto 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 esto 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 uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) establecido.

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 debas realizar otras acciones además de crear el objeto OpenLink. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

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 ya se conoce la URL y solo se necesita abrirla. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

Parámetros

Volver

TextButton: Este objeto, para encadenar.

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

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 establece, el valor predeterminado es el botón 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.