OnionSession

Generates a connection to the onion.net Information Server and is the implementation of the interface IOnionSession.

A connection to the onion.net Information Server is made with this class. The data of the onion.net instance can be accessed via the properties and functions.

Constructors

ConstructorDescription
OnionSession()

Initialises a new instance of the OnionSession class.

OnionSession(IFunctionCache)

Initialises a new instance of the OnionSession class.

OnionSession(IXmlServer, ISession)

Initialises a new instance of the OnionSession class.

OnionSession(IXmlServer, ISession, IFunctionCache)

Initialises a new instance of the OnionSession class.

OnionSession(IXmlServer, ISession, IFunctionCache, IReconnectionHelper)

Initialises a new instance of the OnionSession class.

OnionSession(IXmlServer, ISession, StatisticOptions)

Initialises a new instance of the OnionSession class.

OnionSession(IXmlServer, String, String)

Initialisiert eine neue Instanz der OnionSession-Klasse.

OnionSession(IXmlServer, String, String, StatisticOptions)

Initialises a new instance of the OnionSession class.

OnionSession(Uri, String, String)

Initialises a new instance of the OnionSession class.

OnionSession(Uri, String, String, StatisticOptions)

Initialises a new instance of the OnionSession class.

OnionSession(String, String, String)

Initialises a new instance of the OnionSession class.

OnionSession(String, String, String, IFunctionCache)

Initialises a new instance of the OnionSession class.

OnionSession(String, String, String, StatisticOptions)

Initialises a new instance of the OnionSession class.

OnionSession(String, String)

Initialises a new instance of the OnionSession class.

Events

EventDescription
SessionCorrupt(EventHandler)

Is generated if the connection to the onion.net Information Server is damaged.

SessionInterrupted(EventHandler)

Is generated if the connection to the onion.net Information Server has been interrupted.

SessionRestored(EventHandler)

Is generated if an interrupted connection to the onion.net Information Server was successfully restored.

StateChanged(EventHandler)

Is generated if the status of the connection to the onion.net Information Server has changed.

Properties

PropertyDescription
Cache:IFunctionCache

Supplies a cache for the current session.

Events:IEventHub

Supplies an interface for processing events generated by modifications to data in onion.net.

IsInterrupted:Boolean

Checks whether the current connection to the onion.net Information Server is interrupted.

Repository:IDataRepository

Gets an instance for calling and editing data objects and ChangeSets in the data repository.

Schemata:ISchemaRepository

Supplies an interface for calling and administrating schemas.

Self:IUser

Supplies an instance of the user who logged into the session.

UserManagement:IUserRepository

Supplies an interface for calling and administrating the users and groups in onion.net.

Methods

MethodDescription
AuthenticateCredentials(String, String):IUser

Checks whether the indicated access data is correct.

AuthenticateCredentials(String, String, UserRoles):IUser

Checks whether the indicated access data is correct and the user has the indicated user roles.

Clone():IOnionSession

generates a new session (subsession), based on the current session.

CreateSubSession(String, String):IOnionSession

Creates a new session with the indicated access data

CreateSubSession(String, String, UserRoles):IOnionSession

Creates a new session with the indicated access data.

Dispose():Void

Terminates the session with the onion.net Information Server.

DumpServerStatistics():String

Supplies an Xml with the current state of the server.

Equals(Object):Boolean

Determines whether the indicated object is identical to the current object.

(Inherited by System.Object)

GetHashCode():Int32

Functions as the standard hash function.

(Inherited by System.Object)

GetType():Type

Calls the runtime type of the current instance.

(Inherited by System.Object)

LoadSessionState(OnionSessionState):Void

Loads the state of a saved session.

SaveSessionState():OnionSessionState

Supplies an instance relating to the current state of the session.

ToString():String

Creates a string equivalent of the current exception and returns this.

(Inherited by System.Object)

TranslateException(Exception):Exception

Transforms server exceptions into exceptions of the Client API.