static osapi.jive.corev3.slides
Static class for getting and creating Slides. Functions are used
in the same way as the contents static class, but the "type" field is unnecessary and
there is some additional functionality such as the ability to only get active slides.
Examples:
How to create an slide with minimal fields. You can determine the minimum required fields by reading the
table of properties for an Slide. It's not necessary to include the type
since we are using the slides static class.
//Create a minimal slide var slideJSON = { "subject": "Free pizza in the break room!", "content": { "type": "text/html", "text": "Test slide" }, "targetLink": "https://example.jiveon.com", "image": "https://example.jiveon.com/pizza.png", "parent" : "https://example.jiveon.com/api/core/v3/places/1234" }; osapi.jive.corev3.slides.create(slideJSON) .execute(function(data) { console.log("Created this slide with slides.create()!", data); });
Here is an example of getting a list of slides. To get slides inside a place, use Get slides inside a Carousel, for example.
//Get 5 active slides var request = osapi.jive.corev3.slides.get({ "count": 5, "activeOnly": true }); request.execute(function(data) { console.log("Fetched 5 slides!", data); });
Methods
create(slide,options)
POST /slidesRetrieves
SlideDescription
Create a new slide with specified characteristics, and return an entity representing the newly created slide.
Here is an example of a JSON with the minimum set of fields you must include for an slide in a place:
{ "content": { "type": "text/html", "text": "<body><p>Some interesting text</p></body>" }, "parent" : "https://example.jiveon.com/api/core/v3/places/1234", "subject": "Free beer for everyone", "targetLink": "https://example.jiveon.com", "image": "https://example.jiveon.com/image.png" }
Takes:
- Slide fields describing the new slide
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Names of the fields to be returned |