The LoginScope is the the scope to interact with LogiKal. The LoginScope can only be received by valid connection to a service (LoginScopeFactoryBase<T>.Login). It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenter. The children can be received from the CoreObject<T>.Infos. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.LoginScope:

Public Member Functions
	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 CoreInfoResponse	GetInfoResponse ()
	Gets the info response from service. More...

virtual ProjectCenter	CreateNewInstance (Guid coreObjectId, ProjectCenterInfo projectCenterInfo, ProjectDirectoryInfo projectDirectoryInfo)

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 LoginScope is the the scope to interact with LogiKal. The LoginScope can only be received by valid connection to a service (LoginScopeFactoryBase<T>.Login). It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenter. The children can be received from the CoreObject<T>.Infos.

Member Function Documentation

◆ GetAvailableElementTypes()

IList<ElementType> Ofcas.Lk.Api.Client.Core.LoginScope.GetAvailableElementTypes ( )

Returns a list of all available ElementType for the current LoginScope.

Returns: List with all available element types

◆ GetInfoResponse()

override CoreInfoResponse Ofcas.Lk.Api.Client.Core.LoginScope.GetInfoResponse ( )

protectedvirtual

Gets the info response from service.

Returns: Return the CoreInfoResponse.

Implements Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< ProjectCenter, ProjectCenterInfo >.

◆ GetProgramRuntime()

ProgramRuntime Ofcas.Lk.Api.Client.Core.LoginScope.GetProgramRuntime ( )

Retrieves a ProgramRuntime of the current LoginScope.

Returns: Returns a ProgramRuntime of the current LoginScope.

◆ GetProjectCenter()

ProjectCenter Ofcas.Lk.Api.Client.Core.LoginScope.GetProjectCenter ( ProjectCenterInfo projectCenterInfo )

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

Parameters

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

Returns: the ProjectCenter

Exceptions

Exception If getting project-center failed.

◆ GetRecentProjectInfos()

IList<ProjectInfo> Ofcas.Lk.Api.Client.Core.LoginScope.GetRecentProjectInfos ( )

Obtains the ProjectInfo of the recently opened projects.

Returns: Returns a list of ProjectInfo objects of the recently opened projects.

◆ GetRunnablePrograms()

IList<LoginRunnableProgram> Ofcas.Lk.Api.Client.Core.LoginScope.GetRunnablePrograms ( )

Retrieves a list of available LoginRunnablePrograms.

Returns: Returns a a list of available LoginRunnablePrograms.

◆ GetStandardProjectCenter()

ProjectCenter Ofcas.Lk.Api.Client.Core.LoginScope.GetStandardProjectCenter ( )

Returns the standard project-center. The standard project-center is from type ProjectType.Project.

Returns: the ProjectCenter from type ProjectType.Project

Exceptions

Exception	If getting project-center failed.
NotImplementedException

◆ GetTranslation()

string Ofcas.Lk.Api.Client.Core.LoginScope.GetTranslation	(	string	text,
		int	firstIndex,
		int	secondIndex,
		params string []	parameters
	)

Translates a given text to the language which the API is currently running.