FMLiveSwitchCandidateInfo Class Reference

Candidate information. More...

Instance Methods

(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchCandidateInfo class. More...
 
(NSString *) - ipAddress
 Gets the candidate IP address. More...
 
(FMLiveSwitchNullableInt *) - port
 Gets the candidate port. More...
 
(FMLiveSwitchNullableLong *) - priority
 Gets the candidate priority. More...
 
(NSString *) - protocol
 Gets the candidate protocol. More...
 
(NSString *) - relatedIPAddress
 Gets the candidate related IP address. More...
 
(FMLiveSwitchNullableInt *) - relatedPort
 Gets the candidate related port. More...
 
(NSString *) - relayProtocol
 Gets the candidate relay protocol. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setIPAddress:
 Sets the candidate IP address. More...
 
(void) - setPort:
 Sets the candidate port. More...
 
(void) - setPriority:
 Sets the candidate priority. More...
 
(void) - setProtocol:
 Sets the candidate protocol. More...
 
(void) - setRelatedIPAddress:
 Sets the candidate related IP address. More...
 
(void) - setRelatedPort:
 Sets the candidate related port. More...
 
(void) - setRelayProtocol:
 Sets the candidate relay protocol. More...
 
(void) - setType:
 Sets the candidate type. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
(NSString *) - type
 Gets the candidate type. More...
 
- Instance Methods inherited from FMLiveSwitchInfo
(NSString *) - id
 Gets the identifier. More...
 
(void) - setId:
 Sets the identifier. More...
 

Class Methods

(FMLiveSwitchCandidateInfo *) + candidateInfo
 Initializes a new instance of the FMLiveSwitchCandidateInfo class. More...
 
(NSMutableArray *) + fromJsonArrayWithCandidateReportsJson:
 Deserializes an array from JSON. More...
 
(FMLiveSwitchCandidateInfo *) + fromJsonWithCandidateReportJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonArrayWithCandidateReports:
 Serializes an array to JSON. More...
 
(NSString *) + toJsonWithCandidateReport:
 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

Candidate information.

Method Documentation

◆ candidateInfo

+ (FMLiveSwitchCandidateInfo*) candidateInfo

Initializes a new instance of the FMLiveSwitchCandidateInfo class.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchInfo.

◆ fromJsonArrayWithCandidateReportsJson:

+ (NSMutableArray*) fromJsonArrayWithCandidateReportsJson: (NSString *)  candidateReportsJson

Deserializes an array from JSON.

Parameters
candidateReportsJsonThe JSON.
Returns
The deserialized array.

◆ fromJsonWithCandidateReportJson:

+ (FMLiveSwitchCandidateInfo*) fromJsonWithCandidateReportJson: (NSString *)  candidateReportJson

Deserializes an instance from JSON.

Parameters
candidateReportJsonThe JSON.
Returns
The deserialized instance.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchCandidateInfo class.

Implements FMLiveSwitchInfo.

◆ ipAddress

- (NSString*) ipAddress

Gets the candidate IP address.

◆ port

- (FMLiveSwitchNullableInt*) port

Gets the candidate port.

◆ priority

- (FMLiveSwitchNullableLong*) priority

Gets the candidate priority.

◆ protocol

- (NSString*) protocol

Gets the candidate protocol.

◆ relatedIPAddress

- (NSString*) relatedIPAddress

Gets the candidate related IP address.

◆ relatedPort

- (FMLiveSwitchNullableInt*) relatedPort

Gets the candidate related port.

◆ relayProtocol

- (NSString*) relayProtocol

Gets the candidate relay protocol.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchInfo.

◆ setIPAddress:

- (void) setIPAddress: (NSString *)  value

Sets the candidate IP address.

◆ setPort:

- (void) setPort: (FMLiveSwitchNullableInt *)  value

Sets the candidate port.

◆ setPriority:

- (void) setPriority: (FMLiveSwitchNullableLong *)  value

Sets the candidate priority.

◆ setProtocol:

- (void) setProtocol: (NSString *)  value

Sets the candidate protocol.

◆ setRelatedIPAddress:

- (void) setRelatedIPAddress: (NSString *)  value

Sets the candidate related IP address.

◆ setRelatedPort:

- (void) setRelatedPort: (FMLiveSwitchNullableInt *)  value

Sets the candidate related port.

◆ setRelayProtocol:

- (void) setRelayProtocol: (NSString *)  value

Sets the candidate relay protocol.

◆ setType:

- (void) setType: (NSString *)  value

Sets the candidate type.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithCandidateReports:

+ (NSString*) toJsonArrayWithCandidateReports: (NSMutableArray *)  candidateReports

Serializes an array to JSON.

Parameters
candidateReportsThe array.
Returns
The serialized JSON.

◆ toJsonWithCandidateReport:

+ (NSString*) toJsonWithCandidateReport: (FMLiveSwitchCandidateInfo *)  candidateReport

Serializes an instance to JSON.

Parameters
candidateReportThe instance.
Returns
The serialized JSON.

◆ type

- (NSString*) type

Gets the candidate type.