ARTChannelStateChange Class Reference


                    
                    
                    current

The new current ARTRealtimeChannelState.

Declaration

Objective-C

@property (nonatomic, readonly) ARTRealtimeChannelState current;

Swift

var current: ARTRealtimeChannelState { get }


                    
                    
                    previous

The previous state. For the ARTChannelEvent.ARTChannelEventUpdate event, this is equal to the current state.

Declaration

Objective-C

@property (nonatomic, readonly) ARTRealtimeChannelState previous;

Swift

var previous: ARTRealtimeChannelState { get }


                    
                    
                    event

The event that triggered this ARTRealtimeChannelState change.

Declaration

Objective-C

@property (nonatomic, readonly) ARTChannelEvent event;

Swift

var event: ARTChannelEvent { get }


                    
                    
                    reason

An ARTErrorInfo object containing any information relating to the transition.

Declaration

Objective-C

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

Swift

var reason: ARTErrorInfo? { get }


                    
                    
                    resumed

Indicates whether message continuity on this channel is preserved, see Nonfatal channel errors for more info.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL resumed;

Swift

var resumed: Bool { get }


                    
                    
                    retryAttempt

The retry attempt that triggered this channel state change, if any.

Intended for tests that wish to make assertions about the exact value of retry delays.

Declaration

Objective-C

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

Swift

var retryAttempt: RetryAttempt? { get }


                    
                    
                    -initWithCurrent:previous:event:reason:resumed:retryAttempt:

Undocumented

Declaration

Objective-C

- (instancetype)initWithCurrent:(ARTRealtimeChannelState)current
                       previous:(ARTRealtimeChannelState)previous
                          event:(ARTChannelEvent)event
                         reason:(nullable ARTErrorInfo *)reason
                        resumed:(BOOL)resumed
                   retryAttempt:(nullable ARTRetryAttempt *)retryAttempt;

Swift

init(current: ARTRealtimeChannelState, previous: ARTRealtimeChannelState, event: ARTChannelEvent, reason: ARTErrorInfo?, resumed: Bool, retryAttempt: RetryAttempt?)