osapi.jive.corev3.JiveExtension
Entity representing Jive extensions to the standard activitystrea.ms serialized JSON format. It is optionally included as a top level field in an Activity.
Properties
- answer
- canComment
- canLike
- canReply
- collection
- collectionLink
- collectionRead
- collectionUpdated
- discovery
- display
- followingInStream
- iconCss
- likeCount
- liked
- mentioned
- objectID
- objectType
- objectViewed
- onBehalfOf
- outcomeComment
- outcomeTypeName
- parent
- parentActor
- parentLikeCount
- parentLiked
- parentOnBehalfOf
- parentReplyCount
- productIcon
- productName
- question
- read
- replyCount
- resolved
- state
- update
- updateCollection
- via
Properties
Property | Type | Mode † | Description |
---|---|---|---|
answer | String | read-only | ↑ URI of the correct answer (if any), if this object is a discussion marked as a question. Availability:Only present if the Since: 3.2 |
canComment | Boolean | read-only | ↑ Flag indicating whether the requesting user can comment this object. Availability:Will be present only for object types that support comments. Since: 3.6 |
canLike | Boolean | read-only | ↑ Flag indicating whether the requesting user can like this object. Availability:Will be present only for object types that support being liked. Since: 3.6 |
canReply | Boolean | read-only | ↑ Flag indicating whether the requesting user can reply to this object. Availability:Will be present only for object types that support replies (e.g. Discussions). Since: 3.6 |
collection | String | read-only | ↑ Identifier that groups several activities around the same topic. Activities within such a collection are ordered newest to oldest by activity date. |
collectionLink | String | read-only | ↑ Date of latest activity of the identifier that groups several activities. |
collectionRead | Boolean | read-only | ↑ Boolean indicating if the Acclaim collection is read or unread. Availability:Only present if the containing activity appears in the inbox as Acclaim, e.g. an activity with a verb field of "jive:liked". Since: 3.2 |
collectionUpdated | ISO 8601 Date | read-only | ↑ Date of latest activity of the identifier that groups several activities. |
discovery | String[] | read-only | ↑ Flag indicating the types of discovery (recommended, trending, matters most) that this item is. Since: 3.8 |
display | String | optional | ↑ Value describing the grouping style to be applied to this activity stream entry. Valid values are:
|
followingInStream | Boolean | read-only | ↑ Flag indicating whether the requesting user is following the content object in the stream that was requested. Availability:Will be present only for object types that are content. Since: 3.7 |
iconCss | String | read-only | ↑ CSS Style to locate icon within sprite. |
likeCount | Integer | read-only | ↑ Number of people who have liked this object. Availability:Will be present only for object types that support being liked. Since: 3.4 |
liked | Boolean | read-only | ↑ Flag indicating whether the requesting user has liked this object. Availability:Will be present only for object types that support being liked. Since: 3.5 |
mentioned | Object | read-only | ↑ The object that was actually mentioned (typically a Person or a Place). Availability:Only present when this activity stream entry or inbox entry represents a mention
(i.e. the Since: 3.2 |
objectID | Integer | read-only | ↑ Jive Object ID Retrieves: |
objectType | Integer | read-only | ↑ Jive Object Type Retrieves: |
objectViewed | Boolean | read-only | ↑ Flag indicating that the requesting user has already viewed the top level object this activity is associated with. For example, when viewing activity around a content item, if the requesting user has seen the content item anywhere via any mechanism, true will be returned. Availability:will be present only if the requesting user has already viewed the top level grouping this activity is associated with. Since: 3.10 |
onBehalfOf | OnBehalfOf | optional | ↑ Information that is available when the message or external stream entry was posted by the author on behalf of another person. This person may be an anonymous user, an unknown user with just an email address or another user of Jive. Since: 3.4 |
outcomeComment | String | read-only | ↑ If this activity stream or inbox entry represents setting a Structured Outcome, this field contains the associated comment (if any). |
outcomeTypeName | String | read-only | ↑ If this activity stream or inbox entry represents setting a Structured Outcome, this field contains the type name of the outcome type that was set. |
parent | Object | read-only | ↑ Parent content object for this comment or message. Availability:Only present on Jive creation activities related to comments or messages. Since: 3.1 |
parentActor | Object | read-only | ↑ Actor who created the parent content object for this comment or message. Availability:Only present on Jive creation activities related to comments or messages Since: 3.3 |
parentLikeCount | Integer | read-only | ↑ Number of Only present on Jive creation activities related to comments or messages |
parentLiked | Boolean | read-only | ↑ Flag indicating whether the requesting user has liked the parent content object for this comment or message. Availability:Only present on Jive creation activities related to comments or messages Since: 3.5 |
parentOnBehalfOf | OnBehalfOf | optional | ↑ Information that is available when the message or external stream entry was posted by the author on behalf of another person. This person may be an anonymous user, an unknown user with just an email address or another user of Jive. Since: 3.4 |
parentReplyCount | Integer | read-only | ↑ Number of replies to the parent content object for this comment or message. Availability:Only present on Jive creation activities related to comments or messages Since: 3.3 |
productIcon | String | read-only | ↑ URL to the icon of the client application that created this activity. This information is only available for external stream entries. Since: 3.4 |
productName | String | read-only | ↑ Name of the client application that created this activity. This information is only available for external stream entries. Since: 3.4 |
question | Boolean | read-only | ↑ Flag indicating that this discussion is marked as a question, if Availability:Only present if the Since: 3.2 |
read | Boolean | read-only | ↑ Flag indicating the inbox entry corresponding to this activity has been read. Availability:Only present on activities that correspond to inbox entries |
replyCount | Integer | read-only | ↑ The number of comments on or replies to the Jive object represented by the "object" field of the containing activity. Availability:Only present for supported content types, e.g. direct messages, updates, blog posts, and discussions. |
resolved | String | read-only | ↑ If the Availability:Only present when the |
state | String | read-only | ↑ Flag indicating the current state of an action. Valid values are:
Availability:Only present on activities that correspond to actions, when accessed via |
update | String | read-only | ↑ URI to update the read/unread state of the content object associated with this inbox entry. If the
Availability:Only present on activities that correspond to inbox entries Since: 3.1 |
updateCollection | String | read-only | ↑ URI of the REST endpoint to mark the acclaim inbox entry as read or unread. Availability:Only present if the containing activity appears in the inbox as Acclaim, e.g. an activity with a verb field of "jive:liked". Since: 3.2 |
via | Via | optional | ↑ Information that is available when the message or external stream entry was posted via an external system. Since: 3.4 |