Class TimeFormatLocalizationServer

This is the default server implementation of TimeFormatLocalizationBehavior.

Hierarchy

  • TimeFormatLocalizationServer_base
    • TimeFormatLocalizationServer

Constructors

constructor

Properties

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

Accessors

detectedCalendarType detectedHourFormat

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<TimeFormatLocalization.Cluster, typeof ClusterBehavior>, "hourFormat$Changing" | "hourFormat$Changed"> & {
    activeCalendarType$Changing: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.CalendarType, any>>;
    hourFormat$Changing: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
    supportedCalendarTypes$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TimeFormatLocalization.CalendarType[], any>>;
} & {} & {
    activeCalendarType$Changed: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.CalendarType, any>>;
    hourFormat$Changed: ClusterEvents.AttributeObservable<WritableAttribute<TimeFormatLocalization.HourFormat, any>>;
    supportedCalendarTypes$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TimeFormatLocalization.CalendarType[], 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<ClusterState.Type<TimeFormatLocalization.Cluster, typeof ClusterBehavior>, "hourFormat"> & {
    activeCalendarType: TimeFormatLocalization.CalendarType;
    hourFormat: TimeFormatLocalization.HourFormat;
} & {} & {
    supportedCalendarTypes: TimeFormatLocalization.CalendarType[];
} & {}

Access the behavior's state.

Type declaration

  • ReadonlyactiveCalendarType: TimeFormatLocalization.CalendarType

    Indicates the calendar format that the Node is currently configured to use when conveying dates.

    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 calendar type, and if ActiveLocale is not present, the calendar type is unknown.

    See

    MatterSpecification.v13.Core § 11.4.6.2

  • 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

Type declaration

  • ReadonlysupportedCalendarTypes: TimeFormatLocalization.CalendarType[]

    Indicates a list of CalendarTypeEnum values that are supported by the Node. The list shall NOT contain any duplicate entries. The ordering of items within the list SHOULD NOT express any meaning. The maximum length of the SupportedCalendarTypes list shall be equivalent to the number of enumerations within CalendarTypeEnum.

    See

    MatterSpecification.v13.Core § 11.4.6.3

Static Readonlycluster

cluster: WithFeatures<TimeFormatLocalization.Cluster, readonly ["CalendarFormat"]>

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

Static Readonlydefaults

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

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

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

Static Readonlyid

id

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

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    Static Readonlyname

    name: string

    Static Optional Readonlyschema

    schema?: Schema

    Static ReadonlyState

    State: (new () => ClusterState.Type<WithFeatures<TimeFormatLocalization.Cluster, readonly ["CalendarFormat"]>, Type<TimeFormatLocalization.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

    Accessors

    detectedCalendarType

    detectedHourFormat

    • get detectedHourFormat(): any[any] | any[any]

    • Override this getter with own implementation to detect the hour format of the system.

      Returns any[any] | any[any]

    Methods

    [asyncDispose]

    • [asyncDispose](): MaybePromise

    • Release resources. This is the public API for releasing application resources held by behaviors in internal state.

      Returns MaybePromise

    asAdmin

    • asAdmin(fn): void

    • Execute logic with elevated privileges.

      The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

      Elevated logic effectively ignores ACLs so should be used with care.

      Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.

      Parameters

      • fn: (() => void)

        the elevated logic

          • (): void

          • Returns void

      Returns void

    assertAttributeEnabled

    • assertAttributeEnabled<This, K>(this, attributeName): void

    • Type Parameters

      • This extends Behavior
      • K extends string | number | symbol

      Parameters

      • this: This
      • attributeName: K

      Returns void

    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

    • requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>

    • Type Parameters

      • This extends Behavior
      • K extends string | number | symbol

      Parameters

      • this: This
      • attributeName: K

      Returns Exclude<This["state"][K], undefined>

    toString

    • toString(): string

    • Description used in diagnostic messages.

      Returns string

    Staticalter

    Staticenable

    Staticfor

    Staticset

    • set<This>(this, defaults): This

    • Type Parameters

      Parameters

      Returns This

    Staticwith

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods