Ofcas.Lk.Api.Ui.ServiceProxy Class Reference

ServiceProxy is used to establish a connection to the service. The ServiceProxy ensures that the necessary service is started (Start). The service to be used is part of the LogiKal installation. After the start of the service the login takes place (Login). If a scope is completed, the service must be terminate with the method Stop. The ServiceProxy must be held during the lifetime of the scope. More...

Inheritance diagram for Ofcas.Lk.Api.Ui.ServiceProxy:

Public Member Functions
	ServiceProxy (string installationPath, string args="")
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 ServiceProxy. This method is also called in the destructor. More...
LoginScopeUi	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.Core.Disposable
void	Dispose ()

Protected Member Functions
override void	Dispose (bool disposing)

Additional Inherited Members
Properties inherited from Ofcas.Lk.Api.Core.Disposable
bool	IsDisposed [get]
Events inherited from Ofcas.Lk.Api.Core.Disposable
Action< Disposable >	Disposed

Detailed Description

ServiceProxy is used to establish a connection to the service. The ServiceProxy ensures that the necessary service is started (Start). The service to be used is part of the LogiKal installation. After the start of the service the login takes place (Login). If a scope is completed, the service must be terminate with the method Stop. The ServiceProxy must be held during the lifetime of the scope.

Member Function Documentation

Login()

LoginScopeUi Ofcas.Lk.Api.Ui.ServiceProxy.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.Ui.ServiceProxy.Start

(

)

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

Stop()

void Ofcas.Lk.Api.Ui.ServiceProxy.Stop

(

)

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

---

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

• Ofcas.Lk.Api.Ui/ServiceProxy.cs