Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< TService, TCoreObject > Class Template Reference

Inheritance diagram for Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< TService, TCoreObject >:

Public Member Functions
void	Start ()
	Starts the service. This method must be called first to get the LoginScope (Login). More...
void	Stop ()
	Stops the service. This method must be called before destroying the ServiceProxyBase. This method is also called in the destructor. More...
TCoreObject	Login (string programMode, Int64 uiHandle)
	Login to the API to get access to projects, elvations etc. . Without login no access to the API is available. Attention: Before a login is possible, the service must be started (Start). More...
Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Disposable
void	Dispose ()

Protected Member Functions
	ServiceProxyBase (string installationPath, string args="")
override void	Dispose (bool disposing)
TService	GetService ()
abstract TCoreObject	GetLoginScope (TService service, Guid coreObjectId)
abstract string	GetFullQualifiedServicePath (string installationPath)

Additional Inherited Members
Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< Disposable >	Disposed

Member Function Documentation

Login()

TCoreObject Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< TService, TCoreObject >.Login	(	string	programMode,
		Int64	uiHandle
	)

Login to the API to get access to projects, elvations etc. . Without login no access to the API is available. Attention: Before a login is possible, the service must be started (Start).

Parameters

programMode	The program mode provided from Orgadata for the associated partner
uiHandle	The handle from a window of the user application

Returns

The LoginScopeUi to interact with LogiKal

Exceptions

Exception

If creating login scope fails.

Start()

void Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< TService, TCoreObject >.Start

(

)

Starts the service. This method must be called first to get the LoginScope (Login).

Stop()

void Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< TService, TCoreObject >.Stop

(

)

Stops the service. This method must be called before destroying the ServiceProxyBase. This method is also called in the destructor.

---

The documentation for this class was generated from the following file:

• Ui/src/ServiceProxyBase.cs