SessionProperties Methods

Solclient

SessionProperties Methods
version: 7.2.1.27

The SessionProperties type exposes the following members.

Methods
  Name Description
Public method Clear
Removes all properties.
(Inherited from BaseProperties.)
Public method Clone
Creates a new object that is a deep copy of the current instance.
(Inherited from BaseProperties.)
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from BaseProperties.)
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method Static member FromDictionary
Creates and returns a new SessionProperties given a dictionary of key/value strings

where:

key: is a string representation of a given SessionProperties property SessionPropertiesPROPERTY.

value: is a string representation of the value of that property.

Rules:

1. Keys that are not in the SessionProperties' property set SessionPropertiesPROPERTY are ignored and a warning log is generated.

2. If a property is omitted, the default value is used.

3. Validation and type checking is performed on the provided values; a conversion exception is thrown if any of the provided values cannot be converted.

4. Read-only properties are ignored.

Public method Static member FromDictionaryWithPrefix
Creates and returns a new SessionProperties from a dictionary of key/value strings

where:

key: is a string representation of a given SessionProperties property SessionPropertiesPROPERTY prefixed with a string "prefix".

value: is a string representation of the value of that property.

Rules:

1. Keys that are not in the SessionProperties' property set SessionPropertiesPROPERTY, are ignored and a warning log is generated.

2. If a property is omitted, the default value will be used.

3. Validation and type checking will be performed on the provided values, a conversion exception will be thrown if any of the provided values cannot be converted.

4. Read-only properties are ignored.

Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from BaseProperties.)
Protected method GetPropertyValue
Gets the property value associated with the given key.
(Inherited from BaseProperties.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method SetCCSMPProperty
Sets a property to be passed directly to CCSMP. Properties set in this manner will always override properties set using the shortcut properties, regardless of order.
(Inherited from BaseProperties.)
Protected method SetPropertyValue
Associates a property key with a property value.
(Inherited from BaseProperties.)
Public method ToDictionary
Returns a new IDictionary instance where:

key: is a string representation of a given SessionProperties property SessionPropertiesPROPERTY.

value: is a string representation of the value of that property, or null if the property's value is null.

Note that only readable and writable properties are returned in the dictionary. Read-only properties are ignored.
Public method ToDictionaryWithPrefix
Returns a new IDictionary instance where:

key: is a string representation of a given SessionProperties property SessionPropertiesPROPERTY prefixed with a string "prefix".

value: is a string representation of the value of that property, or null if the property's value is null.

Note that only readable and writable properties are returned in the dictionary. Read-only properties are ignored.
Public method ToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
See Also