ARTRealtimeChannelInternal

Objective-C

@property (readonly) ARTRealtimePresenceInternal *presence

Swift

var presence: ARTRealtimePresenceInternal { get }

Objective-C

@property (readonly) ARTRealtimeAnnotationsInternal *annotations

Swift

var annotations: ARTRealtimeAnnotationsInternal { get }

Objective-C

@property (readonly) ARTPushChannelInternal *push

Swift

var push: ARTPushChannelInternal { get }

Objective-C

@property (nonatomic) ARTRealtimeChannelState state

Swift

var state: ARTRealtimeChannelState { get set }

Objective-C

@property (nonatomic) ARTChannelMode modes

Swift

var modes: ARTChannelMode { get set }

Objective-C

@property (readonly, nonatomic, nullable) ARTErrorInfo *errorReason

Swift

var errorReason: ARTErrorInfo? { get }

Objective-C

@property (readonly, nullable, getter=getOptions_nosync) ARTRealtimeChannelOptions *options_nosync

Objective-C

@property (nonatomic, readonly) NSString *connectionId

Swift

var connectionId: String { get }

Objective-C

- (ARTRealtimeChannelState)state_nosync;

Swift

func state_nosync() -> ARTRealtimeChannelState

Objective-C

- (ARTChannelMode)modes_nosync;

Swift

func modes_nosync() -> ARTChannelMode

Objective-C

- (ARTErrorInfo *)errorReason_nosync;

Swift

func errorReason_nosync() -> ARTErrorInfo

Objective-C

- (NSString * _Nullable)clientId_nosync;

Swift

func clientId_nosync() -> String?

Objective-C

- (ARTChannelProperties *)properties_nosync;

Swift

func properties_nosync() -> ARTChannelProperties

Objective-C

- (BOOL)canBeReattached;

Swift

func canBeReattached() -> Bool

Objective-C

- (BOOL)shouldAttach;

Swift

func shouldAttach() -> Bool

Objective-C

- (BOOL)isAnnotationSubscribeGranted;

Swift

func isAnnotationSubscribeGranted() -> Bool

Objective-C

@property (readonly, weak, nonatomic) ARTRealtimeInternal *realtime

Swift

weak var realtime: ARTRealtimeInternal? { get }

Objective-C

@property (readonly, nonatomic) ARTRestChannelInternal *restChannel

Swift

var restChannel: ARTRestChannelInternal { get }

Objective-C

@property (nonatomic, nullable) NSString *attachSerial

Swift

var attachSerial: String? { get set }

Objective-C

@property (nonatomic, nullable) NSString *channelSerial

Swift

var channelSerial: String? { get set }

Objective-C

@property (readonly, nullable, getter=getClientId) NSString *clientId

Swift

var clientId: String? { get }

Objective-C

@property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTChannelStateChange *> *internalEventEmitter

Swift

var internalEventEmitter: ARTEventEmitter<ARTEvent, ARTChannelStateChange> { get }

Objective-C

@property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTChannelStateChange *> *statesEventEmitter

Swift

var statesEventEmitter: ARTEventEmitter<ARTEvent, ARTChannelStateChange> { get }

Objective-C

@property (readonly, nonatomic) ARTEventEmitter<id<ARTEventIdentification>, ARTMessage *> *messagesEventEmitter

Swift

var messagesEventEmitter: ARTEventEmitter<any ARTEventIdentification, ARTMessage> { get }

Objective-C

@property (nonatomic) BOOL attachResume

Swift

var attachResume: Bool { get set }

Objective-C

- (instancetype)initWithRealtime:(ARTRealtimeInternal *)realtime andName:(NSString *)name withOptions:(ARTRealtimeChannelOptions *)options logger:(ARTInternalLog *)logger;

Swift

init(realtime: ARTRealtimeInternal, andName name: String, with options: ARTRealtimeChannelOptions, logger: InternalLog)

Objective-C

- (void)proceedAttachDetachWithParams:(ARTAttachRequestParams *)params;

Swift

func proceedAttachDetach(with params: AttachRequestParams)

Objective-C

- (void)_attach:(nullable ARTCallback)callback;

Swift

func _attach(_ callback: ARTCallback? = nil)

Objective-C

- (void)_detach:(nullable ARTCallback)callback;

Swift

func _detach(_ callback: ARTCallback? = nil)

Objective-C

- (void)_unsubscribe;

Swift

func _unsubscribe()

Objective-C

- (void)off_nosync;

Swift

func off_nosync()

Objective-C

@property (nonatomic) dispatch_queue_t queue

Swift

var queue: dispatch_queue_t { get set }

Objective-C

@property (readonly) ARTChannelProperties *properties

Swift

var properties: ARTChannelProperties { get }

Objective-C

@property (readonly, nullable, getter=getOptions) ARTRealtimeChannelOptions *options

Objective-C

- (void)attach;

Swift

func attach()

Objective-C

- (void)attach:(nullable ARTCallback)callback;

Swift

func attach(_ callback: ARTCallback? = nil)

Objective-C

- (void)detach;

Swift

func detach()

Objective-C

- (void)detach:(nullable ARTCallback)callback;

Swift

func detach(_ callback: ARTCallback? = nil)

Objective-C

- (ARTEventListener *_Nullable)subscribe:(ARTMessageCallback)callback;

Swift

func subscribe(_ callback: @escaping ARTMessageCallback) -> ARTEventListener?

