BREAKING CHANGE: Update API for connection, communication channel state and is browser value (#14)

* refactor(lib, example, example_full): use streams for communication channel and is ios browser

* feat: add abstract toJson() to message

* refactor: add deprecations for nearby_service

* feat(example): update main.dart

* feat(nearby_service): add comments

* feat(nearby_service_platform_interface): add deprecation to getConnectedDeviceStream

* feat(nearby_service/message): add concrete implementation for toJson()

* feat(nearby_service/android): add deprecations

* fix(nearby_service/android): reset check for android device

* fix(nearby_service/ios): change ios service to deprecations variant

* chore(nearby_service): edit deprecation messages

* chore: update gitignore

* doc: add CONTRIBUTING file

* doc: update CONTRIBUTING file

* chore: update CONTRIBUTING.md

* chore: update CONTRIBUTING.md

* chore: version 0.1.0

* fix(example_full): move startListeningCommunicationChannelState() upper
This commit is contained in:
Kseniia Nikitina
2024-08-18 15:42:53 +02:00
committed by GitHub
parent 1818166d06
commit 7049c39cf0
15 changed files with 388 additions and 79 deletions
+14
View File
@@ -1,3 +1,17 @@
## 0.1.0
**!! BREAKING CHANGES !!**
- Method `connect()` is **deprecated**. Added `connectById()` method instead
- Method `disconnect()` is **deprecated**. Added `disconnectById()` method instead
- Getter `communicationChannelState` is **deprecated**. Added `getCommunicationChannelStateStream()` method
and `communicationChannelStateValue` getter instead
- Getter `isBrowser` is **deprecated**. Added `getIsBrowserStream()` method and `isBrowserValue` getter instead
- Added `toJson()` method to `NearbyMessage` class and its subclasses
More information about the deprecated API here: https://github.com/ksenia312/nearby_service/pull/14.
In the next versions, the deprecated API will be removed.
## 0.0.9
- Add initialization checks for Android and IOS