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 — هذا العنصر، للتسلسل.