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

Class TextInput

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

Google Workspace アドオンと Google Chat アプリでご利用いただけます。

var 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`	入力フィールドの上に表示されるタイトルを設定します。
`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 オブジェクトを返すコールバック関数を指定する必要があります。

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();
}

パラメータ

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

戻る

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

`setTitle(title)`

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

パラメータ

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

戻る

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

`setValue(value)`

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

パラメータ

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

戻る

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