Roam class

Constructors

Roam()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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?>

no setter

Static Methods

allowMockLocation({required bool allow}) → Future<void>

createTrip(RoamTrip roamTrip, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

createUser({required String description, required RoamUserCallBack callBack}) → Future<void>

Create User Accepts Description in String Format Returns Roam User

deleteTrip(String tripId, RoamDeleteTripCallback roamDeleteTripCallback, ErrorCallback errorCallback) → Future<void>

disableAccuracyEngine() → Future<bool?>

Enable Accuracy Engine Use this method disable accuracy engine for location updates

disableBatteryOptimization() → Future<bool?>

Disable Battery Optimization in Android This method is only for Android devices to disable all battery optimization settings by OS and allow the application to track location in background

enableAccuracyEngine() → Future<bool?>

Enable Accuracy Engine Use this method improve accuracy for location updates

endTrip(String tripId, bool stopTracking, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

getActiveTrips(bool isLocal, RoamActiveTripsCallback roamActiveTripsCallback, ErrorCallback errorCallback) → Future<void>

getCurrentLocation({required int accuracy, required RoamCallBack callBack}) → Future<void>

Get Current Location Accepts Accuracy Value in Int format Returns Location

getListenerStatus({required RoamUserCallBack callBack}) → Future<void>

Get User Listener Status Accepts Roam User Id in String Format Returns Roam User

getTrip(String tripId, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

getTripDetails({required String tripId, required RoamTripCallBack callBack}) → Future<void>

getTripStatus({required String tripId, required RoamTripCallBack callBack}) → Future<void>

getTripSummary(String tripId, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

getUser({required String userId, required RoamUserCallBack callBack}) → Future<void>

Get User Accepts Roam User Id in String Format Returns Roam User

initialize({required String publishKey}) → Future<bool?>

Initialize SDK Accepts SDK Key from Roam Playground Project Setting

logoutUser() → Future<bool?>

Logout User Use this method to logout current session of the user and before creating/get another user

offlineTracking(bool enabled) → Future<void>

onLocation(RoamLocationCallback roamLocationCallback) → Future<void>

Location Listener Accepts RoamLocationCallback object Returns location map

pauseTrip(String tripId, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

resumeTrip(String tripId, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

setForeground(bool enabled, String title, String description, String icon, String activity) → Future<void>

Set foreground notification for android Accepts bool and String Returns void

startTracking({required dynamic trackingMode, Map? customMethods}) → Future<bool?>

startTrip(RoamTripCallback roamTripCallback, ErrorCallback errorCallback, {String? tripId, RoamTrip? roamTrip, RoamTrackingMode? roamTrackingMode}) → Future<void>

stopTracking() → Future<bool?>

Stop Tracking Use this method to stop the location tracking

subscribeEvents() → Future<bool?>

Subscribe Events Use this method to enable subscription to own events

subscribeLocation() → Future<bool?>

Subscribe Location Use this method to enable subscription to own location updates

subscribeTrip(String tripId) → void

subscribeTripStatus({required String tripId}) → Future<bool?>

subscribeUserLocation({required String userId}) → Future<bool?>

Subscribe User Location Accepts Roam User Id Use this method to enable subscription to other user's location updates

syncTrip(String tripId, RoamSyncTripCallback roamSyncTripCallback, ErrorCallback errorCallback) → Future<void>

toggleEvents({required bool location, bool? geofence, bool? trips, bool? movingGeofence, required RoamUserCallBack callBack}) → Future<void>

Toggle User Events Accepts Boolean values for Geofence, Trips, Moving Geofence & Location Returns Roam User

toggleListener({required bool events, bool? locations, required RoamUserCallBack callBack}) → Future<void>

Toggle User Listener Accepts Boolean values for Events & Locations Returns Roam User

ubSubscribeTripStatus({required String tripId}) → Future<bool?>

unsubscribeTrip(String tripId) → void

updateCurrentLocation({required int accuracy, Map<String, dynamic>? jsonObject}) → Future<bool?>

Update Current Location Accepts Accuracy Value in Int format Returns Location

updateTrip(RoamTrip roamTrip, RoamTripCallback roamTripCallback, ErrorCallback errorCallback) → Future<void>

Constants

METHOD_ALLOW_MOCK_LOCATION → const String

METHOD_CREATE_TRIP → const String

METHOD_CREATE_USER → const String

METHOD_DELETE_TRIP → const String

METHOD_DISABLE_ACCURACY_ENGINE → const String

METHOD_DISABLE_BATTERY_OPTIMIZATION → const String

METHOD_ENABLE_ACCURACY_ENGINE → const String

METHOD_END_TRIP → const String

METHOD_FOREGROUND_SERVICE → const String

METHOD_GET_ACTIVE_TRIPS → const String

METHOD_GET_CURRENT_LOCATION → const String

METHOD_GET_LISTENER_STATUS → const String

METHOD_GET_TRIP → const String

METHOD_GET_TRIP_DETAILS → const String

METHOD_GET_TRIP_STATUS → const String

METHOD_GET_TRIP_SUMMARY → const String

METHOD_GET_USER → const String

METHOD_INITIALIZE → const String

METHOD_LOGOUT_USER → const String

METHOD_OFFLINE_TRACKING → const String

METHOD_ON_LOCATION → const String

METHOD_PAUSE_TRIP → const String

METHOD_RESUME_TRIP → const String

METHOD_START_QUICK_TRIP → const String

METHOD_START_TRACKING → const String

METHOD_START_TRIP → const String

METHOD_STOP_TRACKING → const String

METHOD_SUBSCRIBE_EVENTS → const String

METHOD_SUBSCRIBE_LOCATION → const String

METHOD_SUBSCRIBE_TRIP → const String

METHOD_SUBSCRIBE_TRIP_STATUS → const String

METHOD_SUBSCRIBE_USER_LOCATION → const String

METHOD_SYNC_TRIP → const String

METHOD_TOGGLE_EVENTS → const String

METHOD_TOGGLE_LISTENER → const String

METHOD_UNSUBSCRIBE_TRIP → const String

METHOD_UNSUBSCRIBE_TRIP_STATUS → const String

METHOD_UPDATE_CURRENT_LOCATION → const String

METHOD_UPDATE_TRIP → const String

TRACKING_MODE_ACTIVE → const String

TRACKING_MODE_BALANCED → const String

TRACKING_MODE_PASSIVE → const String