Class EditorAPI

Hierarchy

APIBase
- EditorAPI

Index

Constructors

Properties

apiClient options

Methods

getBeaconsLookup getBounds getById getGeometryStyles getLevelGeometries getList getSpaceGeometries setApiUrl

Constructors

constructor

new EditorAPI(apiClient: APIClient, options: ClientOptions): EditorAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns EditorAPI
Overrides APIBase.constructor
- Defined in api/EditorAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getBeaconsLookup

getBeaconsLookup(): Promise<EditorBeaconsLookup>
Returns Promise<EditorBeaconsLookup>
- Defined in api/EditorAPI.ts:13

getBounds

getBounds(): Promise<Editor>
Returns Promise<Editor>
- Defined in api/EditorAPI.ts:19

getById

getById(_id: number): Promise<Editor>
Parameters
- _id: number
Returns Promise<Editor>
- Defined in api/EditorAPI.ts:25

getGeometryStyles

getGeometryStyles(): Promise<GeometryStyles>
Returns Promise<GeometryStyles>
- Defined in api/EditorAPI.ts:29

getLevelGeometries

getLevelGeometries(
levelId: string | number,
updateCacheKey?: string,
): Promise<EditorGeometries>
Parameters
- levelId: string | number
- OptionalupdateCacheKey: string
Returns Promise<EditorGeometries>
- Defined in api/EditorAPI.ts:35

getList

getList(): Promise<Editor[]>
Returns Promise<Editor[]>
- Defined in api/EditorAPI.ts:44

getSpaceGeometries

getSpaceGeometries(
spaceId: string | number,
updateCacheKey?: string,
): Promise<EditorGeometries>
Parameters
- spaceId: string | number
- OptionalupdateCacheKey: string
Returns Promise<EditorGeometries>
- Defined in api/EditorAPI.ts:49

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:18