MyChannels.Nirvana.IProperties Interface Reference

Defines an object that can be used to retrieve or store properties on a message. More...

Inheritance diagram for MyChannels.Nirvana.IProperties:
MyChannels.Nirvana.Properties

Public Member Functions

object Get (string key)
 Get the object that matches the specified key More...
 
bool GetBoolean (string key)
 Get the boolean object that matches the specified key More...
 
bool[] GetBooleanArray (string key)
 Get the boolean array that matches the specified key More...
 
byte GetByte (string key)
 Get the byte object that matches the specified key More...
 
byte[] GetByteArray (string key)
 Get the byte array that matches the specified key More...
 
char GetChar (string key)
 Get the char object that matches the specified key More...
 
char[] GetCharArray (string key)
 Get the char array that matches the specified key More...
 
double GetDouble (string key)
 Get the double object that matches the specified key More...
 
double[] GetDoubleArray (string key)
 Get the double array that matches the specified key More...
 
float GetFloat (string key)
 Get the float object that matches the specified key More...
 
float[] GetFloatArray (string key)
 Get the float array that matches the specified key More...
 
int GetInt (string key)
 Get the int object that matches the specified key More...
 
int[] GetIntArray (string key)
 Get the int array that matches the specified key More...
 
long GetLong (string key)
 Get the long object that matches the specified key More...
 
long[] GetLongArray (string key)
 Get the long array that matches the specified key More...
 
IProperties GetProperties (string key)
 Get the IProperties object that matches the specified key More...
 
IProperties[] GetPropertiesArray (string key)
 Get the IProperties array that matches the specified key More...
 
string GetString (string key)
 Get the string object that matches the specified key More...
 
string[] GetStringArray (string key)
 Get the string array that matches the specified key More...
 
void Remove (string key)
 Remove the specified key & associated value More...
 
void Set (string key, object val)
 Set the specified object in the Properties against the specific key More...
 
void Set (string key, string val)
 Set the specified string in the Properties against the specific key More...
 
void Set (string key, int val)
 Set the specified int in the Properties against the specific key More...
 
void Set (string key, long val)
 Set the specified long in the Properties against the specific key More...
 
void Set (string key, byte val)
 Set the specified byte in the Properties against the specific key More...
 
void Set (string key, bool val)
 Set the specified bool in the Properties against the specific key More...
 
void Set (string key, char val)
 Set the specified char in the Properties against the specific key More...
 
void Set (string key, IProperties val)
 Set the specified IProperties in the Properties against the specific key More...
 
void Set (string key, float val)
 Set the specified float in the Properties against the specific key More...
 
void Set (string key, double val)
 Set the specified double in the Properties against the specific key More...
 
void Set (string key, string[] val)
 Set the specified string array in the Properties against the specific key More...
 
void Set (string key, int[] val)
 Set the specified int array in the Properties against the specific key More...
 
void Set (string key, long[] val)
 Set the specified long array in the Properties against the specific key More...
 
void Set (string key, byte[] val)
 Put the specified byte array in the Properties against the specific key More...
 
void Set (string key, bool[] val)
 Put the specified bool array in the Properties against the specific key More...
 
void Set (string key, char[] val)
 Set the specified char array in the Properties against the specific key More...
 
void Set (string key, IProperties[] val)
 Set the specified IProperties array in the Properties against the specific key More...
 
void Set (string key, float[] val)
 Set the specified float array in the Properties against the specific key More...
 
void Set (string key, double[] val)
 Set the specified double array in the Properties against the specific key More...
 

Properties

bool IsReadonly [get]
 True: The message properties are read-only, False: You can store properties on this message. More...
 
IEnumerable< string > Keys [get]
 Get an enumeration of the keys More...
 
object this[string key] [get, set]
 Gets or sets the value associated with the specified key. More...
 

Detailed Description

Defines an object that can be used to retrieve or store properties on a message.

Member Function Documentation

object MyChannels.Nirvana.IProperties.Get ( string  key)

Get the object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

bool MyChannels.Nirvana.IProperties.GetBoolean ( string  key)

Get the boolean object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

bool [] MyChannels.Nirvana.IProperties.GetBooleanArray ( string  key)

Get the boolean array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

byte MyChannels.Nirvana.IProperties.GetByte ( string  key)

Get the byte object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

byte [] MyChannels.Nirvana.IProperties.GetByteArray ( string  key)

Get the byte array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

char MyChannels.Nirvana.IProperties.GetChar ( string  key)

Get the char object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

char [] MyChannels.Nirvana.IProperties.GetCharArray ( string  key)

Get the char array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

double MyChannels.Nirvana.IProperties.GetDouble ( string  key)

Get the double object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

double [] MyChannels.Nirvana.IProperties.GetDoubleArray ( string  key)

Get the double array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

float MyChannels.Nirvana.IProperties.GetFloat ( string  key)

Get the float object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

float [] MyChannels.Nirvana.IProperties.GetFloatArray ( string  key)

Get the float array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

int MyChannels.Nirvana.IProperties.GetInt ( string  key)

Get the int object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

int [] MyChannels.Nirvana.IProperties.GetIntArray ( string  key)

Get the int array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

long MyChannels.Nirvana.IProperties.GetLong ( string  key)

Get the long object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

long [] MyChannels.Nirvana.IProperties.GetLongArray ( string  key)

Get the long array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

IProperties MyChannels.Nirvana.IProperties.GetProperties ( string  key)

Get the IProperties object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

IProperties [] MyChannels.Nirvana.IProperties.GetPropertiesArray ( string  key)

Get the IProperties array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

string MyChannels.Nirvana.IProperties.GetString ( string  key)

Get the string object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

string [] MyChannels.Nirvana.IProperties.GetStringArray ( string  key)

Get the string array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Remove ( string  key)

Remove the specified key & associated value

Parameters
keyThe key to remove

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
object  val 
)

Set the specified object in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
string  val 
)

Set the specified string in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
int  val 
)

Set the specified int in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
long  val 
)

Set the specified long in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
byte  val 
)

Set the specified byte in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
bool  val 
)

Set the specified bool in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
char  val 
)

Set the specified char in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
IProperties  val 
)

Set the specified IProperties in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
float  val 
)

Set the specified float in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
double  val 
)

Set the specified double in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
string[]  val 
)

Set the specified string array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
int[]  val 
)

Set the specified int array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
long[]  val 
)

Set the specified long array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
byte[]  val 
)

Put the specified byte array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
bool[]  val 
)

Put the specified bool array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
char[]  val 
)

Set the specified char array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
IProperties[]  val 
)

Set the specified IProperties array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
float[]  val 
)

Set the specified float array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

void MyChannels.Nirvana.IProperties.Set ( string  key,
double[]  val 
)

Set the specified double array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implemented in MyChannels.Nirvana.Properties.

Property Documentation

bool MyChannels.Nirvana.IProperties.IsReadonly
get

True: The message properties are read-only, False: You can store properties on this message.

IEnumerable<string> MyChannels.Nirvana.IProperties.Keys
get

Get an enumeration of the keys

object MyChannels.Nirvana.IProperties.this[string key]
getset

Gets or sets the value associated with the specified key.

Parameters
keyThe key of the value you would like to get or set.
Returns
The value