Classes Reference


                    
                    
                    ARTAuth

Creates Ably ARTTokenRequest objects and obtains Ably Tokens from Ably to subsequently issue to less trusted clients.

See

See ARTAuthProtocol for details.

Declaration

Objective-C

@interface ARTAuth : NSObject <ARTAuthProtocol>

Swift

class ARTAuth : NSObject, ARTAuthProtocol, @unchecked Sendable


                    
                    
                    ARTAuthDetails

Contains the token string used to authenticate a client with Ably.

Declaration

Objective-C

@interface ARTAuthDetails : NSObject <NSCopying>

Swift

class ARTAuthDetails : NSObject, NSCopying


                    
                    
                    ARTAuthOptions

Passes authentication-specific properties in authentication requests to Ably. Properties set using ARTAuthOptions are used instead of the default values set when the client library is instantiated, as opposed to being merged with them.

Declaration

Objective-C

@interface ARTAuthOptions : NSObject <NSCopying>

Swift

class ARTAuthOptions : NSObject, NSCopying


                    
                    
                    ARTBaseMessage

A base interface for an ARTMessage and an ARTPresenceMessage objects.

Declaration

Objective-C

@interface ARTBaseMessage : NSObject <NSCopying>

Swift

class ARTBaseMessage : NSObject, NSCopying


                    
                    
                    ARTChannel

The base class for ARTRestChannel and ARTRealtimeChannel. Ably platform service organizes the message traffic within applications into named channels. Channels are the medium through which messages are distributed; clients attach to channels to subscribe to messages, and every message published to a unique channel is broadcast by Ably to all subscribers.

See

See ARTChannelProtocol for details.

Declaration

Objective-C

@interface ARTChannel : NSObject <ARTChannelProtocol>

Swift

class ARTChannel : NSObject, ARTChannelProtocol, @unchecked Sendable


                    
                    
                    ARTChannelOptions

Passes additional properties to an ARTRestChannel object, such as encryption.

Declaration

Objective-C

@interface ARTChannelOptions : NSObject

Swift

class ARTChannelOptions : NSObject


                    
                    
                    ARTChannels

Creates and destroys ARTRestChannel and ARTRealtimeChannel objects.

Declaration

Objective-C

@interface ARTChannels<ChannelType> : NSObject

Swift

class ARTChannels<ChannelType> : NSObject, @unchecked Sendable where ChannelType : AnyObject


                    
                    
                    ARTClientInformation

Provides information about the Ably client library and the environment in which it’s running.

Declaration

Objective-C

@interface ARTClientInformation : NSObject

Swift

class ARTClientInformation : NSObject


                    
                    
                    ARTClientOptions

Passes additional client-specific properties to the REST -[ARTRestProtocol initWithOptions:] or the Realtime -[ARTRealtimeProtocol initWithOptions:].

Declaration

Objective-C

@interface ARTClientOptions : ARTAuthOptions

Swift

class ARTClientOptions : ARTAuthOptions


                    
                    
                    ARTConnection

Enables the management of a connection to Ably.

See

See ARTConnectionProtocol for details.

Declaration

Objective-C

@interface ARTConnection : NSObject <ARTConnectionProtocol>

Swift

class ARTConnection : NSObject, ARTConnectionProtocol, @unchecked Sendable


                    
                    
                    ARTConnectionDetails

Contains any constraints a client should adhere to and provides additional metadata about a ARTConnection, such as if a request to -[ARTChannelProtocol publish:callback:] a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.

Declaration

Objective-C

@interface ARTConnectionDetails : NSObject

Swift

class ARTConnectionDetails : NSObject, @unchecked Sendable


                    
                    
                    ARTCipherParams

Sets the properties to configure encryption for an ARTRestChannel or ARTRealtimeChannel object.

Declaration

Objective-C

@interface ARTCipherParams : NSObject <ARTCipherParamsCompatible>

Swift

class ARTCipherParams : NSObject, ARTCipherParamsCompatible


                    
                    
                    ARTCrypto

Contains the properties required to configure the encryption of ARTMessage payloads.

Declaration

Objective-C

@interface ARTCrypto : NSObject

Swift

class ARTCrypto : NSObject


                    
                    
                    ARTDataQuery

This object is used for providing parameters into methods with paginated results.

Declaration

Objective-C

@interface ARTDataQuery : NSObject

Swift

class ARTDataQuery : NSObject


                    
                    
                    ARTRealtimeHistoryQuery

This object is used for providing parameters into ARTRealtimePresence‘s methods with paginated results.

Declaration

Objective-C

@interface ARTRealtimeHistoryQuery : ARTDataQuery

Swift

class ARTRealtimeHistoryQuery : ARTDataQuery


                    
                    
                    ARTDefault

