Class DecoratedText

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

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

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

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAuthorizationAction(action)DecoratedTextConfigura una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setBottomLabel(text)DecoratedTextEstablece el texto de la etiqueta que se utilizará como clave y se muestra debajo del contenido del texto.
setButton(button)DecoratedTextEstablece el Button que se muestra a la derecha del texto.
setComposeAction(action, composedEmailType)DecoratedTextEstablece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setEndIcon(endIcon)DecoratedTextEstablece el IconImage opcional que se muestra a la derecha del contenido.
setOnClickAction(action)DecoratedTextEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)DecoratedTextEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)DecoratedTextConfigura una URL que se abrirá cuando se haga clic en el objeto.
setStartIcon(startIcon)DecoratedTextConfigura el IconImage opcional para que se muestre antes del contenido de texto.
setSwitchControl(switchToSet)DecoratedTextEstablece el Switch que se muestra a la derecha del contenido.
setText(text)DecoratedTextConfigura el texto que se usará como valor.
setTopLabel(text)DecoratedTextEstablece el texto de la etiqueta que se utilizará como clave y se muestra sobre el contenido del texto.
setWrapText(wrapText)DecoratedTextEstablece si el texto del valor se debe mostrar en una o varias líneas.

Documentación detallada

setAuthorizationAction(action)

Configura 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, el complemento se vuelve a cargar.

Un objeto de IU solo puede tener uno de estos 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

NombreTipoDescripción
actionAuthorizationActionEl objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Volver

DecoratedText: Este objeto, para encadenar.


setBottomLabel(text)

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

Parámetros

NombreTipoDescripción
textStringEl 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

NombreTipoDescripción
buttonButtonEl botón que quieres 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 IU solo puede tener uno de los siguientes tipos: 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).

// ...

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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de redacción que se realizará cuando se haga clic en este elemento.
composedEmailTypeComposedEmailTypeEs 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 botón o un ícono.

Parámetros

NombreTipoDescripción
endIconIconImageEl í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 estos 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.

// ...

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

NombreTipoDescripción
actionActionLa 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 adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener 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).

// ...

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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Volver

DecoratedText: Este objeto, para encadenar.


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

Parámetros

NombreTipoDescripción
openLinkOpenLinkUn objeto OpenLink que describe la URL que se abrirá.

Volver

DecoratedText: Este objeto, para encadenar.


setStartIcon(startIcon)

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

Parámetros

NombreTipoDescripción
startIconIconImageEl í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

NombreTipoDescripción
switchToSetSwitchInterruptor para agregar

Volver

DecoratedText: Este objeto, para encadenar.


setText(text)

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

Parámetros

NombreTipoDescripción
textStringEl contenido de texto de este widget.

Volver

DecoratedText: Este objeto, para encadenar.


setTopLabel(text)

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

Parámetros

NombreTipoDescripción
textStringEl texto de la etiqueta.

Volver

DecoratedText: Este objeto, para encadenar.


setWrapText(wrapText)

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

Parámetros

NombreTipoDescripción
wrapTextBooleanSi es true, el texto se ajusta y se muestra en varias líneas. De lo contrario, se truncará el texto.

Volver

DecoratedText: Este objeto, para encadenar.