static osapi.jive.corev3.inboxEntries
Static class for getting Inbox Entries.
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.
Methods
↑
get(options)
GET /inboxRetrieves
InboxEntry[]Description
Return the specified inbox entries for the person making this request. Includes a field unread
that indicates the number of unread inbox entries. A collection of related inbox entries will count as one
unread item as in the user interface. InboxEntry's contain a jive.collection field,
which is part of a JiveExtension.
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| after | String | false | Date and time representing the minimum "last activity in a collection" to be returned. Cannot specify both after and before |
| author | String | false | URI of a person, restricting returned entries to those authored by this person |
| before | String | false | Date and time representing the maximum "last activity in a collection" to be returned. Cannot specify both after and before |
| count | Integer | false | Maximum number of activities to return (default is 25). |
| fields | String | false | Names of the fields to be returned |
| type | String | false | Returns entries of only the specified type(s) (legal values are dm,
mention, and share, default is all) |
| unread | String | false | Flag requesting return of unread entries only |