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 service, Guid coreObjectId)

OperationStatus	RunProgram (int programType)
	Runs the login program specified by the provided type. 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...

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

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

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

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

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

virtual TChild	GetChild (TChildInfo childInfo)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo coreInfo)

virtual void	DeleteChild (TChildInfo coreInfo)

virtual OperationInfo	CanMoveFrom (TChildInfo coreInfo)

virtual TChildInfo	MoveFrom (TChildInfo coreInfo)

virtual OperationInfo	CanCopyFrom (TChildInfo coreInfo)

virtual TChildInfo	CopyFrom (TChildInfo coreInfo)

virtual OperationInfo	CanAdd (ICoreInfo coreInfo)

virtual TChildInfo	Add (ICoreInfo coreInfo)

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

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

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

Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >
const string	NotSupportedCauseNotImplemented
	Default message for methods which are not supported because they are not implemented. More...

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

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.

◆ RunProgram()

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

Runs the login program specified by the provided type.

Parameters

programType The type of program to be run.

Returns: Returns an OperationStatus for the running program.

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

◆ RunProgram()