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

Class DecoratedText

Es un widget que muestra texto con decoraciones opcionales. Entre las claves posibles, se incluyen un ícono, una etiqueta arriba y una etiqueta debajo. Es necesario establecer el contenido de texto y una de las claves con setText(text) y uno de DecoratedText, DecoratedText, setTopLabel(text) o setBottomLabel(text). El objetivo de esta clase es reemplazar a KeyValue.

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
`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 muestra 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 componga un borrador de correo electrónico cuando se haga clic en el objeto.
`setEndIcon(endIcon)`	`DecoratedText`	Establece el `IconImage` opcional que se muestra a la derecha del contenido.
`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 que se muestre 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 muestra sobre el contenido de texto.
`setWrapText(wrapText)`	`DecoratedText`	Establece si el texto del valor se debe mostrar en una sola línea o en varias.

Documentación detallada

`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 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

Nombre	Tipo	Descripción
`action`	`AuthorizationAction`	Es el 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 muestra 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`	El botón para agregar.

Volver

DecoratedText: Este objeto, para encadenar.

`setComposeAction(action, composedEmailType)`

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

Nota: Este método no establece una acción de Compose que se use para extender la IU de Compose. En cambio, este método conecta este elemento de la IU a un Action que compone borradores de mensajes 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`	Es el objeto que especifica la acción de composición que se debe realizar cuando se hace clic en este elemento.
`composedEmailType`	`ComposedEmailType`	Un valor de enumeración que especifica si el borrador compuesto es 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`	El ícono que se agregará.

Volver

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

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

Nombre	Tipo	Descripción
`action`	`Action`	Es el 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 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

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

Volver

DecoratedText: Este objeto, para encadenar.

`setStartIcon(startIcon)`

Establece el IconImage opcional para que se muestre antes del contenido de texto.

Parámetros

Nombre	Tipo	Descripción
`startIcon`	`IconImage`	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`	El interruptor que se agregará.

Volver

DecoratedText: Este objeto, para encadenar.

`setText(text)`

Establece el texto que se usará como valor. Admite el 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 muestra 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.

`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 une y se muestra en varias líneas. De lo contrario, el texto se trunca.

Volver

DecoratedText: Este objeto, para encadenar.