Class TextButton

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
TextButton

Un TextButton con una etiqueta de texto Puedes configurar el color de fondo y desactivar el botón cuando sea necesario.

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAltText(altText)TextButtonEstablece el texto alternativo del botón para mejorar la accesibilidad.
setAuthorizationAction(action)TextButtonConfigura una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setBackgroundColor(backgroundColor)TextButtonEstablece el color de fondo para el botón TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonEstablece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setDisabled(disabled)TextButtonEstablece si el botón está inhabilitado.
setOnClickAction(action)TextButtonEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)TextButtonEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)TextButtonConfigura una URL que se abrirá cuando se haga clic en el objeto.
setText(text)TextButtonEstablece el texto que se muestra en el botón.
setTextButtonStyle(textButtonStyle)TextButtonEstablece el estilo del botón.

Documentación detallada

setAltText(altText)

Establece el texto alternativo del botón para mejorar la accesibilidad. Si no está configurado, se establece de manera predeterminada en el texto que se muestra en el botón.

Parámetros

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

Volver

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

TextButton: Este objeto, para encadenar.


setBackgroundColor(backgroundColor)

Establece el color de fondo para el botón TextButtonStyle.FILLED. Si no estableces el botón TextButtonStyle.FILLED, el botón usará el color secundario definido en el manifiesto del complemento. Este método no funciona en los botones TextButtonStyle.TEXT.

Parámetros

NombreTipoDescripción
backgroundColorStringEl color en formato #rgb.

Volver

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

TextButton: Este objeto, para encadenar.


setDisabled(disabled)

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

Parámetros

NombreTipoDescripción
disabledBooleanEl estado inhabilitado.

Volver

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

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

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

TextButton: Este objeto, para encadenar.


setText(text)

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

Parámetros

NombreTipoDescripción
textStringEl texto que aparece en el botón.

Volver

TextButton: Este objeto, para encadenar.


setTextButtonStyle(textButtonStyle)

Establece el estilo del botón. Si no está configurado, se establece de forma predeterminada en el botón TextButtonStyle.TEXT.

Parámetros

NombreTipoDescripción
textButtonStyleTextButtonStyleEl estilo del botón.

Volver

TextButton: Este objeto, para encadenar.