Classes

The following classes are available globally.

  • @brief Information about a BLE Beacon, as defined in Point Access.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDBeaconInfo : NSObject <BDPSpatialObjectInfo, NSCoding>
  • @brief A rectangular coordinate region on the Earth’s surface, defined by two latitude / longitude corner @ref BDPoint “points”.

    \image html boundingBox.gif

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDBoundingBox : BDGeometry <NSCopying, BDPValidatable, NSCoding>
  • @brief A circular region on the Earth’s surface, defined by a center @ref BDPoint “point” and a radius, in meters.

    \image html circle.gif

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDCircle : BDGeometry <NSCoding>
  • @brief Information about a geofence, as defined in Point Access.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDFenceInfo : NSObject <BDPSpatialObjectInfo, NSCoding>
  • @brief Base class for all geometries.

    Concrete geometries include @ref BDPoint “points”, @ref BDBoundingBox “boxes”, @ref BDCircle “circles”, @ref BDLineString “line-strings” and @ref BDPolygon “polygons”.

    A @ref BDGeometry “geometry”, in this context, represents an area on the surface of the Earth, expressed in latitude and longitude coordinates.

    @copyright Bluedot Innovation

    Declaration

    Objective-C

    @interface BDGeometry : NSObject <BDPGeometry>
  • @brief Open-ended geometry consisting of two or more @ref BDPoint “points” connected by straight-line segments.

    Unlike a @ref BDPolygon “polygon” this geometry is open-ended and has no area.

    When used as a @ref BDFence “fence” geometry, @ref BDLineString is typically used to represent a geographic boundary or check-point along a road or other travel path.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDLineString : BDPolygonal <NSCoding>
  • Represents a recorded, geographic location; combining a geographic @ref BDPointSDK “point” with an altitude, as well as a known accuracy in metres.

    See more

    Declaration

    Objective-C

    @interface BDLocation : NSObject <BDPDeepCopy>
  • @brief Information about a location update.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDLocationInfo : NSObject
  • @brief Entry-point for your Application’s interaction with Point SDK.

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

    Calling the authentication method will start a session with Point Access. Upon success, @ref BDZoneInfo “Zones” will be downloaded and associated actions will be executed by the library, without any further intervention.

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

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

    @ref BDLocationManager exposes two new delegate properties, in addition to the usual delegate property inherited from CLLocationManager:

    • sessionDelegate to which you should assign your own implementation of the @ref BDPSessionDelegate protocol.
    • locationDelegate to which you should assign your own implementation of the @ref BDPLocationDelegate protocol.

    More fully, these features are:

    Session Delegate

    The @ref BDPSessionDelegate protocol provides callbacks that inform the application of Point SDK‘s authentication state with it’s supporting web-service. The rules defined in Point Access will only be observed while authenticated.

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

    Location Delegate

    Following the delegate pattern familiar throughout Apple’s CocoaTouch frameworks, the @ref locationDelegate property of BDLocationManager provides callbacks to notify your application when: Zone information is received. This typically occurs immediately after the authentication process completes. Any Custom Actions defined in the Point Access are triggered, in real-time.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDLocationManager : CLLocationManager
  • @brief A geographic point expressed in latitude and longitude coordinates.

    See more

    Declaration

    Objective-C

    @interface BDPoint : BDGeometry <NSCopying, NSCoding>
  • @brief Produces MapKit overlay renderers for @ref BDFenceInfo and @ref BDBeaconInfo overlays.

    General workflow for using this class is shown in the BDPoint example application source-code on GitHub.

    See more

    Declaration

    Objective-C

    @interface BDPointOverlayRendererFactory : NSObject
  • @brief Thrown when the Point SDK session life-cycle or authentication state has been violated. @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDPointSessionException : NSException
  • @brief Arbitrary region on the Earth’s surface, comprised of two or more @ref BDPoint “points” connected by straight-line segments.

    @image html polygon.gif

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

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDPolygon : BDPolygonal <NSCoding>
  • @brief Base-class for @ref BDGeometry “geometries” defined by an ordered series of @ref BDPoint “points”.

    @ref BDPolygonal is an abstract type and cannot be instantiated directly.

    Instead, instantiate one of its concrete sub-classes.

    See

    details in @ref BDPolygon

    See

    details in @ref BDLineString
    See more

    Declaration

    Objective-C

    @interface BDPolygonal : BDGeometry
  • @brief Contains information about a Zone, including the set of @ref BDFenceInfo “fences” that comprise it.

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

    This usually occurs immediately after the authentication process is complete.

    @copyright Bluedot Innovation

    See more

    Declaration

    Objective-C

    @interface BDZoneInfo : NSObject