osapi.jive.corev3.activities.StreamEntry

An entry in a custom Activity Stream from a Jive application.

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.
`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.
`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 provided by the Jive App that created this entry.
`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 ("entry").
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this content object was most recently updated.
`verb`	`String`	read-only	↑ The verb provided by the Jive App that created this entry.
`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 /streamEntries/1234/comments

Retrieves

Comment

Description

Add a comment about this stream entry.

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

↑

getComments(options)
GET /streamEntries/1234/comments

Retrieves

Comment[]

Description

Return a paginated list of the comments about this stream entry.

Options:

Name	Type	Required	Description
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[]

↑

getLikes(options)
GET /streamEntries/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this stream entry.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people 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:

Person[]

↑

like()
POST /streamEntries/1234/likes

Retrieves

--

Description

Availability:

Must be authenticated, and must not have liked this stream entry already

↑

toURI()

Retrieves

String

Description

Retrieves:

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

↑

unlike()
DELETE /streamEntries/1234/likes

Retrieves

--

Description

Delete the like of this stream entry by the requesting person.

Availability:

Must be authenticated, and must have liked this stream entry already

Resources

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