FDC3Error

Class used to hold errors returned by the FDC3 provider. Inherits from the built-in Error type.

Note that not all errors raised by the service will be of type FDC3Error. Standard JavaScript error types such as TypeError and Error can also be thrown by the API.

Hierarchy

  • Error
    • FDC3Error

Index

Constructors

Properties

Constructors

constructor

  • new FDC3Error(code: string, message: string): FDC3Error

Properties

code

code: string

A string from one of ApplicationError, ChannelError, ConnectionError, ResolveError or SendContextError.

Future versions of the service may add additional error codes. Applications should allow for the possibility of error codes that do not exist in the above enumerations.

message

message: string

Description of the error that occurred.

These messages are not intended to be user-friendly, we do not advise displaying them to end users. If error-specific user messaging is required, use code to determine what message should be displayed.

name

name: string

Always 'FDC3Error'.

Optional stack

stack: undefined | string

Static Error

Error: ErrorConstructor