このページは Cloud Translation API によって翻訳されました。

Class TextInput

テキスト入力を受け入れる入力フィールドウィジェット。

Google Workspace アドオンと Google Chat アプリで利用できます。

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

メソッド

メソッド	戻り値の型	概要
`setFieldName(fieldName)`	`TextInput`	UI 操作が発生したときに生成されるイベントオブジェクトで、このテキスト入力を識別するキーを設定します。
`setHint(hint)`	`TextInput`	テキスト入力のヒントを設定します。
`setMultiline(multiline)`	`TextInput`	入力テキストを 1 行または複数行で表示するかどうかを設定します。
`setOnChangeAction(action)`	`TextInput`	テキスト入力が変更されるたびに実行されるアクションを設定します。
`setSuggestions(suggestions)`	`TextInput`	テキストフィールドに予測入力の候補を設定します。
`setSuggestionsAction(suggestionsAction)`	`TextInput`	自動入力のためにユーザー入力に基づいて候補を取得するコールバックアクションを設定します。
`setTitle(title)`	`TextInput`	入力フィールドの上に表示されるタイトルを設定します。
`setValidation(validation)`	`TextInput`	このウィジェットの検証ルールを設定します。
`setValue(value)`	`TextInput`	入力フィールドに設定する事前入力値を設定します。

詳細なドキュメント

`setFieldName(fieldName)`

UI 操作が発生したときに生成されるイベントオブジェクトで、このテキスト入力を識別するキーを設定します。ユーザーには表示されません。必須で、一意である必要があります。

パラメータ

名前	型	説明
`fieldName`	`String`	この入力を識別するために使用されるキー。

戻る

TextInput - チェーン用のこのオブジェクト。

`setHint(hint)`

テキスト入力のヒントを設定します。入力内容についてユーザーに追加のガイダンスを提供するために使用されます。たとえば、ヒントでは電話番号フィールドの形式（「xxx-xxx-xxxx」）を説明できます。

パラメータ

名前	型	説明
`hint`	`String`	入力フィールドの下に表示するテキストヒント。このテキストは常に表示されます。

戻る

TextInput - チェーン用のこのオブジェクト。

`setMultiline(multiline)`

入力テキストを 1 行に表示するか複数行に表示するかを設定します。

パラメータ

名前	型	説明
`multiline`	`Boolean`	複数行の設定。

戻る

TextInput - チェーン用のこのオブジェクト。

`setOnChangeAction(action)`

テキスト入力が変更されるたびに実行されるアクションを設定します。

パラメータ

名前	型	説明
`action`	`Action`	実行する操作。

戻る

TextInput - チェーン用のこのオブジェクト。

`setSuggestions(suggestions)`

テキストフィールドに予測入力の候補を設定します。

パラメータ

名前	型	説明
`suggestions`	`Suggestions`	使用する候補のコレクション。

戻る

TextInput - チェーン用のこのオブジェクト。

`setSuggestionsAction(suggestionsAction)`

ユーザー入力に基づいて候補を取得し、自動入力を行うコールバックアクションを設定します。Action パラメータには、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();
}

パラメータ

名前	型	説明
`suggestionsAction`	`Action`	この入力の候補を取得するアクション。

戻る

TextInput - チェーン用のこのオブジェクト。

`setTitle(title)`

入力フィールドの上に表示されるタイトルを設定します。必須。

パラメータ

名前	型	説明
`title`	`String`	この入力のテキストラベル。

戻る

TextInput - チェーン用のこのオブジェクト。

`setValidation(validation)`

このウィジェットの検証ルールを設定します。

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

パラメータ

名前	型	説明
`validation`	`Validation`	この `TextInput` ウィジェットの検証ルール。

戻る

TextInput - チェーン用のこのオブジェクト。

`setValue(value)`

入力フィールドに設定する事前入力値を設定します。

パラメータ

名前	型	説明
`value`	`String`	入力に配置されたデフォルト値。フォームのコールバックパラメータでは常に文字列として表されます。

戻る

TextInput - チェーン用のこのオブジェクト。