Classes

Objective-C

@interface ARTAnnotation : NSObject<NSCopying>

/// A Unique ID assigned by Ably to this message.
@property (nullable, readonly, nonatomic) NSString *id;

/// The action, whether this is an annotation being added or removed, one of the `ARTAnnotationAction` enum values.
@property (readonly, nonatomic) ARTAnnotationAction action;

/// The client ID of the publisher of this message.
@property (nonatomic, readonly, nullable) NSString *clientId;

/// The name of this annotation. This is the field that most annotation aggregations will operate on. For example, using "distinct.v1" aggregation (specified in the type), the message summary will show a list of clients who have published an annotation with each distinct annotation.name.
@property (nullable, readonly, nonatomic) NSString *name;

/// An optional count, only relevant to certain aggregation methods, see aggregation methods documentation for more info.
@property (nullable, readonly, nonatomic) NSNumber *count;

/// The message payload, if provided.
@property (nonatomic, readonly, nullable) id data;

/// This is typically empty, as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute contains the remaining transformations not applied to the `data` payload.
@property (nonatomic, readonly, nullable) NSString *encoding;

/// Timestamp of when the message was received by Ably, as a `NSDate` object.
@property (nullable, nonatomic, readonly) NSDate *timestamp;

/// This annotation's unique serial (lexicographically totally ordered).
@property (readonly, nonatomic) NSString *serial;

/// The serial of the message (of type `MESSAGE_CREATE`) that this annotation is annotating.
@property (readonly, nonatomic) NSString *messageSerial;

/// The type of annotation it is, typically some identifier together with an aggregation method; for example: "emoji:distinct.v1". Handled opaquely by the SDK and validated serverside.
@property (readonly, nonatomic) NSString *type;

/// A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
@property (nullable, readonly, nonatomic) id<ARTJsonCompatible> extras;

- (instancetype)initWithId:(nullable NSString *)annotationId
                    action:(ARTAnnotationAction)action
                  clientId:(nullable NSString *)clientId
                      name:(nullable NSString *)name
                     count:(nullable NSNumber *)count
                      data:(nullable id)data
                  encoding:(nullable NSString *)encoding
                 timestamp:(nullable NSDate *)timestamp
                    serial:(nullable NSString *)serial
             messageSerial:(NSString *)messageSerial
                      type:(NSString *)type
                    extras:(nullable id<ARTJsonCompatible>)extras;

@end

Swift

class ARTAnnotation : NSObject, NSCopying, @unchecked Sendable

Objective-C

@interface ARTAttachRequestParams : NSObject

Swift

class AttachRequestParams : NSObject

Objective-C

@interface ARTAttachRetryState : NSObject

Swift

class AttachRetryState : NSObject

Objective-C

@interface ARTAuthInternal : NSObject

@property (nullable, readonly) NSString *clientId;
@property (nullable, nonatomic, readonly) ARTTokenDetails *tokenDetails;

- (void)requestToken:(nullable ARTTokenParams *)tokenParams
         withOptions:(nullable ARTAuthOptions *)authOptions
            callback:(ARTTokenDetailsCallback)callback;

- (void)requestToken:(ARTTokenDetailsCallback)callback;

- (void)authorize:(nullable ARTTokenParams *)tokenParams
          options:(nullable ARTAuthOptions *)authOptions
         callback:(ARTTokenDetailsCallback)callback;

- (void)authorize:(ARTTokenDetailsCallback)callback;

- (void)createTokenRequest:(nullable ARTTokenParams *)tokenParams
                   options:(nullable ARTAuthOptions *)options
                  callback:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;

- (void)createTokenRequest:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;

@end

Swift

class ARTAuthInternal : NSObject

Objective-C

@interface ARTAuth : NSObject <ARTAuthProtocol>

Swift

class ARTAuth : NSObject, ARTAuthProtocol, @unchecked Sendable

Objective-C

@interface ARTAuthOptions : NSObject <NSCopying>

Swift

class ARTAuthOptions : NSObject, NSCopying

Objective-C

@interface ARTBackoffRetryDelayCalculator : NSObject <ARTRetryDelayCalculator>

Swift

class BackoffRetryDelayCalculator : NSObject, RetryDelayCalculator

Objective-C

@interface ARTBaseMessage : NSObject <NSCopying>

Swift

class ARTBaseMessage : NSObject, NSCopying

Objective-C

@interface ARTChannel : NSObject

Swift

class ARTChannel : NSObject, @unchecked Sendable

Objective-C

@interface ARTChannelOptions : NSObject <NSCopying>

Swift

class ARTChannelOptions : NSObject, NSCopying

Objective-C

@interface ARTChannelStateChangeParams : NSObject

Swift

class ChannelStateChangeParams : NSObject

Objective-C

@interface ARTChannels<ChannelType> : NSObject

Swift

class ARTChannels<ChannelType> : NSObject, @unchecked Sendable where ChannelType : AnyObject

