/ fm / liveswitch / Error
Class: Error
fm.liveswitch.Error
An error.
Table of contents
Constructors
Methods
- getCode
- getCodeValue
- getDescription
- getErrorCode
- getException
- getMessage
- getTypeString
- setCode
- setCodeValue
- setErrorCode
- setException
- setMessage
- toJson
- toString
- fromJson
- toJson
Constructors
constructor
+ new Error(): Error
Initializes a new instance of the [[fm.liveswitch.error]] class.
Returns: Error
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:15
+ new Error(code: ErrorCode, exception: Exception): Error
Initializes a new instance of the [[fm.liveswitch.error]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
code |
ErrorCode | The code. |
exception |
Exception | The exception. |
Returns: Error
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:22
+ new Error(code: ErrorCode, message: string): Error
Initializes a new instance of the [[fm.liveswitch.error]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
code |
ErrorCode | The code. |
message |
string | The message. |
Returns: Error
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:30
Methods
getCode
▸ getCode(): ErrorCode
Gets the code.
Returns: ErrorCode
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:115
getCodeValue
▸ getCodeValue(): number
Gets the code.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:127
getDescription
▸ getDescription(): string
Gets the description for this [[fm.liveswitch.error]].
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:139
getErrorCode
▸ getErrorCode(): ErrorCode
Gets the code.
deprecated Use Code instead.
Returns: ErrorCode
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:161
getException
▸ getException(): Exception
Gets the exception.
Returns: Exception
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:173
getMessage
▸ getMessage(): string
Gets the message.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:185
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:9
setCode
▸ setCode(value: ErrorCode): void
Sets the code.
Parameters:
| Name | Type |
|---|---|
value |
ErrorCode |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:197
setCodeValue
▸ setCodeValue(value: number): void
Sets the code.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:209
setErrorCode
▸ setErrorCode(value: ErrorCode): void
Sets the code.
deprecated Use Code instead.
Parameters:
| Name | Type |
|---|---|
value |
ErrorCode |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:223
setException
▸ setException(value: Exception): void
Sets the exception.
Parameters:
| Name | Type |
|---|---|
value |
Exception |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:235
setMessage
▸ setMessage(value: string): void
Sets the message.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:247
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:262
toString
▸ toString(): string
Returns the string representation of this error.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:274
fromJson
▸ StaticfromJson(errorJson: string): Error
Deserializes an instance from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
errorJson |
string | The JSON to deserialize. |
Returns: Error
The deserialized error.
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:69
toJson
▸ StatictoJson(error: Error): string
Serializes an instance to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Error | The error. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/Error.ts:98