configurator-core/src/configurator.
# Hierarchy
-
↳
GlobalCallback
# Table of contents
# Constructors
# Properties
# Methods
- cameraStartsMoving
- get
- mute
- onApiJsonReceived
- onCheckExternalCache
- onKernelMsg
- onNetworkRequest
- unmute
# Constructors
# constructor
• new GlobalCallback(creator
)
# Parameters
Name | Type |
---|---|
creator | string |
# Inherited from
# Properties
# _creator_
• _creator_: string
# Inherited from
# onValidateNetworkResponse
• onValidateNetworkResponse: ExternalResponseValidator
# Methods
# cameraStartsMoving
▸ cameraStartsMoving(): void
# Returns
void
# Inherited from
# 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
# 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
# Inherited from
# mute
▸ mute(): void
# Returns
void
# Inherited from
# 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
# unmute
▸ unmute(): void
# Returns
void