Class BondingService

IQMESH Bonding API service

Hierarchy

BaseIqmeshService
- BondingService

Index

Constructors

Methods

autonetwork bondNode buildOptionsWithRequest removeBond removeBond3 removeBondCoordinator smartConnect

Constructors

constructor

new BondingService(): BondingService
Returns BondingService
Inherited from BaseIqmeshService.constructor

Methods

`Static`autonetwork

autonetwork(
    shared: IqmeshSharedParams,
    params: IqmeshAutonetworkParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Perform AutoNetwork
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshAutonetworkParams
  IQMESH BondNode request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:29

`Static`bondNode

bondNode(
    shared: IqmeshSharedParams,
    params: IqmeshBondNodeParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Bond a device locally
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshBondNodeParams
  IQMESH BondNode request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:45

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: IqmeshSharedParams,
    params: null | IqmeshRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct IQMESH service request object
Parameters
- mType: string
  Message type
- shared: IqmeshSharedParams
  Shared request parameters
- params: null | IqmeshRequestParams
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseIqmeshService.buildOptionsWithRequest
- Defined in services/iqmesh/BaseIqmeshService.ts:17

`Static`removeBond

removeBond(
    shared: IqmeshSharedParams,
    params: IqmeshRemoveBondParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Unbond a device or all devices from network
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshRemoveBondParams
  IQMESH RemoveBond request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:61

`Static`removeBond3

removeBond3(
    shared: IqmeshSharedParams,
    params: IqmeshRemoveBond3Params,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Unbond device(s) from network
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshRemoveBond3Params
  RemoveBond service request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:93

`Static`removeBondCoordinator

removeBondCoordinator(
    shared: IqmeshSharedParams,
    params: IqmeshRemoveBondCoordinatorParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Unbond device(s) in coordinator memory only
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshRemoveBondCoordinatorParams
  IQMESH RemoveBondCoordinator request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:77

`Static`smartConnect

smartConnect(
    shared: IqmeshSharedParams,
    params: IqmeshSmartConnectParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Bond a device via IQMESH SmartConnect
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshSmartConnectParams
  IQMESH SmartConnect request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BondingService.ts:120