Esta página foi traduzida pela API Cloud Translation.

Class TextInput

texto

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étodo	Tipo de retorno	Breve descrição
`addEventAction(eventAction)`	`Widget`	Adiciona a ação de evento que pode ser realizada no widget.
`setFieldName(fieldName)`	`TextInput`	Define a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação da interface.
`setHint(hint)`	`TextInput`	Define uma dica para a entrada de texto.
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	Define uma fonte de dados dos aplicativos do Google Workspace.
`setId(id)`	`Widget`	Define o ID exclusivo atribuído que é usado para identificar o widget a ser alterado.
`setInputMode(inputMode)`	`TextInput`	Define se este campo de entrada de texto aceita a inserção de variáveis.
`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 o 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 pré-preenchido a ser definido no campo de entrada.
`setVisibility(visibility)`	`Widget`	Define a visibilidade do widget.

Documentação detalhada

`addEventAction(eventAction)`

Adiciona a ação de evento que pode ser realizada no widget.

Parâmetros

Nome	Tipo	Descrição
`eventAction`	`EventAction`	O `EventAction` a ser adicionado.

Retornar

Widget: o objeto para encadeamento.

`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

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çõ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

Nome	Tipo	Descrição
`hint`	`String`	A 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. No momento, ele é compatível com usuários e espaços do Chat.

Disponível apenas para complementos do Google Workspace que estendem o Google Workspace Studio.

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

Nome	Tipo	Descrição
`hostAppDataSource`	`HostAppDataSource`	A fonte de dados.

Retornar

TextInput: este objeto, para encadeamento.

`setId(id)`

Define o ID exclusivo atribuído que é usado para identificar o widget a ser alterado. A mutação de widget só é compatível com complementos.

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID do widget, com um limite de 64 caracteres e no formato `[a-zA-Z0-9-]+`.

Retornar

Widget: este objeto, para encadeamento.

`setInputMode(inputMode)`

Define se este campo de entrada de texto aceita a inserção de variáveis.

Disponível apenas para complementos do Google Workspace que estendem o Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Parâmetros

Nome	Tipo	Descrição
`inputMode`	`TextInputMode`	O tipo de entrada permitida para esse campo de entrada de texto. Use RICH_TEXT para oferecer suporte à inserção de variáveis.

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)`

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.

Retornar

TextInput: este objeto, para encadeamento.

`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 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

Nome	Tipo	Descrição
`suggestionsAction`	`Action`	A 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

Nome	Tipo	Descrição
`title`	`String`	O 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

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 pré-preenchido a ser definido no campo de entrada.

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O 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.

`setVisibility(visibility)`

Define a visibilidade do widget. O valor padrão é "VISIBLE".

Parâmetros

Nome	Tipo	Descrição
`visibility`	`Visibility`	O `Visibility` do widget.

Retornar

Widget: o objeto para encadeamento.

Class TextInput Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Métodos

Documentação detalhada

addEventAction(eventAction)

Parâmetros

Retornar

setFieldName(fieldName)

Parâmetros

Retornar

setHint(hint)

Parâmetros

Retornar

setHostAppDataSource(hostAppDataSource)

Parâmetros

Retornar

setId(id)

Parâmetros

Retornar

setInputMode(inputMode)

Parâmetros

Retornar

setMultiline(multiline)

Parâmetros

Retornar

setOnChangeAction(action)

Parâmetros

Retornar

setSuggestions(suggestions)

Parâmetros

Retornar

setSuggestionsAction(suggestionsAction)

Parâmetros

Retornar

setTitle(title)

Parâmetros

Retornar

setValidation(validation)

Parâmetros

Retornar

setValue(value)

Parâmetros

Retornar

setVisibility(visibility)

Parâmetros

Retornar

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`