GeofencingFlutterPlugin class

The GeofencingFlutterPlugin class is a Dart class that provides methods for interacting with the geofencing functionality in the Flutter plugin. It includes methods for initializing the plugin, setting the Woosmap API key, requesting and checking permissions, starting and stopping tracking, watching location and region updates, setting SFMC credentials, starting custom tracking, adding and removing geofence regions, setting the POI radius, and getting and removing locations and POIs.

Constructors

GeofencingFlutterPlugin()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addRegion(GeofenceRegion geofenceRegion) → Future<String?>
The function addRegion adds a geofence region using the GeofencingFlutterPluginPlatform. @param {GeofenceRegion} geofenceRegion - The geofenceRegion parameter is an object of type GeofenceRegion. It represents a geographical region for which a geofence is being added. @returns The method is returning a Future object that resolves to a String or null.
clearLocationWatch() → Future<String?>
The function clearLocationWatch() returns a Future that clears the location watch for geofencing in a Flutter app. @returns The method is returning a Future object that resolves to a String or null.
clearProtectedRegionSlot() → Future<String?>
(Only for iOS platform) Clear region slots to reserve for any third party SDK. GeofencingFlutterPluginPlatform @returns The method is returning a Future object that resolves to a String or null
clearRegionWatch() → Future<String?>
The function clearRegionWatch() clears the region watch for geofencing in a Flutter app. @returns The method is returning a Future object that resolves to a String or null.
getBLEPermissionsStatus() → Future<String?>
The function getBLEPermissionsStatus() returns a Future that resolves to a nullable String representing the status of geofencing permissions. @returns The method is returning a Future object that resolves to a String or null.
getIndoorBeacons({String? venueID, String? ref}) → Future<List<IndoorBeacon>?>
The function getIndoorBeacons returns a Future that retrieves a list of IndoorBeacon objects inside an indoor venue using the GeofencingFlutterPluginPlatform. @param {String} venueID - The optional venueID parameter is a String that represents the ID of an indoor venue for which the beacons will be fetched. @param {String} ref - The optional ref parameter is a String that represents the identifier of the beacon which needs to be fetched. @returns The method is returning a Future object that resolves to a List of IndoorBeacon objects for the given venue or the given ref or both.
getLocations([String? locationId]) → Future<List<Location>?>
The function getLocations returns a future that retrieves a list of locations using the GeofencingFlutterPluginPlatform. @param {String} locationId - The locationId parameter is an optional String that represents the ID of a specific location. If provided, the function will retrieve the location with the matching ID. If not provided, the function will retrieve all locations. @returns a Future object that resolves to a List of Location objects, or null if no locations are found.
getNotificationPermissionsStatus() → Future<String?>
Returns notification permission / enablement status. Android 13+ (API 33): checks POST_NOTIFICATIONS + app enablement. iOS: returns "GRANTED".
getPermissionsStatus() → Future<String?>
The function getPermissionsStatus() returns a Future that resolves to a nullable String representing the status of geofencing permissions. @returns The method is returning a Future object that resolves to a String or null.
getPlatformVersion() → Future<String?>
The function getPlatformVersion() returns a Future that resolves to a String representing the platform version. @returns The method is returning a Future object that contains a String value or null.
getPois([String? poiID]) → Future<List<Poi>?>
The function getPois returns a Future that retrieves a list of Poi objects using the GeofencingFlutterPluginPlatform. @param {String} poiID - The poiID parameter is a String that represents the ID of a point of interest (POI). It is an optional parameter, meaning it can be null or have a value. @returns The method is returning a Future object that resolves to a List of Poi objects, or null if no poiID is provided.
getRegions([String? regionId]) → Future<List<Region>?>
The function getRegions retrieves a list of regions based on an optional region ID. @param {String} regionId - The regionId parameter is an optional String that represents the ID of a specific region. If provided, the function will return a Future containing a List of Region objects that match the specified regionId. If regionId is not provided, the function will return a Future containing a List of all available Region objects @returns The method is returning a Future object that resolves to a List<Region>? (a nullable list of Region objects).
getWatchLocationStream() → Stream<Location>?
The function returns a stream of location updates for geofencing. @returns A stream of locations is being returned.
getWatchRegionStream() → Stream<Region>?
The function returns a stream of regions to watch for geofencing. @returns A Stream of Region objects is being returned.
initialize([dynamic args]) → Future<String?>
The function initializes the GeofencingFlutterPluginPlatform instance with optional arguments and returns a Future that resolves to a String. @param args - The "args" parameter is a list of arguments that you can pass to the "initialize" method. The specific arguments will depend on the requirements of the GeofencingFlutterPluginPlatform's initialize method. @returns The method is returning a Future object that resolves to a String or null.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refreshPois() → Future<String?>
The function refreshPois() returns a Future that refresh latest Points of interest (POIs) using the GeofencingFlutterPluginPlatform. @returns The method is returning a Future object that resolves to a String or null
removeIndoorBeacons() → Future<String?>
The function removeIndoorBeacons() returns a Future that removes indoor points of interest (POIs) using the GeofencingFlutterPluginPlatform. @returns The method is returning a Future object that resolves to a String or null.
removeLocations() → Future<String?>
The function removeLocations() returns a Future that removes geofence locations using the GeofencingFlutterPluginPlatform instance. @returns The method is returning a Future object that resolves to a String or null.
removePois() → Future<String?>
The function removePois() returns a Future that removes points of interest (POIs) using the GeofencingFlutterPluginPlatform. @returns The method is returning a Future object that resolves to a String or null.
removeRegions([String? regionId]) → Future<String?>
The function removeRegions removes geofence regions specified by the regionId. @param {String} regionId - The regionId parameter is a list of String values representing the IDs of the regions that need to be removed. @returns The method is returning a Future object that resolves to a String or null.
requestBLEPermissions() → Future<String?>
The function requestBLEPermissions requests required BLE permissions for beacon-fencing. @returns The method is returning a Future object that resolves to a String or null.
requestNotificationPermissions() → Future<String?>
Requests notification permission (Android 13+). On iOS always "GRANTED".
requestPermissions({bool withBackgroundAccess = false}) → Future<String?>
The function requestPermissions requests permissions for geofencing, with an optional parameter for background permissions. @param {bool} withBackgroundAccess=false - The "background" parameter is a boolean value that indicates whether the geofencing permissions should be requested for background usage. If set to true, the permissions will be requested for background usage, allowing the app to monitor geofences even when it is not in the foreground. If set to false, @returns The method is returning a Future object that resolves to a String or null.
setPoiRadius(String radius) → Future<String?>
The function setPoiRadius sets the radius for points of interest (POI) in a geofencing plugin. @param {String} radius - The radius parameter is a string that represents the desired radius for the point of interest (POI). It specifies the distance from the center of the POI within which the geofencing should be triggered. @returns The method is returning a Future object that resolves to a String or null.
setProtectedRegionSlot(int args) → Future<String?>
(Only for iOS platform) Free up region slots to reserve for any third party SDK. Maximum 3 slots allows GeofencingFlutterPluginPlatform @returns The method is returning a Future object that resolves to a String or null
setSFMCCredentials(Map<String, String> credentials) → Future<String?>
The function setSFMCCredentials sets the SFMC credentials using the provided map of credentials. @param {Map<String, String>} credentials - A map containing the SFMC (Salesforce Marketing Cloud) credentials. The map should have key-value pairs where the key represents the credential name and the value represents the credential value. @returns The method is returning a Future object that resolves to a String or null (String?).
setWoosmapApiKey(String apiKey) → Future<String?>
The function sets the Woosmap API key for geofencing in a Flutter app. @param apiKey - The apiKey parameter is a string that represents the Woosmap API key. This key is used to authenticate and authorize access to the Woosmap API services. @returns The method is returning a Future object that resolves to a String or null (String?).
startCustomTracking(ProfileSource sourceType, String source) → Future<String?>
The function startCustomTracking starts custom tracking using the GeofencingFlutterPluginPlatform instance. @param {ProfileSource} sourceType - The sourceType parameter is of type ProfileSource, which is an enum that represents the type of source for the custom tracking. It could be one of the following values: GPS, WIFI, or CELLULAR. @param {String} source - The "source" parameter is a string that represents the source of the tracking data. It could be a device ID, a user ID, or any other identifier that helps identify the source of the tracking data. @returns The method is returning a Future object that resolves to a String or null (String?).
startTracking(String trackingProfile) → Future<String?>
The function startTracking starts tracking using the GeofencingFlutterPluginPlatform with the specified tracking profile. @param {String} trackingProfile - The trackingProfile parameter is a string that represents the specific profile or configuration for tracking. It could include information such as the desired accuracy, distance filter, or other settings related to the tracking functionality. @returns The method is returning a Future object that resolves to a String or null (String?).
stopTracking() → Future<String?>
The function stopTracking() returns a Future that stops tracking geofencing events. @returns The method is returning a Future object that resolves to a String or null (String?).
toString() → String
A string representation of this object.
inherited
watchLocation() → Future<String?>
The function watchLocation() returns a Future that resolves to a nullable String representing the location. @returns The method watchLocation() is returning a Future object that resolves to a String or null (String?).
watchRegion() → Future<String?>
The function watchRegion() returns a Future that will resolve to a nullable String value. @returns The method is returning a Future object that resolves to a String or null.

Operators

operator ==(Object other) → bool
The equality operator.
inherited