Documentation

Class: PreflightTest

PreflightTest

A PreflightTest monitors progress of an ongoing preflight test.

Instance of PreflightTest is returned by calling module:twilio-video.runPreflight

Fires:

Extends

  • EventEmitter

Methods

stop()

stops ongoing tests and emits error

Events

completed

Preflight test has completed successfully.

Parameters:
Name Type Description
report PreflightTestReport

results of the test.

failed

Preflight test has encountered a failed and is now stopped.

Parameters:
Name Type Description
error TwilioError | Error

error object

progress

Emitted to indicate progress of the test

Parameters:
Name Type Description
progress PreflightProgress

indicates the status completed.