ARTAttachRequestParams

Objective-C


@interface ARTAttachRequestParams : NSObject

Swift

class AttachRequestParams : NSObject

Provides parameters for a request to perform an operation that may ultimately call ARTChannelRealtimeInternal‘s internalAttach:callback: method.

  • Information about the error that triggered this attach request, if any.

    Declaration

    Objective-C

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

    Swift

    var reason: ARTErrorInfo? { get }

  • The value to set for the ATTACH ProtocolMessage‘s channelSerial property.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *channelSerial;

    Swift

    var channelSerial: String? { get }

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    var retryAttempt: RetryAttempt? { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Creates an ARTAttachRequestParams instance with the given reason, whose channelSerial is nil.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReason:(nullable ARTErrorInfo *)reason;

    Swift

    convenience init(reason: ARTErrorInfo?)

  • Creates an ARTAttachRequest instance with the given reason and channelSerial, whose retryAttempt is nil.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReason:(nullable ARTErrorInfo *)reason
                         channelSerial:(nullable NSString *)channelSerial;

    Swift

    convenience init(reason: ARTErrorInfo?, channelSerial: String?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithReason:(nullable ARTErrorInfo *)reason channelSerial:(nullable NSString *)channelSerial retryAttempt:(nullable ARTRetryAttempt *)retryAttempt NS_DESIGNATED_INITIALIZER;

    Swift

    init(reason: ARTErrorInfo?, channelSerial: String?, retryAttempt: RetryAttempt?)