Class Api

This is the request handler for Bruce Api, it should be passed to any method that wants to communicate with this particular api.

Hierarchy

AbstractApi
- Api

Index

Constructors

constructor

new Api(params): BruceApi.Api
Parameters
- params: {
      accountId: string;
      env?: string;
      guardian?: GuardianApi.Api;
      loadConfig?: boolean;
      loadRegionalBaseUrl?: boolean;
      loadWebSocket?: boolean;
  }
  - accountId: string
  - Optional env?: string
  - Optional guardian?: GuardianApi.Api
  - Optional loadConfig?: boolean
  - Optional loadRegionalBaseUrl?: boolean
  - Optional loadWebSocket?: boolean
Returns BruceApi.Api
Overrides AbstractApi.constructor
- Defined in api/bruce-api.ts:75

Properties

Cache

Cache: CacheControl<any>

EntityCdnUrl

EntityCdnUrl: string

LegacyTilesetCdnUrl

LegacyTilesetCdnUrl: string

TilesetCdnUrl

TilesetCdnUrl: string

`Private` accountId

accountId: string

`Protected` baseUrl

baseUrl: string = ""

`Private` cdnBaseUrl

cdnBaseUrl: string

`Private` env

env: string

`Private` loadCancelled

loadCancelled: boolean = false

`Private` loadProm

loadProm: Promise<void>

`Private` messageBroker

messageBroker: IBroker

Accessors

AccountId

get AccountId(): string
Returns string
- Defined in api/bruce-api.ts:32

Loading

get Loading(): Promise<void>
Returns Promise<void>
- Defined in api/bruce-api.ts:70

MessageBroker

get MessageBroker(): IBroker
Returns IBroker
- Defined in api/bruce-api.ts:43

Methods

ConstructCdnUrl

ConstructCdnUrl(url, urlParams?): string
Returns a url routed through the API's CDN. If the CDN is not enabled for the account, this will return null.
Parameters
- url: string
  
  suffix to append to the base url.
- Optional urlParams: URLSearchParams
Returns string
- Defined in api/bruce-api.ts:261

DELETE

DELETE(url, params?): Promise<any>
Performs an HTTP DELETE request. This will prepend the base url to the url.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/bruce-api.ts:310

GET

GET(url, params?): Promise<any>
Performs an HTTP GET request. This will prepend the base url to the url.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/bruce-api.ts:295

GetBaseUrl

GetBaseUrl(): string
Warning: This method does not wait for init to finish loading. This means the url could be changed once fully initialized. The url will be valid either way, but the loaded one may be faster as it is region specific. Await the "Loading" promise if you care about this.

Returns string
Overrides AbstractApi.GetBaseUrl
- Defined in api/bruce-api.ts:242

GetCacheItem

GetCacheItem(key, reqParams?): {
data: any;
found: boolean;
}
Returns a cache item matching the provided key. If the reqParams specify that caching is disabled, null is returned.
Parameters
- key: string
- Optional reqParams: IReqParams
Returns {
data: any;
found: boolean;
}
- data: any
- found: boolean
Inherited from AbstractApi.GetCacheItem
- Defined in api/abstract-api.ts:76

GetCdnBaseUrl

GetCdnBaseUrl(): string
Warning: Wait the "Loading" promise before using this url.

Returns string
- Defined in api/bruce-api.ts:250

GetSessionHeader

GetSessionHeader(): string
Returns the session header.

Returns string
Inherited from AbstractApi.GetSessionHeader
- Defined in api/abstract-api.ts:138

GetSessionId

GetSessionId(): string
Returns the session ID.

Returns string
Inherited from AbstractApi.GetSessionId
- Defined in api/abstract-api.ts:122

POST

POST(url, data, params?): Promise<any>
Performs an HTTP POST request. This will prepend the base url to the url.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/bruce-api.ts:326

PUT

PUT(url, data, params?): Promise<any>
Performs an HTTP PUT request. This will prepend the base url to the url.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/bruce-api.ts:342

SetBaseUrl

SetBaseUrl(url): void
Warning: This will cancel the init process. The init process loads a region specific endpoint. Setting a base url will stop that process from completing.
Parameters
- url: string
Returns void
Overrides AbstractApi.SetBaseUrl
- Defined in api/bruce-api.ts:280

SetCacheItem

SetCacheItem(params): void
Sets a cache item matching the provided key. If the reqParams specify that caching is disabled, then no action is taken.
Parameters
- params: {
      duration?: number;
      key: string;
      req?: IReqParams;
      value: any;
  }
  - Optional duration?: number
  - key: string
  - Optional req?: IReqParams
  - value: any
Returns void
Inherited from AbstractApi.SetCacheItem
- Defined in api/abstract-api.ts:93

