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.ExtendedKey Class Reference

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

Public Member Functions

 ExtendedKey (string key, string value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 
 ExtendedKey (string key, int value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 
 ExtendedKey (string key, long value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 
 ExtendedKey (string key, float value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 
 ExtendedKey (string key, double value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 
 ExtendedKey (string key, decimal value)
 Constructor for a new ExtendedKey that properly formats the key and value. More...
 

Properties

string Key [get, set]
 The trimmed string key. More...
 
string Value [get, set]
 The formatted value. More...
 
bool IsNumeric [get, set]
 Indicates if the server should interpret this value as a numeric value. More...
 

Detailed Description

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

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
string  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. Length is limited to 4000 characters.
PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
int  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. The provided value will be interpreted as a numeric value by the server.
PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
long  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. The provided value will be limited to 18 digits and interpreted as a numeric value by the server.
PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
float  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. 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.
PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
double  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. 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.
PreEmptive.Analytics.Common.ExtendedKey.ExtendedKey ( string  key,
decimal  value 
)

Constructor for a new ExtendedKey that properly formats the key and value.

Parameters
keyThe key to add.
valueThe value to add. 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.

Property Documentation

bool PreEmptive.Analytics.Common.ExtendedKey.IsNumeric
getset

Indicates if the server should interpret this value as a numeric value.

string PreEmptive.Analytics.Common.ExtendedKey.Key
getset

The trimmed string key.

string PreEmptive.Analytics.Common.ExtendedKey.Value
getset

The formatted value.


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