osapi.jive.corev3.extstreams.ExternalStreamInstance

An External Stream Instance represents a configured External Stream Definition that has been attached to a Purposeful Place. It also contains configuration information returned by the configuration UI.

 {
    "id":"1032",
    "displayName":"External Stream",
    "config": {
        "configProp1":"abcd",
        "configProp2":"1234"
    },
    "definition":{
        //External stream definition JSON
       "type":"extStreamDefinition"
    },
    "parent":"http://example.jiveon.com/api/core/v3/places/1037",
    "state":"STAGED",
    "type":"externalStreamInstance",
    "published":"2013-01-25T20:03:08.702+0000",
    "updated":"2013-01-25T20:03:08.702+0000",
    "resources":{
       "self":{
          "allowed":[
             "POST",
             "GET"
          ],
          "ref":"http://example.jiveon.com/api/core/v3/extstreams/1032"
       }
    }
 }

Properties

Property	Type	Mode †	Description
`column`	`Integer`	optional	↑ The column in which this instance is going to appear in the parent.
`config`	`Object`	optional	↑ Configuration of this instance in JSON format. JSON format depends on the needs of each instance. When creating or updating this instance, it is possible to include an extra field forceResendRegistration of type boolean that indicates whether a registration notification should be sent to the external system or not.
`definition`	`ExternalStreamDefinition`	required	↑ The definition type this External Stream Instance belongs to.
`displayName`	`String`	optional	↑ Display name of the External Stream Instance
`externalId`	`String`	optional	↑ An external identifier assigned to this instance. This identifier can be used to access this instance instead of it's id.
`followerCount`	`Integer`	read-only	↑ Number of people following this object. Availability: Will be present only for object types that support being followed.
`id`	`String`	read-only	↑ Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`lastActivityPost`	`ISO 8601 Date`	read-only	↑ Date and time of the last time activity was created for this External Stream Instance. Since: 3.11
`lastRegister`	`ISO 8601 Date`	read-only	↑ Date and time of the last time a registered notification was sent to the external system that is integrating with Jive.
`likeCount`	`Integer`	read-only	↑ Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`parent`	`String`	read-only	↑ URI of the parent place of this instance.
`published`	`ISO 8601 Date`	read-only	↑ Date and time this object was originally created.
`publishError`	`Object`	read-only	↑ Information about the error that happened while publishing data or activity into this tile. If no error happened in the last publish activity then this field is not going to be present. Availability: Will be present only for community admins. Since: 3.11
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`state`	`String`	optional	↑ State of this instance. Possible values are: STAGED - Not configured yet. Default value. VISIBLE - Configured and ready to be used
`status`	`Object`	read-only	↑ Status of this instance when activity was published in JSON format.
`tags`	`String[]`	optional	↑ Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	read-only	↑
`typeCode`	`Integer`	read-only	↑
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this object was most recently updated.

Methods

↑

getPrivateProps()
GET /exstreams/1234/privateprops

Retrieves

Object

Description

Retrieves private properties for this TileInstance

↑

updatePrivateProps(object)
POST /tiles/1234/privateprops

Retrieves

Object

Description

Updates private properties for this TileInstance

Resources

Resource	Method	Returns	Description
`self`	`GET`	`ExternalStreamInstance`	↑ Return an updated version of this external stream instance.

osapi.jive.corev3.extstreams.ExternalStreamInstance

Properties

Methods

Resources

Properties

Availability:

Availability:

Since: 3.11

Availability:

Availability:

Since: 3.11

Availability:

Methods

Retrieves

Description

Retrieves

Description

Resources