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

Class TextInput

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

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

Methods

方法	戻り値の型	概要
`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 - チェーン用のオブジェクト。