FMLiveSwitchDynamic Class Reference

Supplies class instances with a key-value mapping to support dynamic property storage. More...

Instance Methods
(NSMutableDictionary< NSString *, id > *)	- dynamicProperties
	Gets all dynamic properties on this instance. More...
(id)	- getDynamicValueWithKey:
	Gets a property value from the local cache. More...
(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchSerializable class. More...
(void)	- setDynamicValueWithKey:value:
	Sets a property value in the local cache. More...
(bool)	- unsetDynamicValueWithKey:
	Removes a property value from the local cache. More...

Class Methods
(FMLiveSwitchDynamic *)	+ dynamic
Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *)	+ serializable
	Initializes a new instance of the FMLiveSwitchSerializable class. More...

Detailed Description

Supplies class instances with a key-value mapping to support dynamic property storage.

Method Documentation

dynamic

+ (FMLiveSwitchDynamic*) dynamic

dynamicProperties

- (NSMutableDictionary<NSString*,id>*) dynamicProperties

Gets all dynamic properties on this instance.

getDynamicValueWithKey:

- (id) getDynamicValueWithKey:

(NSString *)

key

Gets a property value from the local cache.

Parameters

key	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns

The stored value, if found; otherwise null.

init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchSerializable class.

Implements FMLiveSwitchSerializable.

Implemented in FMLiveSwitchXirSysV3IceServer, FMLiveSwitchXirSysV2IceServer, FMLiveSwitchWebSocketStreamFailureArgs, FMLiveSwitchWebSocketSendArgs, FMLiveSwitchWebSocketReceiveArgs, FMLiveSwitchWebSocketOpenSuccessArgs, FMLiveSwitchWebSocketOpenFailureArgs, FMLiveSwitchWebSocketOpenArgs, FMLiveSwitchWebSocketCloseCompleteArgs, FMLiveSwitchWebSocketCloseArgs, FMLiveSwitchTransport, FMLiveSwitchStunServer, FMLiveSwitchStatControlFrame, FMLiveSwitchSRControlFrame, FMLiveSwitchSliControlFrame, FMLiveSwitchSignallingSuccessArgs, FMLiveSwitchSignallingServiceArgs, FMLiveSwitchSignallingServerUnsubscribeArgs, FMLiveSwitchSignallingServerSubscribeArgs, FMLiveSwitchSignallingServerArgs, FMLiveSwitchSignallingOutputArgs, FMLiveSwitchSignallingMessageBase, FMLiveSwitchSignallingInputArgs, FMLiveSwitchSignallingFailureArgs, FMLiveSwitchSignallingExtensions, FMLiveSwitchSignallingExtensible, FMLiveSwitchSignallingDisconnectCompleteArgs, FMLiveSwitchSignallingDisconnectArgs, FMLiveSwitchSignallingConnectSuccessArgs, FMLiveSwitchSignallingConnectFailureArgs, FMLiveSwitchSignallingConnectArgs, FMLiveSwitchSignallingCompleteArgs, FMLiveSwitchSignallingClientResponse, FMLiveSwitchSignallingClientRequest, FMLiveSwitchSdesControlFrame, FMLiveSwitchRRControlFrame, FMLiveSwitchRpsiControlFrame, FMLiveSwitchPliControlFrame, FMLiveSwitchMediaTrackBase, FMLiveSwitchMediaSourceBase, FMLiveSwitchMediaSinkBase, FMLiveSwitchMediaControlFrame, FMLiveSwitchLayoutPreset, FMLiveSwitchIceSendResponseSuccessArgs, FMLiveSwitchIceSendResponseFailureArgs, FMLiveSwitchIceSendResponseCompleteArgs, FMLiveSwitchIceSendRequestCompleteArgs, FMLiveSwitchIceSendRequestBeforeSendArgs, FMLiveSwitchHttpWebRequestSender, FMLiveSwitchHttpRequestArgs, FMLiveSwitchGenericNackControlFrame, FMLiveSwitchByeControlFrame, and FMLiveSwitchAppControlFrame.

setDynamicValueWithKey:value:

- (void) setDynamicValueWithKey:		(NSString *)	key
value:		(id)	value

Sets a property value in the local cache.

Parameters

key	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
value	The property value. This can be any object that needs to be stored for future use.

unsetDynamicValueWithKey:

- (bool) unsetDynamicValueWithKey:

(NSString *)

key

Removes a property value from the local cache.

Returns true if the value was removed and returns false otherwise.

Parameters

key	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns

true if the value was removed; otherwise, false.