From f7c2da80ae089ebf3655c50a3d42c6f1d653f389 Mon Sep 17 00:00:00 2001 From: Neha Ishwar Date: Mon, 13 May 2024 13:04:16 +1000 Subject: [PATCH 1/2] Updated payload properties --- docs/Point SDK/Flutter/Events List.md | 7 ++++--- docs/Point SDK/Flutter/Geo-triggering.md | 2 +- docs/Point SDK/React Native/Events List.md | 7 ++++--- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/Point SDK/Flutter/Events List.md b/docs/Point SDK/Flutter/Events List.md index bce97e38..d0ca9715 100644 --- a/docs/Point SDK/Flutter/Events List.md +++ b/docs/Point SDK/Flutter/Events List.md @@ -10,15 +10,16 @@ Events List | **Name** | **Description** | **Event payload** | |--------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `didEnterZone` | Device enters a Zone | The method call will send arguments with the following properties: * `fenceInfo`: Fence information * `zoneInfo`: Zone information * `locationInfo`: Location information * `isExitEnabled`: Whether exit is enabled or disabled. `` * `customData`: Zone custom data | -| `didExitZone` | Device exits a Zone | The method call will send with the following properties: * `fenceInfo`: Fence information * `zoneInfo`: Zone information * `date`: Date of the exit event * `duration`: Time between the entry and exit event. | -| `onZoneInfoUpdate` | The SDK downloads the Zones | Array``. List of Zones downloaded. | +| `didEnterZone` | Device enters a Zone | The method call will send arguments with the following properties: * `notificationType`: Entry * `appInfo`: App details * `zoneInfo`: Zone information with Id, name and customData  * `triggerEvents`: Entry Event details with location information and crossedFences * `installRef`: Unique ID assigned to the device per Geo-trigger Session * `projectId`: ProjectId of the Project used from Canvas * `deviceInfo`: Device information * `triggerChainId`: Unique ID assigned to a particular Entry event | +| `didExitZone` | Device exits a Zone | The method call will send with the following properties:* `notificationType`: Exit * `appInfo`: App details * `zoneInfo`: Zone information with Id, name and customData  * `triggerEvents`: Exit Event details with location Info and and corresponding entry event * `installRef`: Unique ID assigned to the device per Geo-trigger Session * `projectId`: ProjectId of the Project used from Canvas * `deviceInfo`: Device information * `triggerChainId`: Unique ID same as the corresponding Entry event | +| `didUpdateZoneInfo` | The SDK downloads the Zones | List of Zones downloaded can be fetched from `BluedotPointSdk.getZonesAndFences()` | Tempo Events ------------ | **Name** | **Description** | **Event payload** | |---------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `tempoTrackingDidUpdate` | Real time ETA updates for every Tempo event send to backend. | Object with the following properties: * `eta` : Estimated time of arrival to a particular store * `etaDirection` : lessThan/ greaterThan from the eta value * `destination`: Destination details of the store like `address`, `location` and `destinationId` * `triggerChainId`: unique Id per Tempo session| | `tempoTrackingStoppedWithError` | Tempo has stopped due to an error. The error will be pass as arguments in the method call. | The method call will send arguments with the following properties: * `code`: Error code * `message`: Error description * `details`: Other error details | Helpers Events diff --git a/docs/Point SDK/Flutter/Geo-triggering.md b/docs/Point SDK/Flutter/Geo-triggering.md index 8546ef52..f21e004b 100644 --- a/docs/Point SDK/Flutter/Geo-triggering.md +++ b/docs/Point SDK/Flutter/Geo-triggering.md @@ -141,7 +141,7 @@ class _MyAppState extends State { geoTriggeringEventChannel.setMethodCallHandler((MethodCall call) async { var args = call.arguments; switch (call.method) { - case GeoTriggeringEvents.onZoneInfoUpdate: + case GeoTriggeringEvents.didUpdateZoneInfo: debugPrint('On Zone Info Update: $args'); break; case GeoTriggeringEvents.didEnterZone: diff --git a/docs/Point SDK/React Native/Events List.md b/docs/Point SDK/React Native/Events List.md index b309b203..00f7a201 100644 --- a/docs/Point SDK/React Native/Events List.md +++ b/docs/Point SDK/React Native/Events List.md @@ -17,15 +17,16 @@ GeoTriggering Events | **Name** | **Description** | **Event payload** | |------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `enterZone` | Device enters a Zone | Object with the following properties: * `fenceInfo`: Fence information * `zoneInfo`: Zone information * `locationInfo`: Location information * `isExitEnabled`: Wether Exit is enabled or disabled. ``` * `customData`: Zone custom data | -| `exitZone` | Device exits a Zone | Object with the following properties: * `fenceInfo`: Fence information * `zoneInfo`: Zone information * `date`: Date of the exit event * `duration`: Time between the entry and exit event. | -| `zoneInfoUpdate` | The SDK downloads the Zones | Array ``. List of Zones downloaded. | +| `enterZone` | Device enters a Zone | Object with the following properties: * `notificationType`: Entry * `appInfo`: App details * `zoneInfo`: Zone information with Id, name and customData  * `triggerEvents`: Entry Event details with location information and crossedFences * `installRef`: Unique ID assigned to the device per Geo-trigger Session * `projectId`: ProjectId of the Project used from Canvas * `deviceInfo`: Device information * `triggerChainId`: Unique ID assigned to a particular Entry event | +| `exitZone` | Device exits a Zone | Object with the following properties: * `notificationType`: Exit * `appInfo`: App details * `zoneInfo`: Zone information with Id, name and customData  * `triggerEvents`: Exit Event details with location Info and and corresponding entry event * `installRef`: Unique ID assigned to the device per Geo-trigger Session * `projectId`: ProjectId of the Project used from Canvas * `deviceInfo`: Device information * `triggerChainId`: Unique ID same as the corresponding Entry event | +| `zoneInfoUpdate` | The SDK downloads the Zones | List of Zones downloaded can be fetched from `BluedotPointSdk.getZonesAndFences()`. | Tempo Events ------------ | **Name** | **Description** | **Event payload** | |---------------------------------|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| `tempoTrackingDidUpdate` | Real time ETA updates for every Tempo event send to backend. | Object with the following properties: * `eta`: Estimated time of arrival to a particular store * `etaDirection` : lessThan/ greaterThan from the eta value * `destination`: Destination details of the store like address, location and destinationId * `triggerChainId`: unique Id per Tempo session | | `tempoTrackingDidExpire` | Tempo session has expired (Default 30 minutes). | Object with the following properties: * `error`: Error description | | `tempoTrackingStoppedWithError` | Tempo has stopped due to an error. _The error will be passed as a parameter in the callback._ | Object with the following properties: * `error`: Error description | From c20ca7a2909afdd9f7010cec60dc1cfeb60de5ad Mon Sep 17 00:00:00 2001 From: Neha Ishwar Date: Thu, 23 May 2024 14:47:22 +1000 Subject: [PATCH 2/2] quick start page updated --- docs/Point SDK/Flutter/Quick Start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Point SDK/Flutter/Quick Start.md b/docs/Point SDK/Flutter/Quick Start.md index 6e91db84..fed8ce9f 100644 --- a/docs/Point SDK/Flutter/Quick Start.md +++ b/docs/Point SDK/Flutter/Quick Start.md @@ -24,7 +24,7 @@ Or with Flutter: This will add a line like this to your package’s pubspec.yaml (and run an implicit `dart pub get`): ```yaml dependencies: - bluedot_point_sdk: ^1.0.0 + bluedot_point_sdk: ^2.0.0 ``` Alternatively, your editor might support `dart pub get` or `flutter pub get`. Check the docs for your editor to learn more.