Class TextInput

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 کلیدی را تنظیم می کند که این ورودی متن را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند.
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)

یک عمل را تنظیم می کند تا هر زمان که ورودی متن تغییر کند، انجام شود.

پارامترها
نام تایپ کنید توضیحات
action Action اقدامی که باید انجام داد.
بازگشت

TextInput - این شی، برای زنجیره‌بندی.


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 - این شیء، برای زنجیر کردن.