Hierarchy (View Summary)

Constructors

Properties

capacity: number

Amount of physical capacity associated with the zone

code: string

Organisational code associated with the zone

count: number

Count of resources associated with the zone

created_at: number

Unix epoch in seconds of the creation time of the object

description: string

Description of the zone's purpose

display_name: string

Custom display name for the zone

id: string

Unique Identifier of the object

images: string[]

List of image URLs

location: string

Geo-location details associated with the zone

map_id: string

ID or URL of or in a map associated with the zone

name: string

Human readable name of the object

parent_id: string

ID of the parent zone

playlists: readonly string[]

List of playlist IDs associated with the system

settings: [
    null
    | PlaceSettings,
    null | PlaceSettings,
    null | PlaceSettings,
    null | PlaceSettings,
] = ...

Tuple of user settings of differring encryption levels for the zone

tags: string[]

List of tags associated with the zone

timezone: string

Timezone of the associated real world location

trigger_list: readonly PlaceTrigger[] = []

List of modules associated with the system. Only available from the show method with the complete query parameter

triggers: readonly string[]

List of triggers associated with the zone

type: string

Organisational categorisation of the zone

updated_at: number

Unix epoch in seconds of the creation time of the object

version: number

Version of the data

Methods