Enumerations

The following enumerations are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, ARTAuthorizationState) {
        ARTAuthorizationSucceeded, //ItemType: nil
        ARTAuthorizationFailed, //ItemType: NSError
        ARTAuthorizationCancelled, //ItemType: nil
    }

    Swift

    enum ARTAuthorizationState : UInt, @unchecked Sendable
  • ARTProtocolMessageFlag bitmask

    See more

    Declaration

    Objective-C

    enum ARTProtocolMessageFlag : NSUInteger {}

    Swift

    struct ARTProtocolMessageFlag : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, ARTRealtimeTransportErrorType) {
        ARTRealtimeTransportErrorTypeOther,
        ARTRealtimeTransportErrorTypeHostUnreachable,
        ARTRealtimeTransportErrorTypeNoInternet,
        ARTRealtimeTransportErrorTypeTimeout,
        ARTRealtimeTransportErrorTypeBadResponse,
        ARTRealtimeTransportErrorTypeRefused
    }

    Swift

    enum ARTRealtimeTransportErrorType : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, ARTRealtimeTransportState) {
        ARTRealtimeTransportStateOpening,
        ARTRealtimeTransportStateOpened,
        ARTRealtimeTransportStateClosing,
        ARTRealtimeTransportStateClosed,
    }

    Swift

    enum ARTRealtimeTransportState : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, ARTSRStatusCode) {
        // 0-999: Reserved and not used.
        ARTSRStatusCodeNormal = 1000,
        ARTSRStatusCodeGoingAway = 1001,
        ARTSRStatusCodeProtocolError = 1002,
        ARTSRStatusCodeUnhandledType = 1003,
        // 1004 reserved.
        ARTSRStatusNoStatusReceived = 1005,
        ARTSRStatusCodeAbnormal = 1006,
        ARTSRStatusCodeInvalidUTF8 = 1007,
        ARTSRStatusCodePolicyViolated = 1008,
        ARTSRStatusCodeMessageTooBig = 1009,
        ARTSRStatusCodeMissingExtension = 1010,
        ARTSRStatusCodeInternalError = 1011,
        ARTSRStatusCodeServiceRestart = 1012,
        ARTSRStatusCodeTryAgainLater = 1013,
        // 1014: Reserved for future use by the WebSocket standard.
        ARTSRStatusCodeTLSHandshake = 1015,
        // 1016-1999: Reserved for future use by the WebSocket standard.
        // 2000-2999: Reserved for use by WebSocket extensions.
        // 3000-3999: Available for use by libraries and frameworks. May not be used by applications. Available for registration at the IANA via first-come, first-serve.
        // 4000-4999: Available for use by applications.
    }

    Swift

    enum ARTSRStatusCode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, ARTWebSocketReadyState) {
        ARTWebSocketReadyStateConnecting   = 0,
        ARTWebSocketReadyStateOpen         = 1,
        ARTWebSocketReadyStateClosing      = 2,
        ARTWebSocketReadyStateClosed       = 3,
    }

    Swift

    enum ARTWebSocketReadyState : Int, @unchecked Sendable
  • Enumerates the possible values of the action field of an ARTAnnotation

    See more

    Declaration

    Objective-C

    enum ARTAnnotationAction : NSUInteger {}

    Swift

    enum ARTAnnotationAction : UInt, @unchecked Sendable
  • The namespace containing the different types of message actions.

    See more

    Declaration

    Objective-C

    enum ARTMessageAction : NSUInteger {}

    Swift

    enum ARTMessageAction : UInt, @unchecked Sendable
  • Describes the possible actions members in the presence set can emit.

    See more

    Declaration

    Objective-C

    enum ARTPresenceAction : NSUInteger {}

    Swift

    enum ARTPresenceAction : UInt, @unchecked Sendable
  • Describes the possible flags used to configure client capabilities, using ARTChannelOptions.

    See more

    Declaration

    Objective-C

    enum ARTChannelMode : NSUInteger {}

    Swift

    struct ARTChannelMode : OptionSet, @unchecked Sendable
  • Describes the interval unit over which statistics are gathered.

    See more

    Declaration

    Objective-C

    enum ARTStatsGranularity : NSUInteger {}

    Swift

    enum ARTStatsGranularity : UInt, @unchecked Sendable
  • The list of all public error codes returned under the error domain ARTAblyErrorDomain

    See more

    Declaration

    Objective-C

    enum ARTErrorCode : NSUInteger {}

    Swift

    enum ARTErrorCode : UInt, @unchecked Sendable
  • The list of all client error codes returned under the error domain ARTAblyErrorDomain

    See more

    Declaration

    Objective-C

    enum ARTClientCodeError : NSUInteger {}

    Swift

    enum ARTClientCodeError : UInt, @unchecked Sendable
  • Describes the realtime ARTConnection object states.

    See more

    Declaration

    Objective-C

    enum ARTRealtimeConnectionState : NSUInteger {}

    Swift

    enum ARTRealtimeConnectionState : UInt, @unchecked Sendable
  • Describes the events emitted by a ARTConnection object. An event is either an ARTRealtimeConnectionEventUpdate or an ARTRealtimeConnectionState.

    See more

    Declaration

    Objective-C

    enum ARTRealtimeConnectionEvent : NSUInteger {}

    Swift

    enum ARTRealtimeConnectionEvent : UInt, @unchecked Sendable
  • Describes the possible states of an ARTRealtimeChannel object.

    See more

    Declaration

    Objective-C

    enum ARTRealtimeChannelState : NSUInteger {}

    Swift

    enum ARTRealtimeChannelState : UInt, @unchecked Sendable
  • Describes the events emitted by an ARTRealtimeChannel object. An event is either an ARTChannelEventUpdate or a ARTRealtimeChannelState.

    See more

    Declaration

    Objective-C

    enum ARTChannelEvent : NSUInteger {}

    Swift

    enum ARTChannelEvent : UInt, @unchecked Sendable