可接受文字輸入的輸入欄位小工具。
適用於 Google Workspace 外掛程式和 Google Chat 應用程式。
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint');
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
set | Text | 設定事件物件中用於識別此文字輸入內容的鍵,該事件物件會在發生 UI 互動行為時產生。 |
set | Text | 設定文字輸入提示。 |
set | Text | 設定輸入文字是否顯示在一行或多行。 |
set | Text | 設定每次文字輸入內容變更時要執行的動作。 |
set | Text | 設定文字欄位中的自動完成建議。 |
set | Text | 設定回呼動作,根據使用者輸入內容擷取自動完成建議。 |
set | Text | 設定要在輸入欄位上方顯示的標題。 |
set | Text | 設定這個小工具的驗證規則。 |
set | Text | 設定要設在輸入欄位的預先填入值。 |
內容詳盡的說明文件
set Field Name(fieldName)
設定事件物件中的鍵,用於在發生 UI 互動行為時,識別此文字輸入內容。使用者看不到。必要欄位,不得重複。
參數
名稱 | 類型 | 說明 |
---|---|---|
field | String | 用於識別此輸入內容的鍵。 |
回攻員
Text
:這個物件用於鏈結。
set Hint(hint)
設定文字輸入提示。用於為使用者提供額外輸入指引。舉例來說,提示可以說明電話號碼欄位的格式 (「xxx-xxx-xxxx」)。
參數
名稱 | 類型 | 說明 |
---|---|---|
hint | String | 顯示在輸入欄位下方的文字提示。這段文字會一直顯示。 |
回攻員
Text
:這個物件用於鏈結。
set Multiline(multiline)
set On Change Action(action)
set Suggestions(suggestions)
set Suggestions Action(suggestionsAction)
設定回呼動作,根據使用者輸入內容擷取自動完成建議。Action
參數必須指定回傳 Suggestions
物件的回呼函式。
const action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({numSuggestions: 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { const suggestions = CardService.newSuggestions(); const numSuggestions = Number.parseInt(e.parameter.numSuggestions); for (let i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion(`Suggestion ${i}`); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
參數
名稱 | 類型 | 說明 |
---|---|---|
suggestions | Action | 針對此輸入內容擷取建議的動作。 |
回攻員
Text
:這個物件用於鏈結。
set Title(title)
set Validation(validation)
設定這個小工具的驗證規則。
const validation = CardService.newValidation().setCharacterLimit('10').setType( CardService.InputType.TEXT); const input = CardService.newTextInput() .setFieldName('text_name_xxx1') .setTitle('Max 10 characters') .setValidation(validation);
參數
名稱 | 類型 | 說明 |
---|---|---|
validation | Validation | 這個 Text 小工具的驗證規則。 |
回攻員
Text
:這個物件用於鏈結。