UbiquityServerLibrary documentation

The following table lists the Services defined in "UbiquityServerLibrary":

Service UbiquityServerService

The following table lists the Operations defined in "UbiquityServerService":

MagicResult
MagicResultString
Magic
ClinicalDocMagic
GetValidSecurityTokenResult
GetValidSecurityToken
RetireSecurityToken
Login
Logout
Echo
DataUpdateResult
SendDataUpdate
GetConnectedClients
ClientLog
PushEvent	deprecated
PushEventResults
UpdateAppEvent
DeleteAppEvent
ForceServerTimeout
GetClientIDFromLicenseKey

Method MagicResult

Parameters:

Flag	Name	Type	Description
In	TransID	AnsiString
In	DataSet	Xml

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.MagicResult(const TransID: AnsiString
        ; const DataSet: Xml);

C# Syntax:


                    public void
                UbiquityServerService.MagicResult(AnsiStringTransID
        , XmlDataSet);

Method MagicResultString

Parameters:

Flag	Name	Type	Description
In	TransID	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.MagicResultString(const TransID: AnsiString
        ; const Result: Utf8String);

C# Syntax:


                    public void
                UbiquityServerService.MagicResultString(AnsiStringTransID
        , Utf8StringResult);

Method Magic

Parameters:

Flag	Name	Type
In	LicenseKey	AnsiString
In	Action	AnsiString
In	LoginUser	AnsiString
In	AppName	AnsiString
In	PatientID	AnsiString
In	Token	AnsiString
In	Parameter1	AnsiString
In	Parameter2	AnsiString
In	Parameter3	AnsiString
In	Parameter4	AnsiString
In	Parameter5	AnsiString
In	Parameter6	AnsiString
In	dataParameter	Binary
In	JobID	AnsiString

Return Value:

Flag	Name	Type
Result	Result	Xml

Oxygene Syntax:

method UbiquityServerService.Magic(const LicenseKey: AnsiString
        ; const Action: AnsiString
        ; const LoginUser: AnsiString
        ; const AppName: AnsiString
        ; const PatientID: AnsiString
        ; const Token: AnsiString
        ; const Parameter1: AnsiString
        ; const Parameter2: AnsiString
        ; const Parameter3: AnsiString
        ; const Parameter4: AnsiString
        ; const Parameter5: AnsiString
        ; const Parameter6: AnsiString
        ; const dataParameter: Binary
        ; const JobID: AnsiString)
        : Xml;

C# Syntax:


          public XmlUbiquityServerService.Magic(AnsiStringLicenseKey
        , AnsiStringAction
        , AnsiStringLoginUser
        , AnsiStringAppName
        , AnsiStringPatientID
        , AnsiStringToken
        , AnsiStringParameter1
        , AnsiStringParameter2
        , AnsiStringParameter3
        , AnsiStringParameter4
        , AnsiStringParameter5
        , AnsiStringParameter6
        , BinarydataParameter
        , AnsiStringJobID);

Method ClinicalDocMagic

Parameters:

Flag	Name	Type
In	LicenseKey	AnsiString
In	Action	AnsiString
In	LoginUser	AnsiString
In	AppName	AnsiString
In	PatientID	AnsiString
In	Token	AnsiString
In	Parameter1	AnsiString
In	Parameter2	AnsiString
In	Parameter3	AnsiString
In	Parameter4	AnsiString
In	Parameter5	AnsiString
In	Parameter6	AnsiString
In	dataParameter	Binary
In	JobID	AnsiString

Return Value:

Flag	Name	Type
Result	Result	Utf8String

Oxygene Syntax:

