static osapi.jive.corev3.inboxEntries
Web service endpoints for interacting with notification inbox entries. See InboxEntry for an example of the JSON representation.
Example:
Perform a GET request to /inbox to get Inbox Entries for the requesting user.
Here is a curl example of getting 10 unread inbox entries, retrieving only the jive field:
curl -u bobby.tables:password "http://example.jiveon.com/api/core/v3/inbox?filter=unread&count=10&fields=jive"
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 |