Class SelectionInput

SelectionInput

حقل إدخال يسمح بالاختيار من بين مجموعة من الخيارات المحدّدة مسبقًا.

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

var checkboxGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.CHECK_BOX)
    .setTitle("A group of checkboxes. Multiple selections are allowed.")
    .setFieldName("checkbox_field")
    .addItem("checkbox one title", "checkbox_one_value", false)
    .addItem("checkbox two title", "checkbox_two_value", true)
    .addItem("checkbox three title", "checkbox_three_value", true)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleCheckboxChange"));

var radioGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.RADIO_BUTTON)
    .setTitle("A group of radio buttons. Only a single selection is allowed.")
    .setFieldName("checkbox_field")
    .addItem("radio button one title", "radio_one_value", true)
    .addItem("radio button two title", "radio_two_value", false)
    .addItem("radio button three title", "radio_three_value", false);

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description")
    .setMultiSelectMaxSelectedItems(3)
    .setMultiSelectMinQueryLength(1);

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
addItem(text, value, selected)	SelectionInput	يضيف عنصرًا جديدًا يمكن اختياره.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)	SelectionInput	يضيف عنصرًا جديدًا يمكن تحديده للقوائم المتعددة الاختيارات.
setExternalDataSource(action)	SelectionInput	لضبط مصدر بيانات خارجي، مثل قاعدة بيانات ارتباطية.
setFieldName(fieldName)	SelectionInput	لضبط المفتاح الذي يحدد إدخال التحديد هذا في كائن الحدث الذي يتم إنشاؤه عندما هناك تفاعل مع واجهة المستخدم.
setMultiSelectMaxSelectedItems(maxSelectedItems)	SelectionInput	تُحدِّد هذه السياسة الحد الأقصى لعدد العناصر التي يمكن للمستخدم اختيارها.
setMultiSelectMinQueryLength(queryLength)	SelectionInput	لتعيين عدد أحرف النص التي يُدخلها المستخدم قبل الإكمال التلقائي لطلبات بحث التطبيق يعرض العناصر المقترحة على البطاقة.
setOnChangeAction(action)	SelectionInput	تحدِّد هذه السياسة Action ليتم تنفيذه كلما تغيّر الإدخال المحدّد.
setPlatformDataSource(platformDataSource)	SelectionInput	لإعداد مصدر بيانات من Google Workspace.
setTitle(title)	SelectionInput	لضبط العنوان الذي سيتم عرضه قبل حقل الإدخال.
setType(type)	SelectionInput	تُحدِّد نوع مصدر الإدخال هذا.

الوثائق التفصيلية

addItem(text, value, selected)

يضيف عنصرًا جديدًا يمكن اختياره.

المعلمات

الاسم	النوع	الوصف
text	Object	النص الذي سيتم عرضه لهذا العنصر. يتم تحويل الوسيطات الأساسية التي ليست سلسلة إلى السلاسل تلقائيًا.
value	Object	قيمة إدخال النموذج التي يتم إرسالها من خلال معاودة الاتصال. وسيطات أساسية ليست سلسلة يتم تحويلها إلى سلاسل تلقائيًا.
selected	Boolean	ما إذا كان قد تم اختيار العنصر تلقائيًا. في حال قبول إدخال التحديد فقط قيمة واحدة (مثل أزرار الاختيار أو القائمة المنسدلة)، لا تضبط هذا الحقل إلا لعنصر واحد.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

addMultiSelectItem(text, value, selected, startIconUri, bottomText)

يضيف عنصرًا جديدًا يمكن تحديده للقوائم المتعددة الاختيارات.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

المعلمات

الاسم	النوع	الوصف
text	Object	النص الذي سيتم عرضه لهذا العنصر. يتم تحويل الوسيطات الأساسية التي ليست سلسلة إلى السلاسل تلقائيًا.
value	Object	قيمة إدخال النموذج التي يتم إرسالها من خلال معاودة الاتصال. وسيطات أساسية ليست سلسلة يتم تحويلها إلى سلاسل تلقائيًا.
selected	Boolean	ما إذا كان قد تم اختيار العنصر تلقائيًا. في حال قبول إدخال التحديد فقط قيمة واحدة (مثل أزرار الاختيار أو القائمة المنسدلة)، لا تضبط هذا الحقل إلا لعنصر واحد.
startIconUri	Object	بالنسبة إلى قوائم التحديد المتعدد، يتم استخدام عنوان URL للرمز المعروض بجوار عنوان حقل النص. يمكن استخدام الملفات بتنسيق PNG وJPEG.
bottomText	Object	بالنسبة إلى قوائم التحديد المتعدد، يتم عرض وصف نصي أو تصنيف نصي أسفل حقل النص لهذا العنصر.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setExternalDataSource(action)

لضبط مصدر بيانات خارجي، مثل قاعدة بيانات ارتباطية.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .setMultiSelectMaxSelectedItems(5)
    .setMultiSelectMinQueryLength(2)
    .setExternalDataSource(CardService.newAction().setFunctionName("getContacts"));

المعلمات

الاسم	النوع	الوصف
action	Action	مصدر البيانات الخارجي.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setFieldName(fieldName)

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

المعلمات

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

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setMultiSelectMaxSelectedItems(maxSelectedItems)

تُحدِّد هذه السياسة الحد الأقصى لعدد العناصر التي يمكن للمستخدم اختيارها.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMaxSelectedItems(3)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

المعلمات

الاسم	النوع	الوصف
maxSelectedItems	Integer	تمثّل هذه السمة الحد الأقصى لعدد العناصر.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setMultiSelectMinQueryLength(queryLength)

لتعيين عدد أحرف النص التي يُدخلها المستخدم قبل الإكمال التلقائي لطلبات بحث التطبيق يعرض العناصر المقترحة على البطاقة.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMinQueryLength(1)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

المعلمات

الاسم	النوع	الوصف
queryLength	Integer	عدد حروف النص.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setOnChangeAction(action)

تحدِّد هذه السياسة Action ليتم تنفيذه كلما تغيّر الإدخال المحدّد.

المعلمات

الاسم	النوع	الوصف
action	Action	الإجراء المطلوب اتخاذه.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setPlatformDataSource(platformDataSource)

لإعداد مصدر بيانات من Google Workspace. تُستخدَم لتعبئة العناصر في قائمة اختيار متعدّد.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .setPlatformDataSource(
       CardService.newPlatformDataSource()
         .setCommonDataSource(CardService.CommonDataSource.USER));

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

المعلمات

الاسم	النوع	الوصف
platformDataSource	PlatformDataSource	مصدر البيانات.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setTitle(title)

لضبط العنوان الذي سيتم عرضه قبل حقل الإدخال.

المعلمات

الاسم	النوع	الوصف
title	String	عنوان حقل الإدخال.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.

---

setType(type)

تُحدِّد نوع مصدر الإدخال هذا. وتكون القيمة التلقائية هي CHECKBOX.

المعلمات

الاسم	النوع	الوصف
type	SelectionInputType	نوع التحديد.

الإرجاع

SelectionInput — هذا العنصر، للتسلسل.