GeofencingFlutterPluginPlatform class abstract
The abstract class GeofencingFlutterPluginPlatform extends PlatformInterface
is defining an
abstract class named GeofencingFlutterPluginPlatform
that extends the PlatformInterface
class.
This abstract class serves as a platform interface for the Geofencing Flutter plugin, providing a
set of methods that need to be implemented by platform-specific classes.
- Inheritance
-
- Object
- PlatformInterface
- GeofencingFlutterPluginPlatform
- Implementers
Constructors
- GeofencingFlutterPluginPlatform()
- Constructs a GeofencingFlutterPluginPlatform.
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() is not implemented and throws an UnimplementedError.
@param {GeofenceRegion} geofenceRegion - The
geofenceRegion
parameter is an object of typeGeofenceRegion
. It represents a geographical region that you want to add to a geofence. -
clearLocationWatch(
) → Future< String?> -
The function
clearLocationWatch()
throws anUnimplementedError
indicating that it has not been implemented yet. -
clearRegionWatch(
) → Future< String?> -
The function
clearRegionWatch()
throws an error indicating that it has not been implemented yet. -
getBLEPermissionsStatus(
) → Future< String?> - The function getBLEPermissionsStatus() is not implemented and throws an UnimplementedError.
-
getIndoorBeacons(
String? venueID, String? ref) → Future< List< IndoorBeacon> ?> -
The function
getIndoorBeacons
returns a Future that may contain a list of IndoorBeacon objects, and it accepts an optional venueID parameter. @param {String}venueID
- ThevenueID
parameter is a nullable String that represents the ID of an indoor venue. @param {String}ref
- Theref
parameter is a nullable String that represents the identifier of an indoor beacon. -
getLocations(
[String? locationId]) → Future< List< Location> ?> -
The function
getLocations
is a placeholder that throws an error indicating it has not been implemented yet. @param {String}locationId
- ThelocationId
parameter is an optionalString
that represents the ID of a specific location. -
getPermissionsStatus(
) → Future< String?> - The function getPermissionsStatus() is not implemented and throws an UnimplementedError.
-
getPlatformVersion(
) → Future< String?> - The function getPlatformVersion() throws an UnimplementedError.
-
getPois(
[String? poiID]) → Future< List< Poi> ?> -
The function
getPois
returns a Future that may contain a list of Poi objects, and it accepts an optional poiID parameter. @param {String}poiID
- ThepoiID
parameter is a nullable String that represents the ID of a point of interest (POI). -
getRegions(
[String? regionId]) → Future< List< Region> ?> -
The function
getRegions
returns a Future that resolves to a list of Region objects, or null, and takes an optional regionId parameter. @param {String}regionId
- The regionId parameter is an optional String that represents the ID of a specific region. -
getWatchLocationStream(
) → Stream< Location> ? - The function getWatchLocationStream() returns a stream of location updates.
-
getWatchRegionStream(
) → Stream< Region> ? - The function getWatchRegionStream() is a placeholder that throws an UnimplementedError.
-
initialize(
[dynamic args]) → Future< String?> -
The function
initialize
is a placeholder that throws an error indicating it has not been implemented yet. @paramargs
- The "args" parameter is a placeholder for any additional arguments that may be required for the initialization process. It can be of any data type or can be omitted if not needed. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
refreshPois(
) → Future< String?> - The function refreshPois() throws an UnimplementedError indicating that it has not been implemented yet.
-
removeIndoorBeacons(
) → Future< String?> - The function removeIndoorBeacons() throws an UnimplementedError indicating that it has not been implemented yet.
-
removeLocations(
) → Future< String?> -
The function
removeLocations()
throws an error indicating that it has not been implemented yet. -
removePois(
) → Future< String?> - The function removePois() throws an UnimplementedError indicating that it has not been implemented yet.
-
removeRegions(
[String? regionId]) → Future< String?> -
The function
removeRegions
is a placeholder that throws an error indicating it has not been implemented yet. @param {String}regionId
- The parameterregionId
is a list of strings, where each string represents the ID of a region to be removed. -
requestBLEPermissions(
) → Future< String?> -
The function
requestBLEPermissions
is not implemented and throws anUnimplementedError
. -
requestPermissions(
[dynamic background]) → Future< String?> -
The function
requestPermissions
is not implemented and throws anUnimplementedError
. @parambackground
- The "background" parameter is a boolean value that indicates whether the permission request should be made in the background or foreground. If it is set to true, the permission request will be made in the background, otherwise it will be made in the foreground. -
setPoiRadius(
String radius) → Future< String?> - The function setPoiRadius() is a placeholder that throws an UnimplementedError. @param {String} radius - The "radius" parameter is a string that represents the desired radius for a point of interest (POI).
-
setSFMCCredentials(
Map< String, String> credentials) → Future<String?> -
The function
setSFMCCredentials
is a placeholder that throws an error indicating it has not been implemented yet. @param {Map<String, String>} credentials - A map containing the SFMC credentials. The keys in the map represent the credential names, and the values represent the corresponding credential values. -
setWoosmapApiKey(
dynamic apiKey) → Future< String?> -
The function
setWoosmapApiKey
is not implemented and throws anUnimplementedError
. @param apiKey - The apiKey parameter is a string that represents the API key for the Woosmap service. -
startCustomTracking(
ProfileSource sourceType, String source) → Future< String?> -
The function "startCustomTracking" is a placeholder that throws an error indicating it has not
been implemented yet.
@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:
@param {String} source - The
source
parameter is a string that represents the source of the profile. It could be a URL, a file path, or any other identifier that indicates where the profile data is coming from. -
startTracking(
dynamic trackingProfile) → Future< String?> - The function "startTracking" is not implemented and throws an error. @param trackingProfile - The trackingProfile parameter is an object or data structure that contains information about the tracking settings or preferences. It could include details such as the type of tracking to be performed, the target or object to be tracked, any specific criteria or conditions for tracking, and any additional configuration options.
-
stopTracking(
) → Future< String?> - The function stopTracking() throws an UnimplementedError indicating that it has not been implemented yet.
-
toString(
) → String -
A string representation of this object.
inherited
-
watchLocation(
) → Future< String?> -
The function
watchLocation()
throws an error indicating that it has not been implemented yet. -
watchRegion(
) → Future< String?> -
The function
watchRegion()
throws an error indicating that it has not been implemented yet.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ GeofencingFlutterPluginPlatform
-
The default instance of GeofencingFlutterPluginPlatform to use.
getter/setter pair