CoPilotMgr (React Native)

Note: All React Native methods are async functions.

CopilotMgr

Methods

UnitsofMeasure

void

CopilotVersion

void

void

void

Int

Motion Lock

Motion Lock is a safety feature within CoPilot that limits a driver’s access to the CoPilot UI while traveling above a threshold speed.

CopilotMgr.setMotionLockMode

Syntax

void setMotionLockMode(motionLockMode)

Parameters

motionLockMode - The mode that you want CoPilot to lock down once motion lock has been initiated. This will dictate the available options once traveling above the specified threshold speed.

Return

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
const MotionLockMode = NativeModules.MotionLockMode;

CopilotMgr.setMotionLockMode(MotionLockMode.ALL_UI_LOCK);

CopilotMgr.getMotionLockMode

Syntax

constant getMotionLockMode()

Parameters

None

Return Values

MotionLockMode

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var mode = await CopilotMgr.getMotionLockMode();

CopilotMgr.getMotionLockSpeedThreshold

Syntax

constant getMotionLockSpeedThreshold()

Parameters

None

Return Value

MotionLockSpeedThreshold - The speed above which Motion Lock is active.

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var speed = await CopilotMgr.getMotionLockSpeedThreshold();

CopilotMgr.setMotionLockSpeedThreshold

Syntax

void setMotionLockSpeedThreshold(motionLockSpeedThreshold)

Parameters

motionLockSpeedThreshold - The speed above which Motion Lock is active.

Return Values

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
const MotionLockSpeedThreshold = NativeModules.MotionLockSpeedThreshold;

CopilotMgr.setMotionLockSpeedThreshold(MotionLockSpeedThreshold.LEVEL_2);

CopilotMgr.getUnitsOfMeasure

Syntax

constant getUnitsOfMeasure()

Parameters

None

Return Value

UnitsOfMeasure - Either METRIC or IMPERIAL units.

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var unit = await CopilotMgr.getUnitsOfMeasure();

CopilotMgr.setUnitsOfMeasure

Syntax

void setUnitsOfMeasure(unitsOfMeasure)

Parameters

unitsOfMeasure - Either METRIC or IMPERIAL units.

Return Value

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
const UnitsOfMeasure = NativeModules.UnitsOfMeasure;

CopilotMgr.setUnitsOfMeasure(UnitsOfMeasure.METRIC);

CopilotMgr.getVersionInfo

Syntax

JSONObject getVersionInfo()

Parameters

None

Return Value

A CopilotVersion JSON object containing information about the version of the CoPilot application and map data.

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var cpVersion = await CopilotMgr.getVersionInfo();

CopilotMgr.enableGPS

Syntax

void enableGPS()

Parameters

None

Return Value

void

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
CopilotMgr.enableGPS();

CopilotMgr.disableGPS

Syntax

void disableGPS()

Parameters

None

Return Value

void

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
CopilotMgr.disableGPS();

CopilotMgr.setConfigurationSetting

Syntax

void setConfigurationSetting(configurationSetting)

Parameters

A JSON Object that has key in ConfigurationName and value in ConfigurationValue

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
const ConfigurationName = NativeModules.ConfigurationName;
const ConfigurationValue = NativeModules.ConfigurationValue;

var configSetting = {};
configSetting.name = ConfigurationName.CHEVRON_DISPLAY;
configSetting.value = ConfigurationValue.CHEVRON_DISPLAY_LAT_LON;
CopilotMgr.setConfigurationSetting(configSetting);

CopilotMgr.getConfigurationSetting

Syntax

JSONObject getConfigurationSetting(configurationName)

Parameters

configurationName - The configuration name for which to retrieve the current settings.

Return Value

A JSON object representing the current setting for the given configuration.

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
const ConfigurationName = NativeModules.ConfigurationName;

var config = await CopilotMgr.getConfigurationSetting(
  ConfigurationName.GPS_FREQUENCY
);
console.log(config.value);

Configuration Name and Values

CopilotMgr.singleSearchInit

