Esta página foi traduzida pela API Cloud Translation.

Class TextInput

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

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

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

Métodos

Método	Tipo de retorno	Breve descrição
`setFieldName(fieldName)`	`TextInput`	Define a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação com a interface.
`setHint(hint)`	`TextInput`	Define uma dica para a entrada de texto.
`setMultiline(multiline)`	`TextInput`	Define se o texto de entrada será mostrado em uma ou várias linhas.
`setOnChangeAction(action)`	`TextInput`	Define uma ação a ser realizada sempre que a entrada de texto mudar.
`setSuggestions(suggestions)`	`TextInput`	Define as sugestões para preenchimento automático no campo de texto.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	Define a ação de callback para buscar sugestões com base na entrada do usuário para preenchimento automático.
`setTitle(title)`	`TextInput`	Define o título que será mostrado acima do campo de entrada.
`setValue(value)`	`TextInput`	Define 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 com a interface. Não está visível para o usuário. Obrigatório. Precisa ser exclusivo.

Parâmetros

Nome	Tipo	Descrição
`fieldName`	`String`	A chave usada para identificar essa entrada.

Retorno

TextInput: este objeto para encadeamento.

`setHint(hint)`

Define uma dica para a entrada de texto. Usado para fornecer ao usuário mais orientação 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

Nome	Tipo	Descrição
`hint`	`String`	A dica de texto a ser exibida abaixo do campo de entrada. Esse texto está sempre visível.

Retorno

TextInput: este objeto para encadeamento.

`setMultiline(multiline)`

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

Parâmetros

Nome	Tipo	Descrição
`multiline`	`Boolean`	A configuração de várias linhas.

Retorno

TextInput: este objeto para encadeamento.

`setOnChangeAction(action)`

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

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser tomada.

Retorno

TextInput: este objeto para encadeamento.

`setSuggestions(suggestions)`

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

Parâmetros

Nome	Tipo	Descrição
`suggestions`	`Suggestions`	A coleção de sugestões a serem usadas.

Retorno

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 preenchimento automático. O parâmetro Action precisa especificar uma função de callback que retorne um objeto SuggestionsResponse.

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

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

// ...

function suggestionCallback(e) {
  var suggestions = CardService.newSuggestions();
  var numSuggestions = parseInt(e.parameter['numSuggestions']);
  for(var i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion('Suggestion ' + i);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parâmetros

Nome	Tipo	Descrição
`suggestionsAction`	`Action`	A ação que busca sugestões para essa entrada.

Retorno

TextInput: este objeto para encadeamento.

`setTitle(title)`

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O rótulo de texto da entrada.

Retorno

TextInput: este objeto para encadeamento.

`setValue(value)`

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor padrão colocado na entrada. Ele é sempre representado como uma string nos parâmetros de callback do formulário.

Retorno

TextInput: este objeto para encadeamento.