Class NodeService

Embedded Node API service

Hierarchy (View Summary)

BaseEmbedService
- NodeService

Index

Constructors

Methods

backup buildOptionsWithRequest read removeBond restore validateBonds

Constructors

constructor

new NodeService(): NodeService
Returns NodeService
Inherited from BaseEmbedService.constructor

Methods

`Static`backup

backup(
    shared: EmbedSharedParams,
    params: EmbedBackupParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Backup Node data
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedBackupParams
  Node backup parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/NodeService.ts:25

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`read

read(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Read node information
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/NodeService.ts:40

`Static`removeBond

removeBond(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Remove bond
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/NodeService.ts:55

`Static`restore

restore(
    shared: EmbedSharedParams,
    params: NodeRestoreParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Restore node data
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: NodeRestoreParams
  Node backup parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/NodeService.ts:71

`Static`validateBonds

validateBonds(
    shared: EmbedSharedParams,
    params: ValidateBondsParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Validate bonds
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: ValidateBondsParams
  Node backup parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/NodeService.ts:87