ably_flutter library

Classes

Auth: Creates Ably TokenRequest objects and obtains Ably Tokens from Ably to subsequently issue to less trusted clients.
AuthOptions: Passes authentication-specific properties in authentication requests to Ably.
Channels<ChannelType>: Creates and destroys RestChannel and RealtimeChannel objects.
ChannelStateChange: Contains state change information emitted by RestChannel and RealtimeChannel objects.
CipherParams: Params to configure encryption for a channel.
ClientOptions: Passes additional client-specific properties to the REST Rest.new or the Realtime Realtime.new
Connection: Enables the management of a connection to Ably.
ConnectionStateChange: Contains ConnectionState change information emitted by the Connection object.
Crypto: Contains the properties required to configure the encryption of Message payloads.
DeltaExtras: Contains any arbitrary key-value pairs, which may also contain other primitive JSON types, JSON-encodable objects, or JSON-encodable arrays from delta compression.
DeviceDetails: Contains the properties of a device registered for push notifications.
DevicePushDetails: Contains the details of the push registration of a device.
DeviceRegistrationParams: Contains properties used to filter PushDeviceRegistrations devices.
ErrorCodes: Static error codes used inside the SDK
ErrorInfo: A generic Ably error object that contains an Ably-specific status code, and a generic status code.
HttpPaginatedResponse<T>: A superset of PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it.
LocalDevice: Contains the device identity token and secret of a device.
Message: Contains an individual message that is sent to, or received from, Ably.
MessageData<T>: Handles supported message data types, their encoding and decoding
MessageExtras: Handles supported message extras types, their encoding and decoding
Notification: Notification sent by APNS or FCM
PaginatedResult<T>: Contains a page of results for message or presence history, stats, or REST presence requests.
PresenceMessage: Contains an individual presence update sent to, or received from, Ably.
Push: Enables a device to be registered and deregistered from receiving push notifications.
PushActivationEvents: Contains streams that will emit a message whenever events related to push notifications occur, such as device activation, deactivation, or update fails.
PushAdmin: Enables the management of device registrations and push notification subscriptions. Also enables the publishing of push notifications to devices.
PushChannel: Enables devices to subscribe to push notifications for a channel.
PushChannelsParams: Contains properties used to filter PushChannelSubscriptions channels.
PushChannelSubscription: 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.
PushChannelSubscriptionParams: Contains properties used to filter PushChannel subscriptions.
PushChannelSubscriptions: Enables device push channel subscriptions.
PushDeviceRegistrations: Enables the management of push notification registrations with Ably.
PushNotificationEvents: Push Notification events, such as message arriving or notification tap.
Realtime: A client that extends functionality of the Rest and provides additional realtime-specific features.
RealtimeChannel: Enables messages to be published and subscribed to.
RealtimeChannelOptions: Passes additional properties to a RealtimeChannel object, such as encryption, ChannelMode and channel parameters.
RealtimeChannels: Creates and destroys RealtimeChannel objects.
RealtimeHistoryParams: Contains properties used to filter RealtimeChannel history.
RealtimePresence: Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.
RealtimePresenceParams: Contains properties used to filter RealtimePresence members.
RemoteMessage: Represents FCM Message on Android and APNS message on iOS Both data and notification are related to corresponding fields in Android FCM 'RemoteMessage' and iOS 'UNNotificationContent'
Rest: A client that offers a simple stateless API to interact directly with Ably's REST API.
RestChannel: Enables messages to be published and historic messages to be retrieved for a channel.
RestChannelOptions: Passes additional properties to a RestChannel object, such as encryption, ChannelModeand channel parameters.
RestChannels: Creates and destroys RestChannel objects.
RestHistoryParams: Contains properties used to filter RestChannel history.
RestPresence: Enables the retrieval of the current and historic presence set for a channel.
RestPresenceParams: Contains properties used to filter RestPresence members.
Stats: Contains application statistics for a specified time interval and time period.
StatsConnectionTypes: Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
StatsMessageCount: Contains the aggregate counts for messages and data transferred.
StatsMessageTraffic: Contains a breakdown of summary stats data for traffic over various transport types.
StatsMessageTypes: Contains a breakdown of summary stats data for different (channel vs presence) message types.
StatsRequestCount: Contains the aggregate counts for requests made.
StatsResourceCount: Contains the aggregate data for usage of a resource in a specific scope.
Timeouts: Static timeouts used inside the SDK
TokenDetails: Contains an Ably Token and its associated metadata.
TokenParams: Defines the properties of an Ably Token.
TokenRequest: Contains the properties of a request for a token to Ably. Tokens are generated using Auth.requestToken.

Functions

dartVersion() → String: Get version of Dart runtime
platformVersion() → Future<String>: Get android/iOS platform version
readSemverFromPlatformVersion(String platformVersion) → String: Extracts semver value from platform version value is split by space and first element is selected as semver value
version() → Future<String>: Get ably library version

Enums

ChannelEvent: Describes the events emitted by a RestChannel or RealtimeChannel object.
ChannelMode: Describes the possible flags used to configure client capabilities, using RestChannelOptions or RealtimeChannelOptions.
ChannelState: Describes the possible states of a RestChannel or RealtimeChannel object.
ConnectionEvent: Describes the events emitted by a Connection object. An event is either an UPDATE or an event from ConnectionState.
ConnectionState: Describes the realtime Connection object states.
DevicePlatform: Describes the device receiving push notifications.
DevicePushState: The current state of the push registration in DevicePushDetails.
FormFactor: Describes the type of device receiving a push notification.
LogLevel: Log levels - control verbosity of log messages
PresenceAction: Describes the possible actions members in the presence set can emit.
StatsIntervalGranularity: Describes the interval unit over which statistics are gathered.

Typedefs

BackgroundMessageHandler = void Function(RemoteMessage message): Type definition for a callback invoked when background push message is received.
LogHandler = void Function({AblyException? exception, String? msg}): Custom handler to handle SDK log messages

Exceptions / Errors

AblyException: An exception generated by the native client library called by this plugin

ably_flutter library

Classes

Functions

Enums

Typedefs

Exceptions / Errors

ably_flutter package

ably_flutter library