osapi.jive.corev3.communications.Share

A Share is a way to share content or places with other users. If a content object is shared, both content and place fields will be present, describing the content object that is shared and the place that contains it. If a place is shared, only place will be present. An example JSON representation looks like this:

Examples:

The minimum JSON required to create a Share:

 {
     "content" : {
         "type" : "text/html",
         "text" : "Hey, you should join in on this discussion!"
     },
     "participants" : [
         "http://jive.somecompany.com/api/core/v3/people/2345"
     ],
     "shared" : "http://jive.somecompany.com/api/core/v3/contents/12345"
 }

Create a Share

The simplest example of creating a Share.

 //Create a simple share
 var user = ... ; //existing user object
 var doc = ...; //existing document object

 var share = {
     "content" : {
         "type" : "text/html",
         "text" : "Here's a share created with the v3 Javascript API!"
     },
     "participants" : [user.toURI()],
     "shared" : doc.toURI()
 };
 
 var request = osapi.jive.corev3.shares.create(share);
 
 request.execute(function(data) {
      console.log("Share created!", data);
 });

Properties

Property	Type	Mode †	Description
`author`	`Person`	read-only	↑ Author of this content object.
`content`	`ContentBody`	required	↑ Content of this content object.
`followerCount`	`Integer`	read-only	↑ Number of people following this object. Availability: Will be present only for object types that support being followed.
`highlightBody`	`String`	read-only	↑ Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	↑ Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	↑ Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`id`	`String`	read-only	↑ Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.
`likeCount`	`Integer`	read-only	↑ Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`parent`	`String`	required	↑ URI of the parent place (or person, for personal content) of this content object.
`parentContent`	`Summary`	read-only	↑ Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`participants`	`Person[]`	required	↑ The people with which a content object or place has been shared.
`published`	`ISO 8601 Date`	read-only	↑ Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	↑ Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`sharedContent`	`Object`	read-only	↑ The content object that was shared, if any. If a place was shared, this field will not be present.
`sharedPlace`	`Place`	read-only	↑ The place containing the content object that was shared, if a content object was shared. If a place was shared, this will be the place.
`status`	`String`	read-only	↑ Published status of this content object. `incomplete` - Content object is in draft mode `pending_approval` - Content object is waiting for approval `rejected` - Content object has been rejected for publication by an approver `published` - Content object has been published
`subject`	`String`	read-only	↑ Subject of this content object.
`tags`	`String[]`	optional	↑ Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	read-only	↑ The object type of this object ("share").
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this content object was most recently updated.
`viewCount`	`Integer`	read-only	↑ Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	read-only	↑ Flag indicating that this content object is potentially visible to external contributors.

Methods

↑

createComment(comment,options)
POST /shares/1234/comments

Retrieves

Comment

Description

Add a comment about this share.

The minimum JSON object needed to create a comment is:

     {
         "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"},
     }

Takes:

Comment describing the new comment

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Comment representing the recorded comment

↑

destroy()
DELETE /shares/1234

Retrieves

--

Description

Delete this content object and any related comments and other related information.

↑

get(options)
GET /shares/1234

Retrieves

Share

Description

Return an updated version of this share.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Share describing this content object

↑

getComments(options)
GET /shares/1234/comments

Retrieves

Comment[]

Description

Return a paginated list of the comments about this content object.

Options:

Name	Type	Required	Description
outcomeType	String	false	The type name of outcomes to filter by.
count	Integer	false	The maximum number of comments to be returned (default is 25)
anchor	String	false	optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned.
excludeReplies	Boolean	false	Flag indicating that replies to the direct comments about this direct message should be excluded (default is false)
fields	String	false	The names of the fields to be returned
hierarchical	Boolean	false	Flag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
startIndex	Integer	false	Zero-relative index of the first comment to be returned (default is zero)

Retrieves:

Comment[]

↑

markRead()
POST /shares/1234/read

Retrieves

--

Description

Mark this share as having been read.

Since: 3.2

↑

markUnread()
DELETE /shares/1234/read

Retrieves

--

Description

Mark this share as unread.

Since: 3.2

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

update(multipartbody,options)
PUT /contents/1234

Retrieves

Content

Description

Update the information about this content object.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Content representing the updated content object

Resources

Resource	Method	Returns	Description
`html`	`GET`	`Object`	↑ Return the HTML representation of this share.

osapi.jive.corev3.communications.Share

Examples:

Properties

Methods

Resources

Properties

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Methods

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Since: 3.2

Retrieves

Description

Since: 3.2

Retrieves

Description

Retrieves:

Retrieves

Description

Retrieves:

Retrieves

Description

Options:

Retrieves:

Resources