osapi.jive.corev3.contents.Announcement

An Announcement can be either a system announcement (visible to everyone) or related to a particular place. Announcements show up in a user's Inbox and on the right sidebar for system announcements.

Examples:

Example JSON

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

{
  "type" : "announcement",
  "status" : "published",
  "subject" : "Can fracking pollute water? Study tries to answer - Yahoo! News",
  "parent" : "https://example.jiveon.com/api/core/v3/places/1001",
  "content" : {
    "type" : "text/html",
    "text" : "<body><p>This is an important announcement</p></body>"
  },
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator"
  }
  "subjectURI" : "http://news.yahoo.com/fracking-pollute-water-study-tries-answer-174343650.html",
  "image" : "http://example.jiveon.com/api/core/v3/images/4512462",
  "endDate" : "2012-07-19T06:59:59.000+0000",
  "publishDate" : "2012-07-11T23:06:35.700+0000",
  "published" : "2012-07-11T23:06:35.696+0000",
  "updated" : "2012-07-11T23:06:35.714+0000"
 }

Create System Announcement

Read create() to learn how to create a new system announcement.

Create Announcement

Read createAnnouncement() to learn how to create a new announcement in a space. Each place has a similar function for creating announcements.

Properties

Property	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`author`	`Person`	read-only	↑ Author of this content object.
`content`	`ContentBody`	required	↑ Content of this content object.
`contentImages`	`Image[]`	read-only	↑ A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	↑ A list of ContentVideo objects providing metadata about videos embedded within this content.
`endDate`	`ISO 8601 Date`	optional	↑ The date and time after which this announcement should no longer be displayed. If no end date is specified during creation then it will default to a week since publish date.
`favoriteCount`	`Integer`	read-only	↑ Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`followerCount`	`Integer`	read-only	↑ Number of people following this object. Availability: Will be present only for object types that support being followed.
`highlightBody`	`String`	read-only	↑ Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	↑ Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	↑ Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`iconCss`	`String`	read-only	↑ CSS Style to locate icon within sprite.
`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.
`image`	`String`	optional	↑ The display URL for the image associated with this Announcement. May be null for announcements that don't have an image.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.
`lastActivityDate`	`ISO 8601 Date`	read-only	↑ Date and time when this had its last activity. Since: 3.12
`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`	optional	↑ URI of the parent place (or person, for personal content) of this content object. If no parent is specified then the root space will be used as the parent.
`parentContent`	`Summary`	read-only	↑ Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentContentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent is visible to the viewer.
`publishDate`	`ISO 8601 Date`	optional	↑ The date and time after which the announcement should start being displayed. If no publish date is specified during creation then it will default to now.
`published`	`ISO 8601 Date`	read-only	↑ Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	↑ Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`searchRankings`	`Object`	read-only	↑ A map of search result scores including social signals. Availability: Will be present in search results only.
`sortKey`	`Integer`	optional	↑ An integer. When several unexpired announcements are displayed, they'll be ordered by descending sortKey.
`status`	`String`	read-only	↑ Published status of this content object. `incomplete` - Content object is in draft mode `awaiting moderation` - Content object is waiting for moderation by an approver `rejected` - Content object has been rejected for publication by an approver `published` - Content object has been published
`subject`	`String`	required	↑ Subject of this content object.
`subjectURI`	`String`	optional	↑ The URI that the subject should link to when displayed. May be null.
`subjectURITargetType`	`String`	read-only	↑ The entity type that the subjectURI property links to. Null if the link target is external, unknown to the CoreObjectTypeProvider, or if subjectURI is null. This property is read-only.
`type`	`String`	required	↑ The object type for this object ("announcement"). This field is required when creating new content.
`typeCode`	`Integer`	read-only	↑
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this content object was most recently updated.
`viewCount`	`Integer`	read-only	↑ Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	read-only	↑ Flag indicating that this content object is potentially visible to external contributors.

Methods

↑

createExtProps(uriinfo,options)
POST /contents/1234/extprops

Retrieves

ExtProps[]

Description

Creates extended properties for content.

 {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }

Availability:

Content should be editable to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

createOutcome(outcome,options)
POST /contents/1234/outcomes

Retrieves

Outcome

Description

Here is an example of a JSON with the minimum set of fields you must include:

{
  "outcomeType":
      {
          "id": 1
      }
}

Availability:

Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already

Takes:

Outcome the outcome to be created.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned.

Retrieves:

Outcome Representation of the newly created outcome

↑

deleteExtProps()
DELETE /contents/1234/extprops

Retrieves

--

Description

Deletes all extended properties for content.

Availability:

Content should be editable to caller.

↑

destroy()
DELETE /announcements/1234

Retrieves

--

Description

Delete this announcement.

↑

get(options)
GET /announcements/1234

Retrieves

Announcement

Description

Return an updated version of this announcement.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Announcement describing this announcement

↑

getChildOutcomeTypes(options)
GET /contents/1234/childOutcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the content object's children.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

getExtProps(options)
GET /contents/1234/extprops

Retrieves

ExtProps

Description

Returns extended properties for content.

Availability:

Content should be visible to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

getOutcomes(options)
GET /contents/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the content.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcomes to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Outcome[]

↑

getOutcomeTypes(options)
GET /contents/1234/outcomeTypes

Retrieves

OutcomeType[]

Description

Return a paginated list of possible outcomes types on the content.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

markRead()
POST /announcements/1234/read

Retrieves

--

Description

Mark this announcement as having been read.

Since: 3.2

↑

markUnread()
DELETE /announcements/1234/read

Retrieves

--

Description

Mark this announcement as having not been read.

Since: 3.2

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

update(options)
PUT /announcements/1234

Retrieves

Announcement

Description

Update the information about this announcement.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Announcement representing the updated announcement

Resources

Resource	Method	Returns	Description
`html`	`GET`	`Object`	↑ Return the HTML representation of this content object.

osapi.jive.corev3.contents.Announcement

Examples:

Example JSON

Create System Announcement

Create Announcement

Properties

Methods

Resources

Properties

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Methods

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Availability:

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Since: 3.2

Retrieves

Description

Since: 3.2

Retrieves

Description

Retrieves:

Retrieves

Description

Options:

Retrieves:

Resources