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.Client.Core.ProgramRuntime:

Public Member Functions
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.Client.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.Client.Core.Disposable
void	Dispose ()

Properties
LoginScope	Parent `[get]`

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

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

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< LoginScope >
TParent	Parent `[get]`
	The parent of this object. More...

Additional Inherited Members
Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
	CoreObjectBase (IApiService apiService, Guid coreObjectId)

override void	Dispose (bool disposing)

virtual void	OnSynchronizedEventReceived (ISynchronizedEvent synchronizedEvent)
	Gets called when a synchronized event was received. More...

void	RaiseIfFailed (BaseResponse response, [CallerMemberName] string callerMethod=null)
	Raises an ApiException if the stated BaseResponse indicates a failure. More...

Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
readonly IApiService	_apiService

Events inherited from Ofcas.Lk.Api.Client.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.Client.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.Client.Core.ProgramRuntime.GetConnectedClients ( )

Retrieves the connected clients of the current runtime.

Returns: Returns a list of ConnectedClient.

◆ RegisterClient()

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

Registers a client to the current runtime.

Parameters

processId The process ID of the client to be registered.

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

Core/src/ProgramRuntime.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeregisterClient()

◆ GetConnectedClients()

◆ RegisterClient()