Esta página foi traduzida pela API Cloud Translation.

Class Grid

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

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

Métodos

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

Documentação detalhada

`addItem(gridItem)`

Adiciona um novo item de grade à grade.

Parâmetros

Nome	Tipo	Descrição
`gridItem`	`GridItem`	O item de grade a ser adicionado.

Retorno

Grid: esse 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 será aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de interface só pode ter 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

Nome	Tipo	Descrição
`action`	`AuthorizationAction`	O objeto que especifica a ação de autorização a ser realizada quando esse elemento é clicado.

Retorno

Grid: esse objeto para encadeamento.

`setBorderStyle(borderStyle)`

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

Parâmetros

Nome	Tipo	Descrição
`borderStyle`	`BorderStyle`	O estilo de borda a ser aplicado.

Retorno

Grid: esse objeto para encadeamento.

`setComposeAction(action, composedEmailType)`

Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. Um objeto de interface só pode ter um dos itens 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).

Observação: esse método não define uma ação de composição usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento da interface a uma Action que compõe mensagens de rascunho no Apps Script que são abertas no Gmail quando a ação é concluída.

// ...

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

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de composição a ser executada quando esse elemento é clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta.

Retorno

Grid: esse objeto para encadeamento.

`setNumColumns(numColumns)`

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

Parâmetros

Nome	Tipo	Descrição
`numColumns`	`Integer`	O número de colunas.

Retorno

Grid: esse objeto para encadeamento.

`setOnClickAction(action)`

Define uma ação que é executada quando o objeto é clicado. Um objeto da interface só pode ter um dos definidos 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

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser realizada quando esse elemento é clicado.

Retorno

Grid: esse 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 interface só pode ter um dos itens 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

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de abrir link a ser realizada quando esse elemento é clicado.

Retorno

Grid: esse objeto para encadeamento.

`setOpenLink(openLink)`

Define um URL a ser aberto quando o objeto for clicado. Use essa função quando o URL já for conhecido e só precisar ser aberto. Um objeto de interface só pode ter um dos seguintes valores: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Parâmetros

Nome	Tipo	Descrição
`openLink`	`OpenLink`	Um objeto `OpenLink` que descreve o URL a ser aberto.

Retorno

Grid: esse 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

Nome	Tipo	Descrição
`title`	`String`	Texto do título.

Retorno

Grid: esse objeto para encadeamento.