method UbiquityServerService.ClinicalDocMagic(const LicenseKey: AnsiString
        ; const Action: AnsiString
        ; const LoginUser: AnsiString
        ; const AppName: AnsiString
        ; const PatientID: AnsiString
        ; const Token: AnsiString
        ; const Parameter1: AnsiString
        ; const Parameter2: AnsiString
        ; const Parameter3: AnsiString
        ; const Parameter4: AnsiString
        ; const Parameter5: AnsiString
        ; const Parameter6: AnsiString
        ; const dataParameter: Binary
        ; const JobID: AnsiString)
        : Utf8String;

C# Syntax:


          public Utf8StringUbiquityServerService.ClinicalDocMagic(AnsiStringLicenseKey
        , AnsiStringAction
        , AnsiStringLoginUser
        , AnsiStringAppName
        , AnsiStringPatientID
        , AnsiStringToken
        , AnsiStringParameter1
        , AnsiStringParameter2
        , AnsiStringParameter3
        , AnsiStringParameter4
        , AnsiStringParameter5
        , AnsiStringParameter6
        , BinarydataParameter
        , AnsiStringJobID);

Method GetValidSecurityTokenResult

Parameters:

Flag	Name	Type	Description
In	TransID	AnsiString
In	Token	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.GetValidSecurityTokenResult(const TransID: AnsiString
        ; const Token: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.GetValidSecurityTokenResult(AnsiStringTransID
        , AnsiStringToken);

Method GetValidSecurityToken

Parameters:

Flag	Name	Type
In	LicenseKey	AnsiString
In	Username	AnsiString
In	Password	AnsiString
In	OriginalToken	AnsiString

Return Value:

Flag	Name	Type
Result	Result	AnsiString

Oxygene Syntax:

method UbiquityServerService.GetValidSecurityToken(const LicenseKey: AnsiString
        ; const Username: AnsiString
        ; const Password: AnsiString
        ; const OriginalToken: AnsiString)
        : AnsiString;

C# Syntax:


          public AnsiStringUbiquityServerService.GetValidSecurityToken(AnsiStringLicenseKey
        , AnsiStringUsername
        , AnsiStringPassword
        , AnsiStringOriginalToken);

Method RetireSecurityToken

Parameters:

Flag	Name	Type
In	Token	AnsiString
In	LicenseKey	AnsiString
In	AppName	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.RetireSecurityToken(const Token: AnsiString
        ; const LicenseKey: AnsiString
        ; const AppName: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.RetireSecurityToken(AnsiStringToken
        , AnsiStringLicenseKey
        , AnsiStringAppName);

Method Login

Parameters:

Flag	Name	Type	Description
In	LicenseKey	AnsiString

Return Value:

Flag	Name	Type
Result	Result	Boolean

Oxygene Syntax:

method UbiquityServerService.Login(const LicenseKey: AnsiString)
        : Boolean;

C# Syntax:


          public BooleanUbiquityServerService.Login(AnsiStringLicenseKey);

Method Logout

Parameters:

Flag	Name	Type	Description
In	LicenseKey	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.Logout(const LicenseKey: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.Logout(AnsiStringLicenseKey);

Method Echo

Parameters:

Flag	Name	Type	Description
In	EchoIn	AnsiString

Return Value:

Flag	Name	Type
Result	Result	AnsiString

Oxygene Syntax:

method UbiquityServerService.Echo(const EchoIn: AnsiString)
        : AnsiString;

C# Syntax:


          public AnsiStringUbiquityServerService.Echo(AnsiStringEchoIn);

Method DataUpdateResult

Parameters:

Flag	Name	Type	Description
In	TransID	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.DataUpdateResult(const TransID: AnsiString
        ; const Result: Xml);

C# Syntax:


                    public void
                UbiquityServerService.DataUpdateResult(AnsiStringTransID
        , XmlResult);

Method SendDataUpdate

Parameters:

Flag	Name	Type
In	LicenseKey	AnsiString
In	Action	AnsiString
In	Manifest	Variant
In	Context	AnsiString

Return Value:

Flag	Name	Type
Result	Result	Xml

Oxygene Syntax:

method UbiquityServerService.SendDataUpdate(const LicenseKey: AnsiString
        ; const Action: AnsiString
        ; const Manifest: Variant
        ; const Context: AnsiString)
        : Xml;

C# Syntax:


          public XmlUbiquityServerService.SendDataUpdate(AnsiStringLicenseKey
        , AnsiStringAction
        , VariantManifest
        , AnsiStringContext);

Method GetConnectedClients

Parameters:

None.

Return Value:

Flag	Name	Type
Result	Result	AnsiString

Oxygene Syntax:

method UbiquityServerService.GetConnectedClients()
        : AnsiString;

C# Syntax:


          public AnsiStringUbiquityServerService.GetConnectedClients();

Method ClientLog

Parameters:

Flag	Name	Type	Description
In	LicenseKey	AnsiString
In	What	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.ClientLog(const LicenseKey: AnsiString
        ; const What: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.ClientLog(AnsiStringLicenseKey
        , AnsiStringWhat);

Method PushEvent

deprecated

Parameters:

Flag	Name	Type	Description
In	EventID	AnsiString
In	Results	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.PushEvent(const EventID: AnsiString
        ; const Results: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.PushEvent(AnsiStringEventID
        , AnsiStringResults);

Method PushEventResults

Parameters:

Flag	Name	Type	Description
In	EventID	AnsiString
In	xmlResults	Xml

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.PushEventResults(const EventID: AnsiString
        ; const xmlResults: Xml);

C# Syntax:


                    public void
                UbiquityServerService.PushEventResults(AnsiStringEventID
        , XmlxmlResults);

Method UpdateAppEvent

Parameters:

Flag	Name	Type	Description
In	AppEventID	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.UpdateAppEvent(const AppEventID: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.UpdateAppEvent(AnsiStringAppEventID);

Method DeleteAppEvent

Parameters:

Flag	Name	Type	Description
In	AppEventID	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.DeleteAppEvent(const AppEventID: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.DeleteAppEvent(AnsiStringAppEventID);

Method ForceServerTimeout

Parameters:

Flag	Name	Type	Description
In	LicenseKey	AnsiString

Return Value:

None.

Oxygene Syntax:

method UbiquityServerService.ForceServerTimeout(const LicenseKey: AnsiString);

C# Syntax:


                    public void
                UbiquityServerService.ForceServerTimeout(AnsiStringLicenseKey);

Method GetClientIDFromLicenseKey

Parameters:

Flag	Name	Type	Description
In	LicenseKey	AnsiString

Return Value:

Flag	Name	Type
Result	Result	AnsiString

Oxygene Syntax:

method UbiquityServerService.GetClientIDFromLicenseKey(const LicenseKey: AnsiString)
        : AnsiString;

C# Syntax:


          public AnsiStringUbiquityServerService.GetClientIDFromLicenseKey(AnsiStringLicenseKey);

The following table lists the Event Sinks defined in "UbiquityServerLibrary":

UnityEvents ()

Event Sink UnityEvents

The following table lists the Events defined in "UnityEvents":

OnGetValidSecurityToken
OnRetireSecurityToken
OnMagic
OnReceiveDataUpdate
OnServerDisconnect
OnSessionTimeout
OnAddEventPoller
OnDeleteEventPoller

Event OnGetValidSecurityToken

Parameters:

Flag	Name	Type	Description
In	TransID	AnsiString
In	ServiceUser	AnsiString
In	ServicePassword	AnsiString
In	OriginalToken	AnsiString	Optional

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnGetValidSecurityToken(const TransID: AnsiString
        ; const ServiceUser: AnsiString
        ; const ServicePassword: AnsiString
        ; const OriginalToken: AnsiString);

C# Syntax:


                    public void
                UnityEvents.OnGetValidSecurityToken(AnsiStringTransID
        , AnsiStringServiceUser
        , AnsiStringServicePassword
        , AnsiStringOriginalToken);

Event OnRetireSecurityToken

Parameters:

Flag	Name	Type	Description
In	Token	AnsiString
In	AppName	AnsiString

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnRetireSecurityToken(const Token: AnsiString
        ; const AppName: AnsiString);

C# Syntax:


                    public void
                UnityEvents.OnRetireSecurityToken(AnsiStringToken
        , AnsiStringAppName);

Event OnMagic

Parameters:

Flag	Name	Type
In	TransID	AnsiString
In	Action	AnsiString
In	LoginUser	AnsiString
In	AppName	AnsiString
In	PatientID	AnsiString
In	Token	AnsiString
In	Parameter1	AnsiString
In	Parameter2	AnsiString
In	Parameter3	AnsiString
In	Parameter4	AnsiString
In	Parameter5	AnsiString
In	Parameter6	AnsiString
In	dataParameter	Binary

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnMagic(const TransID: AnsiString
        ; const Action: AnsiString
        ; const LoginUser: AnsiString
        ; const AppName: AnsiString
        ; const PatientID: AnsiString
        ; const Token: AnsiString
        ; const Parameter1: AnsiString
        ; const Parameter2: AnsiString
        ; const Parameter3: AnsiString
        ; const Parameter4: AnsiString
        ; const Parameter5: AnsiString
        ; const Parameter6: AnsiString
        ; const dataParameter: Binary);

C# Syntax:


                    public void
                UnityEvents.OnMagic(AnsiStringTransID
        , AnsiStringAction
        , AnsiStringLoginUser
        , AnsiStringAppName
        , AnsiStringPatientID
        , AnsiStringToken
        , AnsiStringParameter1
        , AnsiStringParameter2
        , AnsiStringParameter3
        , AnsiStringParameter4
        , AnsiStringParameter5
        , AnsiStringParameter6
        , BinarydataParameter);

Event OnReceiveDataUpdate

Parameters:

Flag	Name	Type
In	TransID	AnsiString
In	Action	AnsiString
In	Manifest	Variant
In	Context	AnsiString

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnReceiveDataUpdate(const TransID: AnsiString
        ; const Action: AnsiString
        ; const Manifest: Variant
        ; const Context: AnsiString);

C# Syntax:


                    public void
                UnityEvents.OnReceiveDataUpdate(AnsiStringTransID
        , AnsiStringAction
        , VariantManifest
        , AnsiStringContext);

Event OnServerDisconnect

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnServerDisconnect();

C# Syntax:


                    public void
                UnityEvents.OnServerDisconnect();

Event OnSessionTimeout

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnSessionTimeout();

C# Syntax:


                    public void
                UnityEvents.OnSessionTimeout();

Event OnAddEventPoller

Parameters:

Flag	Name	Type
In	EventID	AnsiString
In	Event	AnsiString
In	Frequency	Double

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnAddEventPoller(const EventID: AnsiString
        ; const Event: AnsiString
        ; const Frequency: Double);

C# Syntax:


                    public void
                UnityEvents.OnAddEventPoller(AnsiStringEventID
        , AnsiStringEvent
        , DoubleFrequency);

Event OnDeleteEventPoller

Parameters:

Flag	Name	Type	Description
In	EventID	AnsiString

Return Value:

None.

Oxygene Syntax:

method UnityEvents.OnDeleteEventPoller(const EventID: AnsiString);

C# Syntax:


                    public void
                UnityEvents.OnDeleteEventPoller(AnsiStringEventID);

The following table lists the Structs defined in "UbiquityServerLibrary":

The following table lists the Enums defined in "UbiquityServerLibrary":

The following table lists the Arrays defined in "UbiquityServerLibrary":

Array	Element Type	Documentation
LicenseKeys	AnsiString

The following table lists the Exceptions defined in "UbiquityServerLibrary":

The following table lists the external RODL files used by library "UbiquityServerLibrary":