Class TimeFormatLocalizationServer

This is the default server implementation of TimeFormatLocalizationBehavior.

Hierarchy

ClusterBehavior<this> & Omit<Instance<TimeFormatLocalization.Cluster, typeof ClusterBehavior, {
    components: never[];
}>,
    | "events"
    | "cluster"
    | "state"
    | "initialize"
    | typeof asyncDispose> & Omit<{} & {}, never> & {
    cluster: WithFeatures<TimeFormatLocalization.Cluster, readonly ["CalendarFormat"]>;
    events: ClusterEvents<WithFeatures<TimeFormatLocalization.Cluster, readonly ["CalendarFormat"]>, Type<TimeFormatLocalization.Cluster, typeof ClusterBehavior, {
        components: never[];
    }>>;
    features: TypeFromBitSchema<{
        calendarFormat: BitFlag;
    }>;
    state: ClusterState<WithFeatures<TimeFormatLocalization.Cluster, readonly ["CalendarFormat"]>, Type<TimeFormatLocalization.Cluster, typeof ClusterBehavior, {
        components: never[];
    }>>;
    [asyncDispose](): MaybePromise<void>;
}
- TimeFormatLocalizationServer

Index

Constructors

constructor

new TimeFormatLocalizationServer(agent, backing): TimeFormatLocalizationServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns TimeFormatLocalizationServer
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").constructor
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:198

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

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

`Readonly`state

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` `Readonly`cluster

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

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

`Static` `Readonly`defaults

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

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

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

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: {
components: never[];
}

`Static` `Readonly`Internal

Internal: (new () => {})

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

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

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

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

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Accessors

detectedCalendarType

get detectedCalendarType():
    | Buddhist
    | Chinese
    | Coptic
    | Ethiopian
    | Gregorian
    | Hebrew
    | Indian
    | Islamic
    | Japanese
    | Korean
    | Persian
Override this getter with own implementation to detect the calendar type of the system.

Returns
    | Buddhist
    | Chinese
    | Coptic
    | Ethiopian
    | Gregorian
    | Hebrew
    | Indian
    | Islamic
    | Japanese
    | Korean
    | Persian
- Defined in packages/node/src/behaviors/time-format-localization/TimeFormatLocalizationServer.ts:38

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]
- Defined in packages/node/src/behaviors/time-format-localization/TimeFormatLocalizationServer.ts:30

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").[asyncDispose]
- Defined in packages/node/src/behavior/Behavior.ts:206

asAdmin

asAdmin(fn): void
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").asAdmin
- Defined in packages/node/src/behavior/Behavior.ts:135

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").assertAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:180

`Protected`callback

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
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").callback
- Defined in packages/node/src/behavior/Behavior.ts:234

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
Overrides TimeFormatLocalizationBehavior.with("CalendarFormat").initialize
- Defined in packages/node/src/behaviors/time-format-localization/TimeFormatLocalizationServer.ts:17

`Protected`reactTo

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
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").reactTo
- Defined in packages/node/src/behavior/Behavior.ts:220

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>
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").requireAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:168

toString

toString(): string
Returns string
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").toString
- Defined in packages/node/src/behavior/Behavior.ts:211

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").alter
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:251

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").enable
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:261

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").for
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:237

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").set
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:259

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from TimeFormatLocalizationBehavior.with("CalendarFormat").with
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:243

Class TimeFormatLocalizationServer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TimeFormatLocalizationServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

features

Type declaration

ReadonlycalendarFormat: BitFlag

session

Readonlystate

Type declaration

ReadonlyactiveCalendarType: TimeFormatLocalization.CalendarType

See

ReadonlyhourFormat: TimeFormatLocalization.HourFormat

See

Type declaration

ReadonlysupportedCalendarTypes: TimeFormatLocalization.CalendarType[]

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Accessors

detectedCalendarType

Returns | Buddhist | Chinese | Coptic | Ethiopian | Gregorian | Hebrew | Indian | Islamic | Japanese | Korean | Persian

detectedHourFormat

Returns any[any] | any[any]

Methods

[asyncDispose]

Returns MaybePromise

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

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

Parameters

Returns undefined | R

initialize

Returns void

ProtectedreactTo

Type Parameters

Parameters

Returns void

requireAttributeEnabled

Type Parameters

Parameters

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

`Readonly`events

`Readonly`calendarFormat: BitFlag

`Readonly`state

`Readonly`activeCalendarType: TimeFormatLocalization.CalendarType

`Readonly`hourFormat: TimeFormatLocalization.HourFormat

`Readonly`supportedCalendarTypes: TimeFormatLocalization.CalendarType[]

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

Returns
| Buddhist
| Chinese
| Coptic
| Ethiopian
| Gregorian
| Hebrew
| Indian
| Islamic
| Japanese
| Korean
| Persian

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with