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يتم ضبط عدد الأحرف النصية التي يُدخلها المستخدم قبل الإكمال التلقائي لطلب بحث تطبيق Chat وعرض العناصر المقترحة على البطاقة.
setOnChangeAction(action)SelectionInputلضبط Action ليتم تنفيذه كلما تغير إدخال الاختيار.
setPlatformDataSource(platformDataSource)SelectionInputتحدِّد مصدر بيانات من Google Workspace.
setTitle(title)SelectionInputلضبط العنوان بحيث يتم عرضه قبل حقل الإدخال.
setType(type)SelectionInputلضبط نوع هذا الإدخال.

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

addItem(text, value, selected)

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

المَعلمات

الاسمالنوعالوصف
textObjectالنص الذي سيتم عرضه لهذا العنصر. ويتم تحويل الوسيطات الأساسية التي لا تتضمّن سلاسل إلى سلاسل تلقائيًا.
valueObjectقيمة إدخال النموذج التي يتم إرسالها من خلال طلب معاودة الاتصال. يتم تحويل الوسيطات الأساسية التي لا تتضمّن سلسلة إلى سلاسل تلقائيًا.
selectedBooleanما إذا كان قد تم اختيار العنصر تلقائيًا إذا كان الإدخال المحدّد يقبل قيمة واحدة فقط (مثل أزرار الاختيار أو قائمة منسدلة)، اضبط هذا الحقل لعنصر واحد فقط.

استرجاع الكرة

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");

المَعلمات

الاسمالنوعالوصف
textObjectالنص الذي سيتم عرضه لهذا العنصر. ويتم تحويل الوسيطات الأساسية التي لا تتضمّن سلاسل إلى سلاسل تلقائيًا.
valueObjectقيمة إدخال النموذج التي يتم إرسالها من خلال طلب معاودة الاتصال. يتم تحويل الوسيطات الأساسية التي لا تتضمّن سلسلة إلى سلاسل تلقائيًا.
selectedBooleanما إذا كان قد تم اختيار العنصر تلقائيًا إذا كان الإدخال المحدّد يقبل قيمة واحدة فقط (مثل أزرار الاختيار أو قائمة منسدلة)، اضبط هذا الحقل لعنصر واحد فقط.
startIconUriObjectبالنسبة إلى قوائم الاختيار المتعدد، يكون عنوان URL للرمز المعروض بجانب حقل نص العنصر. يمكن استخدام ملفات بتنسيق PNG وJPEG.
bottomTextObjectبالنسبة إلى قوائم الاختيار المتعدد، هو وصف نصي أو تصنيف يتم عرضه أسفل حقل نص العنصر.

استرجاع الكرة

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"));

المَعلمات

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

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.


setFieldName(fieldName)

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

المَعلمات

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

استرجاع الكرة

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");

المَعلمات

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

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.


setMultiSelectMinQueryLength(queryLength)

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

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");

المَعلمات

الاسمالنوعالوصف
queryLengthIntegerعدد أحرف النص.

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.


setOnChangeAction(action)

لضبط Action ليتم تنفيذه كلما تغير إدخال الاختيار.

المَعلمات

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

استرجاع الكرة

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.

المَعلمات

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

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.


setTitle(title)

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

المَعلمات

الاسمالنوعالوصف
titleStringعنوان حقل الإدخال

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.


setType(type)

لضبط نوع هذا الإدخال. وتكون الإعدادات التلقائية CHECKBOX.

المَعلمات

الاسمالنوعالوصف
typeSelectionInputTypeنوع الاختيار

استرجاع الكرة

SelectionInput: هذا الكائن، للتسلسل.