osapi.jive.corev3.activities.Stream

A custom activity stream definition for a person. See the StreamEntry class.

Example:
Example JSON

JSON with the most important data for a Stream. See the table below for a list of all fields. 

{
  "type" : "stream",
  "name" : "Personal Stream",
  "person" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "source" : "custom",
  "receiveEmails" : false,
  "published" : "2012-07-13T22:27:07.331+0000",
  "updated" : "2012-07-13T22:27:07.331+0000"
 }

Properties

PropertyTypeMode †Description
countIntegerread-only↑

The number of activities in this stream that have been added since the last time activities were retrieved with the updateLastRead flag set to true.

Availability:

Only available when retrieving one of your own streams

idStringread-only↑

Unique identifier of this custom stream.

nameStringrequired↑

Name of this custom stream. Will be a zero length string on custom streams with a source other than custom. Must be unique (per user) for streams with source custom.

newUpdatesISO 8601 Dateread-only↑

Date and time denoting the last time that activities in this stream were read (with the updateLastRead parameter set to true). Activities with a published date/time later than this are considered "new updates".

Availability:

Only available when retrieving your own streams

personPersonread-only↑

A Person describing the person that owns this custom stream.

previousUpdatesISO 8601 Dateread-only↑

Date and time denoting the previous value of the newUpdates field, reset when activities are read with the updateLastRead parameter set to true.

Availability:

Only available when retrieving your own streams

publishedISO 8601 Dateread-only↑

Date and time this custom stream was originally created.

receiveEmailsBooleanoptional↑

Flag indicating whether the owner of this custom stream wants to receive email when new activity arrives.

resourcesObjectread-only↑

Resource links (and related permissions for the requesting person) relevant to this object.

sourceStringoptional↑

Source of this particular stream. Custom streams managed via this API MUST have a stream source of custom. Other values for non-custom streams are:

  • all - the standard "Activities" stream
  • communications - the standard "Communications" stream
  • connections - the standard "Connections" stream
  • context - TODO definition
  • profile - TODO definition
  • watches - TODO definition
typeStringread-only↑

The object type of this object ("stream").

updatedISO 8601 Dateread-only↑

Date and time this custom stream configuration was most recently updated.

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

Methods

↑
createAssociations(undefined)
POST /streams/1234/associations

Retrieves

--

Description

Add associations between the specified custom stream and the list of specified Jive objects. This is an all or nothing operation; if any individual attempt to associate fails, all previously successful attempts will be rolled back.

Takes:
  • objectURIs the object URIs of the objects to be associated. Limit the number of URIs per call to 200.
↑
destroy()
DELETE /streams/1234

Retrieves

--

Description

Delete this stream.

↑
destroyAssociations()
DELETE /streams/1234/associations

Retrieves

Object

Description

Remove an association between the specified custom stream and the specified Jive object.

↑
get(options)
GET /streams/1234

Retrieves

Stream

Description

Return an updated version of this stream.

Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Stream representing the updated stream
    • ↑
    getActivity(options)
    GET /streams/1234/activities

    Retrieves

    Activity[]

    Description

    Return a paginated list of activities for the specified stream.

    Options:
    NameTypeRequiredDescription
    afterStringfalseDate and time representing the minimum 'last activity in a collection' timestamp for selecting activities. Cannot specify both after and before
    beforeStringfalseDate and time representing the maximum 'last activity in a collection' timestamp for selecting activities. Cannot specify both after and before
    countIntegerfalseMaximum number of replies to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Activity[]
    • ↑
    getAssociations(options)
    GET /streams/1234/associations

    Retrieves

    Object[]

    Description

    Return a paginated list of for Jive objects that are associated with the specified stream, and match the optionally specified filters.

    The following filter expressions are supported by this service:

    • type(xxx) - Filter by object type(s), where xxx is a comma delimited list of the object types you want returned (document, group, etc.)
    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of replies to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first reply to return (default is 0)
    typeStringfalseFilter by object type(s), Values must be separated by commas list. Example: (document, group)
    Retrieves:
  • []
    • ↑
    update(streamentity,options)
    PUT /streams/1234

    Retrieves

    Stream

    Description

    Update the information about this stream.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Stream representing the updated stream

    • Resources

    ResourceMethodReturnsDescription
    htmlGETObject↑

    Return the HTML representation of this stream.