FMLiveSwitchEventInfo Class Reference

Event information. More...

Instance Methods

(FMLiveSwitchChannelInfo *) - channel
 Gets the channel information. More...
 
(FMLiveSwitchClientInfo *) - client
 Gets the client information. More...
 
(FMLiveSwitchConnectionInfo *) - connection
 Gets the connection information. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(bool) - forced
 Gets whether this event was forced. More...
 
(instancetype) - init
 Initializes a new event. More...
 
(instancetype) - initWithType:
 Initializes a new event. More...
 
(FMLiveSwitchMessageInfo *) - message
 Gets the message information. More...
 
(NSString *) - origin
 Gets the event origin. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setChannel:
 Sets the channel information. More...
 
(void) - setClient:
 Sets the client information. More...
 
(void) - setConnection:
 Sets the connection information. More...
 
(void) - setForced:
 Sets whether this event was forced. More...
 
(void) - setMessage:
 Sets the message information. More...
 
(void) - setOrigin:
 Sets the event origin. More...
 
(void) - setTimestamp:
 Sets the event timestamp in milliseconds since epoch. More...
 
(void) - setType:
 Sets the event type. More...
 
(long long) - timestamp
 Gets the event timestamp in milliseconds since epoch. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
(NSString *) - type
 Gets the event type. More...
 
- Instance Methods inherited from FMLiveSwitchInfo
(NSString *) - id
 Gets the identifier. More...
 
(void) - setId:
 Sets the identifier. More...
 

Class Methods

(FMLiveSwitchEventInfo *) + eventInfo
 Initializes a new event. More...
 
(FMLiveSwitchEventInfo *) + eventInfoWithType:
 Initializes a new event. More...
 
(NSMutableArray *) + fromJsonArrayWithEventJsons:
 Deserializes an array from JSON. More...
 
(FMLiveSwitchEventInfo *) + fromJsonWithEventJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonArrayWithEvents:
 Serializes an array to JSON. More...
 
(NSString *) + toJsonWithEvt:
 Serializes an instance to JSON. More...
 
- Class Methods inherited from FMLiveSwitchInfo
(FMLiveSwitchInfo *) + info
 
(NSMutableArray *) + processArrayWithNewValues:oldValues:
 Processes an array for an info. More...
 
(NSMutableArray *) + processBooleanArrayWithNewValues:oldValues:
 Processes a boolean array for an info. More...
 
(FMLiveSwitchNullableBool *) + processBooleanWithNewValue:oldValue:
 Processes a boolean for an info. More...
 
(FMLiveSwitchNullableDouble *) + processDoubleWithNewValue:oldValue:
 Processes a double for an info. More...
 
(NSMutableArray *) + processFloatArrayWithNewValues:oldValues:
 Processes a float array for an info. More...
 
(FMLiveSwitchNullableFloat *) + processFloatWithNewValue:oldValue:
 Processes a float for an info. More...
 
(NSMutableArray *) + processIntegerArrayWithNewValues:oldValues:
 Processes a integer array for an info. More...
 
(FMLiveSwitchNullableInt *) + processIntegerWithNewValue:oldValue:
 Processes an integer for an info. More...
 
(NSMutableArray *) + processLongArrayWithNewValues:oldValues:
 Processes a long array for an info. More...
 
(FMLiveSwitchNullableLong *) + processLongWithNewValue:oldValue:
 Processes a long for an info. More...
 
(NSObject< FMLiveSwitchIEquivalent > *) + processObjectWithNewValue:oldValue:
 Processes an object for an info. More...
 
(NSMutableArray *) + processShortArrayWithNewValues:oldValues:
 Processes a short array for an info. More...
 
(FMLiveSwitchNullableShort *) + processShortWithNewValue:oldValue:
 Processes a short for an info. More...
 
(NSString *) + processStringWithNewValue:oldValue:
 Processes a string for an info. More...
 

Detailed Description

Event information.

Method Documentation

◆ channel

Gets the channel information.

◆ client

Gets the client information.

◆ connection

- (FMLiveSwitchConnectionInfo*) connection

Gets the connection information.

◆ deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey: (NSString *)  key
valueJson: (NSString *)  valueJson 

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchInfo.

◆ eventInfo

+ (FMLiveSwitchEventInfo*) eventInfo

Initializes a new event.

◆ eventInfoWithType:

+ (FMLiveSwitchEventInfo*) eventInfoWithType: (NSString *)  type

Initializes a new event.

Parameters
typeThe type.

◆ forced

- (bool) forced

Gets whether this event was forced.

◆ fromJsonArrayWithEventJsons:

+ (NSMutableArray*) fromJsonArrayWithEventJsons: (NSString *)  eventJsons

Deserializes an array from JSON.

◆ fromJsonWithEventJson:

+ (FMLiveSwitchEventInfo*) fromJsonWithEventJson: (NSString *)  eventJson

Deserializes an instance from JSON.

◆ init

- (instancetype) init

Initializes a new event.

Implements FMLiveSwitchInfo.

◆ initWithType:

- (instancetype) initWithType: (NSString *)  type

Initializes a new event.

Parameters
typeThe type.

◆ message

Gets the message information.

◆ origin

- (NSString*) origin

Gets the event origin.

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *)  jsonObject

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchInfo.

◆ setChannel:

- (void) setChannel: (FMLiveSwitchChannelInfo *)  value

Sets the channel information.

◆ setClient:

- (void) setClient: (FMLiveSwitchClientInfo *)  value

Sets the client information.

◆ setConnection:

- (void) setConnection: (FMLiveSwitchConnectionInfo *)  value

Sets the connection information.

◆ setForced:

- (void) setForced: (bool)  value

Sets whether this event was forced.

◆ setMessage:

- (void) setMessage: (FMLiveSwitchMessageInfo *)  value

Sets the message information.

◆ setOrigin:

- (void) setOrigin: (NSString *)  value

Sets the event origin.

◆ setTimestamp:

- (void) setTimestamp: (long long)  value

Sets the event timestamp in milliseconds since epoch.

◆ setType:

- (void) setType: (NSString *)  value

Sets the event type.

◆ timestamp

- (long long) timestamp

Gets the event timestamp in milliseconds since epoch.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithEvents:

+ (NSString*) toJsonArrayWithEvents: (NSMutableArray *)  events

Serializes an array to JSON.

◆ toJsonWithEvt:

+ (NSString*) toJsonWithEvt: (FMLiveSwitchEventInfo *)  evt

Serializes an instance to JSON.

◆ type

- (NSString*) type

Gets the event type.