接受文字輸入的輸入欄位小工具。
適用於 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)
setSuggestions(suggestions)
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：這個物件用於鏈結。