PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
PreEmptive.Analytics.Common.ExtendedKeys Class Reference

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

Public Member Functions

 ExtendedKeys ()
 Constructor for ExtendedKeys. More...
 
void Add (string key, string value)
 Adds a new ExtendedKey with the provided key and value. More...
 
void Add (string key, int value)
 Adds a new ExtendedKey with the provided key and value. More...
 
void Add (string key, long value)
 Adds a new ExtendedKey with the provided key and value. More...
 
void Add (string key, float value)
 Adds a new ExtendedKey with the provided key and value. More...
 
void Add (string key, double value)
 Adds a new ExtendedKey with the provided key and value. More...
 
void Add (string key, decimal value)
 Adds a new ExtendedKey with the provided key and value. More...
 
List< ExtendedKeyTagToTags ()
 Converts the Extended Keys into ExtendedKeyTags More...
 

Properties

IDictionary< string, ExtendedKeyMap [get, set]
 IDictionary that contains all of the extended keys that have been added keyed by the ExtendedKey's key. More...
 

Detailed Description

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

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.ExtendedKeys.ExtendedKeys ( )

Constructor for ExtendedKeys.

Member Function Documentation

void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
string  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. Length is limited to 4000 characters.
void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
int  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. The provided value will be interpreted as a numeric value by the server.
void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
long  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. The provided value will be limited to 18 digits and interpreted as a numeric value by the server.
void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
float  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. The provided value will be limited to 18 digits and 5 decimal places as well as being interpreted as a numeric value by the server.
void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
double  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. The provided value will be limited to 18 digits and 5 decimal places as well as being interpreted as a numeric value by the server.
void PreEmptive.Analytics.Common.ExtendedKeys.Add ( string  key,
decimal  value 
)

Adds a new ExtendedKey with the provided key and value.

Parameters
keyThe key to use. Excessive whitespace will be removed and length is limited to 2000 characters.
valueThe value to use. The provided value will be limited to 18 digits and 5 decimal places as well as being interpreted as a numeric value by the server.
List<ExtendedKeyTag> PreEmptive.Analytics.Common.ExtendedKeys.ToTags ( )

Converts the Extended Keys into ExtendedKeyTags

Returns
The list of extended key tags

Property Documentation

IDictionary<string, ExtendedKey> PreEmptive.Analytics.Common.ExtendedKeys.Map
getset

IDictionary that contains all of the extended keys that have been added keyed by the ExtendedKey's key.


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