Provides information about the program after a successful login. Information is created at runtime. Provides the possibility to adjust runtime data. More...

Inheritance diagram for Ofcas.Lk.Api.Core.ProgramRuntime:

Public Member Functions
	ProgramRuntime (IApiService apiService, Guid coreObjectId, CoreObjectBase parent)

void	DeregisterClient (uint processId)
	Deregisters a client from the current runtime. More...

IList< ConnectedClient >	GetConnectedClients ()
	Retrieves the connected clients of the current runtime. More...

void	RegisterClient (uint processId)
	Registers a client to the current runtime. More...

Public Member Functions inherited from Ofcas.Lk.Api.Core.CoreObjectBase
bool	CanDispose ()
	Returns the information about whether the object can be deleted. An object can only be deleted if no children live. More...

IList< Guid >	Children ()
	Returns a list with CoreObjectId for all children More...

Public Member Functions inherited from Ofcas.Lk.Api.Core.Disposable
void	Dispose ()

Public Attributes
LoginScope	Parent => (LoginScope) ParentCore
	Parent of type LoginScope. More...

Additional Inherited Members
Protected Member Functions inherited from Ofcas.Lk.Api.Core.CoreObjectBase
override void	Dispose (bool disposing)

	CoreObjectBase (IApiService apiService, Guid coreObjectId)

	CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent)

	CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent, ICoreInfo coreInfo)

Protected Attributes inherited from Ofcas.Lk.Api.Core.CoreObjectBase
IApiService	_apiService = null

Properties inherited from Ofcas.Lk.Api.Core.CoreObjectBase
Guid	CoreObjectId `[get]`
	The unique identifier of the object instance More...

Guid	ParentCoreObjectId `[get]`
	The unique identifier from the parent object instance More...

ICoreInfo	CoreInfo `[get, protected set]`
	Holds the included informations to the current object More...

DocumentContainer	Documents `[get]`
	Returns the DocumentContainer to handle documents to the object. More...

Properties inherited from Ofcas.Lk.Api.Core.Disposable
bool	IsDisposed `[get]`

Events inherited from Ofcas.Lk.Api.Core.Disposable
Action< Disposable >	Disposed

Detailed Description

Provides information about the program after a successful login. Information is created at runtime. Provides the possibility to adjust runtime data.

Member Function Documentation

◆ DeregisterClient()

void Ofcas.Lk.Api.Core.ProgramRuntime.DeregisterClient ( uint processId )

Deregisters a client from the current runtime.

Parameters

processId The process ID of the client to be deregistered.

◆ GetConnectedClients()

IList<ConnectedClient> Ofcas.Lk.Api.Core.ProgramRuntime.GetConnectedClients ( )

Retrieves the connected clients of the current runtime.

Returns: Returns a list of ConnectedClient.

◆ RegisterClient()

void Ofcas.Lk.Api.Core.ProgramRuntime.RegisterClient ( uint processId )

Registers a client to the current runtime.

Parameters

processId The process ID of the client to be registered.

Member Data Documentation

◆ Parent

LoginScope Ofcas.Lk.Api.Core.ProgramRuntime.Parent => (LoginScope) ParentCore

Parent of type LoginScope.

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

Ofcas.Lk.Api.Core/ProgramRuntime.cs

Public Member Functions

Public Attributes