Classes

Entry-point for your Application’s interaction with Point SDK.

Point SDK carries out location specific, conditional actions that you define in the Canvas web-interface. To start these behaviours with your Application, it is necessary only to call the initialize method on the BDLocationManager.instance “shared singleton instance” of BDLocationManager.

Calling the initialization method will start a session with Canvas..

In general, the BDLocationManager.instance “shared, singleton instance” of BDLocationManager should be used wherever the standard Core Location CLLocationManager class would have been used.

BDLocationManager is a subclass of CLLocationManager and is intended as a drop-in replacement while providing additional features.

BDLocationManager exposes a few new delegate properties, in addition to the usual delegate property inherited from CLLocationManager:

• BDLocationManager.geoTriggeringEventDelegate - to which you should assign your own implementation of the BDPGeoTriggeringEventDelegate protocol. The property provides callbacks to notify your application when Zone information is received and any zone enter/ zone exit events as they occur, in real-time.
• BDLocationManager.tempoTrackingDelegate - to which you should assign your own implementation of the BDPTempoTrackingDelegate protocol. This property provides callbacks to notify your application of Tempo related events.
• BDLocationManager.bluedotServiceDelegate - to which you should assign your own implementation of the BDPBluedotServiceDelegate protocol to receive Bluedot service related callbacks (for e.g. location permission changed, accuracy authorization changed, etc.).

By default, BDLocationManager disables background location updates for While Using location permission, which will not display the visual blue bar in the StatusBar area at the top of the screen and the Point SDK will not process location updates when app is in the background and permission is While Using. If you prefer to enable that behavior when app is in the background and permission is While Using, set BDLocationManager.backgroundLocationAccessForWhileUsing to true.

In addition, some methods of Point SDK classes may only be called while initialized and will otherwise cause an exception to be thrown. Individual restrictions are documented clearly in this API reference. It is only necessary to initialize once during the runtime of the application.

A rectangular coordinate region on the Earth’s surface, defined by two latitude / longitude corner BDPoint “points”.

A circular region on the Earth’s surface, defined by a center BDPoint “point” and a radius, in meters.

Information about a geofence, as defined in Canvas.

Base class for all geometries.

Concrete geometries include BDPoint “points”, BDBoundingBox “boxes”, BDCircle “circles”, BDLineString “line-strings” and BDPolygon “polygons”. A BDGeometry “geometry”, in this context, represents an area on the surface of the Earth, expressed in latitude and longitude coordinates.

Open-ended geometry consisting of two or more BDPoint “points” connected by straight-line segments.

Unlike a BDPolygon “polygon” this geometry is open-ended and has no area. When used as a BDFence “fence” geometry, BDLineString is typically used to represent a geographic boundary or check-point along a road or other travel path.

Represents a recorded, geographic location; combining a geographic BDPointSDK “point” with an altitude, as well as a known accuracy in metres.

Information about a location update.

A geographic point expressed in latitude and longitude coordinates.

Thrown when the Point SDK session life-cycle or initialization state has been violated.

Arbitrary region on the Earth’s surface, comprised of two or more BDPoint “points” connected by straight-line segments.

Unlike a BDLineString “line-string” this geometry forms an enclosed area.

Base-class for BDGeometry “geometries” defined by an ordered series of BDPoint “points”.

BDPolygonal is an abstract type and cannot be instantiated directly.

Instead, instantiate one of its concrete sub-classes.

Contains information about a Zone, including the set of BDFenceInfo “fences” that comprise it.

A set of BDZoneInfo objects will be delivered to your application’s BDPLocationDelegate at the time of their download from the Bluedot Point web-service.

An event triggered by GeoTriggering service when a trigger (zone entry or exit) happens.

This event is being sent to application via BDPGeoTriggeringEventDelegate.didEnterZone(_:) and BDPGeoTriggeringEventDelegate.didExitZone(_:).

A CrossedFence records details when a Fence is crossed. Useful to determine and inspect the list of crossed fences when a Travel Path condition is used.

A FenceEntered event is triggered when Zone entry conditions are met and an Entry trigger is to be registered in Canvas

A FenceExited event is triggered when the device leaves a zone and an Exit trigger is to be registered in Canvas

Detail of the TempoUpdate event being reported to main application via callback BDPTempoTrackingDelegate/tempoTrackingDidUpdate(_:) Includes details of the destination and ETA information

A Destination is a physical location your customers arrive at to collect their mobile order – this is usually your store or restaurant. Also known as Stores within Canvas

Details of the current application

Details about current state of the application

Details about the current device

OS related details

Details of a Zone. See its usage in GeoTriggerEvent.