Pebble App Framework: Phone API
    Preparing search index...

    Interface ConfigBuilderOptions

    The per-section description a face hands buildConfig. Each section is optional. Present means "include it", and its own fields tune it.

    interface ConfigBuilderOptions {
        appearanceItems?: ClayConfigItem[];
        battery?: { description?: string; label?: string };
        bluetooth?: { description?: string };
        calendar?: { description?: string; items?: ClayConfigItem[] };
        clock?: { timeZone?: boolean };
        clockItems?: ClayConfigItem[];
        date?: {
            beats?: boolean;
            default?: string;
            description?: string;
            label?: string;
            options?: { label: string; value: string | number }[];
        };
        heading?: string;
        hourlyVibe?: { description?: string; label?: string };
        intro?: string;
        layoutSections?: ClayConfigItem[];
        location?: { gpsDefault?: boolean };
        quietTime?: { description?: string };
        steps?: { capabilities?: string[]; description?: string; label?: string };
        stocks?: { description?: string; items?: ClayConfigItem[] };
        temperature?: unknown;
        theme?: {
            description?: string;
            label?: string;
            options?: { label: string; value: string | number }[];
            previews?: Record<string, ThemePreviewPictures>;
        };
        weather?: unknown;
    }
    Index
    appearanceItems? battery? bluetooth? calendar? clock? clockItems? date? heading? hourlyVibe? intro? layoutSections? location? quietTime? steps? stocks? temperature? theme? weather?
    appearanceItems?: ClayConfigItem[]

    Extra controls to sit inside the Appearance section, under the theme picker. For a setting that belongs with the look of the face rather than in a section of its own.

    battery?: { description?: string; label?: string }
    bluetooth?: { description?: string }
    calendar?: { description?: string; items?: ClayConfigItem[] }

    The calendar feed: the private iCal link. description replaces the lead line, and items adds a face's own controls under it, such as reminders its watch buzzes for.

    clock?: { timeZone?: boolean }

    timeZone adds the alternate time zone picker to the Clock section, for a face with a second clock. It needs the CLOCK_TIMEZONE_1 key, and works with or without weather.

    clockItems?: ClayConfigItem[]

    Extra controls to sit inside the Clock section, under the time format. For a setting that qualifies how the time itself is written.

    date?: {
        beats?: boolean;
        default?: string;
        description?: string;
        label?: string;
        options?: { label: string; value: string | number }[];
    }

    beats adds the .beat date formats to the end of the list. Only a face whose date line runs through readout_date asks for them, since that is what fills the token in.

    heading?: string
    hourlyVibe?: { description?: string; label?: string }
    intro?: string
    layoutSections?: ClayConfigItem[]
    location?: { gpsDefault?: boolean }
    quietTime?: { description?: string }
    steps?: { capabilities?: string[]; description?: string; label?: string }

    capabilities is Clay's own item filter. A face that shows no step count on some watch passes e.g. ['NOT_PLATFORM_GABBRO'] and Clay drops the control on that platform for it, rather than every face losing it.

    stocks?: { description?: string; items?: ClayConfigItem[] }

    Stock quotes: the data source, its key, and the tickers. description replaces the lead line, and items adds a face's own controls under the tickers, such as a refresh interval its watch reads.

    temperature?: unknown
    theme?: {
        description?: string;
        label?: string;
        options?: { label: string; value: string | number }[];
        previews?: Record<string, ThemePreviewPictures>;
    }

    previews shows a picture of the chosen theme under the dropdown, keyed by the option's value as a string, each a list of one or more pictures (such as a day and a night shot), or a map of such a list per platform so each watch shows its own shots. It comes from the file paf gen <face> theme-previews writes. Without it the picker is the plain select.

    weather?: unknown

    Settings
    Member Visibility

    On This Page
    Properties