Class CardAction

CardAction.

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

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

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setAuthorizationAction(action)	CardAction	Configura 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	Configura 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)

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

Nombre	Tipo	Descripción
action	AuthorizationAction	El objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Volver

CardAction: 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).

Nota: Este método no establece una acción de redacción que se use para extender la IU de redacción. En lugar de ello, este método conecta este elemento de la IU a un Action que redacta mensajes en borrador en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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	El objeto que especifica la acción de redacción que se realizará cuando se haga clic en este elemento.
composedEmailType	ComposedEmailType	Es un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Volver

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

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

Nombre	Tipo	Descripción
action	Action	El objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Volver

CardAction: Este objeto, para encadenar.

---

setOpenLink(openLink)

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

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

Volver

CardAction: Este objeto, para encadenar.

---

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 encadenar.