Class KeyValue

ClaveValor

Obsoleto. Esta clase está obsoleta y no se debe usar en secuencias de comandos nuevas.

Esta clase dejó de estar disponible. En su lugar, usa DecoratedText.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setAuthorizationAction(action)	KeyValue	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setComposeAction(action, composedEmailType)	KeyValue	Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto.
setOnClickAction(action)	KeyValue	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	KeyValue	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	KeyValue	Establece una URL que se abrirá cuando se haga clic en el objeto.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
setBottomLabel(text)	KeyValue	Establece el texto de la etiqueta que se usará como clave.
setButton(button)	KeyValue	Establece el Button que se muestra a la derecha del contexto.
setContent(text)	KeyValue	Establece el texto que se usará como valor.
setIcon(icon)	KeyValue	Establece el ícono que se usará como clave.
setIconAltText(altText)	KeyValue	Establece el texto alternativo para el ícono.
setIconUrl(url)	KeyValue	Establece la URL del ícono que se usará como clave.
setMultiline(multiline)	KeyValue	Establece si el texto del valor se debe mostrar en una sola línea o en varias.
setSwitch(switchToSet)	KeyValue	Establece el Switch que se muestra a la derecha del contenido.
setTopLabel(text)	KeyValue	Establece el texto de la etiqueta que se usará como clave.

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

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

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

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

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

KeyValue: Este objeto, para encadenar.

Métodos obsoletos

setBottomLabel(text)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

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

Parámetros

Nombre	Tipo	Descripción
text	String	Es el texto de la etiqueta. Nota: No admite el formato HTML básico.

Volver

KeyValue: Este objeto, para encadenar.

---

setButton(button)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece el Button que se muestra a la derecha del contexto. Un KeyValue solo puede admitir un botón, un interruptor o un ícono.

Parámetros

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

Volver

KeyValue: Este objeto, para encadenar.

---

setContent(text)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

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

KeyValue: Este objeto, para encadenar.

---

setIcon(icon)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece el ícono que se usará como clave.

Parámetros

Nombre	Tipo	Descripción
icon	Icon	Uno de los valores Icon predefinidos.

Volver

KeyValue: Este objeto, para encadenar.

---

setIconAltText(altText)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece el texto alternativo para el ícono.

Parámetros

Nombre	Tipo	Descripción
altText	String	Es el texto alternativo del ícono.

Volver

KeyValue: Este objeto, para encadenar.

---

setIconUrl(url)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece la URL del ícono que se usará como clave.

Parámetros

Nombre	Tipo	Descripción
url	String	Es la dirección URL de una imagen alojada que se usará como ícono.

Volver

KeyValue: Este objeto, para encadenar.

---

setMultiline(multiline)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

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

Parámetros

Nombre	Tipo	Descripción
multiline	Boolean	El parámetro de configuración de varias líneas.

Volver

KeyValue: Este objeto, para encadenar.

---

setSwitch(switchToSet)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

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

Parámetros

Nombre	Tipo	Descripción
switchToSet	Switch	El interruptor que se agregará.

Volver

KeyValue: Este objeto, para encadenar.

---

setTopLabel(text)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece el texto de la etiqueta que se usará como clave. Se muestra sobre el contenido de texto.

Parámetros

Nombre	Tipo	Descripción
text	String	Es el texto de la etiqueta. Nota: No admite el formato HTML básico.

Volver

KeyValue: Este objeto, para encadenar.