ElectronRpcManager Class

Beta

Coordinates usage of RPC interfaces for an Electron-based application.

Extends

Methods

Name Description
initializeClient(params: ElectronRpcParams, interfaces: RpcInterfaceDefinition[]): ElectronRpcConfiguration Static Initializes ElectronRpcManager for the frontend of an application.  
initializeImpl(params: ElectronRpcParams, interfaces: RpcInterfaceDefinition[]): ElectronRpcConfiguration Static Initializes ElectronRpcManager for the backend of an application.  

Inherited methods

Name Inherited from Description
describeAvailableEndpoints(): Promise<RpcInterfaceEndpoints[]> Static RpcManager Describes the RPC interfaces and endpoints that are currently available from the backend.
getClientForInterface<T extends RpcInterface>(definition: RpcInterfaceDefinition<T extends RpcInterface>): T extends RpcInterface Static RpcManager Returns the RPC client instance for the frontend.
initializeInterface<T extends RpcInterface>(definition: RpcInterfaceDefinition<T extends RpcInterface>): void Static RpcManager Initializes an RPC interface class.
registerImpl<TDefinition extends RpcInterface, TImplementation extends TDefinition>(definition: RpcInterfaceDefinition<TDefinition extends RpcInterface>, implementation: RpcInterfaceImplementation<TImplementation extends TDefinition>): void Static RpcManager Register the RPC implementation class for the backend.
supplyImplInstance<TDefinition extends RpcInterface, TImplementation extends TDefinition>(definition: RpcInterfaceDefinition<TDefinition extends RpcInterface>, instance: TImplementation extends TDefinition): void Static RpcManager Supply the instance of the RPC interface implementation class for the backend (optional).
terminateInterface<T extends RpcInterface>(definition: RpcInterfaceDefinition<T extends RpcInterface>): void Static RpcManager Terminates an RPC interface class.
unregisterImpl<TDefinition extends RpcInterface>(definition: RpcInterfaceDefinition<TDefinition extends RpcInterface>): void Static RpcManager Unregister the RPC implementation class for the backend.

Defined in

Last Updated: 20 September, 2019