InboxEntry

An InboxEntry is an activity in a person's Inbox. The jive.read field denotes whether or not this entry has been read. An example JSON representation looks like this:

Example JSON:

 {
    "published":"2012-12-28T19:12:09.586+0000",
    "title":"some document",
    "updated":"2012-12-28T19:12:08.840+0000",
    "url":"http://example.jiveon.com/docs/DOC-1001",
    "verb":"jive:created",
    "actor":{
       "id":"http://example.jiveon.com/api/core/v3/people/1",
       "displayName":"Administrator",
       "image":{
          "url":"http://example.jiveon.com/api/core/v3/people/1/avatar"
       },
       "objectType":"jive:person",
       "published":"2012-12-28T18:26:08.246+0000",
       "updated":"2013-01-09T16:31:10.028+0000",
       "url":"http://example.jiveon.com/people/admin"
    },
    "content":"<a href=\"http://example.jiveon.com/people/admin\">Administrator</a> created <a href=\"http://example.jiveon.com/docs/DOC-1001\">some document</a>",
    "jive":{
       "collection":"102-1001",
       "collectionUpdated":"2012-12-28T19:12:40.535+0000",
       "read":true,
       "replyCount":1,
       "update":"http://example.jiveon.com/api/core/v3/contents/1008/read"
    },
    "object":{
       "id":"http://example.jiveon.com/api/core/v3/contents/1008",
       "displayName":"some document",
       "objectType":"jive:document",
       "published":"2012-12-28T19:12:08.828+0000",
       "summary":"Expense report for December 2012",
       "updated":"2012-12-28T19:12:08.840+0000",
       "url":"http://example.jiveon.com/docs/DOC-1001"
    },
    "provider":{
       "displayName":"Jive",
       "objectType":"jive:instance",
       "url":"http://example.jiveon.com"
    }
 }

Examples:

Note that, although Inbox Entries look like activities, there is no direct way to create them through Activity Stream related APIs. Instead, the entries are created as a side effect of creating a Share or DirectMessage that includes the recipient, or being @mentioned in a content object.

Mark inbox entries as read or unread

To mark an inbox entry as read, perform a POST with an empty body to the jive.update field. Similarly, to mark as unread, perform a DELETE to the jive.update field. For activity that shows up under "Acclaim", the jive.collectionRead and jive.updateCollection fields will be present. To mark Acclaim as read or unread, perform a POST or DELETE to jive.updateCollection. Note that these fields are only present for activity related to acclaim, e.g. activity generated by another user liking your content with a verb field of jive:liked.

Fields

Field	Type	Mode †	Description
`actor`	`PersonActivityObject`	read-only	The person (or other object) that created this activity.
`content`	`String`	required	Text (or possibly HTML) content describing this activity.
`generator`	`ActivityObject`	read-only	The application used to generate this activity.
`icon`	`MediaLink`	optional	An icon associated with this activity.
`id`	`String`	read-only	Internal identifier for this activity.
`jive`	`JiveExtension`	optional	Jive extensions to the standard Activity Streams format.
`object`	`ActivityObject`	optional	The object that was affected by this activity.
`openSocial`	`OpenSocial`	optional	OpenSocial extensions to the standard Activity Streams format.
`previewImage`	`MediaLink`	read-only	An icon associated with this activity.
`provider`	`ActivityObject`	read-only	The service instance at which this activity was generated.
`published`	`ISO 8601 Date`	read-only	The date and time at which this activity was generated.
`target`	`ActivityObject`	optional	The object representing the "context" or "target" of this activity.
`title`	`String`	required	The title of this activity.
`type`	`String`	read-only	The object type ("activity").
`updated`	`ISO 8601 Date`	read-only	The date and time at which this activity was most recently updated.
`url`	`String`	optional	A URL pointing at more detailed information related to this activity.
`verb`	`String`	optional	The verb describing the category of activity that took place. Verbs for Jive standard actions are prefixed with `jive:` and are for internal use by Jive. Possible values include: jive:applied - used when content is shared, tagged, and for other general purpose activity jive:commented - added a comment jive:correct_answer_set - answer marked as correct answer jive:created - created something jive:helped - something marked as helpful jive:liked - something was liked jive:outcome_set - an outcome was applied jive:replied - replied to a discussion jive:voted - voted in a poll