Um widget de campo de entrada que aceita entrada de texto.
Disponível nos complementos do Google Workspace e nos 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é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 aparece 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 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 preenchimento automático. |
setTitle(title) | TextInput | Define o título a ser mostrado acima do campo de entrada. |
setValidation(validation) | TextInput | Define a regra de validação para este widget. |
setValue(value) | TextInput | Define o valor preenchido previamente 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 aparece para o usuário. Obrigatório, precisa ser exclusivo.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
fieldName | String | A 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. 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 que será exibida abaixo do campo de entrada. Esse texto está sempre visível. |
Retornar
TextInput
: este objeto, para encadeamento.
setMultiline(multiline)
Define se o texto de entrada aparece 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 | A 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 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
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 mostrado acima do campo de entrada. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | Etiqueta 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
Nome | Tipo | Descrição |
---|---|---|
validation | Validation | A regra de validação para este widget TextInput . |
Retornar
TextInput
: este objeto, para encadeamento.
setValue(value)
Define o valor preenchido previamente 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. |
Retornar
TextInput
: este objeto, para encadeamento.