ARTRealtimePresenceInternal

Objective-C

@interface ARTRealtimePresenceInternal : NSObject

@property (nonatomic, readonly) NSString *connectionId;
@property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTPresenceMessage *> *eventEmitter;

- (instancetype)initWithChannel:(ARTRealtimeChannelInternal *)channel logger:(ARTInternalLog *)logger;
- (void)_unsubscribe;
- (BOOL)syncComplete_nosync;
- (BOOL)syncInProgress_nosync;

- (void)failPendingPresence:(ARTStatus *)status;
- (void)broadcast:(ARTPresenceMessage *)pm;

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

@property (nonatomic) dispatch_queue_t queue;
@property (readonly, nonatomic) NSMutableArray<ARTQueuedMessage *> *pendingPresence;

@property (readonly) BOOL syncComplete;

- (void)get:(ARTPresenceMessagesCallback)callback;

- (void)get:(ARTRealtimePresenceQuery *)query callback:(ARTPresenceMessagesCallback)callback;

- (void)enter:(id _Nullable)data;

- (void)enter:(id _Nullable)data callback:(nullable ARTCallback)callback;

- (void)update:(id _Nullable)data;

- (void)update:(id _Nullable)data callback:(nullable ARTCallback)callback;

- (void)leave:(id _Nullable)data;

- (void)leave:(id _Nullable)data callback:(nullable ARTCallback)callback;

- (void)enterClient:(NSString *)clientId data:(id _Nullable)data;

- (void)enterClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

- (void)updateClient:(NSString *)clientId data:(id _Nullable)data;

- (void)updateClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

- (void)leaveClient:(NSString *)clientId data:(id _Nullable)data;

- (void)leaveClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

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

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

- (ARTEventListener *_Nullable)subscribe:(ARTPresenceAction)action callback:(ARTPresenceMessageCallback)callback;

- (ARTEventListener *_Nullable)subscribe:(ARTPresenceAction)action onAttach:(nullable ARTCallback)onAttach callback:(ARTPresenceMessageCallback)callback;

- (void)unsubscribe;

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

- (void)unsubscribe:(ARTPresenceAction)action listener:(ARTEventListener *)listener;

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

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

@end

Swift

class ARTRealtimePresenceInternal : NSObject

Undocumented

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *connectionId

    Swift

    var connectionId: String { get }
  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTPresenceMessage *> *eventEmitter

    Swift

    var eventEmitter: ARTEventEmitter<ARTEvent, ARTPresenceMessage> { get }
  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithChannel:(ARTRealtimeChannelInternal *)channel logger:(ARTInternalLog *)logger;

    Swift

    init(channel: ARTRealtimeChannelInternal, logger: InternalLog)
  • Undocumented

    Declaration

    Objective-C

    - (void)_unsubscribe;

    Swift

    func _unsubscribe()
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)syncComplete_nosync;

    Swift

    func syncComplete_nosync() -> Bool
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)syncInProgress_nosync;

    Swift

    func syncInProgress_nosync() -> Bool
  • Undocumented

    Declaration

    Objective-C

    - (void)failPendingPresence:(ARTStatus *)status;

    Swift

    func failPendingPresence(_ status: ARTStatus)
  • Undocumented

    Declaration

    Objective-C

    - (void)broadcast:(ARTPresenceMessage *)pm;

    Swift

    func broadcast(_ pm: ARTPresenceMessage)
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func onMessage(_ message: ARTProtocolMessage)
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func onSync(_ message: ARTProtocolMessage)
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func onAttached(_ message: ARTProtocolMessage)
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) dispatch_queue_t queue

    Swift

    var queue: dispatch_queue_t { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSMutableArray<ARTQueuedMessage *> *pendingPresence

    Swift

    var pendingPresence: NSMutableArray { get }
  • Undocumented

    Declaration

    Objective-C

    @property (readonly) BOOL syncComplete

    Swift

    var syncComplete: Bool { get }
  • Undocumented

    Declaration

    Objective-C

    - (void)get:(ARTPresenceMessagesCallback)callback;

    Swift

    func get(_ callback: @escaping ARTPresenceMessagesCallback)
  • Undocumented

    Declaration

    Objective-C

    - (void)get:(ARTRealtimePresenceQuery *)query callback:(ARTPresenceMessagesCallback)callback;

    Swift

    func get(_ query: ARTRealtimePresenceQuery, callback: @escaping ARTPresenceMessagesCallback)
  • Undocumented

    Declaration

    Objective-C

    - (void)enter:(id _Nullable)data;

    Swift

    func enter(_ data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)enter:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func enter(_ data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

    - (void)update:(id _Nullable)data;

    Swift

    func update(_ data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)update:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func update(_ data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

    - (void)leave:(id _Nullable)data;

    Swift

    func leave(_ data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)leave:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func leave(_ data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

    - (void)enterClient:(NSString *)clientId data:(id _Nullable)data;

    Swift

    func enterClient(_ clientId: String, data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)enterClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func enterClient(_ clientId: String, data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

    - (void)updateClient:(NSString *)clientId data:(id _Nullable)data;

    Swift

    func updateClient(_ clientId: String, data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)updateClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func updateClient(_ clientId: String, data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

    - (void)leaveClient:(NSString *)clientId data:(id _Nullable)data;

    Swift

    func leaveClient(_ clientId: String, data: Any?)
  • Undocumented

    Declaration

    Objective-C

    - (void)leaveClient:(NSString *)clientId data:(id _Nullable)data callback:(nullable ARTCallback)callback;

    Swift

    func leaveClient(_ clientId: String, data: Any?, callback: ARTCallback? = nil)
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func subscribe(_ callback: @escaping ARTPresenceMessageCallback) -> ARTEventListener?
  • Undocumented

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

    - (ARTEventListener *_Nullable)subscribe:(ARTPresenceAction)action callback:(ARTPresenceMessageCallback)callback;

    Swift

    func subscribe(_ action: ARTPresenceAction, callback: @escaping ARTPresenceMessageCallback) -> ARTEventListener?
  • Undocumented

    Declaration

    Objective-C

    - (ARTEventListener *_Nullable)subscribe:(ARTPresenceAction)action onAttach:(nullable ARTCallback)onAttach callback:(ARTPresenceMessageCallback)callback;

    Swift

    func subscribe(_ action: ARTPresenceAction, onAttach: ARTCallback?, callback: @escaping ARTPresenceMessageCallback) -> ARTEventListener?
  • Undocumented

    Declaration

    Objective-C

    - (void)unsubscribe;

    Swift

    func unsubscribe()
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func unsubscribe(_ listener: ARTEventListener)
  • Undocumented

    Declaration

    Objective-C

    - (void)unsubscribe:(ARTPresenceAction)action listener:(ARTEventListener *)listener;

    Swift

    func unsubscribe(_ action: ARTPresenceAction, listener: ARTEventListener)
  • Undocumented

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

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

    Swift

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

PresenceMap