Class SelectionInput

اختيارإدخال

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

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

const 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'),
        );

const 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: هذا العنصر، لإنشاء سلسلة.