osapi.jive.corev3.contents.Slide

A Slide must be related to a particular place (Carousel). Slides show up in a widget that the place lives in.

Examples:
Example JSON

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

{
  "type" : "slide",
  "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 slide</p></body>"
  },
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator"
  }
  "targetLink" : "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",
  "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 Slide

Read createSlide() to learn how to create a new slide in a carousel.

Properties

PropertyTypeMode †Description
authorPersonread-only↑

Author of this content object.

contentContentBodyrequired↑

Content of this content object.

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.

imageStringrequired↑

The display URL for the image associated with this Slide.

likeCountIntegerread-only↑

Number of people who have liked this object.

Availability:

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

parentStringrequired↑

URI of the parent place (or person, for personal content) of this content object.

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 slide 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 published slides 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.

targetLinkStringrequired↑

The URI that the slide should link to when displayed.

typeStringrequired↑

The object type for this object ("slide"). 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

↑
createComment(comment,options)
POST /contents/1234/comments

Retrieves

Comment

Description

Add a comment about this content object.

The minimum JSON object needed to create a comment is:

     {
         "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"},
     }
Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Comment representing the recorded comment
    • ↑
    destroy()
    DELETE /slides/1234

    Retrieves

    --

    Description

    Delete this slide.

    ↑
    get(options)
    GET /slides/1234

    Retrieves

    Slide

    Description

    Return an updated version of this slide.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Slide describing this slide
    • ↑
    getComments(options)
    GET /contents/1234/comments

    Retrieves

    Comment[]

    Description

    Return a paginated list of the comments about this content object.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of comments to be returned (default is 25)
    anchorStringfalseoptional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned.
    excludeRepliesBooleanfalseFlag indicating that replies to the direct comments about this direct message should be excluded (default is false)
    fieldsStringfalseThe names of the fields to be returned
    hierarchicalBooleanfalseFlag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
    startIndexIntegerfalseZero-relative index of the first comment to be returned (default is zero)
    Retrieves:
  • Comment[]
    • ↑
    toURI()

    Retrieves

    String

    Description

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

    Retrieves

    Slide

    Description

    Update the information about this slides.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Slide representing the updated slide

    • Resources

    ResourceMethodReturnsDescription
    htmlGETObject↑

    Return the HTML representation of this content object.