FMLiveSwitchLogContext Class Reference

LogContext structure to hold ambient properties that can be attached to log events. More...

Instance Methods

(NSString *) - applicationId
 Gets the application Id. More...
 
(NSString *) - bundleTransportId
 Gets the bundle transport Id. More...
 
(NSString *) - candidateId
 Gets the candidate Id. More...
 
(NSString *) - candidatePairId
 Gets the candidate pair Id. More...
 
(NSString *) - channelId
 Gets the channel Id. More...
 
(NSString *) - clientId
 Gets the client Id. More...
 
(FMLiveSwitchLogContext *) - clone
 Clones this object, creating a new instance with the same property values. More...
 
(NSString *) - clusterConnectionId
 Gets cluster connection Id. More...
 
(NSString *) - connectionId
 Gets the connection Id. More...
 
(NSString *) - deviceId
 Gets the device Id. More...
 
(NSString *) - externalConnectionId
 Gets the external connection Id. More...
 
(NSString *) - gatewayId
 Gets the gateway Id. More...
 
(NSString *) - gathererId
 Gets the gatherer Id. More...
 
(NSString *) - iceTransportId
 Gets the Ice transport Id. More...
 
(instancetype) - init
 
(NSString *) - mediaDescriptionManagerId
 Gets the media description manager Id. More...
 
(NSString *) - mediaServerId
 Gets the media server Id. More...
 
(NSString *) - sctpTrasnportId
 Gets the Sctp transport Id. More...
 
(void) - setApplicationId:
 Sets the application Id. More...
 
(void) - setBundleTransportId:
 Sets the bundle transport Id. More...
 
(void) - setCandidateId:
 Sets the candidate Id. More...
 
(void) - setCandidatePairId:
 Sets the candidate pair Id. More...
 
(void) - setChannelId:
 Sets the channel Id. More...
 
(void) - setClientId:
 Sets the client Id. More...
 
(void) - setClusterConnectionId:
 Sets cluster connection Id. More...
 
(void) - setConnectionId:
 Sets the connection Id. More...
 
(void) - setDeviceId:
 Sets the device Id. More...
 
(void) - setExternalConnectionId:
 Sets the external connection Id. More...
 
(void) - setGatewayId:
 Sets the gateway Id. More...
 
(void) - setGathererId:
 Sets the gatherer Id. More...
 
(void) - setIceTransportId:
 Sets the Ice transport Id. More...
 
(void) - setMediaDescriptionManagerId:
 Sets the media description manager Id. More...
 
(void) - setMediaServerId:
 Sets the media server Id. More...
 
(void) - setSctpTrasnportId:
 Sets the Sctp transport Id. More...
 
(void) - setSiteId:
 Sets the site Id. More...
 
(void) - setSocketManagerId:
 Sets the socket manager Id. More...
 
(void) - setStreamId:
 Sets the stream Id. More...
 
(void) - setUserId:
 Sets the user Id. More...
 
(NSString *) - siteId
 Gets the site Id. More...
 
(NSString *) - socketManagerId
 Gets the socket manager Id. More...
 
(NSString *) - streamId
 Gets the stream Id. More...
 
(NSMutableArray *) - toPairArray
 Returns a paired array rerpresentation of this log context. More...
 
(NSString *) - userId
 Gets the user Id. More...
 

Class Methods

(FMLiveSwitchLogContext *) + fromJsonWithValueJson:
 Deserializes json into a LogContext object. More...
 
(FMLiveSwitchLogContext *) + logContext
 

Detailed Description

LogContext structure to hold ambient properties that can be attached to log events.

Method Documentation

◆ applicationId

- (NSString*) applicationId

Gets the application Id.

◆ bundleTransportId

- (NSString*) bundleTransportId

Gets the bundle transport Id.

◆ candidateId

- (NSString*) candidateId

Gets the candidate Id.

◆ candidatePairId

- (NSString*) candidatePairId

Gets the candidate pair Id.

◆ channelId

- (NSString*) channelId

Gets the channel Id.

◆ clientId

- (NSString*) clientId

