Class Chip

Chip

Un Chip con un ícono y una etiqueta de texto. Puedes desactivar el chip cuando sea necesario.

Disponible para las apps de Google Chat. En versión preliminar para desarrolladores para los complementos de Google Workspace.

Versión preliminar para desarrolladores: Disponible como parte del Programa de versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
setAltText(altText)	Chip	Establece el texto alternativo del chip para la accesibilidad.
setAuthorizationAction(action)	Chip	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)	Chip	Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setDisabled(disabled)	Chip	Establece si el chip está inhabilitado.
setIcon(icon)	Chip	Establece el ícono que se usará como chip.
setLabel(label)	Chip	Establece el título del chip.
setOnClickAction(action)	Chip	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	Chip	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	Chip	Establece una URL que se abrirá cuando se haga clic en el objeto.

Documentación detallada

setAltText(altText)

Establece el texto alternativo del chip para la accesibilidad. Si no se establece, se usa de forma predeterminada el texto que se muestra en el chip.

Parámetros

Nombre	Tipo	Descripción
altText	String	El texto alternativo que se asignará a este chip.

Volver

Chip: Este objeto, para el encadenamiento.

---

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. Esto abre la URL en una ventana nueva. Cuando el usuario termina el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.

Un objeto de IU solo puede tener establecido uno de los siguientes: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

const 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 se hace clic en este elemento.

Volver

Chip: Este objeto, para el encadenamiento.

---

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 establecido uno de los siguientes: 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 redacción que se use para extender la IU de redacción. En cambio, este método conecta este elemento de la IU a un Action que redacta mensajes de borrador 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	El objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
composedEmailType	ComposedEmailType	Un valor de enum que especifica si el borrador redactado es un borrador independiente o de respuesta.

Volver

Chip: Este objeto, para el encadenamiento.

---

setDisabled(disabled)

Establece si el chip está inhabilitado. Un chip inhabilitado aparece en gris y no se puede hacer clic en él.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Parámetros

Nombre	Tipo	Descripción
disabled	Boolean	El estado inhabilitado.

Volver

Chip: Este objeto, para el encadenamiento.

---

setIcon(icon)

Establece el ícono que se usará como chip.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Parámetros

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

Volver

Chip: Este objeto, para el encadenamiento.

---

setLabel(label)

Establece el título del chip. Obligatorio.

const chip = CardService.newChip().setLabel('bug Report');

Parámetros

Nombre	Tipo	Descripción
label	String	El texto que se mostrará.

Volver

Chip: 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 establecido uno de los siguientes: 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.

// ...

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	La acción que se debe realizar cuando se hace clic en este elemento.

Volver

Chip: 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 se deba compilar la URL o cuando necesites realizar otras acciones además de crear el objeto OpenLink. Un objeto de IU solo puede tener establecido uno de los siguientes: 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).

// ...

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	El objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

Chip: Este objeto, para el encadenamiento.

---

setOpenLink(openLink)

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

Parámetros

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

Volver

Chip: Este objeto, para el encadenamiento.