Configurator.Internal.GlobalCallback

configurator-core/src/configurator.internal.GlobalCallback

Hierarchy

• UiCallback

  ↳ GlobalCallback

Table of contents

Constructors

• constructor

Properties

• _creator_

• onValidateNetworkResponse

Methods

• cameraStartsMoving

• get

• mute

• onApiJsonReceived

• onCheckExternalCache

• onKernelMsg

• onNetworkRequest

• onReadyForRender

• unmute

Constructors

constructor

• new GlobalCallback(creator)

Parameters

Name	Type
creator	string

Inherited from

UiCallback.constructor

Properties

_creator_

• _creator_: string

Inherited from

UiCallback.creator

---

onValidateNetworkResponse

• onValidateNetworkResponse: ExternalResponseValidator

Methods

cameraStartsMoving

▸ cameraStartsMoving(): void

Returns

void

Inherited from

UiCallback.cameraStartsMoving

---

get

▸ get(target, prop): string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void

Parameters

Name	Type
target	UiCallback
prop	keyof UiCallback

Returns

string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void

Inherited from

UiCallback.get

---

mute

▸ mute(): void

Returns

void

Inherited from

UiCallback.mute

---

onApiJsonReceived

▸ onApiJsonReceived(_url, _rapiPath, _json): Promise<RapiJsonBox>

Parameters

Name	Type	Description
_url	string	URL of the request
_rapiPath	RAPI_PATHS	the RAPI_PATHS enum
_json	any	the JSON response

Returns

Promise<RapiJsonBox>

void

---

onCheckExternalCache

▸ onCheckExternalCache(_url, _requestData): Promise<any>

Parameters

Name	Type
_url	string
_requestData	RequestInit

Returns

Promise<any>

---

onKernelMsg

▸ onKernelMsg(_type, _message, _meta?): void

is called when the Kernel sends us some message

Parameters

Name	Type	Description
_type	KernelMessageType	KernelMessageType can either be exception, error or warning
_message	string	string the message from the Kernel
_meta	KernelMessageMetaInfo	KernelMessageMetaInfo optional, adds more information for debugging

Returns

void

---

onNetworkRequest

▸ onNetworkRequest(_url, _data, _options): void

is called when a network request is made

Parameters

Name	Type
_url	string
_data	RequestInit
_options	FetchOptions

Returns

void

---

onReadyForRender

▸ onReadyForRender(): void

is called the scene is ready for rendering it as an image

Returns

void

Inherited from

UiCallback.onReadyForRender

---

unmute

▸ unmute(): void

Returns

void

Inherited from

UiCallback.unmute