Class Action

Ação

Uma ação que permite a interatividade nos elementos da interface. A ação não acontece diretamente no cliente, mas invoca uma função de callback do Apps Script com parâmetros opcionais.

Disponível para complementos do Google Workspace e apps do Google Chat.

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

Métodos

MétodoTipo de retornoBreve descrição
setFunctionName(functionName)ActionDefine o nome da função de retorno de chamada a ser chamada.
setInteraction(interaction)ActionDefine a interação com um usuário, obrigatória apenas ao abrir uma caixa de diálogo.
setLoadIndicator(loadIndicator)ActionDefine o indicador de carregamento que aparece enquanto a ação está em andamento.
setParameters(parameters)ActionPermite que parâmetros personalizados sejam transmitidos para a função de callback.
setPersistValues(persistValues)ActionIndica se os valores do formulário são determinados pelos valores do cliente ou do servidor depois que uma resposta de ação atualiza o Card do formulário.

Documentação detalhada

setFunctionName(functionName)

Define o nome da função de retorno de chamada a ser chamada. Obrigatório.

Parâmetros

NomeTipoDescrição
functionNameStringO nome da função. Você pode usar funções de bibliotecas incluídas, como Library.libFunction1.

Retorno

Action: este objeto para encadeamento.


setInteraction(interaction)

Define a interação com um usuário, obrigatória apenas ao abrir uma caixa de diálogo. Se não for especificado, o app responderá executando uma Action, como abrir um link ou executar uma função, como de costume.

Disponível apenas nos apps do Google Chat. Indisponível para complementos do Google Workspace.

const action = CardService.newAction()
    .setFunctionName('handleDialog')
    .setInteraction(CardService.Interaction.OPEN_DIALOG);

Parâmetros

NomeTipoDescrição
interactionInteractionA interação a ser especificada.

Retorno

Action: este objeto para encadeamento.


setLoadIndicator(loadIndicator)

Define o indicador de carregamento que aparece enquanto a ação está em andamento.

Parâmetros

NomeTipoDescrição
loadIndicatorLoadIndicatorO indicador a ser exibido.

Retorno

Action: este objeto para encadeamento.


setParameters(parameters)

Permite que parâmetros personalizados sejam transmitidos para a função de callback. Opcional.

Parâmetros

NomeTipoDescrição
parametersObjectTanto as chaves quanto os valores precisam ser strings.

Retorno

Action: este objeto para encadeamento.


setPersistValues(persistValues)

Indica se os valores do formulário são determinados pelos valores do cliente ou do servidor depois que uma resposta de ação atualiza o Card do formulário. Quando definidos como true, os valores do cliente persistem após a resposta do servidor. Quando definido como false, os valores do servidor substituem os valores do formulário. O padrão é false.

Manter os valores do cliente ajuda a evitar situações em que um formulário muda inesperadamente depois que um usuário faz uma edição. Por exemplo, se um usuário fizer uma edição em um TextInput depois de enviar um formulário, mas antes do servidor responder. Se os valores forem mantidos, a edição feita pelo usuário permanecerá depois que a resposta do servidor atualizar o Card. Caso contrário, o valor do formulário retornará ao valor que o usuário enviou originalmente ao formulário.

Manter valores de cliente pode interferir na capacidade do script de limpar campos de formulário ou substituir valores de formulário. Portanto, evite ativar a persistência para esse tipo de funcionalidade. Sem persistência, é recomendável usar o LoadIndicator.SPINNER para eventos, porque isso bloqueia a interface e impede edições do usuário antes que o servidor responda. Também é possível usar LoadIndicator.NONE e conferir se todos os elementos do formulário têm uma ação onChange.

// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setPersistValues(true)
            .setFunctionName('functionName'));

Parâmetros

NomeTipoDescrição
persistValuesBooleanDefine se os valores serão mantidos. O valor padrão é false.

Retorno

Action: este objeto para encadeamento.

Métodos obsoletos