PCSearchAPIParams

Version 1.6 - Updated on 11/17/2016

Superclass: PCResourceAPIParams
Declared In: PCSearchAPIParams.h

Contents

• PCSearchAPIParams
  • Introduction
  • Methods
    • setSortKey:isAscending:
  • Properties
    • count
    • page
    • query
    • sort
    • start

Introduction

PCSearchAPIParams stores parameters required to search for files or folders and performs parameter validation.

Methods

setSortKey:isAscending:

- (void)setSortKey:(NSString *)sortKey isAscending:(BOOL)ascending;

• Discussion
  Call this method to set the sort order for search results. Set the parameter sortKey to the field on which sort is to be done. If the parameter ascending is set to true, the results are displayed in the ascending order. Otherwise, if the parameter ascending is set to false, the results are displayed in the descending order.

Properties

count

@property (nonatomic, assign) int count;

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

page

@property (nonatomic, assign) int page;

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

query

@property (nonatomic, copy) NSString *query;

• Discussion
  Contains the text to be searched and supports a number of query fields that allow clients to restrict the search to particular parts of a file’s or folder’s metadata. The query parameter is based on Lucene search query syntax which takes the following format: query=field:value AND field:value AND field:value. Required. Search can be done on the following fields:
  • author
  • commentCount
  • contentChecksum
  • contentType
  • extension
  • file(Set to true to search for files only and to false to search for folders only)
  • name
  • path
  • size
  • tags
  • versionCreated

sort

@property (nonatomic, copy, readonly) NSString *sort;

• Discussion
  Specifies sort order of the 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

start

@property (nonatomic, assign) int start;

• Discussion
  Starting point for partial responses, for search 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.