Class TextInput

ورودی متن

ویجت فیلد ورودی که ورودی متن را می پذیرد.

برای افزونه‌های Google Workspace و برنامه‌های Google Chat موجود است.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

روش ها

روش نوع برگشت شرح مختصر
set Field Name(fieldName) Text Input کلیدی را تنظیم می کند که این ورودی متن را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند.
set Hint(hint) Text Input یک راهنمایی برای ورودی متن تنظیم می کند.
set Multiline(multiline) Text Input تنظیم می کند که متن ورودی در یک خط یا چند خط نشان داده شود.
set On Change Action(action) Text Input یک عمل را تنظیم می کند تا هر زمان که ورودی متن تغییر کند، انجام شود.
set Suggestions(suggestions) Text Input پیشنهادات تکمیل خودکار را در قسمت متن تنظیم می کند.
set Suggestions Action(suggestionsAction) Text Input عملکرد برگشت به تماس را برای واکشی پیشنهادات بر اساس ورودی کاربر برای تکمیل خودکار تنظیم می‌کند.
set Title(title) Text Input عنوان را تنظیم می کند که در بالای فیلد ورودی نشان داده شود.
set Validation(validation) Text Input قانون اعتبارسنجی را برای این ویجت تنظیم می کند.
set Value(value) Text Input مقدار از پیش پر شده را برای تنظیم در قسمت ورودی تنظیم می کند.

مستندات دقیق

set Field Name(fieldName)

کلیدی را تنظیم می کند که این ورودی متن را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند. برای کاربر قابل مشاهده نیست. الزامی، باید منحصر به فرد باشد.

پارامترها

نام تایپ کنید توضیحات
field Name String کلیدی که برای شناسایی این ورودی استفاده می شود.

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Hint(hint)

یک راهنمایی برای ورودی متن تنظیم می کند. برای راهنمایی بیشتر کاربر در مورد آنچه باید وارد شود استفاده می شود. به عنوان مثال، یک راهنمایی می تواند قالب بندی ("xxx-xxx-xxxx") را برای فیلد شماره تلفن توصیف کند.

پارامترها

نام تایپ کنید توضیحات
hint String راهنمایی متن برای نمایش در زیر فیلد ورودی. این متن همیشه قابل مشاهده است.

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Multiline(multiline)

تنظیم می کند که متن ورودی در یک خط یا چند خط نشان داده شود.

پارامترها

نام تایپ کنید توضیحات
multiline Boolean تنظیم چند خطی

بازگشت

Text Input - این شی، برای زنجیر کردن.

set On Change Action(action)

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

پارامترها

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

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Suggestions(suggestions)

پیشنهادات تکمیل خودکار را در قسمت متن تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
suggestions Suggestions مجموعه پیشنهادات برای استفاده

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Suggestions Action(suggestionsAction)

عملکرد برگشت به تماس را برای واکشی پیشنهادات بر اساس ورودی کاربر برای تکمیل خودکار تنظیم می‌کند. پارامتر Action باید تابع callback را مشخص کند که یک شیء Suggestions Response برمی گرداند.

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 Action اقدامی که پیشنهادهایی را برای این ورودی واکشی می‌کند.

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Title(title)

عنوان را تنظیم می کند که در بالای فیلد ورودی نشان داده شود. مورد نیاز.

پارامترها

نام تایپ کنید توضیحات
title String برچسب متنی برای این ورودی.

بازگشت

Text Input - این شی، برای زنجیر کردن.

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 Input .

بازگشت

Text Input - این شی، برای زنجیر کردن.

set Value(value)

مقدار از پیش پر شده را برای تنظیم در قسمت ورودی تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
value String مقدار پیش فرض قرار داده شده در ورودی. همیشه به عنوان یک رشته در پارامترهای پاسخ به تماس نشان داده می شود.

بازگشت

Text Input - این شی، برای زنجیر کردن.