PreEmptive Analytics iOS API  2.0
The official iOS API for sending PreEmptive Analytics data.
PAExtendedKeys Class Reference

Class that handles extended key data used for sending additional information with messages. More...

Inheritance diagram for PAExtendedKeys:

Instance Methods

(id) - init
 Initializes PAExtendedKeys. More...
 
(void) - addKey:
 Adds the provided PAExtendedKey to the list. More...
 
(void) - addKey:string:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:decimal:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:number:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:int:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:integer:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:long:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:float:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:double:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(void) - addKey:boolean:
 Creates and adds a PAExtendedKey based on the key and value provided. More...
 
(NSUInteger) - count
 Retrieves the number of PAExtendedKeys. More...
 
(NSArray *) - allKeys
 Retrieves an array the keys used. More...
 
(NSArray *) - allExtendedKeys
 Retrieves an array the ExtendedKey objects. More...
 
(PAExtendedKey *) - getExtendedKeyForKey:
 Gets the ExtendedKey for a particular key. More...
 

Detailed Description

Class that handles extended key data used for sending additional information with messages.

Definition at line 14 of file PAExtendedKeys.h.

Method Documentation

- (void) addKey: (PAExtendedKey *)  key

Adds the provided PAExtendedKey to the list.

Parameters
keyThe extended key.
- (void) addKey: (NSString *)  key
boolean: (BOOL)  aBool 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aBoolThe value. YES = "TRUE" NO = "FALSE"
- (void) addKey: (NSString *)  key
decimal: (NSDecimalNumber *)  aDecimal 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aDecimalThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
double: (double)  aDouble 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aDoubleThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
float: (float)  aFloat 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aFloatThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
int: (int)  anInt 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
anIntThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
integer: (NSInteger)  anInt 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
anIntThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
long: (long)  aLong 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aLongThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
number: (NSNumber *)  aNumber 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aNumberThe value. (See DECIMAL_TYPE limit)
- (void) addKey: (NSString *)  key
string: (NSString *)  aString 

Creates and adds a PAExtendedKey based on the key and value provided.

Parameters
keyThe key. (Maximum size 2000)
aStringThe value. (Maximum size 4000)
- (NSArray*) allExtendedKeys

Retrieves an array the ExtendedKey objects.

Returns
An array of the ExtendedKey (PAExtendedKey*).
- (NSArray*) allKeys

Retrieves an array the keys used.

Returns
An array of the keys (NSString*).
- (NSUInteger) count

Retrieves the number of PAExtendedKeys.

Returns
The number of PAExtendedKeys.
- (PAExtendedKey*) getExtendedKeyForKey: (NSString *)  key

Gets the ExtendedKey for a particular key.

Parameters
keyThe key
Returns
The ExtendedKey for that key (or nil).
- (id) init

Initializes PAExtendedKeys.

Returns
An initialized PAExtendedKeys.

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