Click or drag to resize
Six.Sixp.Client Namespace
The Six.Sixp.Client namespace contains the classes necessary to communicate with a SIXP Server. Start by instanciate a Client class. Use the client instance to create a session. Use the session to create requests.
Classes
  ClassDescription
Public classClassicLogin
Login strategy for classic login using username and password
Public classClient
Handles the different sessions
Public classFieldInfo
Information.
Public classFieldInfoSet
Conatins a set of FieldInfo object with a number lookup methods
Public classLoginCredentials
Contains the type of login that shoul be used by the api and the credentials
Public classLoginStrategyBase
Abstract base class for logi strategies
Public classProxySettings
Proxyinställningar.
Public classRequestToEventAdapter
Provides an event adapter to the request listener interface for those applications that preferres the event pattern style.
Public classSixpException
Base object for the exceptions that can be thrown.
Public classSixpExceptionConnect
SixpExceptionConnect exception
Public classSixpExceptionDisconnected
SixpExceptionDisconnected exception
Public classSixpExceptionGeneral
SixpExceptionGeneral exception
Public classSixpExceptionInvalidParameter
SixpExceptionInvalidParameter exception
Public classSixpExceptionNotLoggedIn
SixpExceptionNotLoggedIn exception
Public classSixpExceptionProxy
SixpExceptionProxy exception
Public classSixpExceptionServerVersionNotSupported
SixpExceptionServerVersionNotSupported exception
Public classSixpExceptionTimeout
SixpExceptionTimeout exception
Public classSixpServerSettings
Server connection settings.
Public classTicketQueryLogin
Login strategy for ticket login using workstation id and a ticket from the passport service
Structures
  StructureDescription
Public structureField
Holds a field value and information about the field
Public structureUpdate
Field update info.
Interfaces
  InterfaceDescription
Public interfaceIClientLogging
Interface for client logging
Public interfaceILoginStrategy
Contract that denotes an login strategy
Public interfaceIRequest
Represents data request from SIXP
Public interfaceIRequestEventListener
Interface for request events
Public interfaceISession
Handles communications to a sixp server
Public interfaceISessionEventListener
Interface for session events
Public interfaceISnapshotRequester
Requester for easy synchronous snapshot requests.
Delegates
  DelegateDescription
Public delegateRequestClearTableAction
Delegate used for propagting table cleared events.
Public delegateRequestDestroyedAction
Delegate used for propagating request destoyed events.
Public delegateRequestErrorAction
Delaget used for propagation error events.
Public delegateRequestFieldSetReceived
Delegate used for propagte the FieldSetReceived event.
Public delegateRequestInitTableAction
Delegate used for propagate a table initalizatiuon event.
Public delegateRequestRecordUpdateAction
Delegate used for propagate field update events.
Public delegateRequestTableFilledAction
Delegate used for propagate a table filled event.
Public delegateRequestTextAction
Delegate used for propagating received text events.
Public delegateTicketQueryCallback
Delegate for requesting a ticket from the passport service
Enumerations
  EnumerationDescription
Public enumerationAcceptFormat
Data formats than can the requested from the server.
Public enumerationError
Error type for errors generated locally in the API.
Public enumerationFieldFlags
Field flags.
Public enumerationFieldInfoInternalFieldType
For internal use only.
Public enumerationFieldType
SIXP field types.
Public enumerationLoginType
The login method used
Public enumerationLogLevel
Loglevel flags that determines what the client will try to log by calling OnLogText
Public enumerationProxyType
Proxy type
Public enumerationReconnectStrategy
Determines how the session should behave when disconnected
Public enumerationUpdateType
Type of update.