Ofcas.Lk.Api.Client - Version 3.0  3.0.0.101
Ofcas.Lk.Api.Client.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.Client.Ui.ServiceProxy:
Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< IApiService, LoginScopeUi >

Public Member Functions

 ServiceProxy (string installationPath, string args="")
 
- Public Member Functions inherited from Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< IApiService, LoginScopeUi >
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...
 

Protected Member Functions

override LoginScopeUi GetLoginScope (IApiService service, Guid coreObjectId)
 
override string GetFullQualifiedServicePath (string installationPath)
 
- Protected Member Functions inherited from Ofcas.Lk.Api.Client.Ui.ServiceProxyBase< IApiService, LoginScopeUi >
 ServiceProxyBase (string installationPath, string args="")
 
override void Dispose (bool disposing)
 
TService GetService ()
 
abstract TCoreObject GetLoginScope (TService service, Guid coreObjectId)
 

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.


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