Class: ErrorEvent

  • The ErrorEvent class provides data for cast.framework.events.EventType.ERROR events.

  • The ErrorEvent constructor takes optional parameters for detailedErrorCode, error, reason, and severity.

  • ErrorEvent objects have properties for detailedErrorCode, error, reason, and severity, which provide more details about the error.

cast.framework.events.ErrorEvent

class   static

Event data for a cast.framework.events.EventType.ERROR event.

Constructor

ErrorEvent

new ErrorEvent(detailedErrorCode, error, reason, severity)

Parameter

detailedErrorCode

Optional

cast.framework.events.DetailedErrorCode

Value must not be null.

error

Optional

Object

Value must not be null.

reason

Optional

cast.framework.messages.ErrorReason

Value must not be null.

severity

Optional

cast.framework.events.ErrorSeverity

Value must not be null.

Properties

detailedErrorCode

constant

(non-null cast.framework.events.DetailedErrorCode or undefined)

An error code representing the cause of the error.

error

constant

(non-null Error, non-null Object, or undefined)

The error object. This could be an Error object (for example, if an Error was thrown in an event handler) or an object with error information (for example, if the receiver received an invalid command).

reason

(non-null cast.framework.messages.ErrorReason or undefined)

Optional error reason.

severity

(non-null cast.framework.events.ErrorSeverity or undefined)

Optional error severity.