Class CommissioningDiscovery

Discovers a specific node and commissions it.

Hierarchy (view full)

Constructors

constructor

Accessors

[toStringTag]

Methods

cancel catch finally onComplete onDiscovered then toString is

Constructors

constructor

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

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

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.

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.

ProtectedonComplete

  • onComplete(): Promise<ClientNode>

  • Returns Promise<ClientNode>

ProtectedonDiscovered

  • onDiscovered(node): void

  • Parameters

    • node: ClientNode

    Returns void

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.

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

Staticis

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods