static osapi.jive.corev3.favorites

Static class for getting and creating Favorites. Favorites correspond to creating Bookmarks in the "Create" menu in the Jive UI. They are bookmarks of external URLs.

Methods

↑
create(favorite,options)
POST /contents

Retrieves

Favorite

Description

Create a new favorite with specified characteristics, and return an entity representing the newly created favorite. A favorite is an external URL saved as a bookmark.

Here is an example of a JSON with the minimum set of fields you must include: 

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text</p></body>"
      },
  "favoriteObject" : {
    "type" : "url",
    "url" : "http://news.yahoo.com/scientists-anti-alzheimers-gene-mutation-151901443.html"
  },
  "subject" : "Scientists find anti-Alzheimer's gene mutation - Yahoo! News",
  "type" : "favorite"
 }

Takes:
  • Favorite fields describing the new favorite
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Favorite describing the newly created favorite
    • ↑
    get(options)
    GET /contents

    Retrieves

    Content[]

    Description

    Return a paginated list of favorite that match the specified criteria.

    Options:
    NameTypeRequiredDescription
    authorStringfalseURI of a person, limiting results to objects authored by this person
    countIntegerfalseMaximum number of objects to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    searchStringfalseOne or more search terms separated by commas, limiting results to objects that match the terms
    startIndexIntegerfalseZero-relative index of the first content object to be returned
    tagStringfalseComma delimited list of tag values, limiting results to objects with one of those tags
    Retrieves:
  • Favorite[] Paginated list of matching favorites
    • ↑
    get(options)
    GET /contents/{uri}

    Retrieves

    Content

    Description

    Return a single favorite by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the favorite to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Favorite Representation of the requested favorite
    • ↑
    getEditable(options)
    GET /contents/{uri}/editable

    Retrieves

    Content

    Description