Class TextInput

ورودی متن

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

از اعتبارسنجی ارسال فرم پشتیبانی می‌کند. وقتی Action.setAllWidgetsAreRequired(allWidgetsAreRequired) روی true تنظیم شده باشد یا این ویجت از طریق Action.addRequiredWidget(requiredWidget) مشخص شده باشد، عملیات ارسال مسدود می‌شود مگر اینکه مقداری وارد شود.

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

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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Event Action(eventAction) Widget رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.
set Field Name(fieldName) Text Input کلیدی را تنظیم می‌کند که این ورودی متنی را در شیء رویدادی که هنگام تعامل با رابط کاربری ایجاد می‌شود، شناسایی می‌کند.
set Hint(hint) Text Input یک راهنما برای ورودی متن تنظیم می‌کند.
set Host App Data Source(hostAppDataSource) Text Input یک منبع داده از برنامه‌های Google Workspace تنظیم می‌کند.
set Id(id) Widget شناسه منحصر به فرد اختصاص داده شده برای شناسایی ویجت مورد نظر برای تغییر را تنظیم می‌کند.
set Input Mode(inputMode) 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 Visibility(visibility) Widget میزان نمایش ویجت را تنظیم می‌کند.

مستندات دقیق

add Event Action(eventAction)

رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.

پارامترها

نام نوع توضیحات
event Action Event Action Event Action قرار است اضافه شود.

بازگشت

Widget — شیء، برای زنجیره‌سازی.

set Field Name(fieldName)

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

پارامترها

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

بازگشت

Text Input — این شیء، برای زنجیره‌سازی.

set Hint(hint)

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

پارامترها

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

بازگشت

Text Input — این شیء، برای زنجیره‌سازی.

set Host App Data Source(hostAppDataSource)

یک منبع داده از برنامه‌های Google Workspace تنظیم می‌کند. در حال حاضر از کاربران و فضاهای چت پشتیبانی می‌کند.

فقط برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

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

پارامترها

نام نوع توضیحات
host App Data Source Host App Data Source منبع داده‌ها.

بازگشت

Text Input — این شیء، برای زنجیره‌سازی.

set Id(id)

شناسه منحصر به فردی که برای شناسایی ویجت مورد نظر برای تغییر استفاده می‌شود را تنظیم می‌کند. تغییر ویجت فقط در افزونه‌ها پشتیبانی می‌شود.

پارامترها

نام نوع توضیحات
id String شناسه‌ی ویجت، با محدودیت ۶۴ کاراکتر و با فرمت `[a-zA-Z0-9-]+`.

بازگشت

Widget - این شیء، برای زنجیره‌سازی.

set Input Mode(inputMode)

تعیین می‌کند که آیا این فیلد ورودی متن از درج متغیر پشتیبانی می‌کند یا خیر.

فقط برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

پارامترها

نام نوع توضیحات
input Mode Text Input Mode نوع ورودی مجاز برای این فیلد ورودی متن، از RICH_TEXT برای پشتیبانی از درج متغیر استفاده کنید.

بازگشت

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 باید یک تابع فراخوانی را مشخص کند که یک شیء 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 — این شیء، برای زنجیره‌سازی.

set Visibility(visibility)

میزان نمایش ویجت را تنظیم می‌کند. مقدار پیش‌فرض آن `VISIBLE` است.

پارامترها

نام نوع توضیحات
visibility Visibility Visibility ویجت.

بازگشت

Widget — شیء، برای زنجیره‌سازی.