Objective-C

@interface ARTClientOptions : ARTAuthOptions

Swift

class ARTClientOptions : ARTAuthOptions

Objective-C

@interface ARTConnectRetryState : NSObject

Swift

class ConnectRetryState : NSObject

Objective-C

@interface ARTConnectionRecoveryKey : NSObject

@property (readonly, nonatomic) NSString *connectionKey;
@property (readonly, nonatomic) int64_t msgSerial;
@property (readonly, nonatomic) NSDictionary<NSString *, NSString *> *channelSerials;

- (instancetype)initWithConnectionKey:(NSString *)connectionKey
                            msgSerial:(int64_t)msgSerial
                       channelSerials:(NSDictionary<NSString *, NSString *> *)channelSerials;

- (NSString *)jsonString;
+ (nullable ARTConnectionRecoveryKey *)fromJsonString:(NSString *)json error:(NSError *_Nullable *_Nullable)errorPtr;

@end

Swift

class ARTConnectionRecoveryKey : NSObject

Objective-C

@interface ARTConnectionInternal : NSObject

@property (nullable, readonly, nonatomic) NSString *id;
@property (nullable, readonly, nonatomic) NSString *key;
@property (readonly, nonatomic) NSInteger maxMessageSize;
@property (readonly, nonatomic) ARTRealtimeConnectionState state;
@property (nullable, readonly, nonatomic) ARTErrorInfo *errorReason;

- (instancetype)initWithRealtime:(ARTRealtimeInternal *)realtime logger:(ARTInternalLog *)logger;

- (nullable NSString *)id_nosync;
- (nullable NSString *)key_nosync;
- (BOOL)isActive_nosync;
- (ARTRealtimeConnectionState)state_nosync;
- (nullable ARTErrorInfo *)errorReason_nosync;
- (nullable ARTErrorInfo *)error_nosync;
- (nullable NSString *)createRecoveryKey_nosync;

@property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTConnectionStateChange *> *eventEmitter;
@property(weak, nonatomic) ARTRealtimeInternal* realtime; // weak because realtime owns self

- (void)setId:(NSString *_Nullable)newId;
- (void)setKey:(NSString *_Nullable)key;
- (void)setMaxMessageSize:(NSInteger)maxMessageSize;
- (void)setState:(ARTRealtimeConnectionState)state;
- (void)setErrorReason:(ARTErrorInfo *_Nullable)errorReason;

- (void)emit:(ARTRealtimeConnectionEvent)event with:(ARTConnectionStateChange *)data;

@property (readonly, nonatomic) dispatch_queue_t queue;

@property (nullable, readonly) NSString *recoveryKey DEPRECATED_MSG_ATTRIBUTE("Use `createRecoveryKey` method instead.");

- (nullable NSString *)createRecoveryKey;

- (void)connect;

- (void)close;

- (void)ping:(ARTCallback)callback;

#pragma mark ARTEventEmitter

/**
 * Embeds an `ARTEventEmitter` object.
 */
ART_EMBED_INTERFACE_EVENT_EMITTER(ARTRealtimeConnectionEvent, ARTConnectionStateChange *)

@end

Swift

class ARTConnectionInternal : NSObject

Objective-C

@interface ARTConnection : NSObject <ARTConnectionProtocol>

Swift

class ARTConnection : NSObject, ARTConnectionProtocol, @unchecked Sendable

Objective-C

@interface ARTConnectionDetails : NSObject

Swift

class ARTConnectionDetails : NSObject, @unchecked Sendable

Objective-C

@interface ARTConnectionStateChangeParams : NSObject

Swift

class ConnectionStateChangeParams : NSObject

Objective-C

@interface ARTContinuousClock : NSObject

Swift

class ARTContinuousClock : NSObject

Objective-C

@interface ARTContinuousClockInstant : NSObject

Swift

class ARTContinuousClockInstant : NSObject

Objective-C

@interface ARTCipherParams : NSObject <ARTCipherParamsCompatible>

Swift

class ARTCipherParams : NSObject, ARTCipherParamsCompatible

Objective-C

@interface ARTCbcCipher : NSObject<ARTChannelCipher>

- (id)initWithCipherParams:(ARTCipherParams *)cipherParams logger:(ARTInternalLog *)logger;
+ (instancetype)cbcCipherWithParams:(ARTCipherParams *)cipherParams logger:(ARTInternalLog *)logger;


@property (nonatomic) ARTInternalLog *logger;
@property (readonly, nonatomic) NSData *keySpec;
@property NSData *iv;
@property (readonly) NSUInteger blockLength;

@end

Swift

class ARTCbcCipher : NSObject, ARTChannelCipher

Objective-C

@interface ARTCrypto : NSObject

Swift

class ARTCrypto : NSObject

Objective-C

@interface ARTDataEncoder : NSObject

Swift

class ARTDataEncoder : NSObject

