Class TextInput

إدخال النص

تطبيق مصغّر لحقل إدخال يقبل إدخال النص

var 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لتعيين العنوان بحيث يظهر أعلى حقل الإدخال.
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.

var action = CardService.newAction()
    .setFunctionName('suggestionCallback')
    .setParameters({'numSuggestions': 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  var suggestions = CardService.newSuggestions();
  var numSuggestions = parseInt(e.parameter['numSuggestions']);
  for(var i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion('Suggestion ' + i);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

المَعلمات

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

رحلة العودة

TextInput: هذا الكائن مخصَّص للتسلسل.


setTitle(title)

لتعيين العنوان بحيث يظهر أعلى حقل الإدخال. مطلوبة.

المَعلمات

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

رحلة العودة

TextInput: هذا الكائن مخصَّص للتسلسل.


setValue(value)

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

المَعلمات

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

رحلة العودة

TextInput: هذا الكائن مخصَّص للتسلسل.