Class Parts

Manages the parent-child relationship between endpoints as defined by the "Parts" attribute of the Basic Information cluster.

You can manipulate child parts using MutableSet interface.

Notifications of structural change bubble via Endpoint.lifecycle.changed.

Hierarchy (view full)

Implements

Constructors

constructor

Accessors

[value] added deleted owner size

Methods

[iterator] add assertIdAvailable clear close delete filter find get has indexOf initialize map require reset

Constructors

constructor

Accessors

[value]

  • get [value](): Diagnostic

  • Returns Diagnostic

added

  • get added(): Observable<[T], void>

  • Returns Observable<[T], void>

deleted

  • get deleted(): Observable<[T], void>

  • Returns Observable<[T], void>

Protectedowner

  • get owner(): Endpoint<Empty>

  • Returns Endpoint<Empty>

size

  • get size(): number

  • Returns number

Methods

[iterator]

add

assertIdAvailable

  • assertIdAvailable(id, endpoint): void

  • Confirm availability of an ID amongst the endpoint's children.

    Parameters

    Returns void

clear

close

  • close(): Promise<void>

  • Destroy all parts. Invoked automatically by the owner on destroy.

    Returns Promise<void>

delete

filter

find

get

has

indexOf

  • indexOf(child): number

  • Parameters

    Returns number

initialize

  • initialize(): MaybePromise<void>

  • Initialize all uninitialized Parts.

    Invoked automatically by the owner after behaviors initialize.

    Returns MaybePromise<void>

map

require

  • require(id): Endpoint<Empty>

  • Parameters

    • id: string

    Returns Endpoint<Empty>

reset

  • reset(): Promise<void>

  • Soft-reset all parts. Invoked automatically by the owner on reset.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods