تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class TextInput

أداة حقل إدخال تقبل إدخال نص

تتوفّر هذه الميزة لإضافات Google Workspace وتطبيقات Google Chat.

const 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`	لضبط العنوان الذي سيتم عرضه أعلى حقل الإدخال.
`setValidation(validation)`	`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 دالة ردّ اتصال تعرِض عنصر 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: هذا العنصر، لإنشاء سلسلة.