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

שיטהסוג הערך המוחזרתיאור קצר
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)

הוספת פריט חדש שאפשר לבחור.

פרמטרים

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

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

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