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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
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	ערך הקלט בטופס שנשלח דרך הקריאה החוזרת (callback). ארגומנטים פרימיטיביים שאינם מחרוזות מומרים למחרוזות באופן אוטומטי.
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	ערך הקלט בטופס שנשלח דרך הקריאה החוזרת (callback). ארגומנטים פרימיטיביים שאינם מחרוזות מומרים למחרוזות באופן אוטומטי.
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 – האובייקט הזה, לצורך קישור.