CitySDK iOS Library
 All Classes Functions Variables Enumerations Enumerator Properties
Instance Methods | Properties | List of all members
Parameter Class Reference

It is used to indicate what parameters should the URI have upon a HTTP request. More...

Inheritance diagram for Parameter:

Instance Methods

(id) - initWithName:andValue::
 Constructor first validates the name before actually creating the Parameter. More...
 

Properties

NSString * name
 
id value
 

Detailed Description

It is used to indicate what parameters should the URI have upon a HTTP request.

Its term should be one of the terms shown in ParameterTerms or it returns an error. Its value should be the search value.

Author
Pedro Cruz

Method Documentation

- (id) initWithName: (NSString *)  name
andValue: (id)  value
: (NSError **)  error 

Constructor first validates the name before actually creating the Parameter.

Its validation verifies if it is one of the terms found in ParameterTerms. If it is not found in the aforementioned enum, then it will set the error field.

Parameters
namethe name of the parameter
valuethe value of the parameter used for search
errorset if the parameter term is invalid

The documentation for this class was generated from the following files: