Class TextInput

TextInput

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

Disponível nos complementos do Google Workspace e nos 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étodoTipo de retornoBreve descrição
setFieldName(fieldName)TextInputDefine a chave que identifica essa entrada de texto no objeto de evento que é gerado quando não há é uma interação da interface.
setHint(hint)TextInputDefine uma dica para a entrada de texto.
setMultiline(multiline)TextInputDefine se o texto de entrada será mostrado em uma linha ou em várias.
setOnChangeAction(action)TextInputDefine uma ação a ser executada sempre que a entrada de texto for alterada.
setSuggestions(suggestions)TextInputDefine as sugestões de preenchimento automático no campo de texto.
setSuggestionsAction(suggestionsAction)TextInputDefine a ação de retorno de chamada para buscar sugestões com base na entrada do usuário para preenchimento automático.
setTitle(title)TextInputDefine o título a ser mostrado acima do campo de entrada.
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 que é gerado quando não há é uma interação da interface. Não está visível para o usuário. Obrigatório, 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ção sobre o que inserir. Para exemplo, uma dica pode descrever a formatação ("xxx-xxx-xxxx") para um campo de número de telefone.

Parâmetros

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

Retornar

TextInput: este objeto, para encadeamento.


setMultiline(multiline)

Define se o texto de entrada é mostrado em uma linha ou em várias.

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 executada sempre que a entrada de texto for alterada.

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
suggestionsSuggestionsO conjunto de sugestões a serem usadas.

Retornar

TextInput: este objeto, para encadeamento.


setSuggestionsAction(suggestionsAction)

Define a ação de retorno de chamada para buscar sugestões com base na entrada do usuário para preenchimento automático. A O parâmetro Action precisa especificar uma função de callback que retorna 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

NomeTipoDescrição
suggestionsActionActionA ação que busca sugestões para esta 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
titleStringRótulo de texto para esta entrada.

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. É sempre representado como uma string no de parâmetros de callback de formulário.

Retornar

TextInput: este objeto, para encadeamento.