SetSessionHeader

SetSessionHeader(value): void
Sets the session header.
Parameters
- value: string
Returns void
Inherited from AbstractApi.SetSessionHeader
- Defined in api/abstract-api.ts:146

SetSessionId

SetSessionId(value): void
Sets the session ID.
Parameters
- value: string
Returns void
Inherited from AbstractApi.SetSessionId
- Defined in api/abstract-api.ts:130

UPLOAD

UPLOAD(url, blob, params?): Promise<any>
Performs a file upload request (HTTP POST). This will prepend the base url to the url.
Parameters
- url: string
- blob: Blob
- Optional params: IUploadReqParams
Returns Promise<any>
- Defined in api/bruce-api.ts:358

delete

delete(url, params?): Promise<any>
Performs a DELETE request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.delete
- Defined in api/abstract-api.ts:182

get

get(url, params?): Promise<any>
Performs a GET request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.get
- Defined in api/abstract-api.ts:157

`Private` init

init(guardian?, loadConfig?, loadWebSocket?): Promise<void>
Loads regional base url and sets up message broker.
Parameters
- Optional guardian: GuardianApi.Api
  
  Required for loading regional base url.
- Optional loadConfig: boolean
- Optional loadWebSocket: boolean
Returns Promise<void>
- Defined in api/bruce-api.ts:117

post

post(url, data, params?): Promise<any>
Performs a POST request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.post
- Defined in api/abstract-api.ts:209

put

put(url, data, params?): Promise<any>
Performs a PUT request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.put
- Defined in api/abstract-api.ts:243

upload

upload(url, blob, params?): Promise<any>
Performs a file upload (POST) request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- blob: Blob
- Optional params: IUploadReqParams
Returns Promise<any>
Inherited from AbstractApi.upload
- Defined in api/abstract-api.ts:277

Class Api

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: { accountId: string; env?: string; guardian?: GuardianApi.Api; loadConfig?: boolean; loadRegionalBaseUrl?: boolean; loadWebSocket?: boolean; }

accountId: string

Optional env?: string

Optional guardian?: GuardianApi.Api

Optional loadConfig?: boolean

Optional loadRegionalBaseUrl?: boolean

Optional loadWebSocket?: boolean

Returns BruceApi.Api

Properties

Cache

EntityCdnUrl

LegacyTilesetCdnUrl

TilesetCdnUrl

Private accountId

Protected baseUrl

Private cdnBaseUrl

Private env

Private loadCancelled

Private loadProm

Private messageBroker

Accessors

AccountId

Returns string

Loading

Returns Promise<void>

MessageBroker

Returns IBroker

Methods

ConstructCdnUrl

Parameters

url: string

Optional urlParams: URLSearchParams

Returns string

DELETE

Parameters

url: string

Optional params: IReqParams

Returns Promise<any>

GET

Parameters

url: string

Optional params: IReqParams

Returns Promise<any>

GetBaseUrl

Returns string

GetCacheItem

Parameters

key: string

Optional reqParams: IReqParams

Returns { data: any; found: boolean; }

data: any

found: boolean

GetCdnBaseUrl

Returns string

GetSessionHeader

Returns string

GetSessionId

Returns string

POST

Parameters

url: string

data: any

Optional params: IReqParams

Returns Promise<any>

PUT

Parameters

url: string

data: any

Optional params: IReqParams

Returns Promise<any>

params: {
accountId: string;
env?: string;
guardian?: GuardianApi.Api;
loadConfig?: boolean;
loadRegionalBaseUrl?: boolean;
loadWebSocket?: boolean;
}

`Optional` env?: string

`Optional` guardian?: GuardianApi.Api

`Optional` loadConfig?: boolean

`Optional` loadRegionalBaseUrl?: boolean

`Optional` loadWebSocket?: boolean

`Private` accountId

`Protected` baseUrl

`Private` cdnBaseUrl

`Private` env

`Private` loadCancelled

`Private` loadProm

`Private` messageBroker

`Optional` urlParams: URLSearchParams

`Optional` params: IReqParams

`Optional` params: IReqParams

`Optional` reqParams: IReqParams

Returns {
data: any;
found: boolean;
}

`Optional` params: IReqParams

`Optional` params: IReqParams

params: {
duration?: number;
key: string;
req?: IReqParams;
value: any;
}

`Optional` duration?: number

`Optional` req?: IReqParams

`Optional` params: IUploadReqParams

`Optional` params: IReqParams

`Optional` params: IReqParams

`Private` init

`Optional` guardian: GuardianApi.Api

`Optional` loadConfig: boolean

`Optional` loadWebSocket: boolean

`Optional` params: IReqParams

`Optional` params: IReqParams

`Optional` params: IUploadReqParams