ARTConnectionStateChangeParams

Objective-C


@interface ARTConnectionStateChangeParams : NSObject

Swift

class ConnectionStateChangeParams : NSObject

Provides parameters for a request to perform an operation that may cause an ARTRealtimeInternal instance to emit a connection state change.

ARTRealtimeInternal will incorporate this data into the ARTConnectionStateChange object that it emits as a result of the connection state change.

  • Information about the error that triggered this state change, if any.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) ARTErrorInfo *errorInfo;

    Swift

    var errorInfo: ARTErrorInfo? { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, readonly) ARTRetryAttempt *retryAttempt

    Swift

    var retryAttempt: RetryAttempt? { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) BOOL resumed

    Swift

    var resumed: Bool { get set }

  • Creates an ARTConnectionStateChangeParams instance whose errorInfo is nil.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    convenience init()

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithErrorInfo:(nullable ARTErrorInfo *)errorInfo;

    Swift

    convenience init(errorInfo: ARTErrorInfo?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithErrorInfo:(nullable ARTErrorInfo *)errorInfo
                     retryAttempt:(nullable ARTRetryAttempt *)retryAttempt NS_DESIGNATED_INITIALIZER;

    Swift

    init(errorInfo: ARTErrorInfo?, retryAttempt: RetryAttempt?)