Class TextInput

Entradadetexto

Um widget de campo de entrada que aceita entrada de texto.

Aceita validação de envio de formulários. Quando Action.setAllWidgetsAreRequired(allWidgetsAreRequired) é definido como true ou este widget é especificado por Action.addRequiredWidget(requiredWidget), a ação de envio é bloqueada, a menos que um valor seja inserido.

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

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TextInputDefine a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação da interface.
setHint(hint)TextInputDefine uma dica para a entrada de texto.
setHostAppDataSource(hostAppDataSource)TextInputDefine uma fonte de dados dos aplicativos do Google Workspace.
setMultiline(multiline)TextInputDefine se o texto de entrada aparece em uma ou várias linhas.
setOnChangeAction(action)TextInputDefine uma ação a ser realizada sempre que a entrada de texto mudar.
setSuggestions(suggestions)TextInputDefine as sugestões de preenchimento automático no campo de texto.
setSuggestionsAction(suggestionsAction)TextInputDefine a ação de callback para buscar sugestões com base na entrada do usuário para o preenchimento automático.
setTitle(title)TextInputDefine o título a ser mostrado acima do campo de entrada.
setValidation(validation)TextInputDefine a regra de validação para este widget.
setValue(value)TextInputDefine o valor pré-preenchido a ser definido no campo de entrada.

Documentação detalhada

setFieldName(fieldName)

Define a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação da interface. Não visível para o usuário. Obrigatório e precisa ser exclusivo.

Parâmetros

NomeTipoDescrição
fieldNameStringA chave usada para identificar essa entrada.

Retornar

TextInput: este objeto, para encadeamento.

setHint(hint)

Define uma dica para a entrada de texto. Usado para dar ao usuário mais orientações sobre o que inserir. Por exemplo, uma dica pode descrever a formatação ("xxx-xxx-xxxx") de um campo de número de telefone.

Parâmetros

NomeTipoDescrição
hintStringA dica de texto a ser exibida abaixo do campo de entrada. Esse texto está sempre visível.

Retornar

TextInput: este objeto, para encadeamento.

setHostAppDataSource(hostAppDataSource)

Define uma fonte de dados dos aplicativos do Google Workspace. Atualmente, ele é compatível com usuários e espaços do Chat.

Disponível apenas pelo programa Gemini Alpha para complementos do Google Workspace que estendem os fluxos de trabalho do Google Workspace. 

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Parâmetros

NomeTipoDescrição
hostAppDataSourceHostAppDataSourceA fonte de dados.

Retornar

TextInput: este objeto, para encadeamento.

setMultiline(multiline)

Define se o texto de entrada aparece em uma ou várias linhas.

Parâmetros

NomeTipoDescrição
multilineBooleanA configuração de várias linhas.

Retornar

TextInput: este objeto, para encadeamento.

setOnChangeAction(action)

Define uma ação a ser realizada sempre que a entrada de texto mudar.

Parâmetros

NomeTipoDescrição
actionActionA ação a ser tomada.

Retornar

TextInput: este objeto, para encadeamento.

setSuggestions(suggestions)

Define as sugestões de preenchimento automático no campo de texto.

Parâmetros

NomeTipoDescrição
suggestionsSuggestionsA coleção de sugestões a serem usadas.

Retornar

TextInput: este objeto, para encadeamento.

setSuggestionsAction(suggestionsAction)

Define a ação de callback para buscar sugestões com base na entrada do usuário para o preenchimento automático. O parâmetro Action precisa especificar uma função de callback que retorne um objeto SuggestionsResponse. 

const action = CardService.newAction()
                   .setFunctionName('suggestionCallback')
                   .setParameters({numSuggestions: 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parâmetros

NomeTipoDescrição
suggestionsActionActionA ação que busca sugestões para essa entrada.

Retornar

TextInput: este objeto, para encadeamento.

setTitle(title)

Define o título a ser mostrado acima do campo de entrada. Obrigatório.

Parâmetros

NomeTipoDescrição
titleStringO rótulo de texto para essa entrada.

Retornar

TextInput: este objeto, para encadeamento.

setValidation(validation)

Define a regra de validação para este widget. 

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

Parâmetros

NomeTipoDescrição
validationValidationA regra de validação para este widget TextInput.

Retornar

TextInput: este objeto, para encadeamento.

setValue(value)

Define o valor pré-preenchido a ser definido no campo de entrada.

Parâmetros

NomeTipoDescrição
valueStringO valor padrão colocado na entrada. Ela sempre é representada como uma string nos parâmetros de callback do formulário.

Retornar

TextInput: este objeto, para encadeamento.