ARTRestInternal

Objective-C

@interface ARTRestInternal : NSObject

Swift

class ARTRestInternal : NSObject

ARTRest private methods that are used internally and for internal testing

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithOptions:(ARTClientOptions *)options;

    Swift

    init(options: ARTClientOptions)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithKey:(NSString *)key;

    Swift

    init(key: String)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithToken:(NSString *)token;

    Swift

    init(token: String)

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTRestChannelsInternal *channels

    Swift

    var channels: ARTRestChannelsInternal { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTAuthInternal *auth

    Swift

    var auth: ARTAuthInternal { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTPushInternal *push

    Swift

    var push: ARTPushInternal { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonnull, nonatomic, readonly, getter=device) ARTLocalDevice *device

    Swift

    var device: ARTLocalDevice { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonnull, nonatomic, readonly, getter=device_nosync) ARTLocalDevice *device_nosync

    Swift

    var device_nosync: ARTLocalDevice { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) id<ARTDeviceStorage> storage

    Swift

    var storage: any ARTDeviceStorage { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTClientOptions *options

    Swift

    var options: ARTClientOptions { get }

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    weak var realtime: ARTRealtimeInternal? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) id<ARTEncoder> defaultEncoder

    Swift

    var defaultEncoder: any ARTEncoder { get }

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *defaultEncoding

    Swift

    var defaultEncoding: String { get }

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSDictionary<NSString *, id<ARTEncoder>> *encoders

    Swift

    var encoders: [String : any ARTEncoder] { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable) NSString *prioritizedHost

    Swift

    var prioritizedHost: String? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) id<ARTHTTPExecutor> httpExecutor

    Swift

    var httpExecutor: any ARTHTTPExecutor { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=getBaseUrl) NSURL *baseUrl

    Swift

    var baseUrl: URL { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, copy) NSString *currentFallbackHost

    Swift

    var currentFallbackHost: String? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, readonly, nonatomic) ARTContinuousClockInstant *fallbackRetryExpiration

    Swift

    var fallbackRetryExpiration: ARTContinuousClockInstant? { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) dispatch_queue_t queue

    Swift

    var queue: dispatch_queue_t { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) dispatch_queue_t userQueue

    Swift

    var userQueue: dispatch_queue_t { get set }

  • Provides access to the instance’s logger. As the name says, this property should only be used in the following cases:

    • When writing class methods meeting the following criteria:

      • they wish to perform logging
      • they do not accept a logger parameter
      • their signature is already locked since they are part of the public API of the library
      • they have access to an ARTRest instance

    • When writing tests which wish to perform actions on this instance’s logger (for making assertions about how the logger was set up).

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTInternalLog *_Nonnull logger_onlyForUseInClassMethodsAndTests;

    Swift

    var logger_onlyForUseInClassMethodsAndTests: InternalLog { get }

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic) ARTHttp *http

    Swift

    var http: ARTHttp { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) int fallbackCount

    Swift

    var fallbackCount: Int32 { get set }

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithOptions:(ARTClientOptions *)options realtime:(ARTRealtimeInternal *_Nullable)realtime logger:(ARTInternalLog *)logger;

    Swift

    init(options: ARTClientOptions, realtime: ARTRealtimeInternal?, logger: InternalLog)

  • Undocumented

    Declaration

    Objective-C

    - (nullable NSObject<ARTCancellable> *)_timeWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                                      completion:(ARTDateTimeCallback)callback;

    Swift

    func _time(withWrapperSDKAgents wrapperSDKAgents: [String : String]?, completion callback: @escaping ARTDateTimeCallback) -> (any ARTCancellable & NSObjectProtocol)?

  • Undocumented

    Declaration

    Objective-C

    - (nullable NSObject<ARTCancellable> *)executeRequest:(NSURLRequest *)request
                                     wrapperSDKAgents:(nullable NSDictionary<NSString *, NSString *> *)wrapperSDKAgents
                                           completion:(nullable ARTURLRequestCallback)callback;

    Swift

    func execute(_ request: URLRequest, wrapperSDKAgents: [String : String]?, completion callback: ARTURLRequestCallback? = nil) -> (any ARTCancellable & NSObjectProtocol)?

  • Undocumented

    Declaration

    Objective-C

    - (nullable NSObject<ARTCancellable> *)executeRequest:(NSMutableURLRequest *)request
                                       withAuthOption:(ARTAuthentication)authOption
                                     wrapperSDKAgents:(nullable NSDictionary<NSString *, NSString *> *)wrapperSDKAgents
                                           completion:(ARTURLRequestCallback)callback;

    Swift

    func execute(_ request: NSMutableURLRequest, withAuthOption authOption: ARTAuthentication, wrapperSDKAgents: [String : String]?, completion callback: @escaping ARTURLRequestCallback) -> (any ARTCancellable & NSObjectProtocol)?

  • Undocumented

    Declaration

    Objective-C

    - (nullable NSObject<ARTCancellable> *)internetIsUp:(void (^)(BOOL isUp))cb;

    Swift

    func internetIsUp(_ cb: @escaping (Bool) -> Void) -> (any ARTCancellable & NSObjectProtocol)?

  • Undocumented

    Declaration

    Objective-C

    - (void)setupLocalDevice_nosync;

    Swift

    func setupLocalDevice_nosync()

  • Undocumented

    Declaration

    Objective-C

    - (void)resetLocalDevice_nosync;

    Swift

    func resetLocalDevice_nosync()

  • Undocumented

    Declaration

    Objective-C

    - (void)resetDeviceSingleton;

    Swift

    func resetDeviceSingleton()

  • Undocumented

    Declaration

    Objective-C

    - (void)setAndPersistAPNSDeviceTokenData:(NSData *)deviceTokenData tokenType:(NSString *)tokenType;

    Swift

    func setAndPersistAPNSDeviceTokenData(_ deviceTokenData: Data, tokenType: String)

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func time(withWrapperSDKAgents wrapperSDKAgents: [String : String]?) async throws -> Date

  • Undocumented

    Declaration

    Objective-C

    - (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;

    Swift

    func request(_ method: String, path: String, params: [String : String]?, body: Any?, headers: [String : String]?, wrapperSDKAgents: [String : String]?, callback: @escaping ARTHTTPPaginatedCallback) throws

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func stats(withWrapperSDKAgents wrapperSDKAgents: [String : String]?, completion callback: @escaping ARTPaginatedStatsCallback) -> Bool

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    func stats(_ query: ARTStatsQuery?, wrapperSDKAgents: [String : String]?, callback: @escaping ARTPaginatedStatsCallback) throws