Interface Cluster

Nodes should be expected to be deployed to any and all regions of the world. These global regions may have differing preferences for how dates and times are conveyed. As such, Nodes that visually or audibly convey time information need a mechanism by which they can be configured to use a user’s preferred format.

This cluster supports an interface to a Node. It provides attributes for determining and configuring time and date formatting information that a Node shall utilize when conveying values to a user.

TimeFormatLocalizationCluster supports optional features that you can enable with the TimeFormatLocalizationCluster.with() factory method.

See

MatterSpecification.v13.Core § 11.4

interface Cluster {
    attributes: Merge<{
        hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
    }, GlobalAttributes<{
        calendarFormat: BitFlag;
    }>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: readonly [{
        component: {
            attributes: {
                activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
                supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
            };
        };
        flags: {
            calendarFormat: true;
        };
    }];
    features: {
        calendarFormat: BitFlag;
    };
    id: Branded<44, "ClusterId">;
    name: "TimeFormatLocalization";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
                    supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
                };
            };
            flags: {
                calendarFormat: true;
            };
        }];
        features: {
            calendarFormat: BitFlag;
        };
        id: 44;
        name: "TimeFormatLocalization";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
                    supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
                };
            };
            flags: {
                calendarFormat: true;
            };
        }];
        features: {
            calendarFormat: BitFlag;
        };
        id: 44;
        name: "TimeFormatLocalization";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
                    supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
                };
            };
            flags: {
                calendarFormat: true;
            };
        }];
        features: {
            calendarFormat: BitFlag;
        };
        id: 44;
        name: "TimeFormatLocalization";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
                    supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
                };
            };
            flags: {
                calendarFormat: true;
            };
        }];
        features: {
            calendarFormat: BitFlag;
        };
        id: 44;
        name: "TimeFormatLocalization";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    hourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>;
}, GlobalAttributes<{
    calendarFormat: BitFlag;
}>>

Type declaration

  • ReadonlyhourFormat: WritableAttribute<TimeFormatLocalization.HourFormat, any>

    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

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: readonly [{
    component: {
        attributes: {
            activeCalendarType: WritableAttribute<TimeFormatLocalization.CalendarType, any>;
            supportedCalendarTypes: FixedAttribute<TimeFormatLocalization.CalendarType[], any>;
        };
    };
    flags: {
        calendarFormat: true;
    };
}]

features

features: {
    calendarFormat: BitFlag;
}

Type declaration

  • ReadonlycalendarFormat: BitFlag

    CalendarFormat

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

id

id: Branded<44, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods