Constants

The following constants are available globally.

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTHttpHeaderFieldErrorCodeKey

    Swift

    let ARTHttpHeaderFieldErrorCodeKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTHttpHeaderFieldErrorMessageKey

    Swift

    let ARTHttpHeaderFieldErrorMessageKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSUInteger const ARTIdempotentLibraryGeneratedIdLength

    Swift

    let ARTIdempotentLibraryGeneratedIdLength: UInt

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTDefaultProduction

    Swift

    let ARTDefaultProduction: String

  • Undocumented

    Declaration

    Objective-C

    extern void (^const ARTFallback_shuffleArray

    Swift

    let ARTFallback_shuffleArray: (NSMutableArray) -> Void

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTDeviceIdKey

    Swift

    let ARTDeviceIdKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTDeviceSecretKey

    Swift

    let ARTDeviceSecretKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTDeviceIdentityTokenKey

    Swift

    let ARTDeviceIdentityTokenKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTAPNSDeviceTokenKey

    Swift

    let ARTAPNSDeviceTokenKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTClientIdKey

    Swift

    let ARTClientIdKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTAPNSDeviceDefaultTokenType

    Swift

    let ARTAPNSDeviceDefaultTokenType: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTAPNSDeviceLocationTokenType

    Swift

    let ARTAPNSDeviceLocationTokenType: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTPushActivationCurrentStateKey

    Swift

    let ARTPushActivationCurrentStateKey: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const ARTPushActivationPendingEventsKey

    Swift

    let ARTPushActivationPendingEventsKey: String

  • Error domain used for errors reported by ARTSRWebSocket.

    Declaration

    Objective-C

    extern NSString *const _Nonnull ARTSRWebSocketErrorDomain

    Swift

    let ARTSRWebSocketErrorDomain: String

  • Key used for HTTP status code if bad response was received from the server.

    Declaration

    Objective-C

    extern NSString *const _Nonnull ARTSRHTTPResponseErrorKey

    Swift

    let ARTSRHTTPResponseErrorKey: String

  • Use this pointer as a dictionary value in the ARTClientOptions.agents property and the ARTClientInformation.additionalAgents method to indicate that an agent does not have a version.

    Declaration

    Objective-C

    extern NSString *const _Nonnull ARTClientInformationAgentNotVersioned

    Swift

    let ARTClientInformationAgentNotVersioned: String

  • Set this key in ARTClientOptions.plugins to AblyLiveObjects.Plugin.self after importing AblyLiveObjects from the ably/ably-liveobjects-swift-plugin repository in order to enable LiveObjects functionality.

    Declaration

    Objective-C

    extern const ARTPluginName _Nonnull ARTPluginNameLiveObjects

    Swift

    static let liveObjects: ARTPluginName