osapi.jive.corev3.inbox.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"
    }
 }
Example:

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.

Properties

PropertyTypeMode Description
actorObjectread-only

The person (or other object) that created this activity.

contentStringrequired

Text (or possibly HTML) content describing this activity.

generatorObjectread-only

The application used to generate this activity.

iconMediaLinkoptional

An icon associated with this activity.

idStringread-only

Internal identifier for this activity.

jiveJiveExtensionoptional

Jive extensions to the standard Activity Streams format.

objectObjectoptional

The object that was affected by this activity.

openSocialOpenSocialoptional

OpenSocial extensions to the standard Activity Streams format.

previewImageMediaLinkread-only

An icon associated with this activity.

providerObjectread-only

The service instance at which this activity was generated.

publishedISO 8601 Dateread-only

The date and time at which this activity was generated.

targetObjectoptional

The object representing the "context" or "target" of this activity.

titleStringrequired

The title of this activity.

typeStringread-only
The object type ("activity").
updatedISO 8601 Dateread-only

The date and time at which this activity was most recently updated.

urlStringoptional

A URL pointing at more detailed information related to this activity.

verbStringoptional
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
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Methods

toURI()

Retrieves

String

Description

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