static osapi.jive.corev3.shares

Static class for getting and creating Shares. A Share is a way to share content or places with other users. Creating a share with the participants[] field causes the share to appear in the inbox of each participant.

Methods

↑
create(share,options)
POST /shares

Retrieves

Share

Description

Create a new share based on the provided information. The minimum information required is as shown in the following JSON:

     {
         "content" : {
             "type" : "text/html",
             "text" : "{text}"
         },
         "participants" : [
              "{participantURI}", ...
         ],
         "shared" : "{sharedURI}"
     }

where:

  • {text} - Text of the share message.
  • {participantURI} - Absolute or partial (/people/###) URI for a Jive person.
  • {sharedURI} - Absolute or partial (/contents/###, /places/###, etc.) URI for the Jive content object or place that is being shared
Takes:
  • JSON entity containing the message text, participant URIs, and URI of the shared object
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Share representing the created share
    • ↑
    get(options)
    GET /shares/{uri}

    Retrieves

    Share

    Description

    Retrieve the specified share by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the share to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Share