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

Class DecoratedText

Es un widget que muestra texto con decoraciones opcionales. Las posibles claves incluyen un ícono, una etiqueta arriba y una etiqueta abajo. Es necesario configurar el contenido del texto y una de las claves con setText(text) y uno de los elementos DecoratedText, DecoratedText, setTopLabel(text) o setBottomLabel(text). Esta clase está diseñada para reemplazar KeyValue.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addEventAction(eventAction)`	`Widget`	Agrega la acción del evento que se puede realizar en el widget.
`setAuthorizationAction(action)`	`DecoratedText`	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
`setBottomLabel(text)`	`DecoratedText`	Establece el texto de la etiqueta que se usará como clave y se mostrará debajo del contenido de texto.
`setButton(button)`	`DecoratedText`	Establece el `Button` que se muestra a la derecha del texto.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
`setEndIcon(endIcon)`	`DecoratedText`	Establece el `IconImage` opcional que se muestra a la derecha del contenido.
`setId(id)`	`Widget`	Establece el ID único asignado que se usa para identificar el widget que se modificará.
`setOnClickAction(action)`	`DecoratedText`	Establece una acción que se ejecuta cuando se hace clic en el objeto.
`setOnClickOpenLinkAction(action)`	`DecoratedText`	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
`setOpenLink(openLink)`	`DecoratedText`	Establece una URL que se abrirá cuando se haga clic en el objeto.
`setStartIcon(startIcon)`	`DecoratedText`	Establece el `IconImage` opcional para mostrarlo antes del contenido de texto.
`setSwitchControl(switchToSet)`	`DecoratedText`	Establece el `Switch` que se muestra a la derecha del contenido.
`setText(text)`	`DecoratedText`	Establece el texto que se usará como valor.
`setTopLabel(text)`	`DecoratedText`	Establece el texto de la etiqueta que se usará como clave y se mostrará sobre el contenido de texto.
`setVisibility(visibility)`	`Widget`	Establece la visibilidad del widget.
`setWrapText(wrapText)`	`DecoratedText`	Establece si el texto del valor se debe mostrar en una sola línea o en varias.

Documentación detallada

`addEventAction(eventAction)`

Agrega la acción del evento que se puede realizar en el widget.

Parámetros

Nombre	Tipo	Descripción
`eventAction`	`EventAction`	Es el `EventAction` que se agregará.

Volver

Widget: El objeto, 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. 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 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

Nombre	Tipo	Descripción
`action`	`AuthorizationAction`	Objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento.

Volver

DecoratedText: Este objeto, para encadenar.

`setBottomLabel(text)`

Establece el texto de la etiqueta que se usará como clave y se mostrará debajo del contenido de texto.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el texto de la etiqueta.

Volver

DecoratedText: Este objeto, para encadenar.

`setButton(button)`

Establece el Button que se muestra a la derecha del texto. Un DecoratedText solo puede admitir un botón o un interruptor.

Parámetros

Nombre	Tipo	Descripción
`button`	`Button`	Es el botón que se agregará.

Volver

DecoratedText: 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 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).

Nota: Este método no establece una acción de composición que se use para extender la IU de composición. En cambio, este método conecta el elemento de IU a un objeto Action que compone mensajes de borrador en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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

Nombre	Tipo	Descripción
`action`	`Action`	Objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
`composedEmailType`	`ComposedEmailType`	Es un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Volver

DecoratedText: Este objeto, para encadenar.

`setEndIcon(endIcon)`

Establece el IconImage opcional que se muestra a la derecha del contenido. Un DecoratedText solo puede admitir un botón, un interruptor o un ícono.

Parámetros

Nombre	Tipo	Descripción
`endIcon`	`IconImage`	Ícono que se agregará.

Volver

DecoratedText: Este objeto, para encadenar.

`setId(id)`

Establece el ID único asignado que se usa para identificar el widget que se modificará. La mutación de widgets solo se admite en complementos.

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	Es el ID del widget, con un límite de 64 caracteres y en formato de `[a-zA-Z0-9-]+`.

Volver

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

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

Volver

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

Nombre	Tipo	Descripción
`action`	`Action`	Objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

DecoratedText: Este objeto, 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 se conoce y solo se necesita abrir. Un objeto de IU solo puede tener establecido uno de los siguientes atributos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

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

Volver

DecoratedText: Este objeto, para encadenar.

`setStartIcon(startIcon)`

Establece el IconImage opcional para mostrarlo antes del contenido de texto.

Parámetros

Nombre	Tipo	Descripción
`startIcon`	`IconImage`	Es el ícono que se mostrará.

Volver

DecoratedText: Este objeto, para encadenar.

`setSwitchControl(switchToSet)`

Establece el Switch que se muestra a la derecha del contenido. Un DecoratedText solo puede admitir un botón o un interruptor.

Parámetros

Nombre	Tipo	Descripción
`switchToSet`	`Switch`	Es el interruptor que se agregará.

Volver

DecoratedText: Este objeto, para encadenar.

`setText(text)`

Establece el texto que se usará como valor. Admite formato HTML básico. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el contenido de texto de este widget.

Volver

DecoratedText: Este objeto, para encadenar.

`setTopLabel(text)`

Establece el texto de la etiqueta que se usará como clave y se mostrará sobre el contenido de texto.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el texto de la etiqueta.

Volver

DecoratedText: Este objeto, para encadenar.

`setVisibility(visibility)`

Establece la visibilidad del widget. El valor predeterminado es "VISIBLE".

Parámetros

Nombre	Tipo	Descripción
`visibility`	`Visibility`	Es el `Visibility` del widget.

Volver

Widget: El objeto, para encadenar.

`setWrapText(wrapText)`

Establece si el texto del valor se debe mostrar en una sola línea o en varias.

Parámetros

Nombre	Tipo	Descripción
`wrapText`	`Boolean`	Si es `true`, el texto se ajusta y se muestra en varias líneas. De lo contrario, el texto se trunca.

Volver

DecoratedText: Este objeto, para encadenar.

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

Métodos

Documentación detallada

addEventAction(eventAction)

Parámetros

Volver

setAuthorizationAction(action)

Parámetros

Volver

setBottomLabel(text)

Parámetros

Volver

setButton(button)

Parámetros

Volver

setComposeAction(action, composedEmailType)

Parámetros

Volver

setEndIcon(endIcon)

Parámetros

Volver

setId(id)

Parámetros

Volver

setOnClickAction(action)

Parámetros

Volver

setOnClickOpenLinkAction(action)

Parámetros

Volver

setOpenLink(openLink)

Parámetros

Volver

setStartIcon(startIcon)

Parámetros

Volver

setSwitchControl(switchToSet)

Parámetros

Volver

setText(text)

Parámetros

Volver

setTopLabel(text)

Parámetros

Volver

setVisibility(visibility)

Parámetros

Volver

setWrapText(wrapText)

Parámetros

Volver

Class DecoratedText

`addEventAction(eventAction)`

`setAuthorizationAction(action)`

`setBottomLabel(text)`

`setButton(button)`

`setComposeAction(action, composedEmailType)`

`setEndIcon(endIcon)`

`setId(id)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setStartIcon(startIcon)`

`setSwitchControl(switchToSet)`

`setText(text)`

`setTopLabel(text)`

`setVisibility(visibility)`

`setWrapText(wrapText)`