Un widget que muestra texto con decoraciones opcionales. Las claves posibles incluyen un ícono, una etiqueta arriba y una etiqueta debajo. Debes 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 pretende reemplazar a
.
KeyValue
Está disponible para complementos de Google Workspace y 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 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 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. |
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 | Configura el IconImage opcional que se mostrará antes del contenido de texto. |
setSwitchControl(switchToSet) | DecoratedText | Establece el elemento Switch que se muestra a la derecha del contenido. |
setText(text) | DecoratedText | Establece el texto que se utilizará 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 o varias líneas. |
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 regresa a la aplicación, el complemento se vuelve a cargar.
Un objeto de IU solo puede tener setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
configurado.
// ... var 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 realizará cuando se haga clic en este elemento. |
Devolvedor
DecoratedText
: Este objeto se usa 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 | El texto de la etiqueta. |
Devolvedor
DecoratedText
: Este objeto se usa 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. |
Devolvedor
DecoratedText
: Este objeto se usa 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 configurado 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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | Es el objeto que especifica la acción de composición que se realizará cuando se haga clic en este elemento. |
composedEmailType | ComposedEmailType | Un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta. |
Devolvedor
DecoratedText
: Este objeto se usa 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á. |
Devolvedor
DecoratedText
: Este objeto se usa 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 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
.
// ... 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. |
Devolvedor
DecoratedText
: Este objeto se usa 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 adicionales para crear el objeto OpenLink
. Un objeto de IU solo puede tener 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)
.
// ... 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 | Es el objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento. |
Devolvedor
DecoratedText
: Este objeto se usa 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 sea
conocida y solo se deba abrir. Un objeto de IU solo puede tener 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á. |
Devolvedor
DecoratedText
: Este objeto se usa para encadenar.
setStartIcon(startIcon)
Configura el IconImage
opcional que se mostrará antes del contenido de texto.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
startIcon | IconImage | El ícono que se mostrará. |
Devolvedor
DecoratedText
: Este objeto se usa para encadenar.
setSwitchControl(switchToSet)
Establece el elemento 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 | Botón para agregar. |
Devolvedor
DecoratedText
: Este objeto se usa para encadenar.
setText(text)
Establece el texto que se utilizará como valor. Admite formato HTML básico. Obligatorio.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | El contenido de texto de este widget. |
Devolvedor
DecoratedText
: Este objeto se usa 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 | El texto de la etiqueta. |
Devolvedor
DecoratedText
: Este objeto se usa para encadenar.
setWrapText(wrapText)
Establece si el texto del valor se debe mostrar en una o varias líneas.
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 truncará. |
Devolvedor
DecoratedText
: Este objeto se usa para encadenar.