Class TextInput

TextInput

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

متاحة لإضافات Google Workspace وتطبيقات Google Chat.

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: هذا الكائن، للتسلسل.