Represents default library settings.

Declaration

Objective-C

@interface ARTDefault : NSObject

Swift

class ARTDefault : NSObject


                    
                    
                    ARTDeviceDetails

Contains the properties of a device registered for push notifications.

Declaration

Objective-C

@interface ARTDeviceDetails : NSObject

Swift

class ARTDeviceDetails : NSObject, @unchecked Sendable


                    
                    
                    ARTDeviceIdentityTokenDetails

An object representing a unique device identity token used to communicate with APNS.

Declaration

Objective-C

@interface ARTDeviceIdentityTokenDetails : NSObject <NSSecureCoding>

Swift

class ARTDeviceIdentityTokenDetails : NSObject, NSSecureCoding


                    
                    
                    ARTDevicePushDetails

Contains the details of the push registration of a device.

Declaration

Objective-C

@interface ARTDevicePushDetails : NSObject

Swift

class ARTDevicePushDetails : NSObject, @unchecked Sendable


                    
                    
                    ARTEventListener

An object representing a listener returned by ARTEventEmitter methods.

Declaration

Objective-C

@interface ARTEventListener : NSObject

Swift

class ARTEventListener : NSObject, @unchecked Sendable


                    
                    
                    ARTEventEmitter

A generic interface for event registration and delivery used in a number of the types in the Realtime client library. For example, the ARTConnection and ARTRealtimeChannel objects emit events for their state using the ARTEventEmitter pattern.

Declaration

Objective-C

@interface ARTEventEmitter<EventType : id <ARTEventIdentification>, ItemType>
    : NSObject

Swift

class ARTEventEmitter<EventType, ItemType> : NSObject, @unchecked Sendable where EventType : ARTEventIdentification, ItemType : AnyObject


                    
                    
                    ARTHTTPPaginatedResponse

A superset of ARTPaginatedResult which represents a page of results plus metadata indicating the relative queries available to it. ARTHttpPaginatedResponse additionally carries information about the response to an HTTP request.

Declaration

Objective-C

@interface ARTHTTPPaginatedResponse : ARTPaginatedResult <NSDictionary *>

Swift

class ARTHTTPPaginatedResponse : ARTPaginatedResult<NSDictionary>, @unchecked Sendable


                    
                    
                    ARTLocalDevice

Contains the device identity token and secret of a device. ARTLocalDevice extends ARTDeviceDetails.

Declaration

Objective-C

@interface ARTLocalDevice : ARTDeviceDetails

Swift

class ARTLocalDevice : ARTDeviceDetails, @unchecked Sendable


                    
                    
                    ARTMessage

Contains an individual message that is sent to, or received from, Ably.

Declaration

Objective-C

@interface ARTMessage : ARTBaseMessage

Swift

class ARTMessage : ARTBaseMessage


                    
                    
                    ARTPaginatedResult

Contains a page of results for message or presence history, stats, or REST presence requests. An ARTPaginatedResult response from a REST API paginated query is also accompanied by metadata that indicates the relative queries available to the ARTPaginatedResult object.

Declaration

Objective-C

@interface ARTPaginatedResult<ItemType> : NSObject

Swift

class ARTPaginatedResult<ItemType> : NSObject, @unchecked Sendable where ItemType : AnyObject


                    
                    
                    ARTPresenceMessage

Contains an individual presence update sent to, or received from, Ably.

Declaration

Objective-C

@interface ARTPresenceMessage : ARTBaseMessage

Swift

class ARTPresenceMessage : ARTBaseMessage


                    
                    
                    ARTPush

Enables a device to be registered and deregistered from receiving push notifications.

Declaration

Objective-C

@interface ARTPush : NSObject <ARTPushProtocol>

Swift

class ARTPush : NSObject, ARTPushProtocol, @unchecked Sendable


                    
                    
                    ARTPushAdmin

Enables the management of device registrations and push notification subscriptions. Also enables the publishing of push notifications to devices.

Declaration

Objective-C

@interface ARTPushAdmin : NSObject <ARTPushAdminProtocol>

Swift

class ARTPushAdmin : NSObject, ARTPushAdminProtocol, @unchecked Sendable


                    
                    
                    ARTPushChannel

Enables devices to subscribe to push notifications for a channel.

See

See ARTPushChannelProtocol for details.

Declaration

Objective-C

@interface ARTPushChannel : NSObject <ARTPushChannelProtocol>

Swift

class ARTPushChannel : NSObject, ARTPushChannelProtocol, @unchecked Sendable


                    
                    
                    ARTPushChannelSubscription

Contains the subscriptions of a device, or a group of devices sharing the same clientId, has to a channel in order to receive push notifications.

Declaration

Objective-C

@interface ARTPushChannelSubscription : NSObject

