Class CommissioningDiscovery

Discovers a specific node and commissions it.

Hierarchy (view full)

InstanceDiscovery
- CommissioningDiscovery

Index

Constructors

constructor

new CommissioningDiscovery(owner, options): CommissioningDiscovery
Parameters
- owner: ServerNode<RootEndpoint>
- options: Options
Returns CommissioningDiscovery
Overrides InstanceDiscovery.constructor
- Defined in packages/node/src/behavior/system/controller/discovery/CommissioningDiscovery.ts:18

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Inherited from InstanceDiscovery.[toStringTag]
- Defined in packages/general/dist/esm/util/Promises.d.ts:80

Methods

cancel

cancel(): void
Terminate discovery.

This will not abort node initialization but it will terminate any active discoveries. The discovery result will be the same as if the discovery had timed out.

Returns void
Inherited from InstanceDiscovery.cancel
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:65

catch

catch<TResult>(onrejected?): CancelablePromise<ClientNode | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
  The callback to execute when the Promise is rejected.
Returns CancelablePromise<ClientNode | TResult>
A Promise for the completion of the callback.
Inherited from InstanceDiscovery.catch
- Defined in packages/general/dist/esm/util/Promises.d.ts:78

finally

finally(onfinally?): CancelablePromise<ClientNode>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: null | (() => void)
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns CancelablePromise<ClientNode>
A Promise for the completion of the callback.
Inherited from InstanceDiscovery.finally
- Defined in packages/general/dist/esm/util/Promises.d.ts:79

`Protected`onComplete

onComplete(): Promise<ClientNode>
Returns Promise<ClientNode>
Overrides InstanceDiscovery.onComplete
- Defined in packages/node/src/behavior/system/controller/discovery/CommissioningDiscovery.ts:23

`Protected`onDiscovered

onDiscovered(node): void
Parameters
- node: ClientNode
Returns void
Inherited from InstanceDiscovery.onDiscovered
- Defined in packages/node/src/behavior/system/controller/discovery/InstanceDiscovery.ts:24

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): CancelablePromise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = ClientNode
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: ClientNode) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
  The callback to execute when the Promise is rejected.
Returns CancelablePromise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from InstanceDiscovery.then
- Defined in packages/general/dist/esm/util/Promises.d.ts:77

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from InstanceDiscovery.toString
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:74

`Static`is

is<T>(value): value is CancelablePromise<T>
Type Parameters
- T
Parameters
- value: MaybePromise<T>
Returns value is CancelablePromise<T>
Inherited from InstanceDiscovery.is
- Defined in packages/general/dist/esm/util/Promises.d.ts:81

Class CommissioningDiscovery

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CommissioningDiscovery

Accessors

[toStringTag]

Returns string

Methods

cancel

Returns void

catch

Type Parameters

Parameters

Returns CancelablePromise<ClientNode | TResult>

finally

Parameters

Returns CancelablePromise<ClientNode>

`Protected`onComplete

Returns Promise<ClientNode>

`Protected`onDiscovered

Parameters

Returns void

then

Type Parameters

Parameters

Returns CancelablePromise<TResult1 | TResult2>

toString

Returns string

`Static`is

Type Parameters

Parameters

Returns value is CancelablePromise<T>

Settings

On This Page

Class CommissioningDiscovery

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CommissioningDiscovery

Accessors

[toStringTag]

Returns string

Methods

cancel

Returns void

catch

Type Parameters

Parameters

Returns CancelablePromise<ClientNode | TResult>

finally

Parameters

Returns CancelablePromise<ClientNode>

ProtectedonComplete

Returns Promise<ClientNode>

ProtectedonDiscovered

Parameters

Returns void

then

Type Parameters

Parameters

Returns CancelablePromise<TResult1 | TResult2>

toString

Returns string

Staticis

Type Parameters

Parameters

Returns value is CancelablePromise<T>

Settings

On This Page

`Protected`onComplete

`Protected`onDiscovered

`Static`is