Playlists

Version 1.4 - Updated on 12/15/2016

Contents

addToPlaylist(requestObject)

Adds one or more items to a playlist.

  • Parameters:
    • requestObject — callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call
    • requestObject.add — Array of paths to be added to the playlist
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

createPlaylist(requestObject)

Creates a playlist.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.name — Name of the playlist
    • requestObject.paths — Array of paths to items
    • requestObject.type — Type of the playlist. Can be image, music, video, image, or image-video.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

deleteFromPlaylist(requestObject)

Deletes an item from a playlist.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call
    • requestObject.itemuid — ID of the item to be removed from the playlist
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Return the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

deletePlaylist(requestObject)

Deletes a playlist.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call.
    • requestObject.success — Success callback function. Return the response in the first argument.
    • requestObject.failure — Failure callback function. Return the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

getPlaylistContent(uid, itemuid)

Downloads a file stored inside a playlist.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call.
    • requestObject.itemuid — ID of the item to be downloaded.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

playlist(requestObject)

Retrieves a playlist.

  • Parameters:
    • requestObject — callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

playlistItems(requestObject)

Retrieves playlist’s contents.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

playlists(requestObject)

Retrieves user’s playlists.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

updatePlaylist(requestObject)

Updates a playlist’s metadata. In order to update a playlist’s contents, clients should use updatePlaylistDefinition.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.name — The new name of the playlist
    • requestObject.type — The new type of the playlist. Can be image, music, video, image, or image-video.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

updatePlaylistDefinition(requestObject)

Updates playlist definition and content.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.uid — ID of the playlist which is returned from a playlists call.
    • requestObject.name — New name of the playlist
    • requestObject.paths — New array of paths to place in the playlist
    • requestObject.type — New type of the playlist. Can be image, music, video, image or image-video.
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.