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

Class DecoratedText

Widget que muestra texto con decoraciones opcionales. Las claves posibles incluyen un ícono, una etiqueta arriba y una etiqueta abajo. Se requiere configurar el contenido de texto y una de las teclas con setText(text) y una de 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.

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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 el objeto se hizo clic.
`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 objeto `Button` que se muestra a la derecha del texto.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Establece una acción para redactar un borrador de correo electrónico cuando se hace clic en el objeto.
`setEndIcon(endIcon)`	`DecoratedText`	Establece el objeto `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`	Configura una URL que se abrirá cuando se haga clic en el objeto.
`setStartIcon(startIcon)`	`DecoratedText`	Establece el objeto `IconImage` opcional que se mostrará antes del contenido de texto.
`setSwitchControl(switchToSet)`	`DecoratedText`	Establece el objeto `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 encima del 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 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

DecoratedText: Este objeto para el encadenamiento.

`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`	El texto de la etiqueta.

Volver

DecoratedText: Este objeto para el encadenamiento.

`setButton(button)`

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

Parámetros

Nombre	Tipo	Descripción
`button`	`Button`	El botón para agregar

Volver

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

Nota: Este método no establece una acción de redacción que sea que se usa para extender la IU de Compose. En cambio, este método conecta el elemento de la IU a un Action que redacta borradores de mensajes en Apps Script que se abierto en Gmail cuando se complete 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`	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

DecoratedText: Este objeto para el encadenamiento.

`setEndIcon(endIcon)`

Establece el objeto 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 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

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

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

DecoratedText: Este objeto para el encadenamiento.

`setStartIcon(startIcon)`

Establece el objeto IconImage opcional que se mostrará antes del contenido de texto.

Parámetros

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

Volver

DecoratedText: Este objeto para el encadenamiento.

`setSwitchControl(switchToSet)`

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

Parámetros

Nombre	Tipo	Descripción
`switchToSet`	`Switch`	El interruptor para agregar

Volver

DecoratedText: Este objeto para el encadenamiento.

`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 el encadenamiento.

`setTopLabel(text)`

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

Parámetros

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

Volver

DecoratedText: Este objeto para el encadenamiento.

`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. En caso contrario se trunca el texto.

Volver

DecoratedText: Este objeto para el encadenamiento.