OSAPI Jive Core V3 Picker Reference

Version 4

     

    Required Modules

    When using any of the Jive picker interfaces, you will need to require the the jive-core-v3 feature in your app.xml, such as:

    <ModulePrefs title="Your App Name"

                   description="Your App Description"

                   author="Your Name"

                   author_affiliation="Your Company"

                   author_email="your.name@yourcompany.com">

        <Require feature="jive-core-v3" />

        ....

     


     

    OSAPI Jive V3 - People Picker

     

    The Jive People Picker API allows an app to invoke a people / user picker dialog box and get the results. This gives convenient access via JavaScript to the standard Jive UI control for choosing people.

     

    How It Works

     

    osapi.jive.corev3.people.requestPicker({ 
             success: function(data) { console.log('success: '+JSON.stringify(data)); },
             error: function(data) { console.log('error: '+JSON.stringify(data)); },
             multiple: true
    });
    
    

     

    This picker accepts the following arguments:

    • success (optional) - a callback function to be called once user(s) have been selected from the picker
    • error (optional) - an error callback function to in the event an error has occurred selecting a user
    • multiple (optional) - true/false - if multiple users will be selected (default: false)

     

    Note:  If a user cancels the dialog without picking a user, no callback will be called.

     

    Screenshots

    Single User Selection

    osapi-jivev3-people-picker-single.png

    Multiple User Selection

    osapi-jivev3-people-picker-multiple.png

     

    Reference

     


     

    OSAPI Jive V3 - Place Picker

     

    Request the Jive container to prompt the user to select a place. When the user has done so, the success callback will be called, passing in the place object representing the selected place.

     

    How It Works

     

    osapi.jive.corev3.places.requestPicker({
             type : "space",
             success : function(data) {
                 // "data" will be the Space object (in this case) selected by the user
             }
         });
    
    

     

    This picker accepts the following arguments:

    • success (optional) - a callback function to be called once user(s) have been selected from the picker
    • error (optional) - an error callback function to in the event an error has occurred selecting a user
    • type (optional) - String - Place type value of blog, group, project or space(default: group)

     

    Note:  If a user cancels the dialog without picking a place, no callback will be called.

     

    Screenshots

    Coming soon

     

    Reference

     


     

    OSAPI Jive V3 - Search Content Picker

     

    Request the Jive container to prompt the user to select a single person, place, or piece of content. When the user has done so the success callback will be called, passing in an object representing the selected person, place or piece of content.

     

    The selection can be limited to just one or two of those categories by providing the optional parameters: excludeContent, excludePlaces, or excludePeople.

     

    If the user closes the picker without selecting anything, no callback will occur.

     

    How It Works

     

       osapi.jive.corev3.search.requestPicker({
             excludeContent : true,
             excludePlaces : false,
             excludePeople : false,
             success: function(data) { console.log('success: '+JSON.stringify(data)); },
             error: function(data) { console.log('error: '+JSON.stringify(data)); }
       });
    
    

     

    This picker accepts the following arguments:

    • success (optional) - a callback function to be called once user(s) have been selected from the picker
    • error (optional) - an error callback function to in the event an error has occurred selecting a user
    • excludeContent (optional) - true/false - Tells picker to omit content results (default: false)
    • excludePlaces (optional) - true/false - Tells picker to omit place results (default: false)
    • excludePeople (optional) - true/false - Tells picker to omit people results (default: false)

     

    Note:  If a user cancels the dialog without picking content, no callback will be called.

     

    Screenshots

    Coming soon

     

    Reference