Class Grid

Grade

Uma grade organizada para exibir uma coleção de itens.

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

Métodos

MétodoTipo de retornoBreve descrição
addItem(gridItem)GridAdiciona um novo item à grade.
setAuthorizationAction(action)GridDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBorderStyle(borderStyle)GridDefine o estilo de borda aplicado a cada item da grade.
setComposeAction(action, composedEmailType)GridDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setNumColumns(numColumns)GridO número de colunas a serem exibidas na grade.
setOnClickAction(action)GridDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)GridDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)GridDefine um URL que será aberto quando o objeto for clicado.
setTitle(title)GridDefine o texto do título da grade.

Documentação detalhada

addItem(gridItem)

Adiciona um novo item à grade.

Parâmetros

NomeTipoDescrição
gridItemGridItemO item da grade a ser adicionado.

Retornar

Grid: este objeto, para encadeamento.


setAuthorizationAction(action)

Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. O URL é aberto em uma nova janela. Quando o usuário conclui o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de IU só pode ter um entre setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parâmetros

NomeTipoDescrição
actionAuthorizationActionO objeto que especifica a ação de autorização a ser realizada quando esse elemento é clicado.

Retornar

Grid: este objeto, para encadeamento.


setBorderStyle(borderStyle)

Define o estilo de borda aplicado a cada item da grade. O padrão é NO_BORDER.

Parâmetros

NomeTipoDescrição
borderStyleBorderStyleO estilo da borda a ser aplicado.

Retornar

Grid: este objeto, para encadeamento.


setComposeAction(action, composedEmailType)

Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. Um objeto de IU só pode ter um dos conjuntos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

NomeTipoDescrição
actionActionO objeto que especifica a ação de composição a ser realizada quando esse elemento é clicado.
composedEmailTypeComposedEmailTypeUm valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta.

Retornar

Grid: este objeto, para encadeamento.


setNumColumns(numColumns)

O número de colunas a serem exibidas na grade. Se mostrado no painel à direita, é possível exibir de 1 a 2 colunas, e o valor padrão é 1. Se for exibida em uma caixa de diálogo, é possível exibir de duas a três colunas, e o valor padrão é 2.

Parâmetros

NomeTipoDescrição
numColumnsIntegerO número de colunas.

Retornar

Grid: este objeto, para encadeamento.


setOnClickAction(action)

Define uma ação que é executada quando o objeto é clicado. Um objeto de IU só pode ter um dos conjuntos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorne um 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

NomeTipoDescrição
actionActionA ação a ser realizada quando esse elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.


setOnClickOpenLinkAction(action)

Define uma ação que abre um URL em uma guia quando o objeto é clicado. Use essa função quando o URL precisar ser criado ou quando você precisar realizar outras ações além da criação do objeto OpenLink. Um objeto de IU só pode ter um dos conjuntos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ActionResponse configurado usando 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

NomeTipoDescrição
actionActionO objeto que especifica a ação de link aberto a ser realizada quando esse elemento é clicado.

Retornar

Grid: este objeto, para encadeamento.


Define um URL que será aberto quando o objeto for clicado. Use essa função quando o URL já for conhecido e precisar ser aberto apenas. Um objeto de IU pode ter apenas um dos conjuntos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

Parâmetros

NomeTipoDescrição
openLinkOpenLinkUm objeto OpenLink que descreve o URL a ser aberto.

Retornar

Grid: este objeto, para encadeamento.


setTitle(title)

Define o texto do título da grade. O texto precisa ser uma string simples sem formatação.

Parâmetros

NomeTipoDescrição
titleStringO texto do título.

Retornar

Grid: este objeto, para encadeamento.