The LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxyBase. It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenterUi. The children can be received from the CoreObject<T>.Infos. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Ui.LoginScopeUi:

Public Member Functions
	LoginScopeUi (IApiService apiService, Guid coreObjectId, TimeSpan synchronizeInterval)

OperationStatus	RunProgram (int programType)
	Runs the login program specified by the provided type. More...

OperationStatus	RunProgram (LoginRunnableProgram program, Dictionary< string, object > optionalParameters=null)
	Runs the login program specified by the provided type. More...

IDialogResult< Project >	SelectProject ()
	Selects a project via User Interface (UI). More...

IDialogResult< Elevation >	SelectElevation ()
	Selects an elevation via User Interface (UI). More...

new ProjectCenterUi	GetProjectCenter (ProjectCenterInfo projectCenterInfo)
	Returns the corresponding project-center based on the given information data. Available project-center types are defined in ProjectType. More...

new ProjectCenterUi	GetProjectCenter (ProjectCenterInfo childInfo, ProjectInfo projectInfo)
	Gets a ProjectCenterUi based on a ProjectCenterInfo and a ProjectInfo. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.LoginScope
	LoginScope (IApiService apiService, Guid coreObjectId, TimeSpan synchronizeInternal)

ProgramInformation	GetProgramInformation ()

ProgramRuntime	GetProgramRuntime ()
	Retrieves a ProgramRuntime of the current LoginScope. More...

IList< LoginRunnableProgram >	GetRunnablePrograms ()
	Retrieves a list of available LoginRunnablePrograms. More...

ProjectCenter	GetProjectCenter (ProjectCenterInfo projectCenterInfo)
	Returns the corresponding project-center based on the given information data. Available project-center type are defined in ProjectType. More...

override ProjectCenter	GetChild (ProjectCenterInfo childInfo)

ProjectCenter	GetProjectCenter (ProjectCenterInfo childInfo, ProjectInfo projectInfo)
	Gets a ProjectCenter based on a ProjectCenterInfo and a ProjectInfo. More...

ProjectCenter	GetStandardProjectCenter ()
	Returns the standard project-center. The standard project-center is from type ProjectType.Project. More...

IList< ElementType >	GetAvailableElementTypes ()
	Returns a list of all available ElementType for the current LoginScope. More...

override ProjectCenterInfo	RefreshChild (ProjectCenterInfo childInfo)

string	GetTranslation (string text, int firstIndex, int secondIndex, params string[] parameters)
	Translates a given text to the language which the API is currently running. More...

IList< ProjectInfo >	GetRecentProjectInfos ()
	Obtains the ProjectInfo of the recently opened projects. More...

bool	IsExportNeeded (DatabaseExportType databaseExportType)
	Checks whether the export is needed or not. More...

Stream	GetExport (ExportSettings exportSettings)
	Gets an export stream for the stated export settings. Use ExportSettings.Format in ExportSettings to specify the format of the export. Currently supported are: More...

double	GetGlassPrice (Dictionary< string, object > parameters)
	Gets a glass price based on the stated parameters. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
void	DisposeChild (ICoreObject coreObject)

bool	IsParentOf (ICoreObject coreObject)

abstract TChildInfo	RefreshChild (TChildInfo childInfo)

void	RefreshChildren ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo childInfo)

virtual void	DeleteChild (TChildInfo childInfo)

virtual OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	MoveFrom (ICoreInfo coreInfo)

virtual OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	CopyFrom (ICoreInfo coreInfo)

void	RefreshInfos ()

Protected Member Functions
override ProjectCenter	CreateNewInstance (Guid newCoreObjectId, ProjectCenterInfo projectCenterInfo, ProjectDirectoryInfo projectDirectoryInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.LoginScope
override CoreInfoResponse	GetInfoResponse ()
	Gets the info response from service. More...

override void	Dispose (bool disposing)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId)

TChildInfo	RefreshChild (Predicate< TChildInfo > predicate)
	Refreshes all infos and returns the appropriate info. More...

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
IList< TChildInfo >	Infos

IList< TChildInfo >	ChildrenInfos

Detailed Description

The LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxyBase. It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenterUi. The children can be received from the CoreObject<T>.Infos.

Member Function Documentation

◆ GetProjectCenter() [1/2]

new ProjectCenterUi Ofcas.Lk.Api.Client.Ui.LoginScopeUi.GetProjectCenter ( ProjectCenterInfo projectCenterInfo )

Returns the corresponding project-center based on the given information data. Available project-center types are defined in ProjectType.

Parameters

projectCenterInfo The project-center information obtained through the CoreObject<T>.Infos function.

Returns: the ProjectCenterUi

Exceptions

Exception If getting project-center failed.

◆ GetProjectCenter() [2/2]

new ProjectCenterUi Ofcas.Lk.Api.Client.Ui.LoginScopeUi.GetProjectCenter	(	ProjectCenterInfo	childInfo,
		ProjectInfo	projectInfo
	)

Gets a ProjectCenterUi based on a ProjectCenterInfo and a ProjectInfo.

Parameters

childInfo	The stated ProjectCenterInfo.
projectInfo	The stated ProjectInfo.

Returns: Returns a ProjectCenterUi based on the stated arguments.

◆ RunProgram() [1/2]

OperationStatus Ofcas.Lk.Api.Client.Ui.LoginScopeUi.RunProgram ( int programType )

Runs the login program specified by the provided type.

Parameters

programType The id of program to be run.

Returns: Returns an OperationStatus for the running program.

Exceptions

ApiException Occurs if the method fails.

◆ RunProgram() [2/2]

OperationStatus Ofcas.Lk.Api.Client.Ui.LoginScopeUi.RunProgram	(	LoginRunnableProgram	program,
		Dictionary< string, object >	optionalParameters = `null`
	)

Runs the login program specified by the provided type.

Parameters

program	The program to be run.
optionalParameters	The optional parameters for the program to be run.

Returns: Returns an OperationStatus for the running program.

Exceptions

ApiException Occurs if the method fails.

◆ SelectElevation()

IDialogResult<Elevation> Ofcas.Lk.Api.Client.Ui.LoginScopeUi.SelectElevation ( )

Selects an elevation via User Interface (UI).

Returns: Returns a dialog result which indicates how the Ui was handled. Returns a ready-to-use Elevation if the IDialogResult.Code is DialogResultCode.Accepted.

Exceptions

ApiException Occurs if the method fails.

◆ SelectProject()

IDialogResult<Project> Ofcas.Lk.Api.Client.Ui.LoginScopeUi.SelectProject ( )

Selects a project via User Interface (UI).

Returns: Returns a dialog result which indicates how the Ui was handled. Returns a ready-to-use Project if the IDialogResult.Code is DialogResultCode.Accepted.

Exceptions

ApiException Occurs if the method fails.

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

Ui/src/LoginScopeUi.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetProjectCenter() [1/2]

◆ GetProjectCenter() [2/2]

◆ RunProgram() [1/2]

◆ RunProgram() [2/2]

◆ SelectElevation()

◆ SelectProject()