Objective-C

@interface ARTDataQuery : NSObject

Swift

class ARTDataQuery : NSObject

Objective-C

@interface ARTRealtimeHistoryQuery : ARTDataQuery

Swift

class ARTRealtimeHistoryQuery : ARTDataQuery

Objective-C

@interface ARTDefault : NSObject

Swift

class ARTDefault : NSObject

Objective-C

@interface ARTDeviceDetails : NSObject

Swift

class ARTDeviceDetails : NSObject, @unchecked Sendable

Objective-C

@interface ARTDeviceIdentityTokenDetails : NSObject <NSSecureCoding>

Swift

class ARTDeviceIdentityTokenDetails : NSObject, NSSecureCoding

Objective-C

@interface ARTDevicePushDetails : NSObject

Swift

class ARTDevicePushDetails : NSObject, @unchecked Sendable

Objective-C

@interface ARTDefaultErrorChecker : NSObject <ARTErrorChecker>

Swift

class DefaultErrorChecker : NSObject, ErrorChecker

Objective-C

@interface ARTEventListener : NSObject

Swift

class ARTEventListener : NSObject, @unchecked Sendable

Objective-C

@interface ARTEventEmitter<EventType : id <ARTEventIdentification>, ItemType>
    : NSObject

Swift

class ARTEventEmitter<EventType, ItemType> : NSObject, @unchecked Sendable where EventType : ARTEventIdentification, ItemType : AnyObject

Objective-C

@interface ARTPublicEventEmitter<EventType : id <ARTEventIdentification>,
                                 ItemType>
    : ARTEventEmitter <EventType, ItemType>

Swift

class ARTPublicEventEmitter<EventType, ItemType> : ARTEventEmitter<EventType, ItemType> where EventType : ARTEventIdentification, ItemType : AnyObject

Objective-C

@interface ARTInternalEventEmitter<EventType : id <ARTEventIdentification>,
                                   ItemType>
    : ARTEventEmitter <EventType, ItemType>

Swift

class ARTInternalEventEmitter<EventType, ItemType> : ARTEventEmitter<EventType, ItemType> where EventType : ARTEventIdentification, ItemType : AnyObject

Objective-C

@interface ARTFallbackHosts : NSObject

+ (nullable NSArray<NSString *> *)hostsFromOptions:(ARTClientOptions *)options;

@end

Swift

class ARTFallbackHosts : NSObject

Objective-C

@interface ARTScheduledBlockHandle : NSObject
- (instancetype)initWithDelay:(NSTimeInterval)delay queue:(dispatch_queue_t)queue block:(dispatch_block_t)block;
- (void)cancel;
@end

Swift

class ARTScheduledBlockHandle : NSObject

Objective-C

@interface ARTHTTPPaginatedResponse : ARTPaginatedResult <NSDictionary *>

Swift

class ARTHTTPPaginatedResponse : ARTPaginatedResult<NSDictionary>, @unchecked Sendable

Objective-C

@interface ARTInternalLog: NSObject
#endif

/**
 Provides a shared logger to be used by all public class methods meeting the following criteria:

 - they wish to perform logging
 - they do not have access to any more appropriate logger
 - their signature is already locked since they are part of the public API of the library

 Currently, this returns a logger that will not actually output any log messages, but I've created https://github.com/ably/ably-cocoa/issues/1652 for us to revisit this.
 */
@property (nonatomic, readonly, class) ARTInternalLog *sharedClassMethodLogger_readDocumentationBeforeUsing;

/**
 Creates a logger which forwards its generated messages to the given core object.
 */
- (instancetype)initWithCore:(id<ARTInternalLogCore>)core NS_DESIGNATED_INITIALIZER;

/**
 A convenience initializer which creates a logger whose core is an instance of `ARTDefaultInternalLogCore` wrapping the given logger.
 */
- (instancetype)initWithLogger:(id<ARTVersion2Log>)logger;
/**
 A convenience initializer which creates a logger whose core is an instance of `ARTDefaultInternalLogCore` initialized with that class's `initWithClientOptions:` initializer.
 */
- (instancetype)initWithClientOptions:(ARTClientOptions *)clientOptions;
- (instancetype)init NS_UNAVAILABLE;

/**
 Passes the arguments through to the logger's core object.

 It is not directly used by the internals of the `Ably` library, but it is used by:

 - some of our Swift tests (which can't access the variadic method below), which want to be able to call a logging method on an instance of `ARTInternalLog`
 - `ARTPluginAPI`, to implement its conformance to the `APPluginAPIProtocol` protocol, which is used by plugins written in Swift
*/
- (void)log:(NSString *)message withLevel:(ARTLogLevel)level file:(const char *)fileName line:(NSInteger)line;

// This method should not be called directly — it is for use by the ARTLog* macros. It is tested via the tests of the macros.
- (void)logWithLevel:(ARTLogLevel)level file:(const char *)fileName line:(NSUInteger)line format:(NSString *)format, ...  NS_FORMAT_FUNCTION(4,5);

