Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Error

An error.

Hierarchy

  • Error

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Error(errorCode: ErrorCode, exception: Exception): Error
  • new Error(): Error
  • Initializes a new instance of the fm.icelink.error class.

    Parameters

    • errorCode: ErrorCode

      The error code.

    • exception: Exception

      The exception.

    Returns Error

  • Initializes a new instance of the fm.icelink.error class.

    Returns Error

Properties

Private _errorCode

_errorCode: ErrorCode
internal

Private _exception

_exception: Exception
internal

Methods

getDescription

  • getDescription(): string
  • Gets the description for this fm.icelink.error.

    Returns string

getErrorCode

  • getErrorCode(): ErrorCode
  • Gets the error code.

    Returns ErrorCode

getException

  • getException(): Exception
  • Gets the exception.

    Returns Exception

getTypeString

  • getTypeString(): string

  • Returns string

setErrorCode

  • setErrorCode(value: ErrorCode): void
  • Sets the error code.

    Parameters

    • value: ErrorCode

    Returns void

setException

  • setException(value: Exception): void
  • Sets the exception.

    Parameters

    • value: Exception

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

    The serialized JSON.

toString

  • toString(): string
  • Returns the string representation of this error.

    Returns string

Static fromJson

  • fromJson(errorJson: string): Error
  • Deserializes an instance from JSON.

    Parameters

    • errorJson: string

      The JSON to deserialize.

    Returns Error

    The deserialized error.

Static toJson

  • toJson(error: Error): string
  • Serializes an instance to JSON.

    Parameters

    • error: Error

      The error.

    Returns string

    The serialized JSON.