You are here: Symbol Reference
Symbol Reference
> Ofcas.Lk.Api.Client.Ui Namespace
Ofcas.Lk.Api.Client.Core Namespace
Ofcas.Lk.Api.Client.Core.Exceptions Namespace
Ofcas.Lk.Api.Client.Ui Namespace
Ofcas.Lk.Api.Shared Namespace
Files
> Classes
Classes
Interfaces
> ServiceProxyUi<TService, TCoreObject> Class
DialogResult<T> Class
ElevationUi Class
FileHandlerUi Class
LoginScopeUi Class
PhaseUi Class
ProjectCenterUi Class
ProjectInformationContainerUi Class
ProjectInformationUi Class
ProjectUi Class
ServiceProxy Class
ServiceProxyUi<TService, TCoreObject> Class
SettingContainerUi Class
> ServiceProxyUi<TService, TCoreObject> Methods
ServiceProxyUi<TService, TCoreObject>.ServiceProxyUi Constructor
ServiceProxyUi<TService, TCoreObject> Methods
> ServiceProxyUi<TService, TCoreObject>.Login Method
ServiceProxyUi<TService, TCoreObject>.Login Method
Close

Ofcas.Lk.Api.Client - Version 3.0 | Contents Index Home |

ServiceProxyUi<TService, TCoreObject>.Login Method
Send Feedback
Collapse All Expand All

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).

Syntax
C#
public IDialogResult<TCoreObject> Login(string programMode, IntPtr applicationHandle, TimeSpan synchronizeInterval = default(TimeSpan));
Parameters

Parameters | Description
string programMode | The program mode provided from Orgadata for the associated partner
IntPtr applicationHandle | The handle from a window of the user application.
TimeSpan synchronizeInterval = default(TimeSpan) | The interval to synchronize the core objects in multi-client mode. If the value is TimeSpan.Zero no synchronization will be active.

Returns

The a dialog result with the specific TCoreObject to interact with LogiKal.

Exceptions

Exceptions | Description
ArgumentException | Occurs if any arugment is invalid.
ApiException | Occurs if any error occurs.

Links
ServiceProxyUi<TService, TCoreObject> Class
Ofcas.Lk.Api.Client.Ui Namespace

Copyright © 2020. All rights reserved.
What do you think about this topic? Send feedback!