Um widget de campo de entrada que aceita entrada de texto.
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 que é gerado quando há uma interação com a IU. |
setHint(hint) | TextInput | Define uma dica para a entrada de texto. |
setMultiline(multiline) | TextInput | Define se o texto de entrada será exibido em uma ou várias linhas. |
setOnChangeAction(action) | TextInput | Define uma ação a ser executada sempre que a entrada de texto for alterada. |
setSuggestions(suggestions) | TextInput | Define as sugestões de 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 o preenchimento automático. |
setTitle(title) | TextInput | Define o título a ser exibido 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 que é gerado quando há uma interação com a IU. Não visível para o usuário. Obrigatório, deve ser único.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
fieldName | String | 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 mais orientações ao usuário sobre o que inserir. Por exemplo, uma dica pode descrever a formatação ("xxx-xxx-xxxx") para um campo de número de telefone.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
hint | String | A dica de texto a ser exibida quando a entrada estiver vazia. |
Retornar
TextInput
: este objeto, para encadeamento.
setMultiline(multiline)
Define se o texto de entrada será exibido em uma ou várias linhas.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
multiline | Boolean | A configuração de várias linhas. |
Retornar
TextInput
: este objeto, para encadeamento.
setOnChangeAction(action)
setSuggestions(suggestions)
Define as sugestões de preenchimento automático no campo de texto.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
suggestions | Suggestions | O conjunto 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
.
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 esta entrada. |
Retornar
TextInput
: este objeto, para encadeamento.
setTitle(title)
Define o título a ser exibido acima do campo de entrada. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | Etiqueta 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
Nome | Tipo | Descrição |
---|---|---|
value | String | O valor padrão inserido na entrada. Ele é sempre representado como uma string nos parâmetros de callback do formulário. |
Retornar
TextInput
: este objeto, para encadeamento.