Class SelectionInput

שדה להזנת קלט שמאפשר לבחור מבין קבוצה של אפשרויות מוגדרות מראש.

תומך באימות של שליחת טפסים רק בתפריטים של SelectionInputType.DROP_DOWN ושל SelectionInputType.MULTI_SELECT. אם הערך של Action.setAllWidgetsAreRequired(allWidgetsAreRequired) מוגדר ל-true או שהווידג'ט הזה מצוין באמצעות Action.addRequiredWidget(requiredWidget), פעולת השליחה נחסמת אלא אם נבחר ערך.

זמין לתוספים ל-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

שיטה	סוג הערך שמוחזר	תיאור קצר
`addDataSourceConfig(dataSourceConfig)`	`SelectionInput`	מגדירה את ההגדרות של מקור הנתונים עבור אמצעי הבקרה לבחירה.
`addEventAction(eventAction)`	`Widget`	מוסיף את פעולת האירוע שאפשר לבצע בווידג'ט.
`addItem(text, value, selected)`	`SelectionInput`	הוספת פריט חדש שאפשר לבחור.
`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`	`SelectionInput`	הוספת פריט חדש שאפשר לבחור בו, לתפריטים עם אפשרות לבחירה מרובה.
`setExternalDataSource(action)`	`SelectionInput`	הגדרת מקור נתונים חיצוני, כמו מסד נתונים רלציוני.
`setFieldName(fieldName)`	`SelectionInput`	מגדיר את המפתח שמזהה את קלט הבחירה הזה באובייקט האירוע שנוצר כשמתבצעת אינטראקציה עם ממשק המשתמש.
`setId(id)`	`Widget`	מגדיר את המזהה הייחודי שהוקצה לשימוש בזיהוי הווידג'ט שצריך לשנות.
`setMultiSelectMaxSelectedItems(maxSelectedItems)`	`SelectionInput`	הגדרת המספר המקסימלי של פריטים שמשתמש יכול לבחור.
`setMultiSelectMinQueryLength(queryLength)`	`SelectionInput`	מגדירים את מספר התווים שהמשתמש מזין לפני שהאפליקציה שולחת שאילתה להשלמה אוטומטית ומציגה פריטים מוצעים בכרטיס.
`setOnChangeAction(action)`	`SelectionInput`	הגדרה של `Action` לביצוע בכל פעם שמשתנה קלט הבחירה.
`setPlatformDataSource(platformDataSource)`	`SelectionInput`	הפונקציה מגדירה מקור נתונים מ-Google Workspace.
`setTitle(title)`	`SelectionInput`	הגדרת הכותרת שתוצג לפני שדה להזנת קלט.
`setType(type)`	`SelectionInput`	מגדיר את הסוג של הקלט הזה.
`setVisibility(visibility)`	`Widget`	ההגדרה הזו קובעת את רמת החשיפה של הווידג'ט.

תיעוד מפורט

`addDataSourceConfig(dataSourceConfig)`

מגדירה את ההגדרות של מקור הנתונים עבור אמצעי הבקרה לבחירה. השדה הזה מאפשר שליטה מפורטת יותר במקור הנתונים. השדה הזה הוא אופציונלי.

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setDataSourceConfig(
            CardService.newDataSourceConfig().setPlatformDataSource(
                CardService.newPlatformDataSource().setCommonDataSource(
                    CardService.CommonDataSource.USER,
                )
            )
        );

פרמטרים

שם	סוג	תיאור
`dataSourceConfig`	`DataSourceConfig`	הגדרת מקור הנתונים שתחול על קלט הבחירה.

חזרה

‫SelectionInput – האובייקט הזה, לשרשור.

`addEventAction(eventAction)`

מוסיף את פעולת האירוע שאפשר לבצע בווידג'ט.

פרמטרים

שם	סוג	תיאור
`eventAction`	`EventAction`	ה-`EventAction` שרוצים להוסיף.

חזרה

‫Widget – האובייקט, לשרשור.

`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 – האובייקט הזה, לשרשור.

`setId(id)`

מגדיר את המזהה הייחודי שהוקצה לשימוש בזיהוי הווידג'ט שצריך לשנות. שינוי של ווידג'ט נתמך רק בתוספים.

פרמטרים

שם	סוג	תיאור
`id`	`String`	המזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט [a-zA-Z0-9-]+.

חזרה

‫Widget – האובייקט הזה, לשרשור.

`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 – האובייקט הזה, לשרשור.

`setVisibility(visibility)`

ההגדרה הזו קובעת את רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.

פרמטרים

שם	סוג	תיאור
`visibility`	`Visibility`	ה`Visibility` של הווידג'ט.

חזרה

‫Widget – האובייקט, לשרשור.

Class SelectionInput קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

addDataSourceConfig(dataSourceConfig)

פרמטרים

חזרה

addEventAction(eventAction)

פרמטרים

חזרה

addItem(text, value, selected)

פרמטרים

חזרה

addMultiSelectItem(text, value, selected, startIconUri, bottomText)

פרמטרים

חזרה

setExternalDataSource(action)

פרמטרים

חזרה

setFieldName(fieldName)

פרמטרים

חזרה

setId(id)

פרמטרים

חזרה

setMultiSelectMaxSelectedItems(maxSelectedItems)

פרמטרים

חזרה

setMultiSelectMinQueryLength(queryLength)

פרמטרים

חזרה

setOnChangeAction(action)

פרמטרים

חזרה

setPlatformDataSource(platformDataSource)

פרמטרים

חזרה

setTitle(title)

פרמטרים

חזרה

setType(type)

פרמטרים

חזרה

setVisibility(visibility)

פרמטרים

חזרה

Class SelectionInput

`addDataSourceConfig(dataSourceConfig)`

`addEventAction(eventAction)`

`addItem(text, value, selected)`

`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`

`setExternalDataSource(action)`

`setFieldName(fieldName)`

`setId(id)`

`setMultiSelectMaxSelectedItems(maxSelectedItems)`

`setMultiSelectMinQueryLength(queryLength)`

`setOnChangeAction(action)`

`setPlatformDataSource(platformDataSource)`

`setTitle(title)`

`setType(type)`

`setVisibility(visibility)`