Un TextButton
con una etiqueta de texto Puedes establecer el color de fondo y desactivar el botón
cuando sea necesario.
Está disponible para los complementos de Google Workspace y las 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 la accesibilidad. |
setAuthorizationAction(action) | TextButton | Establece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic. |
setBackgroundColor(backgroundColor) | TextButton | Establece el color de fondo del botón TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Establece una acción para redactar 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 | Configura 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 la accesibilidad. Si no se configura, se establece de manera predeterminada en el texto que se muestra en el botón.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
altText | String | El texto alternativo que se asignará a este botón. |
Volver
TextButton
: Este objeto para el encadenamiento.
setAuthorizationAction(action)
Establece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic. 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 establecido uno de los siguientes 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
Nombre | Tipo | Descripción |
---|---|---|
action | AuthorizationAction | El objeto que especifica la acción de autorización que se debe realizar cuando este elemento se se hizo clic. |
Volver
TextButton
: Este objeto para el encadenamiento.
setBackgroundColor(backgroundColor)
Establece el color de fondo del botón TextButtonStyle.FILLED
. Si no la estableces 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 |
Volver
TextButton
: Este objeto para el encadenamiento.
setComposeAction(action, composedEmailType)
Establece una acción para redactar un borrador de correo electrónico 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)
establecido.
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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | El objeto que especifica la acción de composición que se debe realizar cuando este elemento se se hizo clic. |
composedEmailType | ComposedEmailType | Un valor enum que especifica si el borrador compuesto es una independiente o como borrador de respuesta. |
Volver
TextButton
: Este objeto para el encadenamiento.
setDisabled(disabled)
Establece si el botón está inhabilitado. Los botones inhabilitados aparecen de color gris y no se pueden hacer clic en ellos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
disabled | Boolean | El estado inhabilitado. |
Volver
TextButton
: Este objeto para el encadenamiento.
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
Se establecieron 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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | La acción que se debe realizar cuando se hace clic en este elemento. |
Volver
TextButton
: Este objeto para el encadenamiento.
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
Es necesario crear la URL o cuando debes 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
Se estableció 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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | El objeto que especifica la acción de vínculo abierto que se debe realizar cuando este elemento se se hizo clic. |
Volver
TextButton
: Este objeto para el encadenamiento.
setOpenLink(openLink)
Configura una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya sea
conocido y solo necesita abrirse. Un objeto de IU solo puede tener setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
y setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
establecido.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
openLink | OpenLink | Un objeto OpenLink que describe la URL que se abrirá. |
Volver
TextButton
: Este objeto para el encadenamiento.
setText(text)
Establece el texto que se muestra en el botón.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | El texto que aparece en el botón. |
Volver
TextButton
: Este objeto para el encadenamiento.
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. |
Volver
TextButton
: Este objeto para el encadenamiento.