Class TextInput

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)

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

المعلمات

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

الإرجاع

TextInput: هذا العنصر، لإنشاء سلسلة.


setHint(hint)

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

المعلمات

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

الإرجاع

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 — هذا الكائن يمكن استخدامه في التسلسل.