Altium.Sdk.Ids

Adds the services needed to use the IDS event channel feature.

The collection to add services to. The feature toggling configuration. The abstraction providing session data management capabilities for the channel events.

Encapsulates all SignalR connection-related logic, state and data. Accumulates connection state as it builds it. Initializes connection lifetime managing entities, but is not tied to its lifetime itself.

Initializes a new connection to the specified endpoint using the provided means of authentication.

The full endpoint to connect to. The valid authentication token.

Processes events that come from the specified 's , using to deserialize the event data.

Adds an action to be performed when the client detects a slow or frequently dropping connection. Provides the connection Id.

The action that receives the connection Id.

Adds an action to be performed when the client observes an exception. Provides the connection Id and the error exception.

The action that receives the connection Id, and the error exception.

Adds an action to be performed when the connection state changes. Provides the connection Id, the old state and the new state. For information about connection state values see .

The action that receives the connection Id, old state and new state.

Completes the initialization of the connection and returns its lifetime tracking object.

Stateful and not thread-safe.

Allows to bind together the lifetime of multiple related instances, as well as perform extra actions before their disposal.

Initializes the IDS event channel feature. Meant for use in static initialization contexts, where DI is not available.

Initializes the IDS event channel feature.

IDS URI, global or regional. The delegate that should produce valid AFS session(s) (regional or global, depending on the endpoint). Can be any user's session. If is not set, this parameter is required. Allows to dynamically toggle the feature after initialization. If null, the feature is always on. The abstraction that provides session data management capabilities for the channel events. The delegate that should produce valid authentication tokens. If is not set or returns null, this parameter will be used.

Contains the data that identifies a session (UserId). Exists mostly to provide strong separation of collections that store session data.

The client for SecurityTokens controller of EventChannels IDS API.

Establishes the connection to IDS event channel and attaches all the processing and telemetry to its events.

Connects to the event channel using the provided session Id to retrieve the channel's security token via an extra API call.

IDS URI. The valid AFS Session Id (regional or global) to use for connection authentication. Can be any authenticated user. True if the connection was successfully established. False if the connection is already established or there were errors during initialization.

Connects to the event channel using the provided auth token.

IDS URI. The valid authentication token. True if the connection was successfully established. False if the connection is already established or there were errors during initialization.

Processes the events by type and tracks last received event version.

Resets the last received version.

Manages the lifetime of the objects it contains.

A role-interface for a generic abstract key-value collection that provides only the deletion capability.

Any type that is supported by the specific implementations of this interface.

Removes an element by its key.

The key that uniquely identifies the element that should be removed. True if the element was successfully deleted. Otherwise, false.

Performs only the basic storage operations based on item key only.

A basic key-value store that does not assume any properties for the objects it holds and does not manage their state.

Produces new instances of the stateful .