PCGetPlaylistAPIParams

Version 1.9 - Updated on 05/04/2017

Superclass: PCResourceAPIParams
Declared In: PCGetPlaylistAPIParams.h

Introduction

PCGetPlaylistAPIParams stores parameters required to retrieve a playlist.

@property (nonatomic,
    assign) int count;

Discussion
Maximum items to include in a paginated response, for playlist requests. Required if start is specified.

@property (nonatomic,
    assign) int page;

Discussion
Starting point for partial responses, for playlist requests. Default is 1.

@property (nonatomic,
    copy) NSString *sort;

Discussion
Specifies sort order for a response. Syntax is :{field}+{asc|desc}. Valid values for field are:
- name
- type
- versionCreated
- size
- extension
- album
- artist
- captureDate
- compilation
- contentType
- creationDate
- favorite
- genre
- height
- modificationDate
- priority
- source
- tags
- title
- timelineDate

@property (nonatomic,
    assign) int start;

Discussion
Starting point for partial responses, for playlist requests. Default is 1.
Note: This property deprecated, please use page instead of start.

@property (nonatomic,
    copy) NSString *type;

Discussion
The type of the playlist. Can be one of the following:
- image
- music
- video
- image-video