Enumerations
The following enumerations are available globally.
-
Undocumented
See moreDeclaration
Objective-C
NS_ENUM(NSUInteger, ARTAuthorizationState) { ARTAuthorizationSucceeded, //ItemType: nil ARTAuthorizationFailed, //ItemType: NSError ARTAuthorizationCancelled, //ItemType: nil }
Swift
enum ARTAuthorizationState : UInt, @unchecked Sendable
-
ARTProtocolMessageFlag bitmask
See moreDeclaration
Objective-C
enum ARTProtocolMessageFlag : NSUInteger {}
Swift
struct ARTProtocolMessageFlag : OptionSet, @unchecked Sendable
-
Undocumented
See moreDeclaration
Objective-C
NS_ENUM(NSUInteger, ARTRealtimeTransportErrorType) { ARTRealtimeTransportErrorTypeOther, ARTRealtimeTransportErrorTypeHostUnreachable, ARTRealtimeTransportErrorTypeNoInternet, ARTRealtimeTransportErrorTypeTimeout, ARTRealtimeTransportErrorTypeBadResponse, ARTRealtimeTransportErrorTypeRefused }
Swift
enum ARTRealtimeTransportErrorType : UInt, @unchecked Sendable
-
Undocumented
See moreDeclaration
Objective-C
NS_ENUM(NSUInteger, ARTRealtimeTransportState) { ARTRealtimeTransportStateOpening, ARTRealtimeTransportStateOpened, ARTRealtimeTransportStateClosing, ARTRealtimeTransportStateClosed, }
Swift
enum ARTRealtimeTransportState : UInt, @unchecked Sendable
-
Undocumented
See moreDeclaration
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 moreDeclaration
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
See moreaction
field of anARTAnnotation
Declaration
Objective-C
enum ARTAnnotationAction : NSUInteger {}
Swift
enum ARTAnnotationAction : UInt, @unchecked Sendable
-
The namespace containing the different types of message actions.
See moreDeclaration
Objective-C
enum ARTMessageAction : NSUInteger {}
Swift
enum ARTMessageAction : UInt, @unchecked Sendable
-
Describes the possible actions members in the presence set can emit.
See moreDeclaration
Objective-C
enum ARTPresenceAction : NSUInteger {}
Swift
enum ARTPresenceAction : UInt, @unchecked Sendable
-
Describes the possible flags used to configure client capabilities, using
See moreARTChannelOptions
.Declaration
Objective-C
enum ARTChannelMode : NSUInteger {}
Swift
struct ARTChannelMode : OptionSet, @unchecked Sendable
-
Describes the interval unit over which statistics are gathered.
See moreDeclaration
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 moreDeclaration
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 moreDeclaration
Objective-C
enum ARTClientCodeError : NSUInteger {}
Swift
enum ARTClientCodeError : UInt, @unchecked Sendable
-
Describes the realtime
See moreARTConnection
object states.Declaration
Objective-C
enum ARTRealtimeConnectionState : NSUInteger {}
Swift
enum ARTRealtimeConnectionState : UInt, @unchecked Sendable
-
Describes the events emitted by a
See moreARTConnection
object. An event is either anARTRealtimeConnectionEventUpdate
or anARTRealtimeConnectionState
.Declaration
Objective-C
enum ARTRealtimeConnectionEvent : NSUInteger {}
Swift
enum ARTRealtimeConnectionEvent : UInt, @unchecked Sendable
-
Describes the possible states of an
See moreARTRealtimeChannel
object.Declaration
Objective-C
enum ARTRealtimeChannelState : NSUInteger {}
Swift
enum ARTRealtimeChannelState : UInt, @unchecked Sendable
-
Describes the events emitted by an
See moreARTRealtimeChannel
object. An event is either anARTChannelEventUpdate
or aARTRealtimeChannelState
.Declaration
Objective-C
enum ARTChannelEvent : NSUInteger {}
Swift
enum ARTChannelEvent : UInt, @unchecked Sendable