PCGetTrashAPIParams

Version 1.9 - Updated on 05/04/2017

Superclass: PCResourceAPIParams
Declared In: PCGetTrashAPIParams.h

Contents

• PCGetTrashAPIParams
  • Introduction
  • Properties
    • count
    • deep
    • filter
    • page
    • sort
    • start

Introduction

PCGetTrashAPIParams stores parameters required to retrieve a list of files and folders that have been deleted from user’s Personal Cloud Storage account.

Properties

count

@property (nonatomic,
    assign) int count; 

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

deep

@property (nonatomic,
    copy) NSString *deep; 

• Discussion
  Specifies whether the search should stop at the topmost deleted item in the tree (deep=false), or list all the deleted contents (deep=true).

filter

@property (nonatomic,
    assign) NSString *filter; 

• Discussion
  
• If set to file, includes only files in the response.
• If set to folder, includes only folders in the response.

page

@property (nonatomic,
    assign) int page; 

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

sort

@property (nonatomic,
    copy) NSString *sort; 

• Discussion
  Controls the sort order in which the response is returned. Uses the syntax: sort={field}+(asc|desc).

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.