本頁面由 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`	設定輸入文字要顯示一行還是多行。
`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)`

設定輸入文字要顯示一行還是多行。

參數

名稱	類型	說明
`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：這個物件用於鏈結。