OkHi class
The primary class for integrating OkHi with your app.
Constructors
- OkHi()
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
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
-
platformVersion
→ Future<
String> -
Returns the system version of the current platform
no setter
Static Methods
-
canStartVerification(
bool requestServices) → Future< bool> - Checks whether all necessary permissions and services are available in order to start the address verification process.
-
getConfiguration(
) → OkHiAppConfiguration? - Returns the current configuration
-
initialize(
OkHiAppConfiguration configuration) → Future< bool> - Initializes the library with provided API Keys and optional notification configuration.
-
isBackgroundLocationPermissionGranted(
) → Future< bool> - Checks whether background location permission is granted.
-
isForegroundServiceRunning(
) → Future< bool> - Android Only - Checks if the foreground service is running.
-
isGooglePlayServicesAvailable(
) → Future< bool> - Android Only - Checks if Google Play Services is available.
-
isLocationPermissionGranted(
) → Future< bool> - Checks whether when in use location permission is granted
-
isLocationServicesEnabled(
) → Future< bool> - Checks whether location services are enabled.
-
requestBackgroundLocationPermission(
) → Future< bool> - Requests for background location permission.
-
requestEnableGooglePlayServices(
) → Future< bool> - Android Only - Requests user to enable Google Play Services.
-
requestEnableLocationServices(
) → Future< bool> - Requests the user to enable location services by showing an in app modal on android and opening location settings on iOS.
-
requestLocationPermission(
) → Future< bool> - Requests for when in use location permission.
-
startForegroundService(
) → Future< bool> - Android Only - Starts a foreground service that speeds up rate of verification.
-
startVerification(
OkHiUser user, OkHiLocation location, OkHiVerificationConfiguration? configuration) → Future< String> - Starts verification for a particular address using the response object returned by OkHiLocationManager.
-
stopForegroundService(
) → Future< bool> - Android Only - Stops previously started foreground services.
-
stopVerification(
OkHiUser user, OkHiLocation location) → Future< String> - Stops verification for a particular address.