PCMetaDataAPIParams

Version 1.9 - Updated on 05/04/2017

Declared In: PCMetaDataAPIParams.h

Superclass: PCResourceAPIParams Declared In: PCMetaDataAPIParams.h

Contents

• PCMetaDataAPIParams
  • Introduction
  • Properties
    • count
    • filter
    • includeDeleted
    • page
    • path
    • sort
    • start

Introduction

PCMetaDataAPIParams is a PCResourceAPIParams which stores additional parameters required to retrieve metadata of any resource.

Properties

count

@property (nonatomic,
    assign) int count; 

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

filter

@property (nonatomic,
    assign) NSString *filter; 

• Discussion
  Set to file or folder, to include only those types of items in the response.

includeDeleted

@property (nonatomic,
    assign) BOOL includeDeleted; 

• Discussion
  If set to true, response includes deleted files and folders. Default is false.

page

@property (nonatomic,
    assign) int page;

• Discussion
  Starting point for partial responses for folder requests. Default is 1.

path

@property (nonatomic,
    copy) NSString *path; 

• Discussion
  Full path to the file or folder. If not set, returns the metadata of the root folder.

sort

@property (nonatomic,
    copy) NSString *sort;

• Discussion
  Specifies the sort order of the response. Valid values are:
  • name
  • type
  • versionCreated
  • size, extension
  • album
  • artist
  • captureDate
  • compilation
  • contentType
  • creationDate
  • favorite
  • genre
  • height
  • modificationDate
  • priority
  • source
  • tags
  • title
  • timelineDate

start

@property (nonatomic,
    assign) int start; 

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

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