Class UnitLocalizationServer

This is the default server implementation of UnitLocalizationBehavior.

Hierarchy

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString alter enable for set with

Constructors

constructor

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<UnitLocalization.Cluster, typeof ClusterBehavior>, never> & {
    temperatureUnit$Changing: ClusterEvents.AttributeObservable<WritableAttribute<UnitLocalization.TempUnit, any>>;
} & {} & {
    temperatureUnit$Changed: ClusterEvents.AttributeObservable<WritableAttribute<UnitLocalization.TempUnit, any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    temperatureUnit: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlytemperatureUnit: BitFlag

    TemperatureUnit

    The Node can be configured to use different units of temperature when conveying values to a user.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<UnitLocalization.Cluster, typeof ClusterBehavior>, never> & {
    temperatureUnit: UnitLocalization.TempUnit;
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlytemperatureUnit: UnitLocalization.TempUnit

    The TemperatureUnit attribute shall indicate the unit for the Node to use only when conveying temperature in communication to the user. If provided, this value shall take priority over any unit implied through the ActiveLocale Attribute.

    See

    MatterSpecification.v13.Core § 11.5.6.1

Static Readonlycluster

cluster: WithFeatures<UnitLocalization.Cluster, readonly ["TemperatureUnit"]>

Base cluster state include all attribute values but may be extended by subclasses.

Static Readonlydefaults

defaults: ClusterState.Type<WithFeatures<UnitLocalization.Cluster, readonly ["TemperatureUnit"]>, Type<UnitLocalization.Cluster, typeof ClusterBehavior, {
    components: never[];
}>>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<WithFeatures<UnitLocalization.Cluster, readonly ["TemperatureUnit"]>, Type<UnitLocalization.Cluster, typeof ClusterBehavior, {
    components: never[];
}>>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Static Readonlyname

name: string

Static Optional Readonlyschema

schema?: Schema

Static ReadonlyState

State: (new () => ClusterState.Type<WithFeatures<UnitLocalization.Cluster, readonly ["TemperatureUnit"]>, Type<UnitLocalization.Cluster, typeof ClusterBehavior, {
    components: never[];
}>>)

Static Readonlysupervisor

supervisor: RootSupervisor

Staticsupports

supports: ((other: Type) => boolean)

Type declaration

    • (other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

Methods

[asyncDispose]

asAdmin

  • asAdmin(fn): void

  • Parameters

    • fn: (() => void)

      the elevated logic

        • (): void

        • Returns void

    Returns void

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(): void

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Returns void

ProtectedreactTo

  • reactTo<O>(observable, reactor, options?): void

  • Install a Reactor.

    Important: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    Parameters

    Returns void

requireAttributeEnabled

toString

Staticalter

Staticenable

Staticfor

Staticset

Staticwith

Settings

Member Visibility

On This Page

Constructors
Properties
Methods