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" : "https://example.jiveon.com/servlet/JiveServlet/downloadImage/22-1001-1028/campbell_med_good.jpg",
  "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

PropertyTypeMode †Description
authorPersonread-only↑

Author of this content object.

contentContentBodyrequired↑

Content of this content object.

endDateISO 8601 Dateoptional↑

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.

followerCountIntegerread-only↑

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

highlightBodyStringread-only↑

Highlight snippet of a search match in the body or description.

Availability:

Will be present in search results only.

highlightSubjectStringread-only↑

Highlight snippet of a search match in the subject or name.

Availability:

Will be present in search results only.

highlightTagsStringread-only↑

Highlight snippet of a search match in tags.

Availability:

Will be present in search results only.

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.

imageStringoptional↑

The display URL for the image associated with this Announcement. May be null for announcements that don't have an image.

likeCountIntegerread-only↑

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

parentStringoptional↑

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.

parentContentSummaryread-only↑

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentPlaceSummaryread-only↑

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

publishDateISO 8601 Dateoptional↑

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.

publishedISO 8601 Dateread-only↑

Date and time when this content object was originally created.

replyCountIntegerread-only↑

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only↑

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

sortKeyIntegeroptional↑

An integer. When several unexpired announcements are displayed, they'll be ordered by descending sortKey.

statusStringread-only↑

Published status of this content object.

  • incomplete - Content object is in draft mode
  • pending_approval - Content object is waiting for approval
  • rejected - Content object has been rejected for publication by an approver
  • published - Content object has been published
subjectStringrequired↑

Subject of this content object.

subjectURIStringoptional↑

The URI that the subject should link to when displayed. May be null.

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

typeStringrequired↑

The object type for this object ("announcement"). This field is required when creating new content.

updatedISO 8601 Dateread-only↑

Date and time this content object was most recently updated.

viewCountIntegerread-only↑

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only↑

Flag indicating that this content object is potentially visible to external contributors.

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

Methods

↑
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:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Announcement describing this announcement
    • ↑
    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:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Announcement representing the updated announcement

    • Resources

    ResourceMethodReturnsDescription
    htmlGETObject↑

    Return the HTML representation of this content object.