GeofenceApi

public protocol GeofenceApi

Protocol to provide access to GeofenceSDK methods whereby users can add and/or remove programmatic geofences as well as listeners to events related to Geofences

  • Add a GeofenceTrigger for a property

    Declaration

    Swift

    func addGeofenceTrigger(propertyId: Int,
                        geofenceTrigger: GeofenceTrigger) -> Bool

    Parameters

    propertyId

    An identifier for the property
    geofenceTrigger

    The Geofence trigger to associate with property

  • Add multiple GeofenceTriggers at once for a property

    Declaration

    Swift

    func addGeofenceTriggers(propertyId: Int,
                         geofenceTriggers: [GeofenceTrigger]) -> Bool

    Parameters

    propertyId

    An identifier for the property
    geofenceTriggers

    List of Geofence triggers to associate with property

  • Remove a specific GeofenceTrigger from a property

    Declaration

    Swift

    func removeGeofenceTrigger(propertyId: Int,
                          geofenceId: String) -> Bool

    Parameters

    propertyId

    An identifier for the property
    geofenceTrigger

    The Geofence trigger to remove from property

  • Remove all GeofenceTriggers from a property

    Declaration

    Swift

    func removeAllGeofenceTriggers(propertyId: Int) -> Bool

    Parameters

    propertyId

    An identifier for the property

  • Add a listener to GeofenceTrigger call back events

    Declaration

    Swift

    func addListener(geofenceCallback: GeofenceCallback)

    Parameters

    geofenceCallback

    The callback to register as listener for Geofence events

  • Remove a listener to GeofenceTrigger call back events

    Declaration

    Swift

    func removeListener(geofenceCallback: GeofenceCallback) -> Bool

    Parameters

    geofenceCallback

    The callback to remove as listener for Geofence events