The LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxy. 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...
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.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... | |
Protected Member Functions | |
| override CoreObjectBase | GetProjectCenterObject (Guid newCoreObjectId, ProjectCenterInfo projectCenterInfo, ProjectDirectoryInfo projectDirectoryInfo) |
Detailed Description
The LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxy. 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.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.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:
- Ofcas.Lk.Api.Ui/LoginScopeUi.cs