@property (nonatomic) ARTLogLevel logLevel;

@end

Swift

class InternalLog : NSObject

Objective-C

@interface ARTDefaultInternalLogCore : NSObject <ARTInternalLogCore>

Swift

class DefaultInternalLogCore : NSObject, InternalLogCore

Objective-C

@interface ARTDefaultJitterCoefficientGenerator
    : NSObject <ARTJitterCoefficientGenerator>

Swift

class DefaultJitterCoefficientGenerator : NSObject, JitterCoefficientGenerator

Objective-C

@interface ARTJsonEncoder : NSObject <ARTJsonLikeEncoderDelegate>

@end

Swift

class ARTJsonEncoder : NSObject, ARTJsonLikeEncoderDelegate

Objective-C

@interface ARTJsonLikeEncoder : NSObject <ARTEncoder>

@property (nonatomic, nullable) id<ARTJsonLikeEncoderDelegate> delegate;

- (instancetype)initWithDelegate:(id<ARTJsonLikeEncoderDelegate>)delegate;
- (instancetype)initWithLogger:(ARTInternalLog *)logger delegate:(nullable id<ARTJsonLikeEncoderDelegate>)delegate;
- (instancetype)initWithRest:(ARTRestInternal *)rest delegate:(nullable id<ARTJsonLikeEncoderDelegate>)delegate logger:(ARTInternalLog *)logger;

@end

Swift

class ARTJsonLikeEncoder : NSObject, ARTEncoder

Objective-C

@interface ARTLocalDevice : ARTDeviceDetails

Swift

class ARTLocalDevice : ARTDeviceDetails, @unchecked Sendable

Objective-C

@interface ARTLogLine : NSObject

@property(nonatomic, readonly) NSDate *date;
@property(nonatomic, readonly) ARTLogLevel level;
@property(nonatomic, readonly) NSString *message;

- (instancetype)initWithDate:(NSDate *)date level:(ARTLogLevel)level message:(NSString *)message;

- (NSString *)toString;

@end

Swift

class ARTLogLine : NSObject

Objective-C

@interface ARTLogAdapter : NSObject <ARTVersion2Log>

Swift

class LogAdapter : NSObject, Version2Log

Objective-C

@interface ARTMessageAnnotations : NSObject

Swift

class ARTMessageAnnotations : NSObject

Objective-C

@interface ARTMessageVersion : NSObject

Swift

class ARTMessageVersion : NSObject

Objective-C

@interface ARTMsgPackEncoder : NSObject <ARTJsonLikeEncoderDelegate>

@end

Swift

class ARTMsgPackEncoder : NSObject, ARTJsonLikeEncoderDelegate

Objective-C

@interface ARTOSReachability : NSObject  <ARTReachability>
@end

Swift

class ARTOSReachability : NSObject, ARTReachability

Objective-C

@interface ARTPaginatedResult<ItemType> : NSObject

Swift

class ARTPaginatedResult<ItemType> : NSObject, @unchecked Sendable where ItemType : AnyObject

Objective-C

@interface ARTPresenceQuery : NSObject

Swift

class ARTPresenceQuery : NSObject

Objective-C

@interface ARTPresenceMessage : ARTBaseMessage

Swift

class ARTPresenceMessage : ARTBaseMessage

Objective-C

@interface ARTPushInternal : NSObject

@property (nonatomic, readonly) ARTPushAdminInternal *admin;
@property (readonly) dispatch_queue_t queue;

- (instancetype)initWithRest:(ARTRestInternal *)rest logger:(ARTInternalLog *)logger;

#if TARGET_OS_IOS
- (void)getActivationMachine:(void (^)(ARTPushActivationStateMachine *))block;

/// Direct access to _activationMachine var for internal testing.
/// Throws an exception if there is no activation machine or it could not be locked immediately.
@property (readonly) ARTPushActivationStateMachine *activationMachine;

/// Create the _activationMachine manually with a custom delegate for internal testing.
- (ARTPushActivationStateMachine *)createActivationStateMachineWithDelegate:(id<ARTPushRegistererDelegate, NSObject>)delegate;
#endif

#if TARGET_OS_IOS

