ویجت فیلد ورودی که ورودی متن را می پذیرد.
برای افزونههای 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 | کلیدی را تنظیم می کند که این ورودی متن را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند. |
setHint(hint) | TextInput | یک راهنمایی برای ورودی متن تنظیم می کند. |
setMultiline(multiline) | TextInput | تنظیم می کند که متن ورودی در یک خط یا چند خط نشان داده شود. |
setOnChangeAction(action) | TextInput | یک عمل را تنظیم می کند تا هر زمان که ورودی متن تغییر کند، انجام شود. |
setSuggestions(suggestions) | TextInput | پیشنهادات تکمیل خودکار را در قسمت متن تنظیم می کند. |
setSuggestionsAction(suggestionsAction) | TextInput | عملکرد برگشت به تماس را برای واکشی پیشنهادات بر اساس ورودی کاربر برای تکمیل خودکار تنظیم میکند. |
setTitle(title) | TextInput | عنوان را تنظیم می کند که در بالای فیلد ورودی نشان داده شود. |
setValue(value) | TextInput | مقدار از پیش پر شده را برای تنظیم در قسمت ورودی تنظیم می کند. |
مستندات دقیق
setFieldName(fieldName)
کلیدی را تنظیم می کند که این ورودی متن را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند. برای کاربر قابل مشاهده نیست. الزامی، باید منحصر به فرد باشد.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
fieldName | String | کلیدی که برای شناسایی این ورودی استفاده می شود. |
برگشت
TextInput
- این شیء، برای زنجیر کردن.
setHint(hint)
یک راهنمایی برای ورودی متن تنظیم می کند. برای راهنمایی بیشتر کاربر در مورد آنچه باید وارد شود استفاده می شود. به عنوان مثال، یک راهنمایی می تواند قالب بندی ("xxx-xxx-xxxx") را برای فیلد شماره تلفن توصیف کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
hint | String | راهنمایی متن برای نمایش در زیر فیلد ورودی. این متن همیشه قابل مشاهده است. |
برگشت
TextInput
- این شیء، برای زنجیر کردن.
setMultiline(multiline)
تنظیم می کند که متن ورودی در یک خط یا چند خط نشان داده شود.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
multiline | Boolean | تنظیم چند خطی |
برگشت
TextInput
- این شیء، برای زنجیر کردن.
setOnChangeAction(action)
setSuggestions(suggestions)
پیشنهادات تکمیل خودکار را در قسمت متن تنظیم می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
suggestions | Suggestions | مجموعه پیشنهادات برای استفاده |
برگشت
TextInput
- این شیء، برای زنجیر کردن.
setSuggestionsAction(suggestionsAction)
عملکرد برگشت به تماس را برای واکشی پیشنهادات بر اساس ورودی کاربر برای تکمیل خودکار تنظیم میکند. پارامتر Action
باید تابع callback را مشخص کند که یک شیء 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
- این شیء، برای زنجیر کردن.