0.0.3 • Published 6 years ago
cordova-plugin-transporter v0.0.3
Transporter Ionic Plugin
To Install the Plugin please run the following command in your terminal
$ cordova plugin add https://github.com/transportercity/transporter-ionic
Plugin methods
To use the plugin in a Cordova application, just use the transporter
object.
All methods are defined below.
var transporter = cordova.plugins.transporter;
// method to test whether the plugin has installed successfully or not
// Just pass any string and on calling this method you will get the alert
// with the same string message
transporter.testMethod("Pass any message string",success,error);
// method to pass the secret key to the transporter server to identify the user
// you can get the secret key after signup at https://transporter.city
transporter.initialize(secretKey,success,error);
//Method to set userId which helps to identify different bikers/runners/delivery Boys of the same user
// userId could be your rider phone number/any unique Id
transporter.setUserId(userId,success,error);
//Method to set Description/Name of the biker
//This is used to identity the bikers/runners/delivery Boys on Transporter Dashboard
transporter.setDescription(description,success,error);
//Method to start Tracking
transporter.startTracking(success, error);
//Method to stop Tracking
transporter.stopTracking(success, error);
//Method to check Location Settings,
//returns true if the gps location service is on else false
transporter.isLocationEnabled(success, error);
//Method to request Location Settings if gps location service is off
transporter.requestLocationSettings(success, error);
//Method to check Self Permissions main location permission
//Must be used with android versions less than 23
//returns true if the permissions to use the location service is given else false
transporter.checkSelfPermissions(success, error);
//Method to request Self location Permissions when checkSelfPermissions returns false
transporter.requestPermissions(success, error);
Support
For any query, please reach out to us at care@transporter.city
or call +91-9557932744