Se usó la API de Cloud Translation para traducir esta página.

Class OverflowMenuItem

Un OverflowMenuItem con un ícono y una etiqueta de texto. Puedes desactivar el elemento de menú cuando sea necesario.

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setAuthorizationAction(action)`	`OverflowMenuItem`	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)`	`OverflowMenuItem`	Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto.
`setDisabled(disabled)`	`OverflowMenuItem`	Establece si el elemento de menú está inhabilitado.
`setOnClickAction(action)`	`OverflowMenuItem`	Establece una acción que se ejecuta cuando se hace clic en el objeto.
`setOnClickOpenLinkAction(action)`	`OverflowMenuItem`	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
`setOpenLink(openLink)`	`OverflowMenuItem`	Establece una URL que se abrirá cuando se haga clic en el objeto.
`setStartIcon(icon)`	`OverflowMenuItem`	Establece el ícono inicial del elemento de menú.
`setText(text)`	`OverflowMenuItem`	Establece el título del elemento de menú.

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

OverflowMenuItem: 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 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 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 abrirán en Gmail cuando se complete 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

OverflowMenuItem: Este objeto, para encadenar.

`setDisabled(disabled)`

Establece si el elemento de menú está inhabilitado. Un elemento inhabilitado está inhabilitado y no se puede hacer clic en él.

Parámetros

Nombre	Tipo	Descripción
`disabled`	`Boolean`	Es el estado inhabilitado.

Volver

OverflowMenuItem: 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) configurado.

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

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

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

OverflowMenuItem: Este objeto, para encadenar.

`setStartIcon(icon)`

Establece el ícono inicial del elemento de menú.

Parámetros

Nombre	Tipo	Descripción
`icon`	`IconImage`	El ícono que se mostrará

Volver

OverflowMenuItem: Este objeto, para encadenar.

`setText(text)`

Establece el título del elemento del menú. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	Es el texto que se mostrará.

Volver

OverflowMenuItem: Este objeto, para encadenar.