Interface ZoneAPI

Zone-related API methods

See

Zones API Docs

interface ZoneAPI {
    get devices(): () => Promise<ZoneDevice[]>;
    create(zone: Zone.CreateRequest): Promise<string>;
    delete(zoneId: string): Promise<void>;
    edit(zoneId: string, zone: Zone.CreateRequest): Promise<void>;
    flatList(): Promise<FlatZone[]>;
    list(): Promise<{ defaultZone: Zone; zones: Zone[] }>;
}

Hierarchy

  • API
    • ZoneAPI

Accessors

devices

Methods

create delete edit flatList list

Accessors

devices

Methods

create

delete

  • delete(zoneId: string): Promise<void>

  • Parameters

    • zoneId: string

    Returns Promise<void>

edit

flatList

list

Settings

Member Visibility

On This Page

Accessors
Methods