SessionProperties Methods

Solclient

previous page next page

Solclient

version: 7.2.1.27

The SessionProperties type exposes the following members.

Methods

	Name	Description
	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 attempt to free resources and perform other cleanup operations before the Object 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 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.
	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.
	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.)
	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.)
	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.
	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.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Reference

SessionProperties Class

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page