ServiceProxyNoUi.Login Method

You are here: Symbol Reference

Symbol Reference

> Ofcas.Lk.Api.Client.Core 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

> ServiceProxyNoUi Class

AddressContainer Class

AddressInfo Class

BaseElementElevationInfo Class

CoreInfo<TData, TParentObject, TParent> Class

CoreObjectBase Class

CoreObjectFullyQualified<TParent, TOwnInfo, TChild, TChildInfo> Class

CoreObjectWithChildren<TChild, TChildInfo> Class

CoreServiceProxy<TService, TCoreObject> Class

Disposable Class

DocumentContainer Class

DocumentInfo Class

ElementPricelist Class

ElementPricelistConfigurator Class

ElementPricelistContainer Class

ElementPricelistElevationInfo Class

ElementPricelistInfo Class

Elevation Class

ElevationInfo Class

ElevationInstance Class

ElevationInstanceInfo Class

FileHandler Class

InsertionElevationInfo Class

LayerElevationInfo Class

LoginScope Class

MaterialElevationInfo Class

PhaseAndElevationsResult Class

PhaseInfo Class

ProjectCenter Class

ProjectCenterInfo Class

ProjectDirectoryInfo Class

ProjectInfo Class

ProjectInformation Class

ProjectInformationContainer Class

ProjectInformationInfo Class

SearchAgent Class

SearchResult Class

SegmentElevationInfo Class

ServiceProxyBase<TService, TCoreObject> Class

ServiceProxyNoUi Class

SettingContainer Class

StandardElevationInfo Class

SynchronizationRestriction Class

TextElevationInfo Class

> ServiceProxyNoUi Methods

ServiceProxyNoUi Constructor

ServiceProxyNoUi Methods

> ServiceProxyNoUi.Login Method

ServiceProxyNoUi.GetLoginScope Method

ServiceProxyNoUi.Login Method

Close

Ofcas.Lk.Api.Client - Version 3.0

Contents

Index

Home

ServiceProxyNoUi.Login Method

Collapse All

Expand All

Login to the API to get access to projects, elevations 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 LoginScope Login(LoginArguments loginArguments, string programMode, TimeSpan synchronizeInterval = default(TimeSpan));

Parameters

Parameters	Description
LoginArguments loginArguments	The configuration of the dongle, e.g. the licenses to use (LoginArguments).
string programMode	The program mode provided from Orgadata for the associated partner
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.

Exceptions

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

Links

ServiceProxyNoUi Class
Ofcas.Lk.Api.Client.Core Namespace

Copyright © 2020. All rights reserved.

Contents

Index

Home

What do you think about this topic? Send feedback!