ARTChannels Class Reference


                    
                    
                    -exists:

Checks if a channel has been previously retrieved using the -[ARTChannels get:] method.

Declaration

Objective-C

- (BOOL)exists:(NSString *)name;

Swift

func exists(_ name: String!) -> Bool

Parameters


                                name

The channel name.

Return Value

true if the channel exists, otherwise false.


                    
                    
                    -get:

Creates a new ARTRestChannel or ARTRealtimeChannel object, or returns the existing channel object.

Declaration

Objective-C

- (ChannelType)get:(NSString *)name;

Swift

func get(_ name: String!) -> ChannelType!

Parameters


                                name

The channel name.

Return Value

A ARTRestChannel or ARTRealtimeChannel object.


                    
                    
                    -get:options:

Creates a new ARTRestChannel or ARTRealtimeChannel object, with the specified ARTChannelOptions, or returns the existing channel object.

Declaration

Objective-C

- (ChannelType)get:(NSString *)name options:(ARTChannelOptions *)options;

Swift

func get(_ name: String!, options: ARTChannelOptions!) -> ChannelType!

Parameters

`name`	The channel name.
`options`	An `ARTChannelOptions` object.

Return Value

A ARTRestChannel or ARTRealtimeChannel object.


                    
                    
                    -release:

Releases an ARTRestChannel or an ARTRealtimeChannel object by deleting it. It also removes any listeners associated with the channel. To release an ARTRealtimeChannel channel, the ARTRealtimeChannelProtocol.state must be ARTRealtimeChannelState.ARTRealtimeChannelInitialized, ARTRealtimeChannelState.ARTRealtimeChannelDetached, or ARTRealtimeChannelState.ARTRealtimeChannelFailed.

Declaration

Objective-C

- (void)release:(NSString *)name;

Swift

func release(_ name: String!)

Parameters


                                name

The channel name.


                    
                    
                    channels

Undocumented

Declaration

Objective-C

@property (nonatomic, readonly) NSMutableDictionary<NSString *, ChannelType> *channels

Swift

var channels: NSMutableDictionary { get }


                    
                    
                    nosyncIterable

Undocumented

Declaration

Objective-C

@property (readonly, getter=getNosyncIterable) id<NSFastEnumeration> nosyncIterable

Swift

var nosyncIterable: any NSFastEnumeration { get }


                    
                    
                    prefix

Undocumented

Declaration

Objective-C

@property (nonatomic, readonly) NSString *prefix

Swift

var prefix: String { get }


                    
                    
                    -addPrefix:

Undocumented

Declaration

Objective-C

- (NSString *)addPrefix:(NSString *)name;

Swift

func addPrefix(_ name: String) -> String


                    
                    
                    -_exists:

Undocumented

Declaration

Objective-C

- (BOOL)_exists:(NSString *)name;

Swift

func _exists(_ name: String) -> Bool


                    
                    
                    -_get:

Undocumented

Declaration

Objective-C

- (ChannelType)_get:(NSString *)name;

Swift

func _get(_ name: String) -> ChannelType


                    
                    
                    -_getChannel:options:addPrefix:

Undocumented

Declaration

Objective-C

- (ChannelType)_getChannel:(NSString *)name options:(ARTChannelOptions * _Nullable)options addPrefix:(BOOL)addPrefix;

Swift

func _getChannel(_ name: String, options: ARTChannelOptions?, addPrefix: Bool) -> ChannelType


                    
                    
                    -_release:

Undocumented

Declaration

Objective-C

- (void)_release:(NSString *)name;

Swift

func _release(_ name: String)


                    
                    
                    -initWithDelegate:dispatchQueue:prefix:

Undocumented

Declaration

Objective-C

- (instancetype)initWithDelegate:(id<ARTChannelsDelegate>)delegate dispatchQueue:(dispatch_queue_t)queue prefix:(nullable NSString *)prefix;

Swift

init(delegate: any ARTChannelsDelegate, dispatchQueue queue: dispatch_queue_t, prefix: String?)