AbstractRemoteDebuggerService
On this page
- AbstractRemoteDebuggerService ⇐
Abstract
- AbstractRemoteDebuggerService()
- initialize() ⇒
Promise
- getProfile() ⇒
Promise.<Object>
- getCurrentScreen() ⇒
Promise.<AbstractScreen>
- getCurrentScreenData() ⇒
Promise.<Object>
- getEventBusData() ⇒
Object
- getInputEventBusData() ⇒
Object
- getViewData(viewHash) ⇒
Promise.<Object>
- highlightView(viewHash)
- onScreenHide(screenToHide)
- getInfo() ⇒
Promise.<(Object|void)>
AbstractRemoteDebuggerService ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Service:
Properties
Name | Type |
---|---|
socket | ProxySocketServerExtService |
- AbstractRemoteDebuggerService ⇐
Abstract
- new AbstractRemoteDebuggerService()
- .initialize() ⇒
Promise
- .getProfile() ⇒
Promise.<Object>
- .getCurrentScreen() ⇒
Promise.<AbstractScreen>
- .getCurrentScreenData() ⇒
Promise.<Object>
- .getEventBusData() ⇒
Object
- .getInputEventBusData() ⇒
Object
- .getViewData(viewHash) ⇒
Promise.<Object>
- .highlightView(viewHash)
- .onScreenHide(screenToHide)
- .getInfo() ⇒
Promise.<(Object|void)>
AbstractRemoteDebuggerService()
Class defining a Remote Debugger service.
initialize() ⇒ Promise
Function called before the initialization of the service to register a screen listener on the event bus.
Kind: instance method of AbstractRemoteDebuggerService
getProfile() ⇒ Promise.<Object>
Utility method to retrieve the current JSON profile used in the application.
Kind: instance method of AbstractRemoteDebuggerService
getCurrentScreen() ⇒ Promise.<AbstractScreen>
Utility method to retrieve the current screen.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Promise.<AbstractScreen>
- Returns a promise holding the current Screen
getCurrentScreenData() ⇒ Promise.<Object>
Utility method to retrieve the current screen data.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Promise.<Object>
- Returns a promise holding the current Screen data
getEventBusData() ⇒ Object
Utility method to retrieve the generic event bus events.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Object
- Returns an object holding the filtered event bus data
getInputEventBusData() ⇒ Object
Utility method to retrieve the input event bus events.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Object
- Returns an object holding the input event bus data
getViewData(viewHash) ⇒ Promise.<Object>
Utility method to retrieve the wanted view data.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Promise.<Object>
- Returns a promise holding the wanted view data
Param | Type | Description |
---|---|---|
viewHash | String | Hash value that is used to filter views |
highlightView(viewHash)
Method used to highlight (i.e. red border) a given view.
Kind: instance method of AbstractRemoteDebuggerService
Param | Type | Description |
---|---|---|
viewHash | String | Hash value that is used to filter views |
onScreenHide(screenToHide)
Event handler called to remove debugging child red rectangle item when current screen is hidden (i.e. screen has changed)
Kind: instance method of AbstractRemoteDebuggerService
Param | Type |
---|---|
screenToHide | Object |
getInfo() ⇒ Promise.<(Object|void)>
Method used to get some information from the middleware.
Kind: instance method of AbstractRemoteDebuggerService
Returns: Promise.<(Object|void)>
- Returning a Promise resolved with an embedded Object as {$$hash: string, hardwareVersion: any, softwareVersion: any, serialNumber: any, bootVersion: any, uiVersion: any, vendorName: any, modelName: any, deviceType: any, deviceModel: any, familyName: any, macAddress: any, userAgent: any, customerId: any, networkInfrastructureType: any, casInfo: any}