RouteMgr (React Native)

Note: All React Native methods are async functions.

Methods

void

VehicleRoutingProfile

boolean

boolean

void

void

void

void

StopList

boolean

boolean

List<​JSON Object (Leg)>

Hooks and Callbacks

Hooks and Callbacks related to routing can be found below.

RouteMgr.setActiveVehicleRoutingProfile

Syntax

void setActiveVehicleRoutingProfile(JSONObject)

Parameters

VehicleRoutingProfile JSON Object - The profile to set in CoPilot

Return Value

None

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleRoutingProfile = NativeModules.VehicleRoutingProfile;
const VehicleType = NativeModules.VehicleType;

var profile = await VehicleRoutingProfile.createNewProfile(
  "CPIK Test",
  VehicleType.TRUCK_HEAVY_DUTY
);
RouteMgr.setActiveVehicleRoutingProfile(profile);

RouteMgr.getActiveVehicleRoutingProfile

Syntax

JSONObject getActiveVehicleRoutingProfile();

Parameters

None

Return Value

VehicleRoutingProfile - CoPilot’s currently selected routing profile.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var currentProfile = await RouteMgr.getActiveVehicleRoutingProfile();

RouteMgr.getVehicleRoutingProfiles

Syntax

JSONArray getVehicleRoutingProfiles()

Parameters

None

Return Value

JSON Array of VehicleRoutingProfile JSON objects - A list of all routing profiles in CoPilot

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var allProfiles = await RouteMgr.getVehicleRoutingProfiles();

RouteMgr.getVehicleRoutingProfile

Syntax

getVehicleRoutingProfile(string profileName)

Parameters

string profileName - The profile name to search for.

Return Value

VehicleRoutingProfile - The profile found that matches the search name, or null if no match was found.

Sample Code

var profile = await RouteMgr.getVehicleRoutingProfile(name);

RouteMgr.resetVehicleRoutingProfileToDefault

Parameters

String profileName - The profile name to reset

Return Value

Boolean - True if the specified profile was found and reset, false otherwise.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var result = await RouteMgr.resetVehicleRoutingProfileToDefault("ResetTest");

VehicleRoutingProfile

Methods

VehicleRoutingProfile.createNewProfile

Syntax

JSONObject createNewProfile(profileName, vehicleType)

Parameters

profileName - A string with the profile name.

vehicleType - The vehicle type to be used to create the routing profile.

Return Value

A VehicleRoutingProfile JSON Object

Sample Code

const VehicleRoutingProfile = NativeModules.VehicleRoutingProfile;
const VehicleType = NativeModules.VehicleType;

var rpTruckDef = await VehicleRoutingProfile.createNewProfile(
  "HeavyDutyDefaults",
  VehicleType.TRUCK_HEAVY_DUTY
);

RouteMgr.resetUserRoadSpeeds

Syntax

void resetUserRoadSpeeds(vehicleType, jurisdiction)

Parameters

vehicleType - The vehicle type to get the custom road speeds for. This field is mandatory. Passing in an invalid vehicle type of null will result in a null value being returned.

String jurisdiction - The jurisdiction to get the custom road speeds for. Passing null or empty string will return all jurisdictions.

Return Value

None

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleType = NativeModules.VehicleType;

RouteMgr.resetUserRoadSpeeds(VehicleType.TRUCK_MEDIUM_DUTY, "New Jersey");
RouteMgr.resetUserRoadSpeeds(VehicleType.TRUCK_HEAVY_DUTY, "");

RouteMgr.setUserRoadSpeeds

Syntax

void setUserRoadSpeeds(roadSpeedSet)

Parameters

RoadSpeedSet - A JSON Object with the custom road speed set to set in CoPilot.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleType = NativeModules.VehicleType;

var roadSpeedsNJ = await RouteMgr.getDefaultRoadSpeeds(
  VehicleType.TRUCK_MEDIUM_DUTY,
  "New Jersey"
);
roadSpeedsNJ.urbanSpeeds.interstate = 30;
roadSpeedsNJ.ruralSpeeds.divided_highway = 25;
await RouteMgr.setUserRoadSpeeds(roadSpeedsNJ);

RouteMgr.addVehicleRoutingProfile

Syntax

void addVehicleRoutingProfile(VehicleRoutingProfile)

Parameter

VehicleRoutingProfile JSON Object - The profile to add into CoPilot.

Return Value None

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleRoutingProfile = NativeModules.VehicleRoutingProfile;
const VehicleType = NativeModules.VehicleType;

var profile = await VehicleRoutingProfile.createNewProfile(
  "CPIK Test",
  VehicleType.TRUCK_HEAVY_DUTY
);
RouteMgr.addVehicleRoutingProfile(profile);

RouteMgr.getUserRoadSpeeds

