ElectronRpcConfiguration Class
Beta
RPC interface configuration for an Electron-based application.
Extends
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| assign<T extends RpcInterface>(definition: RpcInterfaceDefinition<T extends RpcInterface>, supplier: RpcConfigurationSupplier): void Static | RpcConfiguration | Sets the configuration supplier for an RPC interface class. |
| initializeInterfaces(configuration: RpcConfiguration): void Static | RpcConfiguration | Initializes the RPC interfaces managed by the configuration. |
| obtain<T extends RpcConfiguration>(configurationConstructor: object): T extends RpcConfiguration Static | RpcConfiguration | Obtains the instance of an RPC configuration class. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| isElectron Accessor StaticReadOnly | boolean | ||
| protocol Abstract | ElectronRpcProtocol | The protocol of the configuration. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| developmentMode Static | boolean | RpcConfiguration | Whether development mode is enabled. |
| interfaces Abstract | () => RpcInterfaceDefinition[] | RpcConfiguration | The RPC interfaces managed by the configuration. |
| pendingOperationRetryInterval | number | RpcConfiguration | The target interval (in milliseconds) between connection attempts for pending RPC operation requests. |
| strictMode Static | boolean | RpcConfiguration | Whether strict mode is enabled. |
| throwOnTokenMismatch Static | boolean | RpcConfiguration | Whether to throw an error when the IModelToken in the operation parameter list differs from the token in the URL. |
Object Literals
| Name | Description |
|---|---|
| requestContext Static | Enables passing of application-specific context with each RPC request. |
Defined in
Last Updated: 08 January, 2020