Skip to main content

Interface: HealthCheck

api/model/sessionInfo.HealthCheck

Properties​

batteryLow​

• Optional batteryLow: boolean

Returns true if "Phone battery low" message is detected

Healthy: false

isHere​

• Optional isHere: boolean

Returns true if "Use Here" button is not detected

Healthy: true

isPhoneDisconnected​

• Optional isPhoneDisconnected: boolean

Whether or not the "Phone is disconnected" message is showing within the web app.

Healthy: false

online​

• Optional online: boolean

Result of window.navigator.onLine

Healthy: true

queuedMessages​

• Optional queuedMessages: number

The number of messages queued up in the browser. Messages can start being queued up due to the web app awaiting a connection with the host device.

Healthy: 0

retryingIn​

• Optional retryingIn: number

Returns the number of seconds the "Retrying in ..." dialog is indicating. If the dialog is not showing, it will return 0.

Healthy: 0

state​

• Optional state: STATE

The state of the web app.

Healthy: 'CONNECTED'

tryingToReachPhone​

• Optional tryingToReachPhone: boolean

Returns true if "trying to reach phone" dialog is detected

Healthy: false

wapiInjected​

• Optional wapiInjected: boolean

Returns true if the WAPI object is detected.

Healthy: true