SessionProperties Methods
Methods
| Clear |
Removes all properties.
(Inherited from BaseProperties) |
| Clone |
Creates a new object that is a deep copy of the current instance.
(Inherited from BaseProperties) |
| Equals |
Determines whether the specified Object is equal to the current Object.
(Inherited from BaseProperties) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| 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 SessionProperties.PROPERTY. value: is a string representation of the value of that property. Rules: 1. Keys that are not in the SessionProperties' property set SessionProperties.PROPERTY 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. |
| 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 SessionProperties.PROPERTY 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 SessionProperties.PROPERTY, 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. |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from BaseProperties) |
| GetPropertyValue |
Gets the property value associated with the given key.
(Inherited from BaseProperties) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RemoveProperty |
internal method to remove property from property map
(Inherited from BaseProperties) |
| 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) |
| SetPropertyValue |
Associates a property key with a property value.
(Inherited from BaseProperties) |
| SetReferencePropertyValue |
Associates a property key with a property value.
The value will not be marked for serialization.
(Inherited from BaseProperties) |
| ToDictionary |
Returns a new IDictionary instance where:
key: is a string representation of a given SessionProperties property SessionProperties.PROPERTY. 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. |
| ToDictionaryWithPrefix |
Returns a new IDictionary instance where:
key: is a string representation of a given SessionProperties property SessionProperties.PROPERTY 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. |
| ToString |
Returns a String that represents the current Object.
(Overrides Object.ToString()) |