ARTChannelStateChangeParams

Objective-C


@interface ARTChannelStateChangeParams : NSObject

Swift

class ChannelStateChangeParams : NSObject

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

ARTRealtimeChannelInternal will incorporate some of this data into the ARTChannelStateChange object that it emits as a result of the connection state change.

  • A state that some operations will use when failing pending presence operations.

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTState state;

    Swift

    var state: ARTState { get }

  • 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 }

  • Whether the ARTRealtimeChannelInternal instance should update its errorReason property.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL storeErrorInfo;

    Swift

    var storeErrorInfo: Bool { get }

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    var retryAttempt: RetryAttempt? { get }

  • The resumed value of the ARTProtocolMessage that triggered this state change.

    Declaration

    Objective-C

    @property (nonatomic) BOOL resumed;

    Swift

    var resumed: Bool { get set }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Creates an ARTChannelStateChangeParams instance whose errorInfo is nil, and whose storeErrorInfo is NO.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithState:(ARTState)state;

    Swift

    convenience init(state: ARTState)

  • Creates an ARTChannelStateChangeParams instance with the given errorInfo, whose storeErrorInfo is YES.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithState:(ARTState)state
                            errorInfo:(nullable ARTErrorInfo *)errorInfo;

    Swift

    convenience init(state: ARTState, errorInfo: ARTErrorInfo?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithState:(ARTState)state
                    errorInfo:(nullable ARTErrorInfo *)errorInfo
               storeErrorInfo:(BOOL)storeErrorInfo;

    Swift

    convenience init(state: ARTState, errorInfo: ARTErrorInfo?, storeErrorInfo: Bool)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithState:(ARTState)state
                    errorInfo:(nullable ARTErrorInfo *)errorInfo
               storeErrorInfo:(BOOL)storeErrorInfo
                 retryAttempt:(nullable ARTRetryAttempt *)retryAttempt NS_DESIGNATED_INITIALIZER;

    Swift

    init(state: ARTState, errorInfo: ARTErrorInfo?, storeErrorInfo: Bool, retryAttempt: RetryAttempt?)