Objective-C

- (ARTEventListener *_Nullable)subscribeWithAttachCallback:(nullable ARTCallback)onAttach callback:(ARTMessageCallback)callback;

Swift

func subscribe(attachCallback onAttach: ARTCallback?, callback: @escaping ARTMessageCallback) -> ARTEventListener?

Objective-C

- (ARTEventListener *_Nullable)subscribe:(NSString *)name callback:(ARTMessageCallback)callback;

Swift

func subscribe(_ name: String, callback: @escaping ARTMessageCallback) -> ARTEventListener?

Objective-C

- (ARTEventListener *_Nullable)subscribe:(NSString *)name onAttach:(nullable ARTCallback)onAttach callback:(ARTMessageCallback)callback;

Swift

func subscribe(_ name: String, onAttach: ARTCallback?, callback: @escaping ARTMessageCallback) -> ARTEventListener?

Objective-C

- (void)unsubscribe;

Swift

func unsubscribe()

Objective-C

- (void)unsubscribe:(ARTEventListener *_Nullable)listener;

Swift

func unsubscribe(_ listener: ARTEventListener?)

Objective-C

- (void)unsubscribe:(NSString *)name listener:(ARTEventListener *_Nullable)listener;

Swift

func unsubscribe(_ name: String, listener: ARTEventListener?)

Objective-C

- (void)historyWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                         completion:(ARTPaginatedMessagesCallback)callback;

Swift

func history(withWrapperSDKAgents wrapperSDKAgents: [String : String]?) async -> (ARTPaginatedResult<ARTMessage>?, ARTErrorInfo?)

Objective-C

- (BOOL)history:(ARTRealtimeHistoryQuery *_Nullable)query wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTPaginatedMessagesCallback)callback error:(NSError *_Nullable *_Nullable)errorPtr;

Swift

func history(_ query: ARTRealtimeHistoryQuery?, wrapperSDKAgents: [String : String]?, callback: @escaping ARTPaginatedMessagesCallback) throws

Objective-C

- (void)setOptions:(ARTRealtimeChannelOptions *_Nullable)options callback:(nullable ARTCallback)callback;

Swift

func setOptions(_ options: ARTRealtimeChannelOptions?, callback: ARTCallback? = nil)

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func on(_ event: ARTChannelEvent, callback cb: @escaping (ARTChannelStateChange) -> Void) -> ARTEventListener

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func on(_ cb: @escaping (ARTChannelStateChange) -> Void) -> ARTEventListener

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func once(_ event: ARTChannelEvent, callback cb: @escaping (ARTChannelStateChange) -> Void) -> ARTEventListener

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func once(_ cb: @escaping (ARTChannelStateChange) -> Void) -> ARTEventListener

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func off(_ event: ARTChannelEvent, listener: ARTEventListener)

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func off(_ listener: ARTEventListener)

Objective-C

ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)

Swift

func off()

Objective-C

- (void)performTransitionToState:(ARTRealtimeChannelState)state withParams:(ARTChannelStateChangeParams *)params;

Swift

func performTransition(to state: ARTRealtimeChannelState, with params: ChannelStateChangeParams)

Objective-C

- (void)onChannelMessage:(ARTProtocolMessage *)message;

Swift

func onChannelMessage(_ message: ARTProtocolMessage)

Objective-C

- (void)publishProtocolMessage:(nonnull ARTProtocolMessage *)pm
                      callback:(nonnull ARTStatusCallback)cb;

Swift

func publishProtocolMessage(_ pm: ARTProtocolMessage, callback cb: @escaping ARTStatusCallback)

Objective-C

- (void)setAttached:(ARTProtocolMessage *)message;

Swift

func setAttached(_ message: ARTProtocolMessage)

Objective-C

- (void)setDetached:(ARTProtocolMessage *)message;

Swift

func setDetached(_ message: ARTProtocolMessage)

Objective-C

- (void)onMessage:(ARTProtocolMessage *)message;

Swift

func onMessage(_ message: ARTProtocolMessage)

Objective-C

- (void)onPresence:(ARTProtocolMessage *)message;

Swift

func onPresence(_ message: ARTProtocolMessage)

Objective-C

- (void)onSync:(ARTProtocolMessage *)message;

Swift

func onSync(_ message: ARTProtocolMessage)

Objective-C

- (void)onError:(ARTProtocolMessage *)error;

Swift

func onError(_ error: ARTProtocolMessage)

Objective-C

- (void)setSuspended:(ARTChannelStateChangeParams *)params;

Swift

func setSuspended(_ params: ChannelStateChangeParams)

Objective-C

- (void)setFailed:(ARTChannelStateChangeParams *)params;

Swift

func setFailed(_ params: ChannelStateChangeParams)

Objective-C

- (void)detachChannel:(ARTChannelStateChangeParams *)params;

Swift

func detachChannel(_ params: ChannelStateChangeParams)

Objective-C

- (void)emit:(ARTChannelEvent)event with:(ARTChannelStateChange *)data;

Swift

func emit(_ event: ARTChannelEvent, with data: ARTChannelStateChange)

Objective-C

- (void)setPluginDataValue:(nonnull id)value forKey:(nonnull NSString *)key;

Swift

func setPluginDataValue(_ value: Any, forKey key: String)

Objective-C

- (nullable id)pluginDataValueForKey:(nonnull NSString *)key;

Swift

func pluginDataValue(forKey key: String) -> Any?