Syntax

JSONArray getUserRoadSpeeds(VehicleType, jurisdiction)

Parameters

VehicleType - The vehicle type to get the custom road speeds for. This field is mandatory. Passing in an invalid vehicle type of null will result in a null value being returned.

String jurisdiction - The jurisdiction to get the custom road speeds for. Passing null or empty string will return all jurisdictions.

Return Value

A JSON array of RoadSpeedSet objects representing the user road speeds that are set in CoPilot.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleType = NativeModules.VehicleType;

var userSpeedNJ = await RouteMgr.getUserRoadSpeeds(
  VehicleType.TRUCK_MEDIUM_DUTY,
  "New Jersey"
);
var allUserSpeeds = await RouteMgr.getUserRoadSpeeds(
  VehicleType.TRUCK_MEDIUM_DUTY,
  ""
);

RouteMgr.getDefaultRoadSpeeds

Syntax

JSONArray getDefaultRoadSpeeds(VehicleType, jurisdiction)

Parameters

VehicleType - The vehicle type to get the custom road speeds for. This field is mandatory. Passing in an invalid vehicle type of null will result in a null value being returned.

String jurisdiction - The jurisdiction to get the default road speeds for. Passing null or empty string will return all jurisdictions.

Return Value

A JSON array of RoadSpeedSet objects representing the default road speeds.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const VehicleType = NativeModules.VehicleType;

var roadSpeedsNJ = await RouteMgr.getDefaultRoadSpeeds(
  VehicleType.TRUCK_MEDIUM_DUTY,
  "New Jersey"
);
var allDefaultRoadSpeeds = await RouteMgr.getDefaultRoadSpeeds(
  VehicleType.TRUCK_MEDIUM_DUTY,
  ""
);

RouteMgr.isCopilotReadyToAddStops

Syntax

bool isCopilotReadyToAddStops()

Parameters

None

Return Value

Returns boolean value whether or not CoPilot is ready to add stops

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var iSReadyToAddStops = await RouteMgr.isCopilotReadyToAddStops();

RouteMgr.addStop

Note: When you have a Latitude and Longitude value as well as the street address, CoPilot will prioritize the information provided.

Scenario 1 – Only the full address is passed

• CoPilot will try to geocode the address.

Scenario 2 – Only lat/long is passed

• CoPilot will try to use lat/long to provide the route.

Scenario 3 – Both Address and lat/long are passed

• CoPilot will geocode the address and compare the air distance between the address location and the input lat/lon. If the input street name is within 1 mile of the input lat/lon, then CoPilot will route to a point closest to the lat/lon on that input street.

  If the input street name is not within 1 mile of the input lat/lon, CoPilot will route to a point on the closest street to the input lat/lon. It will also send “ERROR_STREET_NOT_FOUND.”

Tip: When passing UK Postcodes note that this will be used as the sole location for geocoding an address. UK postcodes are simply lat/long points and are a useful tool to quickly geocode an address. As a result, when passing a UK postcode and a lat/long, CoPilot will geocode the postcode not the lat/long. It is not advised that both UK postcode and lat/long coordinates are passed together and as a result we recommend the following:

• If you have lat/long for a destination pass the lat/long. Optional extras include House Number, Street Name, City Name, Country. Do not include UK Postcode if you have a lat/long for a destination
• Pass UK postcode. Optional extras include House Number, Street Name, City Name, Country.

Syntax

RouteMgr.addStop(AddStopPurpose, Stop, RoutePreviewMode)

Parameters

AddStopPurpose - A native module constant describing how to incorporate a stop into a trip.

Stop - A JSON object with details about the stop.

RoutePreviewMode - A native module constant that tells CoPilot what route preview that user wants to show in CoPilot UI.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;
const AddStopPurpose = NativeModules.AddStopPurpose;
const RoutePreviewMode = NativeModules.RoutePreviewMode;

var latlon = {};
latlon.latitude = 40.368273;
latlon.longitude = -74.654965;
var stopBuilder = await StopBuilder.fromLatLon(latlon);
var stops = await StopBuilder.geocode(
  stopBuilder,
  GeocodeSearchType.BEST_MATCH
);
RouteMgr.addStop(
  AddStopPurpose.NEW_TRIP,
  stops[0],
  RoutePreviewMode.NO_PREVIEW
);

RouteMgr.addStops

Note: When you have a Latitude and Longitude value as well as the street address, CoPilot will prioritize the information provided.

Scenario 1 – Only the full address is passed

• CoPilot will try to geocode the address.

Scenario 2 – Only lat/long is passed

• CoPilot will try to use lat/long to provide the route.

Scenario 3 – Both Address and lat/long are passed

