Interface TimeFormatLocalizationBehavior

interface TimeFormatLocalizationBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        hourFormat$Changing: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
    } & {} & {
        hourFormat$Changed: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
    } & {} & {} & {};
    features: TypeFromBitSchema<{
        calendarFormat: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<{}, never> & {
        hourFormat: TimeFormatLocalization.HourFormat;
    } & {} & {} & {};
    [asyncDispose](): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    initialize(_options?: {}): MaybePromise;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    toString(): string;
    State: any;
}

Hierarchy

  • TimeFormatLocalizationBehaviorType
    • TimeFormatLocalizationBehavior

Properties

[reference] agent cluster context endpoint env events features session state

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString

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<Events, never> & {
    hourFormat$Changing: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
} & {} & {
    hourFormat$Changed: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    calendarFormat: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlycalendarFormat: BitFlag

    CalendarFormat

    The Node can be configured to use different calendar formats when conveying values to a user.

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    hourFormat: TimeFormatLocalization.HourFormat;
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlyhourFormat: TimeFormatLocalization.HourFormat

    Indicates the format that the Node is currently configured to use when conveying the hour unit of time.

    If not UseActiveLocale, this value shall take priority over any unit implied through the ActiveLocale attribute.

    If UseActiveLocale, any unit implied through the ActiveLocale attribute is used as the hour format, and if ActiveLocale is not present, the hour format is unknown.

    See

    MatterSpecification.v13.Core § 11.4.6.1

Methods

[asyncDispose]

asAdmin

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(_options?): MaybePromise

  • 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.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods