static osapi.jive.corev3.search

Static class for searching objects by extended properties (ExtProps).

Methods

↑
byExtProp(options)
GET /extprops/{key}/{value}

Retrieves

Content

Description

Return a List of objects by key or value.

Options:
NameTypeRequiredDescription
keyStringtrueProperty key
valueStringtrueProperty value
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • List of objects matching property key or value. The list can contain any of following objects (Content or Person or Place)
    • ↑
    byExtPropKey(options)
    GET /extprops/{key}

    Retrieves

    Content

    Description

    Return a List of objects by key.

    Options:
    NameTypeRequiredDescription
    keyStringtrueProperty key
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • List of objects matching property key or value. The list can contain any of following objects (Content or Person or Place)
    • ↑
    requestPicker(options)

    Retrieves

    Object

    Description

    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 options excludeContent, excludePlaces, or excludePeople.

    If the user closes the picker without selecting anything, no callback will occur. An example call:

         osapi.jive.corev3.search.requestPicker({
         excludePlaces : true,
         success : function(data) {
             // "data" will be a Person object or an
             // object representing a piece of content
             // selected by the user
         }
     };
    Availability:

    Available only within a Jive App that has included the jive-core-v3 feature.

    Options:
    NameTypeRequiredDescription
    excludeContentBooleanfalseFlag indicating that the user is not allowed to select content (default is false)
    excludePlacesBooleanfalseFlag indicating that the user is not allowed to select a place (default is false)
    excludePeopleBooleanfalseFlag indicating that the user is not allowed to select a person (default is false)
    errorFunctionfalseCallback function that will be called if an error occurs. Passed data object will include a message field containing the error message.
    successFunctionfalseCallback function that will be called if the user successfully selects a person, place, or piece of content. Passed data object will be a corresponding object, including all of the instance methods