• CoPilot will geocode the address and compare the air distance between the address location and the input lat/lon. If the input street name is within 1 mile of the input lat/lon, then CoPilot will route to a point closest to the lat/lon on that input street.

  If the input street name is not within 1 mile of the input lat/lon, CoPilot will route to a point on the closest street to the input lat/lon. It will also send “ERROR_STREET_NOT_FOUND.”

Tip: When passing UK Postcodes note that this will be used as the sole location for geocoding an address. UK postcodes are simply lat/long points and are a useful tool to quickly geocode an address. As a result, when passing a UK postcode and a lat/long, CoPilot will geocode the postcode not the lat/long. It is not advised that both UK postcode and lat/long coordinates are passed together and as a result we recommend the following:

• If you have lat/long for a destination pass the lat/long. Optional extras include House Number, Street Name, City Name, Country. Do not include UK Postcode if you have a lat/long for a destination
• Pass UK postcode. Optional extras include House Number, Street Name, City Name, Country.

Syntax

void addStops(AddStopPurpose, stopList, RoutePreviewMode)

Parameters

AddStopPurpose - A native module constant describing how to incorporate a stop into a trip.

stopList - A JSON array of Stop objects with details about the stop.

RoutePreviewMode - A native module constant that tells CoPilot what route preview that user wants to show in CoPilot UI.

Return Value

None

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;
const AddStopPurpose = NativeModules.AddStopPurpose;
const RoutePreviewMode = NativeModules.RoutePreviewMode;

var stopList = [];

var latlon = {};
latlon.latitude = 40.368273;
latlon.longitude = -74.654965;
var stopBuilder = await StopBuilder.fromLatLon(latlon);
var stops = await StopBuilder.geocode(
  stopBuilder,
  GeocodeSearchType.BEST_MATCH
);
stopList.push(stops[0]);

latlon.latitude = 40.345621;
latlon.longitude = -74.645877;
stopBuilder = await StopBuilder.fromLatLon(latlon);
stops = await StopBuilder.geocode(stopBuilder, GeocodeSearchType.BEST_MATCH);
stopList.push(stops[0]);

RouteMgr.addStops(
  AddStopPurpose.AFTER_FINAL_DESTINATION,
  stopList,
  RoutePreviewMode.NO_PREVIEW
);

RouteMgr.deleteStop

Syntax

RouteMgr.deleteStop(int index)

Parameters

Index - index of stop in trip to delete. You can use the constants RouteMgr.NEXT_STOP and RouteMgr.FINAL_STOP to delete stops at the beginning and end of the trip.

Sample Code

const RouteMgr = NativeModules.RouteMgr;

RouteMgr.deleteStop(RouteMgr.NEXT_STOP
);

RouteMgr.removeAllStops

Syntax

void removeAllStops()

Parameters

None

Return Value

None

Sample Code

NativeModules.RouteMgr.removeAllStops();

RouteMgr.getStopList

Syntax

JSONArray getStopList()

Parameters

None

Return Value

A JSON array of Stop objects that represent the stops on the current route.

Sample Code

var stops = await NativeModules.RouteMgr.getStopList();

RouteMgr.calculateRoute

Syntax

void calculateRoute()

Parameters

None

Return Value

None

Sample Code

const RouteMgr = NativeModules.RouteMgr;
const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;
const AddStopPurpose = NativeModules.AddStopPurpose;
const RoutePreviewMode = NativeModules.RoutePreviewMode;

RouteMgr.removeAllStops();

var stopList = [];

var latlon = {};
latlon.latitude = 40.36842;
latlon.longitude = -74.655036;
var stopBuilder = await StopBuilder.fromLatLon(latlon);
var stops = await StopBuilder.geocode(
  stopBuilder,
  GeocodeSearchType.BEST_MATCH
);
stopList.push(stops[0]);

latlon.latitude = 40.36853;
latlon.longitude = -74.6552036;
stopBuilder = await StopBuilder.fromLatLon(latlon);
stops = await StopBuilder.geocode(stopBuilder, GeocodeSearchType.BEST_MATCH);
stopList.push(stops[0]);

RouteMgr.addStops(
  AddStopPurpose.AFTER_FINAL_DESTINATION,
  stopList,
  RoutePreviewMode.NO_PREVIEW
);

RouteMgr.calculateRoute();

RouteMgr.latLonAheadOnRoute

Syntax

RouteMgr.latLonAheadOnRoute(int minutes)

Parameters

minutes - Number of minutes to look ahead on current route.

Return Value

Coordinate - object holding the coordinates that are minutes ahead on route.

Sample Code

const RouteMgr = NativeModules.RouteMgr;

var coords = RouteMgr.latLonAheadOnRoute(10
);

RouteMgr.optimizeStops

Syntax

bool optimizeStops(bKeepFinalDestination)

Parameters