Swift

class ARTPushChannelSubscription : NSObject


                    
                    
                    ARTPushChannelSubscriptions

Enables device push channel subscriptions.

See

See ARTPushChannelSubscriptionsProtocol for details.

Declaration

Objective-C

@interface ARTPushChannelSubscriptions
    : NSObject <ARTPushChannelSubscriptionsProtocol>

Swift

class ARTPushChannelSubscriptions : NSObject, ARTPushChannelSubscriptionsProtocol, @unchecked Sendable


                    
                    
                    ARTPushDeviceRegistrations

Enables the management of push notification registrations with Ably.

See

See ARTPushDeviceRegistrationsProtocol for details.

Declaration

Objective-C

@interface ARTPushDeviceRegistrations
    : NSObject <ARTPushDeviceRegistrationsProtocol>

Swift

class ARTPushDeviceRegistrations : NSObject, ARTPushDeviceRegistrationsProtocol, @unchecked Sendable


                    
                    
                    ARTRealtime

A client that extends the functionality of the ARTRest and provides additional realtime-specific features.

Declaration

Objective-C

@interface ARTRealtime : NSObject <ARTRealtimeProtocol>

Swift

class ARTRealtime : NSObject, ARTRealtimeProtocol, @unchecked Sendable


                    
                    
                    ARTChannelProperties

Describes the properties of the channel state.

Declaration

Objective-C

@interface ARTChannelProperties : NSObject

Swift

class ARTChannelProperties : NSObject


                    
                    
                    ARTRealtimeChannel

Enables messages to be published and subscribed to. Also enables historic messages to be retrieved and provides access to the ARTRealtimePresence object of a channel. Also implements ARTEventEmitter interface and emits ARTChannelEvent events, where a ARTChannelEvent is either a ARTRealtimeChannelState or an ARTChannelEvent.ARTChannelEventUpdate.

Declaration

Objective-C

@interface ARTRealtimeChannel : NSObject <ARTRealtimeChannelProtocol>

Swift

class ARTRealtimeChannel : NSObject, ARTRealtimeChannelProtocol, @unchecked Sendable


                    
                    
                    ARTRealtimeChannelOptions

Passes additional properties to an ARTRealtimeChannel object, such as encryption, an ARTChannelMode and channel parameters.

Declaration

Objective-C

@interface ARTRealtimeChannelOptions : ARTChannelOptions

Swift

class ARTRealtimeChannelOptions : ARTChannelOptions


                    
                    
                    ARTRealtimePresenceQuery

This object is used for providing parameters into ARTRealtimePresence‘s methods with paginated results.

Declaration

Objective-C

@interface ARTRealtimePresenceQuery : ARTPresenceQuery

Swift

class ARTRealtimePresenceQuery : ARTPresenceQuery


                    
                    
                    ARTRealtimePresence

Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.

See

See ARTRealtimePresenceProtocol for details.

Declaration

Objective-C

@interface ARTRealtimePresence : ARTPresence <ARTRealtimePresenceProtocol>

Swift

class ARTRealtimePresence : ARTPresence, ARTRealtimePresenceProtocol, @unchecked Sendable


                    
                    
                    ARTRest

A client that offers a simple stateless API to interact directly with Ably’s REST API.

Declaration

Objective-C

@interface ARTRest : NSObject <ARTRestProtocol>

Swift

class ARTRest : NSObject, ARTRestProtocol, @unchecked Sendable


                    
                    
                    ARTRestChannel

Enables messages to be published and historic messages to be retrieved for a channel.

Declaration

Objective-C

@interface ARTRestChannel : NSObject <ARTRestChannelProtocol>

Swift

class ARTRestChannel : NSObject, ARTRestChannelProtocol, @unchecked Sendable


                    
                    
                    ARTPresenceQuery

This object is used for providing parameters into ARTRestPresence‘s methods with paginated results.

Declaration

Objective-C

@interface ARTPresenceQuery : NSObject

Swift

class ARTPresenceQuery : NSObject


                    
                    
                    ARTRestPresence

Enables the retrieval of the current and historic presence set for a channel.

See

See ARTRestPresenceProtocol for details.

Declaration

Objective-C

@interface ARTRestPresence : ARTPresence <ARTRestPresenceProtocol>

Swift

class ARTRestPresence : ARTPresence, ARTRestPresenceProtocol, @unchecked Sendable


                    
                    
                    ARTStatsQuery

This object is used for providing parameters into ARTStats‘s methods with paginated results.

Declaration

Objective-C

@interface ARTStatsQuery : ARTDataQuery

Swift

class ARTStatsQuery : ARTDataQuery


                    
                    
                    ARTStatsMessageCount

Contains the aggregate counts for messages and data transferred.

