/ fm / liveswitch / EventInfo
Class: EventInfo
fm.liveswitch.EventInfo
Event information.
Hierarchy
-
↳ EventInfo
Table of contents
Constructors
Methods
- deserializeProperties
- fmliveswitchEventInfoInit
- getChannel
- getClient
- getConnection
- getForced
- getId
- getMessage
- getOrigin
- getTimestamp
- getType
- getTypeString
- serializeProperties
- setChannel
- setClient
- setConnection
- setForced
- setId
- setMessage
- setOrigin
- setTimestamp
- setType
- toJson
- fromJson
- fromJsonArray
- processArray
- processBoolean
- processBooleanArray
- processDouble
- processFloat
- processFloatArray
- processInteger
- processIntegerArray
- processLong
- processLongArray
- processObject
- processShort
- processShortArray
- processString
- toJson
- toJsonArray
Constructors
constructor
+ new EventInfo(): EventInfo
Initializes a new event.
Returns: EventInfo
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:34
+ new EventInfo(type
: string): EventInfo
Initializes a new event.
Parameters:
Name | Type | Description |
---|---|---|
type |
string | The type. |
Returns: EventInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:40
Methods
deserializeProperties
▸ Protected
deserializeProperties(key
: string, valueJson
: string): void
Deserializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The key. |
valueJson |
string | The value in JSON format. |
Returns: void
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:135
fmliveswitchEventInfoInit
▸ Private
fmliveswitchEventInfoInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:30
getChannel
▸ getChannel(): ChannelInfo
Gets the channel information.
Returns: ChannelInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:178
getClient
▸ getClient(): ClientInfo
Gets the client information.
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:190
getConnection
▸ getConnection(): ConnectionInfo
Gets the connection information.
Returns: ConnectionInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:202
getForced
▸ getForced(): boolean
Gets whether this event was forced.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:214
getId
▸ getId(): string
Gets the identifier.
Returns: string
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336
getMessage
▸ getMessage(): MessageInfo
Gets the message information.
Returns: MessageInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:226
getOrigin
▸ getOrigin(): string
Gets the event origin.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:238
getTimestamp
▸ getTimestamp(): number
Gets the event timestamp in milliseconds since epoch.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:250
getType
▸ getType(): string
Gets the event type.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:262
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:10
serializeProperties
▸ Protected
serializeProperties(jsonObject
: Hash<string, string>): void
Serializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
jsonObject |
Hash<string, string> | The JSON object. |
Returns: void
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:275
setChannel
▸ setChannel(value
: ChannelInfo): void
Sets the channel information.
Parameters:
Name | Type |
---|---|
value |
ChannelInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:314
setClient
▸ setClient(value
: ClientInfo): void
Sets the client information.
Parameters:
Name | Type |
---|---|
value |
ClientInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:326
setConnection
▸ setConnection(value
: ConnectionInfo): void
Sets the connection information.
Parameters:
Name | Type |
---|---|
value |
ConnectionInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:338
setForced
▸ setForced(value
: boolean): void
Sets whether this event was forced.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:350
setId
▸ setId(value
: string): void
Sets the identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363
setMessage
▸ setMessage(value
: MessageInfo): void
Sets the message information.
Parameters:
Name | Type |
---|---|
value |
MessageInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:362
setOrigin
▸ setOrigin(value
: string): void
Sets the event origin.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:374
setTimestamp
▸ setTimestamp(value
: number): void
Sets the event timestamp in milliseconds since epoch.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:386
setType
▸ setType(value
: string): void
Sets the event type.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:399
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:411
fromJson
▸ Static
fromJson(eventJson
: string): EventInfo
Deserializes an instance from JSON.
Parameters:
Name | Type |
---|---|
eventJson |
string |
Returns: EventInfo
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:75
fromJsonArray
▸ Static
fromJsonArray(eventJsons
: string): EventInfo[]
Deserializes an array from JSON.
Parameters:
Name | Type |
---|---|
eventJsons |
string |
Returns: EventInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:91
processArray
▸ Static
processArray<T>(newValues
: T[], oldValues
: T[]): T[]
Processes an array for an info.
Type parameters:
Name | Type |
---|---|
T |
IEquivalent<T, T> |
Parameters:
Name | Type | Description |
---|---|---|
newValues |
T[] | The new values. |
oldValues |
T[] | The old values. |
Returns: T[]
The new values, if the new values are not equivalent to the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34
processBoolean
▸ Static
processBoolean(newValue
: boolean, oldValue
: boolean): boolean
Processes a boolean for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
boolean | The new value. |
oldValue |
boolean | The old value. |
Returns: boolean
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60
processBooleanArray
▸ Static
processBooleanArray(newValues
: boolean[], oldValues
: boolean[]): boolean[]
Processes a boolean array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
boolean[] | The new values. |
oldValues |
boolean[] | The old values. |
Returns: boolean[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75
processDouble
▸ Static
processDouble(newValue
: number, oldValue
: number): number
Processes a double for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101
processFloat
▸ Static
processFloat(newValue
: number, oldValue
: number): number
Processes a float for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116
processFloatArray
▸ Static
processFloatArray(newValues
: number[], oldValues
: number[]): number[]
Processes a float array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131
processInteger
▸ Static
processInteger(newValue
: number, oldValue
: number): number
Processes an integer for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157
processIntegerArray
▸ Static
processIntegerArray(newValues
: number[], oldValues
: number[]): number[]
Processes a integer array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174
processLong
▸ Static
processLong(newValue
: number, oldValue
: number): number
Processes a long for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200
processLongArray
▸ Static
processLongArray(newValues
: number[], oldValues
: number[]): number[]
Processes a long array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217
processObject
▸ Static
processObject<T>(newValue
: T, oldValue
: T): T
Processes an object for an info.
Type parameters:
Name | Type |
---|---|
T |
Object & IEquivalent<T, T> |
Parameters:
Name | Type | Description |
---|---|---|
newValue |
T | The new value. |
oldValue |
T | The old value. |
Returns: T
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243
processShort
▸ Static
processShort(newValue
: number, oldValue
: number): number
Processes a short for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264
processShortArray
▸ Static
processShortArray(newValues
: number[], oldValues
: number[]): number[]
Processes a short array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281
processString
▸ Static
processString(newValue
: string, oldValue
: string): string
Processes a string for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
string | The new value. |
oldValue |
string | The old value. |
Returns: string
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307
toJson
▸ Static
toJson(evt
: EventInfo): string
Serializes an instance to JSON.
Parameters:
Name | Type |
---|---|
evt |
EventInfo |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:107
toJsonArray
▸ Static
toJsonArray(events
: EventInfo[]): string
Serializes an array to JSON.
Parameters:
Name | Type |
---|---|
events |
EventInfo[] |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/EventInfo.ts:121