Class TextInput

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');

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
addEventAction(eventAction)	Widget	تضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.
setFieldName(fieldName)	TextInput	تضبط هذه السمة المفتاح الذي يحدّد إدخال النص هذا في عنصر الحدث الذي يتم إنشاؤه عند حدوث تفاعل مع واجهة المستخدم.
setHint(hint)	TextInput	تضبط هذه السمة تلميحًا لإدخال النص.
setHostAppDataSource(hostAppDataSource)	TextInput	تضبط هذه السمة مصدر بيانات من تطبيقات Google Workspace.
setId(id)	Widget	يضبط هذا الإجراء المعرّف الفريد الذي تمّ تعيينه والذي يُستخدَم لتحديد الأداة التي سيتمّ تغييرها.
setInputMode(inputMode)	TextInput	تضبط هذه السمة ما إذا كان حقل إدخال النص هذا يتيح إدراج متغيرات.
setMultiline(multiline)	TextInput	تحديد ما إذا كان النص المُدخَل يظهر في سطر واحد أو عدة أسطر
setOnChangeAction(action)	TextInput	تضبط هذه السمة إجراءً يتم تنفيذه كلما تغيّر النص المُدخَل.
setSuggestions(suggestions)	TextInput	تضبط هذه السمة الاقتراحات للإكمال التلقائي في حقل النص.
setSuggestionsAction(suggestionsAction)	TextInput	تضبط هذه السمة إجراء معاودة الاتصال لجلب الاقتراحات استنادًا إلى بيانات أدخلها المستخدم للإكمال التلقائي.
setTitle(title)	TextInput	تضبط هذه السمة العنوان المطلوب عرضه فوق حقل الإدخال.
setValidation(validation)	TextInput	تضبط هذه السمة قاعدة التحقّق من الصحة لهذا التطبيق المصغّر.
setValue(value)	TextInput	تضبط هذه السمة القيمة التي سيتم ملؤها مسبقًا في حقل الإدخال.
setVisibility(visibility)	Widget	تضبط هذه السمة مستوى ظهور الأداة.

مستندات تفصيلية

addEventAction(eventAction)

تضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.

المعلمات

الاسم	النوع	الوصف
eventAction	EventAction	تمثّل هذه السمة EventAction المطلوب إضافتها.

الإرجاع

Widget — العنصر، للتسلسل

---

setFieldName(fieldName)

تضبط هذه السمة المفتاح الذي يحدّد إدخال النص هذا في عنصر الحدث الذي يتم إنشاؤه عند حدوث تفاعل مع واجهة المستخدم. لا يظهر للمستخدم. مطلوب، ويجب أن يكون فريدًا.

المعلمات

الاسم	النوع	الوصف
fieldName	String	المفتاح المستخدَم لتحديد هذا الإدخال.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setHint(hint)

تضبط هذه السمة تلميحًا لإدخال النص. تُستخدَم لتزويد المستخدم بإرشادات إضافية حول ما يجب إدخاله. على سبيل المثال، يمكن أن يصف تلميح التنسيق ("xxx-xxx-xxxx") لحقل رقم الهاتف.

المعلمات

الاسم	النوع	الوصف
hint	String	تلميح النص المطلوب عرضه أسفل حقل الإدخال يكون هذا النص مرئيًا دائمًا.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setHostAppDataSource(hostAppDataSource)

تضبط هذه السمة مصدر بيانات من تطبيقات Google Workspace. يتوافق حاليًا مع المستخدمين ومساحات Chat.

لا تتوفّر إلا لإضافات 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);

المعلمات

الاسم	النوع	الوصف
hostAppDataSource	HostAppDataSource	مصدر البيانات

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setId(id)

يضبط هذا الإجراء المعرّف الفريد الذي تمّ تعيينه والذي يُستخدَم لتحديد الأداة التي سيتمّ تغييرها. لا يمكن تغيير التطبيقات المصغّرة إلا في الإضافات.

المعلمات

الاسم	النوع	الوصف
id	String	معرّف الأداة، ويمكن أن يتضمّن 64 حرفًا بحدّ أقصى وبالتنسيق `[a-zA-Z0-9-]+`.

الإرجاع

Widget: هذا العنصر، للتسلسل

---

setInputMode(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);

المعلمات

الاسم	النوع	الوصف
inputMode	TextInputMode	نوع الإدخال المسموح به لحقل إدخال النص هذا، استخدِم RICH_TEXT للسماح بإدراج متغيرات.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setMultiline(multiline)

تحديد ما إذا كان النص المُدخَل يظهر في سطر واحد أو عدة أسطر

المعلمات

الاسم	النوع	الوصف
multiline	Boolean	إعداد الأسطر المتعددة

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setOnChangeAction(action)

تضبط هذه السمة إجراءً يتم تنفيذه كلما تغيّر النص المُدخَل.

المعلمات

الاسم	النوع	الوصف
action	Action	الإجراء المطلوب اتّخاذه

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setSuggestions(suggestions)

تضبط هذه السمة الاقتراحات للإكمال التلقائي في حقل النص.

المعلمات

الاسم	النوع	الوصف
suggestions	Suggestions	مجموعة الاقتراحات التي يمكن استخدامها.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setSuggestionsAction(suggestionsAction)

تضبط هذه السمة إجراء معاودة الاتصال لجلب الاقتراحات استنادًا إلى بيانات أدخلها المستخدم للإكمال التلقائي. يجب أن تحدّد المَعلمة Action دالة ردّ اتصال تعرض عنصر SuggestionsResponse.

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();
}

المعلمات

الاسم	النوع	الوصف
suggestionsAction	Action	الإجراء الذي يسترد اقتراحات لهذا الإدخال.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setTitle(title)

تضبط هذه السمة العنوان المطلوب عرضه فوق حقل الإدخال. الحقل مطلوب.

المعلمات

الاسم	النوع	الوصف
title	String	تمثّل هذه السمة التصنيف النصي لعنصر الإدخال هذا.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setValidation(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	قاعدة التحقّق من الصحة لأداة TextInput هذه.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setValue(value)

تضبط هذه السمة القيمة التي سيتم ملؤها مسبقًا في حقل الإدخال.

المعلمات

الاسم	النوع	الوصف
value	String	القيمة التلقائية التي يتم وضعها في حقل الإدخال ويتم تمثيله دائمًا كسلسلة في مَعلمات معاودة الاتصال الخاصة بالنموذج.

الإرجاع

TextInput: هذا العنصر، للتسلسل

---

setVisibility(visibility)

تضبط هذه السمة مستوى ظهور الأداة. القيمة التلقائية هي `VISIBLE`.

المعلمات

الاسم	النوع	الوصف
visibility	Visibility	Visibility الأداة

الإرجاع

Widget — العنصر، للتسلسل