Skip to content

Updated payload properties #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nehabluedot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated payload properties #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7c2da8
Updated payload properties
nehabluedot May 13, 2024
c20ca7a
quick start page updated
nehabluedot May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/Point SDK/Flutter/Events List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. `<Bool>` * `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`<Zones>`. 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
Expand Down
2 changes: 1 addition & 1 deletion docs/Point SDK/Flutter/Geo-triggering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ class _MyAppState extends State<MyApp> {
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:
Expand Down
2 changes: 1 addition & 1 deletion docs/Point SDK/Flutter/Quick Start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions docs/Point SDK/React Native/Events List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. `<Bool>`` * `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 `<Zones>`. 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 |

Expand Down