Extension SDK API reference

HostApi

const hostApi = createHostConnection()

getElements

getElements({
    select?: ElementSelect,
    filter?: ElementFilter
}): Promise<QueryPick<ElementData, ElementSelect>[]>

Filter by ElementFilter and select the returned properties with ElementSelect which defaults to DefaultSelect`

Return type matches ElementSelect

getElementById

getElementById({
    id: string,
    select?: ElementSelect
}): Promise<QueryPick<ElementData, ElementSelect>>

Return type matches ElementSelect

getSpaces

getSpaces({
    select?: SpaceSelect,
    filter?: SpaceFilter
}): Promise<QueryPick<SpaceData, SpaceSelect>[]>

Filter by SpaceFilter and select the returned properties with SpaceSelect which defaults to DefaultSelect

Return type matches SpaceSelect

getSpaceById

getSpaceById({
    id: string,
    select?: SpaceSelect
}): Promise<QueryPick<SpaceData, SpaceSelect>>

Return type matches SpaceSelect

Types

DefaultSelect

type DefaultSelect = { id: true; type: true }

BaseSelect

interface BaseSelect {
  id?: boolean
  type?: boolean
  name?: boolean
  customId?: boolean
  customAttributes?: boolean | Record<string, boolean>
  dimensions?:
    | boolean
    | {
        width?: boolean
        length?: boolean
        height?: boolean
      }
  boundingBox?: boolean
  boundingBoxContour?: boolean
}

SpaceSelect

export interface SpaceSelect extends BaseSelect {
  category?: boolean
  subCategory?: boolean
  isExternal?: boolean
  area?: boolean
  labelPoint?: boolean
  seatCapacity?: boolean
  polygons?: boolean
  elements?: ElementQuery
}

ElementSelect

export interface ElementSelect extends BaseSelect {
  product?: ProductSelect | boolean
  isExternal?: boolean
  position?: boolean
  rotation?: boolean
}

BaseFilter

interface BaseFilter {
  id?: StringComparator
  type?: StringComparator
  name?: StringComparator
  customId?: StringComparator
  customAttributes?: Record<string, StringComparator | NumberComparator | BooleanComparator>
  dimensions?: {
    width?: NumberComparator
    length?: NumberComparator
    height?: NumberComparator
  }
}

ElementFilter

export interface ElementFilter extends BaseFilter {
  product?: ProductFilter
  isExternal?: BooleanComparator
}

SpaceFilter

export interface SpaceFilter extends BaseFilter {
  category?: StringComparator
  subCategory?: StringComparator
  seatCapacity?: NumberComparator
  isExternal?: BooleanComparator
  area?: NumberComparator
}

SpaceQuery

export type SpaceQuery = {
  select?: SpaceSelect
  where?: SpaceFilter
}