bool bKeepFinalDestination- Set to true to keep optimization from changing the final stop.

Return Value

True on success

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var routeOptimizationSuccessful = await RouteMgr.optimizeStops(true);

RouteMgr.getRouteLegs

Syntax

JSONArray getRouteLegs(ignoreWaypoints)

Parameters

boolean ignoreWaypoints - If true, waypoints will not be included as endpoints of trip legs. Instead, adjacent legs containing waypoints will be combined.

Return Value

A JSON Array of Leg JSON objects

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var legList = await RouteMgr.getRouteLegs(false);

RouteMgr.hasDestination

Syntax

bool hasDestination()

Parameters

None

Return Value

boolean value whether or not CoPilot has a valid destination with a calculated route.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var navigatingToDestination = await RouteMgr.hasDestination();

RouteMgr.deleteRoutingProfile

Syntax

constant deleteRoutingProfile(profileName)

Parameters

string profileName – The exact String name of the profile to delete.

Return Value

RoutingProfileDeletionResult – A constant with details of the deletion success, or if a failure, a cause for the failure.

Sample Code

const RouteMgr = NativeModules.RouteMgr;
var result = await RouteMgr.deleteRoutingProfile("ProfileName B");

RouteSync

Methods

RouteSync.sendManagedRouteJSON

Note: Refer to this JSON format for more information. The format for the JSON string is:

Sample Code

{
           "Compliance": 0,
           "OorDistance": 0.2,
           "Legs": [
             {
               "Coords": [
                 -74730013,
                 40297252,
                 -74729914,
                 40297361,
                 -74729477,
                 40297821
               ]
             },
             {
               "Coords": [
                 -74660179,
                 40348429,
                 -74660635,
                 40349433,
                 -74659734,
                 40349679
               ]
             }
           ],
           "Stops": [
               {
                 "Location": {
                   "Address": {
                     "StreetAddress": "",
                     "City": "Lawrence Township",
                     "State": "NJ",
                     "Zip": "08648",
                     "County": "Mercer",
                     "Country": ""
                   },
                   "Coords": {
                     "Lat": "40.297263",
                     "Lon": "-74.730034"
                   }
                 },
                 "Waypoint": false,
                 "Name": "Stop A"
               },
               {
                 "Location": {
                   "Coords": {
                     "Lat": "40.348727",
                     "Lon": "-74.659049"
                   }
                 },
                 "Waypoint": false,
                 "Name": "Stop B"
               },
               {
                 "Location": {
                   "Address": {
                     "StreetAddress": "",
                     "City": "New York",
                     "State": "NY",
                     "Zip": "10001",
                     "County": "New York",
                     "Country": ""
                   }
                 },
                 "Waypoint": false,
                 "Name": "Stop C"
               }
             ]
           }

Syntax

RouteSync.sendManageRouteJSON(String json)

Sample Code

const RouteSync= NativeModules.RouteSync;

//Read your JSON file using a file reader...
//JSON should look like the example above
var json = {...}
RouteSync.sendManagedRouteJSON(json);

RouteSync.sendManagedRouteJSONStopList

Syntax

RouteSync.sendManageRouteJSON(String json, stopList)

Sample Code

const RouteSync= NativeModules.RouteSync;

//Read your JSON file using a file reader...
//json should look like the example above
var json = {...}
//create a list of Stops to skip
const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;

var latlon = {};
latlon.latitude = 40.368273;
latlon.longitude = -74.654965;
var stopBuilder = await StopBuilder.fromLatLon(latlon);
var stops = await StopBuilder.geocode(
  stopBuilder,
  GeocodeSearchType.BEST_MATCH
);
RouteSync.sendManagedRouteJSONStoplist(json, stops);

RouteSync.sendManagedRouteByObjects

Syntax

RouteSync.sendManageRouteByObjects(listOfCoordinates)

Parameters

listOfCoordinates - Array of Coordinate objects

Sample Code

const RouteSync= NativeModules.RouteSync;


//create a list of Stops to skip
var coords[];
//First Coordinate
var latlon1 = {};
latlon1.latitude = 40.368273;
latlon1.longitude = -74.654965;
//Second Coordinate
var latlon1 = {};
latlon1.latitude = 40.384224;
latlon1.longitude = -74.674230;
coords.push(latlon1);
coords.push(latlon2);
RouteSync.sendManagedRouteByObjects(coords);

RouteSync.sendManagedRouteByBinary

Syntax

RouteSync.sendManageRouteByBinary(binaryInput)

Parameters

binaryInput - String representation of the binary DAT file.

Sample Code

const RouteSync= NativeModules.RouteSync;

//Code to read a DAT file as a String from your applications support files
var binaryFile = ...
RouteSync.sendManagedRouteByBinary(binaryFile);