{"id":20770527,"url":"https://github.com/ably/ably-flutter","last_synced_at":"2025-10-26T14:05:09.929Z","repository":{"id":39587902,"uuid":"235354202","full_name":"ably/ably-flutter","owner":"ably","description":"A wrapper around our Cocoa and Java client library SDKs, providing iOS and Android support for those using Flutter and Dart.","archived":false,"fork":false,"pushed_at":"2025-02-19T16:50:10.000Z","size":5781,"stargazers_count":61,"open_issues_count":73,"forks_count":18,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-03-30T03:06:42.408Z","etag":null,"topics":["android","client-library","dart","flutter","ios","realtime","realtime-messaging","sdk","streaming","websockets"],"latest_commit_sha":null,"homepage":"https://ably.com/download","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ably.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-21T13:54:09.000Z","updated_at":"2025-03-04T12:50:16.000Z","dependencies_parsed_at":"2023-12-22T21:29:14.446Z","dependency_job_id":"aeff3394-cc29-46ba-ba17-8912c7af7949","html_url":"https://github.com/ably/ably-flutter","commit_stats":{"total_commits":2608,"total_committers":26,"mean_commits":100.3076923076923,"dds":0.7246932515337423,"last_synced_commit":"c6a780f4ad740872cf632360393d46d1bb33224f"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fably-flutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fably-flutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fably-flutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fably-flutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ably","download_url":"https://codeload.github.com/ably/ably-flutter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430873,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","client-library","dart","flutter","ios","realtime","realtime-messaging","sdk","streaming","websockets"],"created_at":"2024-11-17T12:10:06.122Z","updated_at":"2025-10-26T14:05:09.924Z","avatar_url":"https://github.com/ably.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Ably Pub/Sub Flutter Header](images/flutterSDK-github.png)\n[![Pub Version](https://img.shields.io/pub/v/ably_flutter)](https://pub.dev/packages/ably_flutter)\n[![License](https://badgen.net/github/license/ably/ably-flutter)](https://github.com/ably/ably-flutter/blob/main/LICENSE)\n\n---\n\n# Ably Pub/Sub Flutter SDK\n\nBuild any realtime experience using Ably’s Pub/Sub Flutter SDK. Supported on popular platforms and frameworks, including Android and iOS.\n\nAbly Pub/Sub provides flexible APIs that deliver features such as pub-sub messaging, message history, presence, and push notifications. Utilizing Ably’s realtime messaging platform, applications benefit from its highly performant, reliable, and scalable infrastructure.\n\nFind out more:\n\n* [Ably Pub/Sub docs.](https://ably.com/docs/basics)\n* [Ably Pub/Sub examples.](https://ably.com/examples?product=pubsub)\n\n---\n\n## Getting started\n\nEverything you need to get started with Ably:\n\n* [Getting started in Pub/Sub using Flutter.](https://ably.com/docs/getting-started/flutter)\n* [SDK Setup for Flutter.](https://ably.com/docs/getting-started/setup?lang=flutter)\n\n---\n\n## Supported platforms\n\nAbly aims to support a wide range of platforms. If you experience any compatibility issues, open an issue in the repository or contact [Ably support](https://ably.com/support).\n\nThis SDK supports the following platforms:\n\n| Platform | Support |\n|----------|---------|\n| Android  | Android 4.4 (API level 19) or newer. Java 8 language features supported via [Desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring). |\n| iOS      | iOS 10 or newer |\n| Flutter  | Flutter 2.5.0 or higher |\n\n\u003e [!NOTE]\n\u003e If your project needs support for SDK Version lower than 24, Android Gradle Plugin 4.0.0+ must be used.\nYou might also need to upgrade [gradle distribution](https://developer.android.com/studio/releases/gradle-plugin#updating-plugin).\n\u003e [!IMPORTANT]\n\u003e SDK versions \u003c 1.2.25 will be [deprecated](https://ably.com/docs/platform/deprecate/protocol-v1) from November 1, 2025.\n\n---\n\n## Installation\n\nTo get started with your project, install the package:\n\nAdd the Ably Flutter package to your project by including it in your `pubspec.yaml` file:\n\n```yaml\ndependencies:\n  ably_flutter: ^1.2.40\n```\n\nOnce added to your dependencies, import it in your Dart code:\n\n```dart\nimport 'package:ably_flutter/ably_flutter.dart' as ably;\n```\n\n\u003e [!NOTE]\n\u003e When increasing the version of `ably_flutter` in your `pubspec.yaml`, if there are breaking changes, follow the [updating / migration guide](UPDATING.md).\n\n---\n\n## Usage\n\nThe following code connects to Ably's realtime messaging service, subscribes to a channel to receive messages, and publishes a test message to that same channel:\n\n```dart\n  // Initialize Ably Realtime client\n  final clientOptions = ably.ClientOptions(\n    key: 'your-ably-api-key',\n    clientId: 'me',\n  );\n  \n  final realtimeClient = ably.Realtime(options: clientOptions);\n  \n  // Wait for connection to be established\n  await realtimeClient.connection\n      .on(ably.ConnectionEvent.connected)\n      .first\n      .then((stateChange) {\n    print('Connected to Ably');\n  });\n  \n  // Get a reference to the 'test-channel' channel\n  final channel = realtimeClient.channels.get('test-channel');\n  \n  // Subscribe to all messages published to this channel\n  channel.subscribe().listen((ably.Message message) {\n    print('Received message: ${message.data}');\n  });\n  \n  // Publish a test message to the channel\n  await channel.publish(\n    name: 'test-event',\n    data: 'hello world',\n  );\n```\n\n---\n\n\n## Releases\n\nThe [CHANGELOG.md](./CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).\n\n---\n\n## Contributing\n\nRead the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to contribute to Ably.\n\n---\n\n## Support, feedback, and troubleshooting\n\nFor help or technical support, visit the [Ably Support page](https://ably.com/support) or [GitHub Issues](https://github.com/ably/ably-flutter/issues) for community-reported bugs and discussions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fably-flutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fably%2Fably-flutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fably-flutter/lists"}