+ (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken rest:(ARTRest *)rest;

+ (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken realtime:(ARTRealtime *)realtime;

+ (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error rest:(ARTRest *)rest;

+ (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error realtime:(ARTRealtime *)realtime;

+ (void)didRegisterForLocationNotificationsWithDeviceToken:(NSData *)deviceToken rest:(ARTRest *)rest;

+ (void)didRegisterForLocationNotificationsWithDeviceToken:(NSData *)deviceToken realtime:(ARTRealtime *)realtime;

+ (void)didFailToRegisterForLocationNotificationsWithError:(NSError *)error rest:(ARTRest *)rest;

+ (void)didFailToRegisterForLocationNotificationsWithError:(NSError *)error realtime:(ARTRealtime *)realtime;

- (void)activate;

- (void)deactivate;

#endif

@end

Swift

class ARTPushInternal : NSObject

Objective-C

@interface ARTPush : NSObject <ARTPushProtocol>

Swift

class ARTPush : NSObject, ARTPushProtocol, @unchecked Sendable

Objective-C

@interface ARTPushActivationEvent : NSObject <NSSecureCoding>

- (NSData *)archiveWithLogger:(nullable ARTInternalLog *)logger;
+ (nullable ARTPushActivationState *)unarchive:(NSData *)data withLogger:(nullable ARTInternalLog *)logger;

@end

Swift

class ARTPushActivationEvent : NSObject, NSSecureCoding

Objective-C

@interface ARTPushActivationErrorEvent : ARTPushActivationEvent

Swift

class ARTPushActivationErrorEvent : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationDeviceIdentityEvent : ARTPushActivationEvent

Swift

class ARTPushActivationDeviceIdentityEvent : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationEventCalledActivate : ARTPushActivationEvent
@end

Swift

class ARTPushActivationEventCalledActivate : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationEventCalledDeactivate : ARTPushActivationEvent
@end

Swift

class ARTPushActivationEventCalledDeactivate : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationEventGotPushDeviceDetails : ARTPushActivationEvent
@end

Swift

class ARTPushActivationEventGotPushDeviceDetails : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationEventGettingPushDeviceDetailsFailed
    : ARTPushActivationErrorEvent

Swift

class ARTPushActivationEventGettingPushDeviceDetailsFailed : ARTPushActivationErrorEvent

Objective-C

@interface ARTPushActivationEventGotDeviceRegistration
    : ARTPushActivationDeviceIdentityEvent

Swift

class ARTPushActivationEventGotDeviceRegistration : ARTPushActivationDeviceIdentityEvent

Objective-C

@interface ARTPushActivationEventGettingDeviceRegistrationFailed
    : ARTPushActivationErrorEvent

Swift

class ARTPushActivationEventGettingDeviceRegistrationFailed : ARTPushActivationErrorEvent

Objective-C

@interface ARTPushActivationEventRegistrationSynced
    : ARTPushActivationDeviceIdentityEvent

Swift

class ARTPushActivationEventRegistrationSynced : ARTPushActivationDeviceIdentityEvent

Objective-C

@interface ARTPushActivationEventSyncRegistrationFailed
    : ARTPushActivationErrorEvent

Swift

class ARTPushActivationEventSyncRegistrationFailed : ARTPushActivationErrorEvent

Objective-C

@interface ARTPushActivationEventDeregistered : ARTPushActivationEvent
@end

Swift

class ARTPushActivationEventDeregistered : ARTPushActivationEvent

Objective-C

@interface ARTPushActivationEventDeregistrationFailed
    : ARTPushActivationErrorEvent

Swift

class ARTPushActivationEventDeregistrationFailed : ARTPushActivationErrorEvent

Objective-C

@interface ARTPushActivationState : NSObject <NSSecureCoding>

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger;
+ (instancetype)new NS_UNAVAILABLE;
+ (instancetype)newWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger;

@property (atomic, nullable) ARTPushActivationStateMachine *machine;

- (nullable ARTPushActivationState *)transition:(ARTPushActivationEvent *)event;

- (NSData *)archive;
+ (nullable ARTPushActivationState *)unarchive:(NSData *)data withLogger:(nullable ARTInternalLog *)logger;

@end

Swift

class ARTPushActivationState : NSObject, NSSecureCoding

Objective-C

@interface ARTPushActivationPersistentState : ARTPushActivationState

Swift

class ARTPushActivationPersistentState : ARTPushActivationState

Objective-C

@interface ARTPushActivationStateNotActivated : ARTPushActivationPersistentState

Swift

class ARTPushActivationStateNotActivated : ARTPushActivationPersistentState

Objective-C

@interface ARTPushActivationStateWaitingForDeviceRegistration : ARTPushActivationState
@end

Swift

class ARTPushActivationStateWaitingForDeviceRegistration : ARTPushActivationState

Objective-C

@interface ARTPushActivationStateWaitingForPushDeviceDetails
    : ARTPushActivationPersistentState

Swift

class ARTPushActivationStateWaitingForPushDeviceDetails : ARTPushActivationPersistentState

Objective-C

@interface ARTPushActivationStateWaitingForNewPushDeviceDetails
    : ARTPushActivationPersistentState

Swift

class ARTPushActivationStateWaitingForNewPushDeviceDetails : ARTPushActivationPersistentState

Objective-C

@interface ARTPushActivationStateWaitingForRegistrationSync : ARTPushActivationState

- (instancetype)initWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger NS_UNAVAILABLE;
+ (instancetype)newWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger NS_UNAVAILABLE;

- (instancetype)initWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger fromEvent:(ARTPushActivationEvent *)event;
+ (instancetype)newWithMachine:(ARTPushActivationStateMachine *)machine logger:(ARTInternalLog *)logger fromEvent:(ARTPushActivationEvent *)event;

@property (atomic) ARTPushActivationEvent *fromEvent;

@end

Swift

class ARTPushActivationStateWaitingForRegistrationSync : ARTPushActivationState

Objective-C

@interface ARTPushActivationStateAfterRegistrationSyncFailed
    : ARTPushActivationPersistentState

Swift

class ARTPushActivationStateAfterRegistrationSyncFailed : ARTPushActivationPersistentState

Objective-C

@interface ARTPushActivationStateWaitingForDeregistration : ARTPushActivationState
@end

Swift

class ARTPushActivationStateWaitingForDeregistration : ARTPushActivationState

Objective-C

@interface ARTPushActivationDeprecatedPersistentState
    : ARTPushActivationPersistentState

Swift

class ARTPushActivationDeprecatedPersistentState : ARTPushActivationPersistentState

Objective-C

@interface ARTPushActivationStateAfterRegistrationUpdateFailed
    : ARTPushActivationDeprecatedPersistentState

Swift

class ARTPushActivationStateAfterRegistrationUpdateFailed : ARTPushActivationDeprecatedPersistentState

Objective-C

@interface ARTPushActivationStateMachine : NSObject

@property (readonly, nonatomic) ARTPushActivationEvent *lastEvent;
@property (readonly, nonatomic) ARTPushActivationState *current;
@property (readonly, nonatomic) NSArray<ARTPushActivationEvent *> *pendingEvents;

- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;

- (void)sendEvent:(ARTPushActivationEvent *)event;

@end

Swift

class ARTPushActivationStateMachine : NSObject

Objective-C

@interface ARTPushAdminInternal : NSObject

@property (nonatomic, readonly) ARTPushDeviceRegistrationsInternal *deviceRegistrations;
@property (nonatomic, readonly) ARTPushChannelSubscriptionsInternal *channelSubscriptions;

- (instancetype)initWithRest:(ARTRestInternal *)rest logger:(ARTInternalLog *)logger;

- (void)publish:(ARTPushRecipient *)recipient data:(ARTJsonObject *)data wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(nullable ARTCallback)callback;

@end

Swift

class ARTPushAdminInternal : NSObject

Objective-C

@interface ARTPushAdmin : NSObject <ARTPushAdminProtocol>

Swift

class ARTPushAdmin : NSObject, ARTPushAdminProtocol, @unchecked Sendable

Objective-C

@interface ARTPushChannelInternal : NSObject

- (instancetype)init:(ARTRestInternal *)rest withChannel:(ARTChannel *)channel logger:(ARTInternalLog *)logger;

- (void)subscribeDeviceWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents;

- (void)subscribeDeviceWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                 completion:(nullable ARTCallback)callback;

- (void)subscribeClientWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents;

- (void)subscribeClientWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                 completion:(nullable ARTCallback)callback;

- (void)unsubscribeDeviceWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents;

- (void)unsubscribeDeviceWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                   completion:(nullable ARTCallback)callback;

- (void)unsubscribeClientWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents;

- (void)unsubscribeClientWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                   completion:(nullable ARTCallback)callback;

- (BOOL)listSubscriptions:(NSStringDictionary *)params
         wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                 callback:(ARTPaginatedPushChannelCallback)callback
                    error:(NSError *_Nullable *_Nullable)errorPtr;

@end

Swift

class ARTPushChannelInternal : NSObject

Objective-C

@interface ARTPushChannel : NSObject <ARTPushChannelProtocol>

Swift

class ARTPushChannel : NSObject, ARTPushChannelProtocol, @unchecked Sendable

Objective-C

@interface ARTPushChannelSubscriptionsInternal : NSObject

- (instancetype)initWithRest:(ARTRestInternal *)rest logger:(ARTInternalLog *)logger;

- (void)save:(ARTPushChannelSubscription *)channelSubscription wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

- (void)listChannelsWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents completion:(ARTPaginatedTextCallback)callback;

- (void)list:(NSStringDictionary *)params wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTPaginatedPushChannelCallback)callback;

- (void)remove:(ARTPushChannelSubscription *)subscription wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

- (void)removeWhere:(NSStringDictionary *)params wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

@end

Swift

class ARTPushChannelSubscriptionsInternal : NSObject

Objective-C

@interface ARTPushChannelSubscriptions
    : NSObject <ARTPushChannelSubscriptionsProtocol>

Swift

class ARTPushChannelSubscriptions : NSObject, ARTPushChannelSubscriptionsProtocol, @unchecked Sendable

Objective-C

@interface ARTPushDeviceRegistrationsInternal : NSObject

- (instancetype)initWithRest:(ARTRestInternal *)rest logger:(ARTInternalLog *)logger;

- (void)save:(ARTDeviceDetails *)deviceDetails wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

- (void)get:(ARTDeviceId *)deviceId wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(void (^)(ARTDeviceDetails *_Nullable,  ARTErrorInfo *_Nullable))callback;

- (void)list:(NSStringDictionary *)params wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTPaginatedDeviceDetailsCallback)callback;

- (void)remove:(NSString *)deviceId wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

- (void)removeWhere:(NSStringDictionary *)params wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTCallback)callback;

@end

Swift

class ARTPushDeviceRegistrationsInternal : NSObject

Objective-C

@interface ARTPushDeviceRegistrations
    : NSObject <ARTPushDeviceRegistrationsProtocol>

Swift

class ARTPushDeviceRegistrations : NSObject, ARTPushDeviceRegistrationsProtocol, @unchecked Sendable

Objective-C

@interface ARTQueuedDealloc : NSObject

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)init:(id)ref queue:(dispatch_queue_t)queue;