Declaration

Objective-C

@interface ARTStatsMessageCount : NSObject

Swift

class ARTStatsMessageCount : NSObject


                    
                    
                    ARTStatsMessageTypes

Contains a breakdown of summary stats data for different (channel vs presence) message types.

Declaration

Objective-C

@interface ARTStatsMessageTypes : NSObject

Swift

class ARTStatsMessageTypes : NSObject


                    
                    
                    ARTStatsMessageTraffic

Contains a breakdown of summary stats data for traffic over various transport types.

Declaration

Objective-C

@interface ARTStatsMessageTraffic : NSObject

Swift

class ARTStatsMessageTraffic : NSObject


                    
                    
                    ARTStatsResourceCount

Contains the aggregate data for usage of a resource in a specific scope.

Declaration

Objective-C

@interface ARTStatsResourceCount : NSObject

Swift

class ARTStatsResourceCount : NSObject


                    
                    
                    ARTStatsConnectionTypes

Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.

Declaration

Objective-C

@interface ARTStatsConnectionTypes : NSObject

Swift

class ARTStatsConnectionTypes : NSObject


                    
                    
                    ARTStatsRequestCount

Contains the aggregate counts for requests made.

Declaration

Objective-C

@interface ARTStatsRequestCount : NSObject

Swift

class ARTStatsRequestCount : NSObject


                    
                    
                    ARTStatsPushCount

Details the stats on push notifications.

Declaration

Objective-C

@interface ARTStatsPushCount : NSObject

Swift

class ARTStatsPushCount : NSObject


                    
                    
                    ARTStats

Contains application statistics for a specified time interval and time period.

Declaration

Objective-C

@interface ARTStats : NSObject

Swift

class ARTStats : NSObject


                    
                    
                    ARTErrorInfo

A generic Ably error object that contains an Ably-specific status code, and a generic status code. Errors returned from the Ably server are compatible with the ARTErrorInfo structure and should result in errors that inherit from ARTErrorInfo.

See

For possible NSError.code see Ably error codes.

Declaration

Objective-C

@interface ARTErrorInfo : NSError

Swift

class ARTErrorInfo : NSError


                    
                    
                    ARTTokenDetails

Contains an Ably Token and its associated metadata.

Declaration

Objective-C

@interface ARTTokenDetails : NSObject <NSCopying>

Swift

class ARTTokenDetails : NSObject, NSCopying


                    
                    
                    ARTTokenParams

Defines the properties of an Ably Token.

Declaration

Objective-C

@interface ARTTokenParams : NSObject <NSCopying>

Swift

class ARTTokenParams : NSObject, NSCopying


                    
                    
                    ARTTokenRequest

Contains the properties of a request for a token to Ably. Tokens are generated using -[ARTAuthProtocol requestToken:].

Declaration

Objective-C

@interface ARTTokenRequest : NSObject

Swift

class ARTTokenRequest : NSObject


                    
                    
                    ARTConnectionStateChange

Contains ARTRealtimeConnectionState change information emitted by the ARTConnection object.

Declaration

Objective-C

@interface ARTConnectionStateChange : NSObject

Swift

class ARTConnectionStateChange : NSObject, @unchecked Sendable


                    
                    
                    ARTChannelStateChange

Contains state change information emitted by an ARTRealtimeChannel object.

Declaration

Objective-C

@interface ARTChannelStateChange : NSObject

Swift

class ARTChannelStateChange : NSObject, @unchecked Sendable


                    
                    
                    ARTChannelMetrics

Contains the metrics associated with a ARTRestChannel or ARTRealtimeChannel, such as the number of publishers, subscribers and connections it has.

Declaration

Objective-C

@interface ARTChannelMetrics : NSObject

Swift

class ARTChannelMetrics : NSObject, @unchecked Sendable


                    
                    
                    ARTChannelOccupancy

Contains the metrics of a ARTRestChannel or ARTRealtimeChannel object.

Declaration

Objective-C

@interface ARTChannelOccupancy : NSObject

Swift

class ARTChannelOccupancy : NSObject, @unchecked Sendable


                    
                    
                    ARTChannelStatus

Contains the status of a ARTRestChannel or ARTRealtimeChannel object such as whether it is active and its ARTChannelOccupancy.

Declaration

Objective-C

@interface ARTChannelStatus : NSObject

Swift

class ARTChannelStatus : NSObject, @unchecked Sendable


                    
                    
                    ARTChannelDetails

Contains the details of a ARTRestChannel or ARTRealtimeChannel object such as its ID and ARTChannelStatus.

Declaration

Objective-C

@interface ARTChannelDetails : NSObject

Swift

class ARTChannelDetails : NSObject, @unchecked Sendable