Se usó la API de Cloud Translation para traducir esta página.

Class TextButton

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

Está disponible para complementos de Google Workspace y apps de Google Chat.

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

Métodos

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

Documentación detallada

`setAltText(altText)`

Establece el texto alternativo del botón para fines de accesibilidad. Si no la estableces, el valor predeterminado será el texto que se muestra en el botón.

Parámetros

Nombre	Tipo	Descripción
`altText`	`String`	El texto alternativo para asignar a este botón.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setAuthorizationAction(action)`

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

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

// ...

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

Parámetros

Nombre	Tipo	Descripción
`action`	`AuthorizationAction`	Es el objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setBackgroundColor(backgroundColor)`

Establece el color de fondo del botón TextButtonStyle.FILLED. Si no se configura para un botón TextButtonStyle.FILLED, este usará el color secundario definido en el manifiesto del complemento. Este método es una no-op para los botones TextButtonStyle.OUTLINED.

Parámetros

Nombre	Tipo	Descripción
`backgroundColor`	`String`	El color en formato #rgb.

Devolvedor

TextButton: Este objeto se usa 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 configurado 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).

Nota: Este método no establece una acción de redacción que se use para extender la IU de redacción. En cambio, este método conecta este elemento de la IU a una Action que redacta borradores en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de composición que se realizará cuando se haga clic en este elemento.
`composedEmailType`	`ComposedEmailType`	Un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setDisabled(disabled)`

Establece si el botón está inhabilitado. Los botones inhabilitados están inhabilitados y no se pueden hacer clic en ellos.

Parámetros

Nombre	Tipo	Descripción
`disabled`	`Boolean`	El estado inhabilitado.

Devolvedor

TextButton: Este objeto se usa 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 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.

// ...

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

Nombre	Tipo	Descripción
`action`	`Action`	La acción que se debe realizar cuando se hace clic en este elemento.

Devolvedor

TextButton: Este objeto se usa 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 necesites realizar otras acciones adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener 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).

// ...

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

Nombre	Tipo	Descripción
`action`	`Action`	Es el objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setOpenLink(openLink)`

Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya sea conocida y solo se deba abrir. Un objeto de IU solo puede tener setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

Parámetros

Nombre	Tipo	Descripción
`openLink`	`OpenLink`	Un objeto `OpenLink` que describe la URL que se abrirá.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setText(text)`

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

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el texto que aparece en el botón.

Devolvedor

TextButton: Este objeto se usa para encadenar.

`setTextButtonStyle(textButtonStyle)`

Establece el estilo del botón. Si no la estableces, el valor predeterminado será el botón TextButtonStyle.OUTLINED.

Parámetros

Nombre	Tipo	Descripción
`textButtonStyle`	`TextButtonStyle`	El estilo del botón

Devolvedor

TextButton: Este objeto se usa para encadenar.