osapi.jive.corev3.activities.Publication

A PublicationEntity represents a Publication definition within Jive. Publications are processed to generate activity streams that are "forced" upon users ("subscription streams"). A Publication contains Subscriptions, which are definitions consisting of a set of subscribers (user groups or individual users) and a set of associations (places such as spaces, social groups, blogs, or projects). Exactly one activity stream is generated for each user defined as a subscriber. This activity stream consists of all of the places for which a user is defined in the subscriber set for that subscription. Publications must have unique names. Publication names follow the same length restriction as a custom activity stream. By default, the system is limited to only allow 10 Publications and 100 Subscriptions within each publication.

Properties

PropertyTypeMode Description
authorPersonread-only

A Person describing the person that created this publication. During create, this will be set automatically to the authenticated user.

displayOrderIntegeroptional

The index of the total ordering in which an activity stream generated from this publication should be displayed. If this is not specified in a call to create a publication, it will default to the last position. If this is not specified in a call to update a publication, the value will not be modified.

idStringread-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.

isBeingProcessedBooleanread-only

The status of the processing of this publication into activity streams. After saving a publication, it may take several minutes to process all of the publications to create activity streams. During this time, any update of the publication will be rejected by the service.

isReceiveEmailsBooleanread-only

Defines if the streams generated from this publication should force users to receive emails.

nameStringrequired

Name of this publication. Must be unique among all publications.

publishedISO 8601 Dateread-only

Date and time this publication was originally created.

resourcesObjectread-only

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

subscribersTypeStringread-only

If this publication contains a subscription including Everyone or Registered Users. This is simply a top-level flag as to the status of the underlying subscriptions, so modifying this value in update operations will not set the publication to be visible to Everyone or Registered Users groups

subscriptionsSubscription[]optional

A Subscription list describing the subscriptions that are in this publication.

typeStringread-only

The object type of this object.

typeCodeIntegerread-only
updatedISO 8601 Dateread-only

Date and time this publication 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

destroy()
DELETE /publications/1234

Retrieves

--

Description

Delete this publication.

Availability:

Available to Jive admins only

get(options)
GET /publications/1234

Retrieves

Publication

Description

Return an updated version of this publication.

Availability:

Available to Jive admins only

Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Publication representing the updated publication
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(options)
    PUT /publications/1234

    Retrieves

    Publication

    Description

    Update the information about this publication.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Publication representing the updated publication