/ fm / liveswitch / ClientStateRecord

Class: ClientStateRecord

fm.liveswitch.ClientStateRecord

Represents a single Client state transition record with timing information.

Table of contents

Constructors

• constructor

Methods

• fmliveswitchClientStateRecordInit
• getClientStateString
• getDateTime
• getState
• getTimeStamp
• getTypeString
• setDateTime
• setState
• setTimeStamp

Constructors

constructor

+ new ClientStateRecord(): ClientStateRecord

Returns: ClientStateRecord

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:22

Methods

fmliveswitchClientStateRecordInit

▸ PrivatefmliveswitchClientStateRecordInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:19

---

getClientStateString

▸ getClientStateString(): string

Gets the string representation of the client state.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:40

---

getDateTime

▸ getDateTime(): DateTime

Gets the UTC datetime when the state transition occurred.

Returns: DateTime

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:67

---

getState

▸ getState(): ClientState

Gets the Client state.

Returns: ClientState

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:79

---

getTimeStamp

▸ getTimeStamp(): number

Gets the millisecond timestamp when the state transition occurred.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:91

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.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/ClientStateRecord.ts:103

---

setState

▸ setState(value: ClientState): void

Sets the Client state.

Parameters:

Name	Type
value	ClientState

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ClientStateRecord.ts:115

---

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/ClientStateRecord.ts:127