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

PropertyTypeMode †Description
answerStringread-only↑

URI of the correct answer (if any), if this object is a discussion marked as a question.

Availability:

Only present if the object field contains a discussion marked as a question, with a message marked as the correct answer

Since: 3.2
canCommentBooleanread-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
canLikeBooleanread-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
canReplyBooleanread-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
collectionStringread-only↑

Identifier that groups several activities around the same topic. Activities within such a collection are ordered newest to oldest by activity date.

collectionLinkStringread-only↑

Date of latest activity of the identifier that groups several activities.

collectionReadBooleanread-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
collectionUpdatedISO 8601 Dateread-only↑

Date of latest activity of the identifier that groups several activities.

discoveryString[]read-only↑

Flag indicating the types of discovery (recommended, trending, matters most) that this item is.

Since: 3.8
displayStringoptional↑

Value describing the grouping style to be applied to this activity stream entry. Valid values are:

  • update - Each activity is presented as a separate update (default value)
  • grouped - Activities are grouped by common generator (i.e. which app created this) and verb
  • digest - Specialized format (Jive internal use only)
followingInStreamBooleanread-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
iconCssStringread-only↑

CSS Style to locate icon within sprite.

likeCountIntegerread-only↑

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

Since: 3.4
likedBooleanread-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
mentionedObjectread-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 verb field contains "jive.mentioned").

Since: 3.2
objectIDIntegerread-only↑
Jive Object ID
Retrieves:
  • Jive Object ID
  • objectTypeIntegerread-only↑
    Jive Object Type
    Retrieves:
  • Jive Object Type
  • objectViewedBooleanread-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
    onBehalfOfOnBehalfOfoptional↑

    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
    outcomeCommentStringread-only↑

    If this activity stream or inbox entry represents setting a Structured Outcome, this field contains the associated comment (if any).

    outcomeTypeNameStringread-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.

    parentObjectread-only↑

    Parent content object for this comment or message.

    Availability:

    Only present on Jive creation activities related to comments or messages.

    Since: 3.1
    parentActorObjectread-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
    parentLikeCountIntegerread-only↑

    Number of

    Availability:

    Only present on Jive creation activities related to comments or messages

    Since: 3.3
    parentLikedBooleanread-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
    parentOnBehalfOfOnBehalfOfoptional↑

    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
    parentReplyCountIntegerread-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
    productIconStringread-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
    productNameStringread-only↑

    Name of the client application that created this activity. This information is only available for external stream entries.

    Since: 3.4
    questionBooleanread-only↑

    Flag indicating that this discussion is marked as a question, if object is a discussion.

    Availability:

    Only present if the object field contains a discussion.

    Since: 3.2
    readBooleanread-only↑

    Flag indicating the inbox entry corresponding to this activity has been read.

    Availability:

    Only present on activities that correspond to inbox entries

    replyCountIntegerread-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.

    resolvedStringread-only↑

    If the object field contains a discussion marked as a question, this field will contain the resolution state ("open", "resolved", or "assumed_resolved").

    Availability:

    Only present when the object field contains a discussion marked as a question

    stateStringread-only↑

    Flag indicating the current state of an action. Valid values are:

    • awaiting_action
    • accepted
    • rejected
    • ignored
    • hidden
    Availability:

    Only present on activities that correspond to actions, when accessed via GET /actions (REST) or osapi.jive.corev3.actions.get() (JavaScript)

    updateStringread-only↑

    URI to update the read/unread state of the content object associated with this inbox entry. If the read field value is true, send a DELETE to this URI to mark it as unread. If the read field value is false, send a POST to this URI to mark it as read.

    Availability:

    Only present on activities that correspond to inbox entries

    Since: 3.1
    updateCollectionStringread-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
    viaViaoptional↑

    Information that is available when the message or external stream entry was posted via an external system.

    Since: 3.4
    †
    → Fields used by update and create operations
    → Fields used only by create operations
    → Fields not used by update or create operations