Class CardAction

CardAction

Es un elemento de menú en el que se puede hacer clic y que se agrega al menú del encabezado de la tarjeta.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
setAuthorizationAction(action)	CardAction	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)	CardAction	Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setOnClickAction(action)	CardAction	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	CardAction	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	CardAction	Establece una URL que se abrirá cuando se haga clic en el objeto.
setText(text)	CardAction	Establece el texto del menú para esta acción.

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. 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 la IU solo puede tener uno de los siguientes parámetros establecidos: 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

CardAction: 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 la IU solo puede tener uno de los siguientes parámetros establecidos: 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

CardAction: Este objeto, para el encadenamiento.

---

setOnClickAction(action)

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: 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

CardAction: 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 la IU solo puede tener uno de los siguientes parámetros establecidos: 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

CardAction: 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 la IU solo puede tener uno de los siguientes parámetros establecidos: 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

CardAction: Este objeto, para el encadenamiento.

---

setText(text)

Establece el texto del menú para esta acción.

Parámetros

Nombre	Tipo	Descripción
text	String	El texto del elemento de menú.

Volver

CardAction: Este objeto, para el encadenamiento.