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