Subscription
A SubscriptionEntity
represents a set of users or groups and a set of places to which those users should follow
in an activity stream. SubscriptionEntities are always contained within the "subscribers" attribute of a
Publication.
When subscriptions are updated, the SubscriptionEntity should include the id to avoid
unnecessarily deleting and recreating Subscription objects; however, this has no actual effect on the streams
generated from the publication definition.
Fields
Field | Type | Mode † | Description |
---|---|---|---|
associations | String[] | optional | An array of URIs for the places that this subscription references. |
id | String | read-only | Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs. |
name | String | read-only | Name of this subscription. This is automatically generated based on the names of the subscribers. |
published | ISO 8601 Date | read-only | Date and time this subscription was originally created. |
resources | Object | read-only | Resource links (and related permissions for the requesting person) relevant to this object. |
subscriberCount | Integer | read-only | Subscriber count of this subscription. This is the cardinality of the deduplicated set of all users in all subscribers for this publication. |
subscribers | String[] | optional | An array of URIs for the users and security groups that this subscription references. |
type | String | read-only | The object type of this object ("subscription"). |
updated | ISO 8601 Date | read-only | Date and time this subscription configuration was most recently updated. |