このページは 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");

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 インタラクション時に生成されるイベントオブジェクト内の、このテキスト入力を識別するキーを設定します。ユーザーには表示されません。必須。一意である必要があります。

パラメータ

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

リターン

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

`setHint(hint)`

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

パラメータ

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

リターン

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

`setMultiline(multiline)`

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

パラメータ

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

リターン

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

`setOnChangeAction(action)`

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

パラメータ

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

リターン

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

`setSuggestions(suggestions)`

テキストフィールドにオートコンプリートの候補を設定します。

パラメータ

Name	型	説明
`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();
}

パラメータ

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

リターン

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

`setTitle(title)`

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

パラメータ

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

リターン

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

`setValue(value)`

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

パラメータ

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

リターン

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