Gets the client Id.

◆ clone

Clones this object, creating a new instance with the same property values.

Returns
A new LogContext instance with the same properties as this instance.

◆ clusterConnectionId

- (NSString*) clusterConnectionId

Gets cluster connection Id.

◆ connectionId

- (NSString*) connectionId

Gets the connection Id.

◆ deviceId

- (NSString*) deviceId

Gets the device Id.

◆ externalConnectionId

- (NSString*) externalConnectionId

Gets the external connection Id.

◆ fromJsonWithValueJson:

+ (FMLiveSwitchLogContext*) fromJsonWithValueJson: (NSString *)  valueJson

Deserializes json into a LogContext object.

Parameters
valueJsonValue to deserialize
Returns
Logcontext

◆ gatewayId

- (NSString*) gatewayId

Gets the gateway Id.

◆ gathererId

- (NSString*) gathererId

Gets the gatherer Id.

◆ iceTransportId

- (NSString*) iceTransportId

Gets the Ice transport Id.

◆ init

- (instancetype) init

◆ logContext

+ (FMLiveSwitchLogContext*) logContext

◆ mediaDescriptionManagerId

- (NSString*) mediaDescriptionManagerId

Gets the media description manager Id.

◆ mediaServerId

- (NSString*) mediaServerId

Gets the media server Id.

◆ sctpTrasnportId

- (NSString*) sctpTrasnportId

Gets the Sctp transport Id.

◆ setApplicationId:

- (void) setApplicationId: (NSString *)  value

Sets the application Id.

◆ setBundleTransportId:

- (void) setBundleTransportId: (NSString *)  value

Sets the bundle transport Id.

◆ setCandidateId:

- (void) setCandidateId: (NSString *)  value

Sets the candidate Id.

◆ setCandidatePairId:

- (void) setCandidatePairId: (NSString *)  value

Sets the candidate pair Id.

◆ setChannelId:

- (void) setChannelId: (NSString *)  value

Sets the channel Id.

◆ setClientId:

- (void) setClientId: (NSString *)  value

Sets the client Id.

◆ setClusterConnectionId:

- (void) setClusterConnectionId: (NSString *)  value

Sets cluster connection Id.

◆ setConnectionId:

- (void) setConnectionId: (NSString *)  value

Sets the connection Id.

◆ setDeviceId:

- (void) setDeviceId: (NSString *)  value

Sets the device Id.

◆ setExternalConnectionId:

- (void) setExternalConnectionId: (NSString *)  value

Sets the external connection Id.

◆ setGatewayId:

- (void) setGatewayId: (NSString *)  value

Sets the gateway Id.

◆ setGathererId:

- (void) setGathererId: (NSString *)  value

Sets the gatherer Id.

◆ setIceTransportId:

- (void) setIceTransportId: (NSString *)  value

Sets the Ice transport Id.

◆ setMediaDescriptionManagerId:

- (void) setMediaDescriptionManagerId: (NSString *)  value

Sets the media description manager Id.

◆ setMediaServerId:

- (void) setMediaServerId: (NSString *)  value

Sets the media server Id.

◆ setSctpTrasnportId:

- (void) setSctpTrasnportId: (NSString *)  value

Sets the Sctp transport Id.

◆ setSiteId:

- (void) setSiteId: (NSString *)  value

Sets the site Id.

◆ setSocketManagerId:

- (void) setSocketManagerId: (NSString *)  value

Sets the socket manager Id.

◆ setStreamId:

- (void) setStreamId: (NSString *)  value

Sets the stream Id.

◆ setUserId:

- (void) setUserId: (NSString *)  value

Sets the user Id.

◆ siteId

- (NSString*) siteId

Gets the site Id.

◆ socketManagerId

- (NSString*) socketManagerId

Gets the socket manager Id.

◆ streamId

- (NSString*) streamId

Gets the stream Id.

◆ toPairArray

- (NSMutableArray*) toPairArray

Returns a paired array rerpresentation of this log context.

◆ userId

- (NSString*) userId

Gets the user Id.