/ fm / liveswitch / ConnectionStateRecord
Class: ConnectionStateRecord
fm.liveswitch.ConnectionStateRecord
Represents a single connection state transition record with timing information.
Table of contents
Constructors
Methods
- fmliveswitchConnectionStateRecordInit
- getDateTime
- getState
- getTimeStamp
- getTypeString
- setDateTime
- setState
- setTimeStamp
- toString
Constructors
constructor
+ new ConnectionStateRecord(): ConnectionStateRecord
Returns: ConnectionStateRecord
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:22
Methods
fmliveswitchConnectionStateRecordInit
▸ Private
fmliveswitchConnectionStateRecordInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:19
getDateTime
▸ getDateTime(): DateTime
Gets the UTC datetime when the state transition occurred.
Returns: DateTime
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:40
getState
▸ getState(): ConnectionState
Gets the connection state.
Returns: ConnectionState
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:52
getTimeStamp
▸ getTimeStamp(): number
Gets the millisecond timestamp when the state transition occurred.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:64
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:9
setDateTime
▸ setDateTime(value
: DateTime): void
Sets the UTC datetime when the state transition occurred.
Parameters:
Name | Type |
---|---|
value |
DateTime |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:76
setState
▸ setState(value
: ConnectionState): void
Sets the connection state.
Parameters:
Name | Type |
---|---|
value |
ConnectionState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:88
setTimeStamp
▸ setTimeStamp(value
: number): void
Sets the millisecond timestamp when the state transition occurred.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:100
toString
▸ toString(previousTime
: number): string
Creates a string representation of the state transition.
Parameters:
Name | Type | Description |
---|---|---|
previousTime |
number | The timestamp of the previous state transition in milliseconds. Use 0 for the initial state. |
Returns: string
A formatted string describing the state transition and duration if applicable.
Defined in: Generated/TypeScript/fm.liveswitch/ConnectionStateRecord.ts:116