@end

Swift

class ARTQueuedDealloc : NSObject

Objective-C

@interface ARTRealtime : NSObject <ARTRealtimeProtocol>

Swift

class ARTRealtime : NSObject, ARTRealtimeProtocol, @unchecked Sendable

Objective-C

@interface ARTRealtimeInternal : NSObject
#endif

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithOptions:(ARTClientOptions *)options;
- (instancetype)initWithKey:(NSString *)key;
- (instancetype)initWithToken:(NSString *)token;

@property (nonatomic, readonly) ARTConnectionInternal *connection;
@property (nonatomic, readonly) ARTRealtimeChannelsInternal *channels;
@property (readonly) ARTAuthInternal *auth;
@property (readonly) ARTPushInternal *push;
#if TARGET_OS_IOS
@property (nonnull, nonatomic, readonly, getter=device) ARTLocalDevice *device;
#endif
@property (readonly, nullable, getter=clientId) NSString *clientId;

@property (readonly, nonatomic) dispatch_queue_t queue;

- (void)timeWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                      completion:(ARTDateTimeCallback)callback;

- (BOOL)request:(NSString *)method
           path:(NSString *)path
         params:(nullable NSStringDictionary *)params
           body:(nullable id)body
        headers:(nullable NSStringDictionary *)headers
wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
       callback:(ARTHTTPPaginatedCallback)callback
          error:(NSError *_Nullable *_Nullable)errorPtr;

- (void)ping:(ARTCallback)cb;

- (BOOL)statsWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                         callback:(ARTPaginatedStatsCallback)callback;

- (BOOL)stats:(nullable ARTStatsQuery *)query wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents callback:(ARTPaginatedStatsCallback)callback error:(NSError *_Nullable *_Nullable)errorPtr;

- (void)connect;

- (void)close;

@end

Swift

class ARTRealtimeInternal : NSObject

Objective-C

@interface ARTRealtimeAnnotationsInternal : NSObject<ARTRealtimeAnnotationsProtocol>

@property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTAnnotation *> *eventEmitter;
@property (readonly, weak, nonatomic) ARTRealtimeInternal *realtime; // weak because realtime owns self

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

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

@property (nonatomic) dispatch_queue_t queue;

@end

Swift

class ARTRealtimeAnnotationsInternal : NSObject, ARTRealtimeAnnotationsProtocol

Objective-C

@interface ARTRealtimeAnnotations : NSObject <ARTRealtimeAnnotationsProtocol>

Swift

class ARTRealtimeAnnotations : NSObject, ARTRealtimeAnnotationsProtocol, @unchecked Sendable

Objective-C

@interface ARTRealtimeChannelInternal : ARTChannel

Swift

class ARTRealtimeChannelInternal : ARTChannel

Objective-C

@interface ARTRealtimeChannel : NSObject <ARTRealtimeChannelProtocol>

Swift

class ARTRealtimeChannel : NSObject, ARTRealtimeChannelProtocol, @unchecked Sendable

Objective-C

@interface ARTRealtimeChannelsInternal : NSObject

- (ARTRealtimeChannelInternal *)get:(NSString *)name;
- (ARTRealtimeChannelInternal *)get:(NSString *)name options:(ARTRealtimeChannelOptions *)options;
- (id<NSFastEnumeration>)copyIntoIteratorWithMapper:(ARTRealtimeChannel *(^)(ARTRealtimeChannelInternal *))mapper;

- (instancetype)initWithRealtime:(ARTRealtimeInternal *)realtime logger:(ARTInternalLog *)logger;

@property (readonly, getter=getNosyncIterable) id<NSFastEnumeration> nosyncIterable;
@property (nonatomic, readonly, getter=getCollection) NSMutableDictionary<NSString *, ARTRealtimeChannelInternal *> *collection;
- (ARTRealtimeChannelInternal *)_getChannel:(NSString *)name options:(ARTChannelOptions * _Nullable)options addPrefix:(BOOL)addPrefix;

