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
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`author`	`Person`	read-only	↑ Author of this content object.
`authors`	`Summary[]`	read-only	↑ The people with which a content object or place has been shared with authoring rights. This list is a subset of participants.
`content`	`ContentBody`	required	↑ Content of this content object.
`contentImages`	`Image[]`	read-only	↑ A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	↑ A list of ContentVideo objects providing metadata about videos embedded within this content.
`favoriteCount`	`Integer`	read-only	↑ Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`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.
`iconCss`	`String`	read-only	↑ CSS Style to locate icon within sprite.
`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.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.
`lastActivityDate`	`ISO 8601 Date`	read-only	↑ Date and time when this had its last activity. Since: 3.12
`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.
`parentContentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent is visible to the viewer.
`participants`	`Person[]`	read-only	↑ The people with which a content object or place has been shared.
`places`	`Place[]`	read-only	↑ The places with which a content object or place has been shared. Since: 3.12
`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.
`searchRankings`	`Object`	read-only	↑ A map of search result scores including social signals. Availability: Will be present in search results only.
`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 `awaiting moderation` - Content object is waiting for moderation by an approver `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").
`typeCode`	`Integer`	read-only	↑
`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
`viewers`	`Summary[]`	read-only	↑ The people with which a content object or place has been shared with viewing rights. This list is a subset of participants.
`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

↑

createExtProps(uriinfo,options)
POST /contents/1234/extprops

Retrieves

ExtProps[]

Description

Creates extended properties for content.

 {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }

Availability:

Content should be editable to caller.

Options:

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

Retrieves:

ExtProps[]

↑

createOutcome(outcome,options)
POST /contents/1234/outcomes

Retrieves

Outcome

Description

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

{
  "outcomeType":
      {
          "id": 1
      }
}

Availability:

Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already

Takes:

Outcome the outcome to be created.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned.

Retrieves:

Outcome Representation of the newly created outcome

↑

deleteExtProps()
DELETE /contents/1234/extprops

Retrieves

--

Description

Deletes all extended properties for content.

Availability:

Content should be editable to caller.

↑

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

↑

getChildOutcomeTypes(options)
GET /contents/1234/childOutcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the content object's children.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

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[]

↑

getExtProps(options)
GET /contents/1234/extprops

Retrieves

ExtProps

Description

Returns extended properties for content.

Availability:

Content should be visible to caller.

Options:

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

Retrieves:

ExtProps[]

↑

getOutcomes(options)
GET /contents/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the content.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcomes to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Outcome[]

↑

getOutcomeTypes(options)
GET /contents/1234/outcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the content.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

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:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Availability:

Availability:

Methods

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Availability:

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Since: 3.2

Retrieves

Description

Since: 3.2

Retrieves

Description

Retrieves:

Retrieves