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

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
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)

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

المعلمات

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

الإرجاع

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

setFieldName(fieldName)

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setHint(hint)

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

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setId(id)

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

المعلمات

الاسمالنوعالوصف
idStringمعرّف الأداة، ويجب ألا يتجاوز 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);

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setMultiline(multiline)

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setOnChangeAction(action)

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setSuggestions(suggestions)

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

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setTitle(title)

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

المعلمات

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

الإرجاع

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

المعلمات

الاسمالنوعالوصف
validationValidationقاعدة التحقّق من الصحة الخاصة بتطبيق TextInput المصغّر هذا

الإرجاع

TextInput: هذا الكائن، للتسلسل

setValue(value)

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

المعلمات

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

الإرجاع

TextInput: هذا الكائن، للتسلسل

setVisibility(visibility)

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

المعلمات

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

الإرجاع

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