PCContactAPIParams

Version 1.7 - Updated on 01/12/2017

Superclass: PCResourceAPIParams
Declared In: PCContactAPIParams.h

Introduction

PCContactAPIParams stores parameters required to retrieve contacts.

Methods

setQueryValue:forField:

- (void)setQueryValue:(NSString *)value forField:(NSString *)field;
  • Discussion

    Call this method to set query for contact results:

    • parameter value to be searched for in particular parts of a contact
    • parameter field on which the search is to be done

    Supports the following fields:

    • address
    • email
    • ID
    • IM
    • name
    • tel
    • field-tag.type, such as address.home
    • address.type.subfield, such as address.home.street
    • favorite, such as favorite:true and favorite:false

setSortKey:isAscending:

- (void)setSortKey:(ContactSortType)sortType isAscending:(BOOL)ascending;
  • Discussion
    Call this method to set the sort order for contact results:
    • parameter sortType - the field on which the sort is to be done
    • parameter ascending:
      • if set to true, the results are in ascending order
      • if set to false, the results are in descending order

Properties

count

@property (nonatomic,
    assign) int count; 
  • Discussion
    Maximum items to include in a paginated response. Defaulted to 200.

page

@property (nonatomic,
    assign) int page; 
  • Discussion
    Page number to return, for paginated responses. Default is 1.

query

@property (nonatomic,
    readonly) NSString *query; 
  • Discussion
    Contains the text to be searched for in a particular part of a contact. Supports following fields:
    • address
    • email
    • ID
    • IM
    • name
    • tel
    • field-tag.type, such as address.home
    • address.type.subfield, such as address.home.street
    • favorite, such as favorite:true and favorite:false

sort

@property (nonatomic,
    copy,
    readonly) NSString *sort;
  • Discussion
    Specifies sort order for the response. Syntax is :{field}+{asc|desc}. Valid values for field are:
    • created
    • favorite
    • firstname
    • ID
    • modified
    • lastname
    • version

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