Documentation New Spark Media Platform Developer Documentation Portal

A collection is like an album of content. You can manipulate the lineup of the content inside the following Collections.

Collections.addFileToCollection

Adds a file to a manual collection.

If the collection is type 2 (saved search), the media does not exist, the collection does not exist or the media is already in the collection the request will fail.

If the Automatically active field is active for the collection the media will be directly set as active. If Automatically active is not set the media item will be placed in the read more »

Collections.createCollection

This method creates a collection in a vhost. Pass the application Id and the array $collectionInfo in order to create the new collection. The collection can be one of two types: Manual (type 1) or Saved Search (type 2). For the Manual collection, the $collectionInfo parameters to pass are name, type, and description. For the Saved Search collection, the $collectionInfo parameters to pass are: read more »

Collections.deleteCollection

Deletes a saved search or manual collection.

Collections.getCollectionByName

Use this method to get the id of the collection with a specific title.

Collections.getCollectionData

This method returns the collection info along with media in the collection based upon the collection ID requested. This method returns two arrays, "info" and "data". The "info" array holds the collection ID information where the "data" array holds a list of arrays for each media item in the collection. read more »

Collections.getCollectionInfo

This method returns collection information about the requested collection ID.

Collections.getCollections

This method returns a list of collections from the specified vhost returned in a array. Each array will contain the collection information.

Collections.updateCollectionInfo

Updates collection information such as title or description.

Collections.updateManualCollection

This method is used to update a manual collection. The possible uses for this would be to re-order the media in the collection, or delete media from a collection.

The newOrder argument is an array of media ID's in the collection and the new order that they should be returned to in from this point forward.

The deletedFiles argument is an array containing read more »

Collections.updateSearchCollection

This method is used to update a saved search collection.

The settings argument is an array of media ID's in the collection and the new order that they should be returned to in from this point forward.

The collection name and description can be changed with the updateCollectionInfo method.

Developer Documentation Portal

API Reference