ARTTestClientOptions

Objective-C

@interface ARTTestClientOptions : NSObject <NSCopying>

Swift

class ARTTestClientOptions : NSObject, NSCopying

Provides an interface for injecting additional configuration into ARTRest or ARTRealtime instances.

This is for anything that test code wishes to be able to configure but which should not be part of the public API of these classes.

  • Initial value is nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *channelNamePrefix;

    Swift

    var channelNamePrefix: String? { get set }

  • Initial value is ARTDefault.realtimeRequestTimeout.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval realtimeRequestTimeout;

    Swift

    var realtimeRequestTimeout: TimeInterval { get set }

  • Initial value is ARTFallback_shuffleArray.

    Declaration

    Objective-C

    @property (nonatomic) void (^_Nonnull) (NSMutableArray *_Nonnull) shuffleArray;

    Swift

    var shuffleArray: (NSMutableArray) -> Void { get set }

  • Initial value is an instance of ARTDefaultRealtimeTransportFactory.

    Declaration

    Objective-C

    @property (nonatomic) id<ARTRealtimeTransportFactory> _Nonnull transportFactory;

    Swift

    var transportFactory: any RealtimeTransportFactory { get set }

  • RTN20c helper. This property is used to provide a way for the test code to simulate the case where a reconnection attempt results in a different outcome to the original connection attempt. Initial value is nil.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nonnull reconnectionRealtimeHost;

    Swift

    var reconnectionRealtimeHost: String { get set }

  • Initial value is an instance of ARTDefaultJitterCoefficientGenerator.

    Declaration

    Objective-C

    @property (nonatomic) id<ARTJitterCoefficientGenerator> _Nonnull jitterCoefficientGenerator;

    Swift

    var jitterCoefficientGenerator: any JitterCoefficientGenerator { get set }