דף זה תורגם על ידי Cloud Translation API.

Class 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`	הערך של קלט הטופס שנשלח דרך הקריאה החוזרת (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 – האובייקט הזה, לשרשור.