Syntax

void singleSearchInit()

Return Values

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
CopilotMgr.singleSearchInit();

CopilotMgr.singleSearch

Syntax

singleSearch(String query)

Parameters

String query- the single search query

Return Values

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
CopilotMgr.singleSearch("McDonalds");

CopilotMgr.singleSearchJSON

Syntax

singleSearchJSON(String json)

Parameters

String json - the single search JSON parsed as a String

Return Values

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
// You will need to read your json file into a string to pass
// in the string as a parameter to the function
var json = readJsonFile(file)
CopilotMgr.singleSearchJSON(json);

Example of a single search JSON

{
	"Query": "1 independence way princeton nj",
	"MaxResults": 20,
	"Location": {
		"Address": {
			"StreetAddress": "1 independence way",
			"City": "Princeton",
			"State": "NJ",
			"Zip": "08540",
			"County": "Mercer",
			"Country": ""
		},
		"Coords": {
			"Lat": "40.361076",
			"Lon": "-74.601515"
		}
	},
	"Searchtype": 1,
	"PoiCategories": ["Airport", "bank", "CAT scales"],
	"Countries": ["CA", "US", "GL"],
	"States": ["NJ", "NM"]
}

CopilotMgr.getSingleSearchPOICategories

Syntax

getSingleSearchPOICategories()

Parameters

None

Return Value

A list of Strings that contain the POI categories

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var poiCategories = await CopilotMgr.getSingleSearchPOICategories();

CopilotMgr.getSingleSearchCountries

Syntax

getSingleSearchCountries()

Parameters

None

Return Value

A list of Strings that contain the single search countries available

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var countries = await CopilotMgr.getSingleSearchCountries();

CopilotMgr.getSingleSearchStates

Syntax

getSingleSearchStates()

Parameters

None

Return Value

A list of Strings that contain the single search states available

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var countries = await CopilotMgr.getSingleSearchStates();

CopilotMgr.getPOICategories

Syntax

getPOICategories()

Parameters

None

Return Values

A list of Strings that contain the POI categories available.

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var categories = await CopilotMgr.getPOICategories();

CopilotMgr.searchPOIsAlongRoute

Syntax

searchPOIsAlongRoute(String poiSearchName, List typeIDs, int maxResults)

Parameters

poiSearchName - name of the POI you are searching for

typeIds - list of POI Ids that should be searched. These can get any of the categories retrieved from getPOICategories()

maxResults - maximum number of results expected

Return Values

None

Sample Code

const CopilotMgr = NativeModules.CopilotMgr;
var categories = await CopilotMgr.getPOICategories();
// Here we are searching for McDonalds with all categories selected and we want to see a maximum of 10 results
var pois = await CopilotMgr.searchPOIsAlongRoute("mcdonalds", categories, 10);

StopBuilder

Methods

String

Sample Code

const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;

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
);

StopBuilder.Geocode(GeocodeSearchType)

Syntax

JSONArray geocode(stopBuilder, geocodeSearchType)

Parameters

A StopBuilder JSON object, which contains information about the stop.

geocodeSearchType - The type of geocode matching

Sample Code

const StopBuilder = NativeModules.StopBuilder;
const GeocodeSearchType = NativeModules.GeocodeSearchType;

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
);

StopBuilder.getNearbyStreets

Syntax

JSONArray getNearbyStreets(stopBuilder, distance, maxResults)

Parameters

A StopBuilder JSON object, which contains information about the stop.

distance- An int value for the maximum distance to return street names from. Maximum of 1 mile.

maxResults - An int value for the number of results to be returned. Maximum of 10.

Return Value

JSON Array of StreetSearchResult JSON objects

Sample Code

const StopBuilder = NativeModules.StopBuilder

var latlon = {​};
latlon.latitude = 40.355233;
latlon.longitude = -74.604895;
var stopBuilder = await StopBuilder.fromLatLon(latlon);

var nearbyStreets = await StopBuilder.getNearbyStreets(stopBuilder, 5, 10)