@property (nonatomic) dispatch_queue_t queue;

- (BOOL)exists:(NSString *)name;
- (void)release:(NSString *)name callback:(nullable ARTCallback)errorInfo;
- (void)release:(NSString *)name;

@end

Swift

class ARTRealtimeChannelsInternal : NSObject

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

Objective-C

@interface ARTRealtimePresence : ARTPresence <ARTRealtimePresenceProtocol>

Swift

class ARTRealtimePresence : ARTPresence, ARTRealtimePresenceProtocol, @unchecked Sendable

Objective-C

@interface ARTRealtimeTransportError : NSObject

@property (nonatomic) NSError *error;
@property (nonatomic) ARTRealtimeTransportErrorType type;
/**
 This meaning of this property is only defined if the error is of type `ARTRealtimeTransportErrorTypeBadResponse`.
 */
@property (nonatomic) NSInteger badResponseCode;
@property (nonatomic) NSURL *url;

- (instancetype)initWithError:(NSError *)error type:(ARTRealtimeTransportErrorType)type url:(NSURL *)url;
- (instancetype)initWithError:(NSError *)error badResponseCode:(NSInteger)badResponseCode url:(NSURL *)url;

- (NSString *)description;

@end

Swift

class ARTRealtimeTransportError : NSObject

Objective-C

@interface ARTDefaultRealtimeTransportFactory
    : NSObject <ARTRealtimeTransportFactory>

Swift

class DefaultRealtimeTransportFactory : NSObject, RealtimeTransportFactory

Objective-C

@interface ARTRestInternal : NSObject

Swift

class ARTRestInternal : NSObject

Objective-C

@interface ARTRest : NSObject <ARTRestProtocol>

Swift

class ARTRest : NSObject, ARTRestProtocol, @unchecked Sendable

Objective-C

@interface ARTRestAnnotationsInternal : NSObject<ARTRestAnnotationsProtocol>

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

@end

Swift

class ARTRestAnnotationsInternal : NSObject, ARTRestAnnotationsProtocol

Objective-C

@interface ARTRestAnnotations : NSObject <ARTRestAnnotationsProtocol>

Swift

class ARTRestAnnotations : NSObject, ARTRestAnnotationsProtocol, @unchecked Sendable

Objective-C

@interface ARTRestChannelInternal : ARTChannel

Swift

class ARTRestChannelInternal : ARTChannel

Objective-C

@interface ARTRestChannel : NSObject <ARTRestChannelProtocol>

Swift

class ARTRestChannel : NSObject, ARTRestChannelProtocol, @unchecked Sendable

Objective-C

@interface ARTRestChannelsInternal : NSObject

- (ARTRestChannelInternal *)get:(NSString *)name;
- (ARTRestChannelInternal *)get:(NSString *)name options:(ARTChannelOptions *)options;
- (id<NSFastEnumeration>)copyIntoIteratorWithMapper:(ARTRestChannel *(^)(ARTRestChannelInternal *))mapper;

- (instancetype)initWithRest:(ARTRestInternal *)rest logger:(ARTInternalLog *)logger;
- (ARTRestChannelInternal *)_getChannel:(NSString *)name options:(ARTChannelOptions * _Nullable)options addPrefix:(BOOL)addPrefix;

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

@end

Swift

class ARTRestChannelsInternal : NSObject

Objective-C

@interface ARTRestPresenceInternal : NSObject

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

- (void)get:(ARTPaginatedPresenceCallback)callback;

- (BOOL)get:(ARTPaginatedPresenceCallback)callback error:(NSError *_Nullable *_Nullable)errorPtr;

- (BOOL)get:(ARTPresenceQuery *)query callback:(ARTPaginatedPresenceCallback)callback error:(NSError *_Nullable *_Nullable)errorPtr;

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

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

@end

Swift

class ARTRestPresenceInternal : NSObject

Objective-C

@interface ARTRestPresence : ARTPresence <ARTRestPresenceProtocol>

Swift

class ARTRestPresence : ARTPresence, ARTRestPresenceProtocol, @unchecked Sendable

Objective-C

@interface ARTRetrySequence : NSObject

Swift

class RetrySequence : NSObject

Objective-C

@interface ARTRetryAttempt : NSObject

Swift

class RetryAttempt : NSObject

Objective-C

@interface ARTSRWebSocket : NSObject <ARTWebSocket, NSStreamDelegate>

Swift

class ARTSRWebSocket : NSObject, ARTWebSocket, StreamDelegate

Objective-C

@interface ARTTestClientOptions : NSObject <NSCopying>

Swift

class ARTTestClientOptions : NSObject, NSCopying

Objective-C

@interface ARTTokenParams : NSObject <NSCopying>

Swift

class ARTTokenParams : NSObject, NSCopying