Octant class

Constructors

Octant()

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

teamCode ↔ String?
getter/setter pair
userId ↔ String?
getter/setter pair

Static Methods

configureIntervals({int gatheringInterval = 5, int uploadingInterval = 20}) → Future
Configure the intervals of location gathering and uploading
enableDebug(bool debug) → dynamic
Enable debugging logs
init(String userId, {String? teamCode, String? baseUrl}) → Future
Setup SDK with userId, teamCode and BaseUrl before we start using SDK
queryRanking({int startTime = 0, int endTime = 0, int limit = 10, List<String> userCodeList = const [], String? remarkCode}) → Future<List<UserRank>>
API to query current ranking of travelled distance
queryUserCoordinate({int startTime = 0, int endTime = 0, int limit = 10, String? remarkCode}) → Future
API to query current user's history locations
requestForPermisions() → Future
startService({String? notificationDrawable, String? notificationTitle, String? notificationContent}) → Future<bool?>
Start a foregroud service to fetch and upload location periodically, the interval can be configured by configureIntervals
startTracing() → Future
Start to collecting location and timerTask to upload locations.
stopService() → Future
Unbind and stop the service
updateUserDetails(String userId, {String? teamCode}) → Future
API to update userId in case we want to switch account