Skip to main content

CoPilotMgr (CPIK Libraries)

Contents

CopilotVersion

Overview
DescriptionA class containing information about the version of CoPilot and map data that is currently loaded on a device. This includes software version, map data version, year and quarter.
Supported on Android Since Version9.6.0.821
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getAppVersion()
string
Returns the CoPilot application version.
getDataVersion()
string
Returns the CoPilot map data version.
getDataYear()
Int
Returns the year of the map data version.
getDataQuarter()
Int
Returns the quarter of the map data version.

Sample Code

CopilotVersion.getAppVersion

Overview
DescriptionReturns the CoPilot application version currently installed on the device.
Supported Since CoPilot Version9.6.0.867
Supported in following PlatformsAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

String object containing the application version.

Sample Code

Related APIs

CopilotVersion.getDataVersion

Overview
DescriptionReturns the CoPilot map data version that is downloaded on the device.
Supported Since Version9.6.0.867
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

String object containing the map data version.

Sample Code

CopilotVersion.getDataYear

Overview
DescriptionReturns an integer representing the year of the map data version that is currently in use on the device (e.g. 2014).
Supported Since Version9.6.0.867
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Integer value of the year of the map data version.

Sample Code

Related APIs

CopilotVersion.getDataQuarter

Overview
DescriptionReturns an integer representing the quarter that the map data version was released (1, 2, 3, or 4).
Supported Since Version9.6.0.867
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Integer value of the quarter of the map data version.

Sample Code

Related APIs

StopBuilder

Overview
DescriptionBuilds stops using some of the optional parameters for creating stops.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
fromLatLon(Coordinate)
StopBuilder
Static method to create a StopBuilder from a latitude / longitude combination.
fromCountryAndPostalCode(String, String)
StopBuilder
Static method to create a StopBuilder from a country and postal code combination.
fromCityAndState (String, String)
StopBuilder
Static method to create a StopBuilder from a city and state combination.
setLatLong (Coordinate)
StopBuilder
Sets lat/long information for the stop to be created.
setPostalCode (String)
StopBuilder
Sets postal code for the stop to be created.
setStreetAddress (String)
StopBuilder
Sets street address for the stop to be created.
setCity (String)
StopBuilder
Sets city for the stop to be created.
setState (String)
StopBuilder
Sets state for the stop to be created.
setCountry(String)
StopBuilder
Sets country for the stop to be created.
setName(String)
StopBuilder
Sets optional name for the stop to be created.
setCounty(String)
StopBuilder
Sets optional county for the stop to be created.
setDestinationFlag(boolean)
StopBuilder
Sets optional flag to designate whether this stop is to be a waypoint.
geocode(GeocodeSearchType)
StopList
Geocodes the address and returns the list of stops.
setID(String)
StopBuilder
Sets a custom ID for the stop. *Available in version 10.9 and greater
setNote(String)
StopBuilder
Sets a custom note against the stop that will be shown on the stop details screen within the CoPilot UI.*Available in version 10.9 and greater
setEarliestArrivalTime(ArrivalTimeWindowInfo)
StopBuilder
Sets the Earliest acceptable Arrival Time when the stop can be reached. If no date is given, the current date will be used. Requires Additional License. (Optional, but if used setLatestArrivalTime and setPlannedDuration need to be used also.) *Available in version 10.9 and greater
setLatestArrivalTime(ArrivalTimeWindowInfo)
StopBuilder
Sets the Latest Arrival Time for Time Window the stop should be reached. If no date is given, the current date will be used. Requires Additional License.*Available in version 10.9 and greater
setPlannedDuration(int)
StopBuilder
Sets the planned duration for the stop. This should reflect all the non-driving (dwell) time at the destination. Requires Additional License. *Please note Planned Duration will be updated to Seconds in future releases. *Available in version 10.9 and greater
setSideOfStreetAdherence(StopSideAdherenceLevel)
StopBuilder
Sets Side of Street Adherence for the stop.*Available in version 10.9 and greater
setCustomFields(HashMap<String,String> customFields)
StopBuilder
Sets Custom Field for the stop that is used when providing a custom chevron display to the driver.
Please note, to use this field the configuration setting for custom chevron display must also be set. This field should never be used to add a unique identifier to the stop, setID can be used for this purpose. Further details on the configuration setting which must be set can be found within ConfigurationSettings.*Available in version 10.9 and greater
setIcon
string
Sets stop icon image. The name of the image should be passed. Image of the matching name must be saved within CoPilot.*Available in version 10.9 and greater
getNearbyStreets
string
Returns list of nearby streets relative to the coordinates passed to CoPilot, returned as StreetSearchResult
StreetSearchResult
string
Provides list of nearby streets relative to the coordinates passed to CoPilot via getNearbyStreets.

Notes

To build a waypoint rather than a stop, call the setDestinationFlag() method with a false parameter. (Stops are the default.) Waypoints are locations added only to guide the route along desired roads. CoPilot will tell drivers to stop at a stop or to drive through a waypoint.

Sample Code

Stop

Overview
DescriptionThe Stop object provides data related to a specific location. CoPilot uses this information to geocode an address and add it as a stop on a route. Depending on the information provided, CoPilot will endeavor to populate as much of the remaining information about the stop as possible. Stop objects have many optional parameters and should be created via a StopBuilder object.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
isDestination()
Boolean
Returns true if the stop is a destination.
getName()
string
Gets the name of the object.
getAddress()
string
Gets the address of the object.
getCity()
string
Gets the city in which the object resides.
getState()
string
Gets the state in which the object resides.
getCountry()
string
Gets the country in which the object resides.
getCounty()
string
Gets the county in which the object resides.
getZip()
string
Gets the postal code in which the object resides.
getCoordinate()
Coordinate
Gets the coordinate object.
getID()
string
Gets the Stop ID for the the stop object.This is an optional field.*Available in version 10.9 and greater
getNote()
string
Gets the note associated with the stop object. This is an optional field. *Available in version 10.9 and greater
getEarliestArrivalTime()
ArrivalTimeWindowInfo
Gets the optional early time for the time window where a stop should be reached. *Available in version 10.9 and greater
getLatestArrivalTime()
ArrivalTimeWindowInfo
Gets the latest time for the time window where a stop should be reached. This is an optional field.*Available in version 10.9 and greater
getPlannedDurationMinutes()
Int
Gets the expected Dwell/Wait time that is added to a stop. This is an optional field. *Please note Planned Duration will be updated to Seconds in a release of CoPilot. *Available in version 10.9 and greater
getSideOfStreet()
StopSide
Gets the side of the street that the stop is on. *Available in version 10.9 and greater
getSideOfStreetAdherence()
StopSideAdherenceLevel
Gets the side of street adherence level that the routing uses to calculate its route to this stop. *Available in version 10.9 and greater
getETA()
string
Gets the current ETA for this stop. *Available in version 10.9 and greater
getCustomFields()
Hashmap<String,String>
Gets a Hashmap of the optional custom fields for this stop. *Available in version 10.9 and greater
getIcon()
string
Get the stop icon image name for the stop object. *Available in version 10.9 and greater
getTimeZoneOffset()
Int
Get time zone offset for the stop object. *Available in version 10.9 and greater

Example Output

  • Name: myStop
  • Address: Hallenstraat 19
  • City: Brussels
  • State:
  • Zip: 1000
  • Country: BE
  • Waypoint: false
  • Location:
    • Coordinates:50.85N, 4.35E
  • ID: This is id
  • Note: This is a note
  • Earliest Arrival Time:5/22/2018:13:0
  • Latest Arrival Time: 5/22/2018:14:0
  • Delivery Status:EARLY
  • Planned Duration:12
  • TimeZoneOffset:240
  • Side Of Street:UNKNOWN
  • Side Of Street Adherence:MODERATE
  • Advanced ETA:2018-05-31T14:32:20-04:00
  • Icon:myStopIcon
  • Custom Field : (CUSTOMCHEVRONDISPLAY:chevronmessage)
  • Vehicle Restricted: False

stop.isVehicleRestricted

Overview
DescriptionReturns true if the stop is mapped to a Vehicle Restricted Road (only allows pedestrians or bicycles). If this is true, CoPilot will route to closest road that allows vehicles.
Supported on Android Since Version10.14
Supported on iOS Since Version10.14
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None

Return Values

Boolean

Sample Code

StopBuilder.getNearbyStreets

Overview
DescriptionThis API will return a list of nearby streets relative to the coordinates passed to CoPilot. All nearby street names within the configurable distance, set as a maximum of 1 mile, will be returned. The number of streets returned can be set up to a maximum of 10. Streets will be returned sorted in order of distance.
Supported on Android Since Version10.9
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik.stopbuilder

Syntax

Parameters

ParameterDescription
distanceMaximum distance to return street names from, maximum distance of 1 mile.
maxResultsNumber of results to be returned. Maximum of 10.

Return Value

Street Name - String
Distance - double

Sample Code

StopBuilder.StreetSearchResult

Overview
DescriptionThis API will return a list of nearby streets relative to the coordinates passed to CoPilot. All nearby street names within the configurable distance, set as a maximum of 1 mile will be returned. The number of streets returned can be limited within the request which will be returned sorted in order of distance.
Supported on Android Since Version10.9
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik.stopbuilder

Syntax

Parameters

ParameterDescription
distanceThresholdMaximum distance to return street names from, maximum distance of 1 mile.
maxResultsNumber of results to be returned

Return Value

Street Name - String
Distance - double

Sample Code

GeocodeSearchType

Overview
DescriptionAn enum that allows different types of geocoding. Geocoding attempts to match user input with actual locations in the CoPilot map database.
Supported on Android Since Version9.6.0.1000
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
EXACT_MATCH_ONLYReturn only one stop. Will only return a stop that is an exact match to the input.
MULTI_MATCHWill return a list of stops which are closest to the given information.
BEST_MATCHReturns the best match geocoded stop from the given information.

StopSideAdherenceLevel

Overview
DescriptionAn enumerated value that defines the Side of Street adherence level, which defines the extent to which CoPilot will try to route to the side of the street where a stop is located.
For further details on how this can affect a route, please see the Side of Street explanation document.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
OFFWill not reroute according to side of the street.
MINIMALWill increase the route by up to a maximum of 1⁄4 mile to avoid ending up on the wrong side of the street.
MODERATEWill increase the route by up to a maximum of 1/2 mile to avoid ending up on the wrong side of the street.
AVERAGEWill increase the route by up to a maximum of 1 mile to avoid ending up on the wrong side of the street.
STRICTWill increase the route by up to a maximum of 5 miles to avoid ending up on the wrong side of the street.
ADHEREWill increase the route by up to a maximum of 10 miles to avoid ending up on the wrong side of the street.
STRONGLY_ADHEREWill route the driver by any possible means to reach the correct side of the street.

StopSide

Overview
DescriptionAn enumerated value that represents whether the side of street of the specified stop is known. If it is known, the value will indicate if it is on the left-hand side of the road or right.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
UNKNOWNStop Side Unknown
LEFTStop Side Left
RIGHTStop Side Right

StopArrivalStatus

Overview
DescriptionAn enumerated value that indicates the status of the stop relative to the defined time window.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
UNKNOWNArrival window status unknown
EARLYStop arrival time early and expected before the defined window
ON_TIMEOn time with the defined arrival time window
AT_RISKCurrent ETA is at risk of the arrival time window
LATECurrent ETA is later than the defined window

StopClickedInfo

Overview
DescriptionThe StopClickedInfo class is used within the onMapStopClicked callback, which is called when a user clicks on a location on the map.

StopClickedInfo can be used to replicate the UI functionality in CoPilot, and it is specifically useful if using the CPIK No_Widget views and a custom UI. This would allow the integration application to replicate the pop up information based on a user tapping on the map screen.

Supported Since Version10.14
Platforms SupportedAndroid, iOS Linux
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getClickedStop()
Stop
Gets information about the stop that was clicked.
getClickType()
StopClickType
Lets you distinguish whether a click on the map was a road, origin, destination, waypoint or intermediate stop.
toString()
String
Returns the string representation of the Stop object.

getClickType

Overview
DescriptionLets you distinguish whether a click on the map was a road, origin, destination, waypoint or intermediate stop.
Supported Since Version10.9.0.958
Platforms SupportedAndroid, iOS Linux
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None

Return Values

A StopClickType

Sample Code

StopClickType

Overview
DescriptionA value that represents the type for the location a user clicked on the map.
Supported Since Version10.9.0.958
Platforms SupportedAndroid, iOS Linux
TypeMethod
Packagecom.alk.cpik.ui

Syntax

StopClickType.ROAD

Values
ROAD
ORIGIN_STOP
DEST_STOP
WAYPOINT
INTERMEDIATE_STOP
UNKNOWN_ERROR

Sample Code

ArrivalTimeWindowInfo

Overview
DescriptionArrivalTimeWindowInfo is a class that is used to assign a time window. Date information (i.e., day, month and year) are optional, but minutes from midnight is required. If user only specifies minutes from midnight, CoPilot will use today’s date. Minutes from midnight is the time since midnight in minutes. For example, if minutes from midnight is set to 960, this equates to a time of 4:00PM.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeObject
Packagecom.alk.cpik

Methods

Method NameReturn Type
getDay()int
getMonth()int
getYear()int
getMinutesFromMidnight()int
setDate(int, int, int)void
setMinutesFromMidnight(int)void
toString()
String

Sample Code

FavoriteBuilder

Overview
DescriptionFavorite objects have many optional parameters, and should be built via this FavoriteBuilder class. Favorites are CoPilot’s list of a user’s favorite locations.
For example: Favorite myFavorite = new FavoriteBuilder.setName(“MyFavorite”).setCountry(“US”).build();
Supported on Android Since Version9.6.0.821
Supported on iOS Since VersionAndroid, Linux
TypeClass
Packagecom.alk.cpik.trip

Methods

Method NameReturn TypeDescription
setName(String)FavoriteBuilderSets name of the favorite.
setStreetAddress(String)FavoriteBuilderSets street address of the favorite.
setCity(String)FavoriteBuilderSets city of the favorite.
setState(String)FavoriteBuilderSets state of the favorite.
setCountry(String)FavoriteBuilderSets country of the favorite.
setZip(String)FavoriteBuilderSets zip code of the favorite.
setFavoriteType(FavoriteType)FavoriteBuilderSets FavoriteType of the favorite.
setFavoriteType(int)FavoriteBuilderSets FavoriteType of the int.
setCoordinates(LocationCoordinate)FavoriteBuilderSets coordinates of the favorite.
build() FavoriteConstructs and returns a new favorite object with the information that has been set using a FavoriteBuilder object.

Sample Code

Favorite

Overview
DescriptionFavorite objects contain information to be used in CoPilot’s list of a user’s favorite locations. Favorite objects have many optional parameters and cannot be constructed by themselves. They should be created via a FavoriteBuilder object.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeObject
Packagecom.alk.cpik.trip

Methods

Method NameReturn TypeDescription
getFavoriteType() FavoriteTypeGets the FavoriteType describing the favorite.
getName()
string
Gets name of the object.
getAddress()
string
Gets address of the object.
getCity()
string
Gets city in which the object resides.
getState()
string
Gets state in which the object resides.
getCountry()
string
Gets country in which the object resides.
getZip()
string
Gets postal code in which the object resides.

Example Output

Name: myFavorite Address: Avenue A.J. Slegers 397 City: Brussels State: Zip: 1200 Country: BE Type: HOME Location: Coordinates: 50.84035N, 4.413889E

FavoriteType

Overview
DescriptionAn enum of the ways to define a favorite type.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeEnum
Packagecom.alk.cpik.trip

Values

ValueDescription
GENERALThe favorite is a general favorite.
HOMEThe favorite is the Home location.
WORKThe favorite is the Work location.

ContactBuilder

Overview
DescriptionBuilder to create Contact objects
Supported on Android Since Version9.6.0
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Public Methods

Method NameReturn Type
setName(String)
string
setPhoneNumber(String)
ContactBuilder
setEmailAddress(String)
ContactBuilder
setStreetAddress(String)
ContactBuilder
setCity(String)
ContactBuilder
setState(String)
ContactBuilder
setCountry(String)
ContactBuilder
setZip(String)
ContactBuilder
setCoordinates(Coordinate)
ContactBuilder
build()Contact

Sample Code

CopilotMgr

Overview
DescriptionA class containing static methods for setting and checking various CoPilot features and settings.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
enableMotionLock(boolean)
void
Enables or disables Motion Lock, which locks the navigation map when the vehicle is in motion.
getMotionLockEnabled()
Boolean
Returns whether Motion Lock is enabled or disabled.
getMotionLockSpeedThreshold()
MotionLockSpeedThreshold
Returns a MotionLockSpeedThreshold object containing the SpeedThreshold for Motion Lock.
setMotionLockSpeedThreshold( MotionLockSpeedThreshold)
void
Sets the SpeedThreshold at which Motion Lock is engaged.
getTimeFormat() [Linux only]
TimeFormat
Returns a TimeFormat enum representing the currently set format.
setTimeFormat(TimeFormat) [Linux only]
void
Sets the time format for CoPilot.
getUnitsOfMeasure()
UnitsofMeasure
Gets the UnitsOfMeasure displayed by CoPilot.
setUnitsOfMeasure(int)
void
Sets the UnitsOfMeasure displayed by CoPilot.
getVersionInfo()
CopilotVersion
Returns a CopilotVersion object containing information about CoPilot’s application version number and map data version.
setTurnInstructionCallbackDelay(int)
void
Sets the time between when turn instruction callbacks onReadyToSpeakTurnInstruction and onSpeakTurnInstructionComplete are fired when CoPilot starts speaking.
getTurnInstructionCallbackDelay()
Int
Retrieves the current delay between when the turn instruction callbacks onReadyToSpeakTurnInstruction and onSpeakTurnInstructionComplete.
getView() [Android only]
View
Retrieves the view associated with the CoPilot service.
isActive() [Android only]
Boolean
Determines if CoPilot can receive API calls. APIs can only be called after the onCPStartup callback is sent and before the onCPShutdown callback returns.
enableGPS() [Android only]
void
Restarts the CoPilot GPS Service and resumes all suspended GPS activities including listening, and processing.
disableGPS() [Android only]
void
Suspends background GPS/routing processing and deregister the CoPilot GPS Service. Background Navigation will not work after this API call.
setBillingProvider (IBillingProviderInterface) [Android only]
void
Sets a third-party, in-app billing provider that should be used by CoPilot for in-app billing operations.
setCopilotStartupParameters (CopilotStartupParams) [Android only]
void
Sets the CopilotStartupParams object that contains overridden methods used during CoPilot Startup.
addFavorite(Favorite)
void
Adds a new favorite to CoPilot’s favorites list.
removeFavorite(int)
void
Removes a favorite from CoPilot.
getFavoritesList()
List<Favorite>
Returns the list of favorites currently stored in CoPilot’s favorites list.

CoPilotMgr.singleSearchInit

Overview
DescriptionThis API initiates single search. This includes several HTTP requests and requires internet connection. Once the initialization has successfully finished, a callback onSingleSearchReady will be returned indicating that the other Single Search APIs are available to use.
Note: This API must be called and the onSingleSearchReady callback received before Single Search APIs can be used.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Sample Code

SingleSearchError

Overview
DescriptionA response enum from a request to the Single Search web service. Responses will provide information on the result of the request including specific reasons if a request fails.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
OKSuccessfully get the single search response
FAILURE_INITFailed to initialize single search
FAILURE_WEBSERVICESingle Search Web Service returns errors
FAILURE_CONNECTThere are network connection issues
FAILURE_INVALID_JSONWhile using singleSearchJSON API, the JSON parameter user passes in is invalid
FAILURE_DATA_NOT_LICENSED_OR_NOT_INSTALLEDYou requested data is either not licensed or not installed
FAILURE_DATA_NOT_AVAILABLE_FOR_RESULTThe stop results returned from single search web service are not valid in CoPilot installed data
FAILURE_GENERICUnknown errors

CopilotMgr.singleSearch

Overview
DescriptionThis API is used for a Single Search query. It will send user’s query string together with all default search settings to the Single Search web service. This API is not synchronous. A callback onSingleSearchFinished will be returned once web service gives the response back.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax - static void singleSearch(String query)

Parameters String: Single search query string. Can be address, POI name, street name, city name, zip.

Sample Code

CopilotMgr.singleSearchJSON

Overview
DescriptionThis API is used for Single Search query. User needs to pass a JSON string containing the query with the customized search settings. This API is not synchronous. A callback onSingleSearchFinished will be fired once web service gives the response back.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax - static void singleSearchJSON(String settingsJSON)

Parameters String: A json string that contains query string as well as search settings. Below is an example:

{
  "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, // Searchtype filters search results so that the API only returns certain types of matching locations.
  // Possible values are: 0 - ALL (Default), 1- ADDRESS_ONLY, 2- POI_ONLY, 3- CITY_ONLY, 4- CUSTOM_PLACE_ONLY
  "PoiCategories":["Airport", "bank", "CAT scales"],
  "Countries":["CA", "US", "GL"],
  "States":["NJ", "NM"]

Sample Code

CopilotMgr.getSingleSearchPOICategories

Overview
DescriptionThis API is used to get a list of POI categories that can be recognized by Single Search web service. This is used to form the json string for singleSearchJSON API, specifically the “PoiCategories” field.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax - static List getSingleSearchPOICategories()

Return Values - List

Sample Code

CopilotMgr.getSingleSearchCountries

Overview
DescriptionThis API will return the list of countries the user is able to search within. User may need it to form the json string (the “Countries” field) for singleSearchJSON API.
Please note the countries that are returned must have been licensed, map data present on the device and those countries supported by the Single Search Web service.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
Type
Packagecom.alk.cpik

Syntax - static List getSingleSearchCountries ()

Return Values - List

Sample Code

CopilotMgr.getSingleSearchStates

Overview
DescriptionThis API will return the list of states the user is able to search within. User may need it to form the json string (the “States” field) for singleSearchJSON API.
Please note the states that are returned are those within regions that have been licensed, appropriate map data is present on the device and those states supported by the Single Search Web service.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Sample Code

Motion Lock

Motion Lock is a safety feature within CoPilot which limits access to the CoPilot UI once traveling above a threshold speed. This feature has been enhanced to increase the amount of interaction that is available through multiple modes available.

CoPilotMgr.setMotionLockMode

Overview
DescriptionMotion lock will lock the CoPilot UI once traveling above a specified speed. The UI can be locked down over a different range of modes, restricting more or less of the UI based on integration needs.
The threshold at which Motion Lock will be initiated should be set using setMotionLockSpeedThreshold. This API is just to set the lock mode, it’s not responsible for the actual lock to be activated.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

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

Sample Code

CopilotMgr.getMotionLockMode

Overview
DescriptionTo return the current Motion Lock mode this API should be used. The mode dictates the extent to which the CoPilot UI will be locked down once initiated and traveling above the threshold speed. This will not return the threshold speed.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax

Return Values - MotionLockMode

Sample Code

MotionLockMode

Overview
DescriptionA value representing the Motion Lock UI mode that CoPilot will apply when motion lock is activated.
Supported Since Version10.9
Platforms SupportedAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
ALL_UI_UNLOCKUnlock all UI, do not lock any UI elements when traveling above the threshold speed.
ALL_UI_LOCKLock all UI when traveling above the defined threshold speed. This will also disable all pop ups except for the destination arrival pop up. All action required pop-ups have a default decision which will be followed if they are shown.
ONLY_DRIVING_UI_ACCESSOnly allow access to driving functions. This will Lock access to the entire UI with the exception of the following:

Driving Menu → 2D/3D
Driving menu → Directions/Safety
Driving Menu → Clear Destination
Driving Menu → Close
Zoom buttons on map
Reset to current location button on map
POI Alert button on map
Popups
Map drag/swipe/pan/multi touch
Sound mute button
Mapsure button on navigation dialog

This is the default mode available within the CoPilot UI.

ONLY_DRIVING_UI_ACCESS_EXTENDONLY_DRIVING_UI_ACCESS plus access to the following (disable keyboard):

Driving Menu → Find POIs
Main POI categories
Search All
More Categories
Driving Menu → My Route → Alternate
Go (Green circular button on plan trip screen)
Traffic Bar and traffic refresh button
Buttons in flow traffic map except for the setting button

PASSENGER_MODEAllow a temporary disablement of Motion Lock when used by a passenger. Motion Lock settings should be resumed upon restarting CoPilot.
When this mode is set, all UI will be unlocked. Once the application is re-launched CoPilot will resume in the previous MotionLock mode.
To enable this mode the following configuration is required to be set within the user.cfg:

[User Settings]
“EnablePassengerMode”=1

Once this is set this mode being passed will replicate the user selecting the passenger mode button within the UI.

CopilotMgr.getMotionLockEnabled

Overview
DescriptionReturns whether or not Motion Lock is currently enabled. Motion Lock will lock the CoPilot navigation screen, preventing user input, then the current speed is greater than or equal to a certain threshold. This threshold can be set using setMotionLockSpeedThreshold.
Supported on Android Since Version9.6.0.821
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if enabled, false if disabled.

Sample Code

CopilotMgr.enableMotionLock

Overview
DescriptionEnables or disables the Motion Lock in CoPilot. Motion Lock will lock the CoPilot navigation screen, preventing user input, when the current speed is greater than or equal to a certain threshold. This threshold can be set using setMotionLockSpeedThreshold.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

boolean enable - Set to true to enable, false to disable.

Sample Code

CopilotMgr.getMotionLockSpeedThreshold

Overview
DescriptionReturns the current speed threshold at which Motion Lock will be enabled. Motion Lock will lock the CoPilot navigation screen, preventing user input, when the vehicle’s speed reaches this threshold.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

MotionLockSpeedThreshold - An Enum indicating the speed above which Motion Lock is active.

Sample Code

CopilotMgr.setMotionLockSpeedThreshold

Overview
DescriptionSets the threshold (in mph) for enabling and disabling Motion Lock. Motion Lock prevents user interaction with CoPilot while driving at or above a specified speed threshold.
The values for this API can be found in the MotionLockSpeedThreshold Enum API.
Supported Since Version9.6.0.821
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

speedThreshold – An Enum indicating the speed limit which, once reached, will enforce Motion Lock.

Sample Code

Java

CopilotMgr.getUnitsOfMeasure

Overview
DescriptionReturns the measurement type currently set within CoPilot, metric or imperial. Units of Measurement are used for functions including speed, distance and vehicle dimensions.
Supported on Android Since Version9.6.0.821
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik
MeasureMetricImperial
SpeedKilometers per Hour (KPH)Miles per Hour (MPH)
DistanceKilometers, Meters, CentimetersMiles, Feet, Inches
Vehicle DimensionsMeters, Centimeters, TonFeet, Inches, Ton, 000’s Pounds (US)

Syntax

Return Value

UnitsOfMeasure - An Enum representing either metric or imperial units.

Sample Code

CopilotMgr.setUnitsOfMeasure

Overview
DescriptionSets whether metric or imperial values should be used within CoPilot. Units of Measurement are used for functions including speed, distance and vehicle dimensions.
Supported on Android Since Version9.6.0.757
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik
MeasureMetricImperial
SpeedKilometers per Hour (KPH)Miles per Hour (MPH)
DistanceKilometers, Meters, CentimetersMiles, Feet, Inches
Vehicle DimensionsMeters, Centimeters, TonFeet, Inches, Ton, 000’s Pounds (US)

Syntax

Parameters

UnitsOfMeasure - An Enum representing either metric or imperial units.

Return Value

Void

Sample Code

CopilotMgr.getVersionInfo

Overview
DescriptionReturns a CoPilot version object, which includes details of the currently installed CoPilot application version number as well as the map data release (year and quarter).
Supported on Android Since Version9.6.0.821
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

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

Sample Code

CopilotMgr.setTurnInstructionCallbackDelay

Overview
DescriptionAllows the integrated application to set a time delay between the notification that a turn instruction is about to be played and when CoPilot actually starts to speak. This is used to delay the announcement, allowing for the muting of other audio such as a radio or a third-party application announcement.
The delay is in milliseconds, and will impact the onReadyToSpeakTurnInstruction and onSpeakTurnInstructionComplete.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

Delay – The number of milliseconds for which to delay the time between turn instruction callbacks and speech instructions. Must be between 0 and 2000, inclusive.

Sample Code

CopilotMgr.getTurnInstructionCallbackDelay

Overview
DescriptionRetrieves the current time delay between the notification a turn instruction is about to be played and when CoPilot actually starts to speak. The delay is in milliseconds.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Returns an int value to represent delay in milliseconds.

Sample Code

CopilotMgr.getView

Overview
DescriptionRetrieves the view associated with the CoPilot service. CoPilot only has one view; multiple calls to this function will return the same instance. In order to reuse the view, it must be removed from its parent. If CoPilot should have focus, requestFocus() must be used instead.
Supported on Android Since Version9.6.0.821
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None

Return Value

android.view.View object

Sample Code

CopilotMgr.isActive

Overview
DescriptionDetermines whether or not CoPilot is able to receive API calls. APIs can be called only after onCPStartup is sent and before onCPShutdown returns.
Supported on Android Since Version9.6.0.821
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None.

Return Value

Boolean - True if CoPilot is ready to receive API calls, false otherwise.

Sample Code

CopilotMgr.setCopilotStartupParameters

Overview
DescriptionSets a CopilotStartupParams object that contains overridden methods used during CoPilot Startup.
Supported on Android Since Version9.6.0.821
TypeMethod
Packagecom.alk.cpik

Syntax

Java void setCopilotStartupParameters(CopilotStartupParams copilotStartupParams)

Parameters

copilotStartupParams - object that contains overridden methods used during CoPilot Startup.

Return Value

void

Sample Code

CopilotMgr.enableGPS

Overview
DescriptionRestarts the CoPilot GPS Service and resumes all suspended activities following the API call CopilotMgr.disableGPS(). CoPilot will register with the GPS receiver to initiate listening and processing the current position again.
Supported on Android Since Version9.6.0.1184
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None.

Return Value

void

Sample Code

CopilotMgr.disableGPS

Overview
DescriptionAttempts to minimize CPU usage by suspending background GPS/routing processing and unregistering the CoPilot GPS Service. Background navigation will not work after this API call; this will mean that your application cannot retrieve updated ETA or distance information.
Supported on Android Since Version9.6.0.1184
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

None.

Return Value

void

Sample Code

CopilotMgr.setBillingProvider

Overview
DescriptionSets a third-party, in-app billing provider that should be used by CoPilot for in-app billing operations. This requires implementation of the IBillingProviderInterface interface. This requires integration with googleplaybilling.jar which is included in the “Library and Resources/jars” folder of the initial application delivery.
Supported on Android Since Version9.6.0.821
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

billingProvider - Implementation of the com.alk.copilot.IBillingProviderInterface interface.

Return Value

void

Sample Code

CopilotMgr.addFavorite

Overview
DescriptionAdds a new favorite location (address or point of interest) to CoPilot’s favorite list. FavoriteStop must be geocoded and the lat/long set within FavoriteBuilder before calling this API.
Once favorites have been successfully added, they will be available for the driver to select in the CoPilot address entry screen. Favorites can be assigned a name and address, and they can also be set to different types, including Home, Work, and General.

Favorites should be built using a FavoriteBuilder object.

Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

favorite - A favorite object built with FavoriteBuilder.

Return Value

void

Sample Code

CopilotMgr.removeFavorite

Overview
DescriptionRemoves unwanted locations from CoPilot’s favorite list. The favorite list can be retrieved by calling CopilotMgr.getFavoritesList(). Once successfully removed, the driver will no longer see the unwanted locations in CoPilot.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik.trip

Syntax

Parameters

Index - The index of the location to be removed within the favorites list, as returned by a call to CopilotMgr.getFavoritesList().

Sample Code

CopilotMgr.getFavoritesList

Overview
DescriptionReturns the list of all favorites currently stored in CoPilot’s favorites list. This list will match the complete list available within the CoPilot address search menu.
Supported on AndroidSince Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

java.util.List - Returns the list of favorites currently stored in CoPilot’s favorites list.

Sample Code

CopilotMgr.allowCellularDataForGlobalUsage

Overview
DescriptionSets the global configuration for the use of cellular data for CoPilot services that require an Internet connection, such as ActiveTraffic. This configuration setting needs to be true before any other cellular data configuration settings can be changed.
These settings only configure cellular connections and do not affect the use of Wi-Fi for CoPilot services.
Control over the use of cellular data for specific features can be set with the following APIs: allowCellularDataForFeedback, allowCellularDataForMapDownloads, allowCellularDataForNewsAndUpdates, allowCellularDataForSearch, allowCellularDataForSystemFiles, allowCellularDataForTrafficServices
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the global use of cellular data.

Sample Code

CopilotMgr.isAllowingCellularDataForGlobalUsage

Overview
DescriptionRetrieves the current setting for global cellular data usage, enabled or disabled. This needs to return true before any other cellular data configurations can be changed.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data, false otherwise.

Sample Code

CopilotMgr. allowCellularDataForFeedback

Overview
DescriptionSets whether or not cellular data can be used when providing map data feedback to Trimble MAPS. If disabled, users will only be able to provide map data feedback via a Wi-Fi connection. This feature is only available for Trimble’s own data for North America.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the use of cellular data for feedback.

Sample Code

CopilotMgr.isAllowingCellularDataForFeedback

Overview
DescriptionRetrieves the current setting from CoPilot of whether or not cellular data is enabled for providing map data feedback to ALK Technologies. This feature is only available for ALK’s own data for North America.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data for feedback, false otherwise.

Sample Code

CopilotMgr.allowCellularDataForMapDownloads

Overview
DescriptionSets whether or not cellular data can be used to download map data to the device. CoPilot map data is stored locally on a device. Due to the potential size of map data, it is recommended that cellular data use should not be allowed for map downloads without considering the monthly cellular data limits for the device.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Note: Map data sizes vary per region, but can be up to 5 GB.

Syntax

Parameters

Boolean - Set to true to use cellular data for map data downloads, false otherwise.

Sample Code

CopilotMgr.isAllowingCellularDataForMapDownloads

Overview
DescriptionRetrieves the current setting from CoPilot of whether or not map data can be downloaded using the cellular network.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data for map downloads, false otherwise.

Sample Code

CopilotMgr.allowCellularDataForNewsAndUpdates

Overview
DescriptionSets whether or not cellular data can be used to retrieve news and updates. News and Updates can be found within the MyCoPilot Menu.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the use of cellular data for news and updates.

Sample Code

CopilotMgr.isAllowingCellularDataForNewsAndUpdates

Overview
DescriptionRetrieves the current setting in CoPilot for whether or not cellular data can be used for news and updates.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data for news and updates, false otherwise.

Sample Code

CopilotMgr.allowCellularDataForSearch

Overview
DescriptionSets whether or not cellular data can be used for destination searches using third-party suppliers. Address and point of interest (POI) search is managed locally on the device using the onboard maps, but CoPilot also has plug-ins to third-party suppliers for extra locations and information. These third-party searches require an Internet connection.
If you disable cellular data for Address and POI searches, it would also be advisable to disable that search menu option in CoPilot. (The feature is likely to be required while the driver is not connected to Wi-Fi.) To do this, please see additional documentation for customizing the CoPilot user interface.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the use of cellular data for searches.

Sample Code

Related APIs

CopilotMgr.isAllowingCellularDataForSearch

Overview
DescriptionRetrieves the current setting in CoPilot of whether or not cellular data can be used for destination searches using third-party suppliers.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data for searches, false otherwise.

Sample Code

Related APIs

CopilotMgr.allowCellularDataForSocial

Overview
DescriptionSets whether or not cellular data can be used for social media.
Supported Since Version9.6.0.821
Deprecated Last Supported9.6.8.2000
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Java void allowCellularDataForSocial(boolean bEnable)

Parameters

bEnable – Enables or disables the use of cellular data for social media.

Sample Code

Related APIs

CopilotMgr.isAllowingCellularDataForSocial

Overview
DescriptionRetrieves the current setting in CoPilot of whether or not cellular data can be used for social media.
Supported Since Version9.6.0.821
Deprecated Last Supported9.6.8.2000
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Java boolean isAllowingCellularDataForSocial ()

Return Value

Boolean - True if CoPilot is using cellular data for social media, false otherwise.

Sample Code

Related APIs

CopilotMgr.isActive() CoPilotMgr.allowCellularDataForGlobalUsage(boolean)

CopilotMgr.allowCellularDataForSystemFiles

Overview
DescriptionSets whether or not cellular data can be used to download the required system files. CoPilot system files include translated text languages as well as voice files used for guidance instructions.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the use of cellular data for system files.

Sample Code

Related APIs

CopilotMgr.isActive() CoPilotMgr.allowCellularDataForGlobalUsage(boolean) CopilotMgr.isallowingCellularDataForSystemFiles()

CopilotMgr.isAllowingCellularDataForSystemFiles

Overview
DescriptionRetrieves the current setting in CoPilot of whether or not cellular data can be used for downloading required system files.
Supported Since Version9.6.0.821
Platforms SupportedAndroid
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

Boolean - True if CoPilot is using cellular data for system files, false otherwise.

Sample Code

Related APIs

CopilotMgr.allowCellularDataForTrafficServices

Overview
DescriptionSets whether or not cellular data can be used for the CoPilot ActiveTraffic service. CoPilot’s ActiveTraffic service requires a regular connection to the Internet. If ActiveTraffic is enabled but this setting is disabled, it will make using the live traffic service inconsistent and unreliable. Using Wi-Fi only is likely to cause breaks in the communication, and traffic data that is older than 15 minutes since the last synchronization is flushed as expired.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

bEnable – Enables or disables the use of cellular data for traffic services.

Sample Code

Related APIs

CopilotMgr.isAllowingCellularDataTrafficServices

Overview
DescriptionRetrieves the current setting in CoPilot of whether or not cellular data can be used for the ActiveTraffic service.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Code Boolean value to retrieve the setting being used for cellular data for traffic services

Sample Code

Related APIs

CopilotMgr.getPOICategories

Overview
DescriptionReturns a list of all of the point of interest (POI) categories in CoPilot.
Supported on Android Since Version9.6.4.
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

List - The list of CoPilot’s POI categories.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.GetPOICategories() CopilotMgr.CancelPOISearch() CopilotMgr.SearchPOIsNearLocation() CopilotMgr.SearchPOIsAlongRoute() CopilotMgr.setPOIAlertSettings() CopilotMgr.getPOIAlertSettings()

CopilotMgr.searchPOIsNearLocation

Overview
DescriptionSearches for points of interest (POIs) in one or more specific categories (such as restaurant, fuel or hotels) near a location. The results of the search are sent to POIListener.onPOISearchResult for each listener passed in and registered with POIListener.
Supported on Android Since Version9.6.8
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

poiSearchName - The text name of the POI to search for. If left blank, will search all POIs meeting the other criteria.

typeIDs - One or more categories in which to search. IDs can be obtained via CopilotMgr.getPOICategories

stopToSearchNear - A stop representing the location to search near.

radius - The radius around the location for which to search within. Units are miles or kilometers, depending on CoPilot’s unit setting.

maxResults - The maximum number of results to return.

resultCallbacks - A List of POIListener for which to send the onPOISearchResults callback as search results are found.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.GetPOICategories() CopilotMgr.CancelPOISearch() CopilotMgr.SearchPOIsAlongRoute() CopilotMgr.setPOIAlertSettings() CopilotMgr.getPOIAlertSettings()

CopilotMgr.searchPOIsAlongRoute

Overview
DescriptionSearches for points of interest (POIs) in one or all categories (such as restaurant, fuel or hotels) along the planned route. The results of the search are sent to POIListener.onPOISearchResult for each listener passed in and registered with POIListener.
Supported on Android Since Version9.6.4
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

String searchName - The text name of the POI to search for. If left blank, will search all POIs meeting the other criteria.

typeID - The category in which to search. IDs can be obtained via CopilotMgr.getPOICategories

maxResults - The maximum number of results to return.

resultCallbacks - A List of POIListener for which to send the onPOISearchResults callback as search results are found.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.GetPOICategories() CopilotMgr.CancelPOISearch() CopilotMgr.SearchPOIsAlongRoute() CopilotMgr.setPOIAlertSettings() CopilotMgr.getPOIAlertSettings()

CopilotMgr.cancelPOISearch

Overview
DescriptionCancels the point of interest (POI) search that is running following the initial request.
Supported Since Version9.6.4.
Platforms SupportedAndroid, Linux
TypeMethod
Packagecom.alk.cpik

Syntax

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.GetPOICategories() CopilotMgr.CancelPOISearch() CopilotMgr.SearchPOIsNearLocation() CopilotMgr.setPOIAlertSettings() CopilotMgr.getPOIAlertSettings()

CopilotMgr.setPOIAlertSettings

Overview
DescriptionEnables or disables point of interest (POI) alerts, see POI Settings. POI alerts are provided to the driver during guidance to inform him or her of specific POI categories. These alerts are received via POIListener.onPOIAlert.
Supported on Android Since Version9.6.0.
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

poiSettings - The POISettings to set in CoPilot.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.GetPOICategories() CopilotMgr.CancelPOISearch() CopilotMgr.SearchPOIsNearLocation() CopilotMgr.SearchPOIsAlongRoute() CopilotMgr.setPOIAlertSettings() CopilotMgr.getPOIAlertSettings()

CopilotMgr.getPOIAlertSettings

Overview
DescriptionGets settings in relation to POI alerts, see POISettings. These alerts are received via POIListener.onPOIAlert(List).
Supported on Android Since Version9.6.0.
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

POISettings - representing current CoPilot POI alert settings.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.SetPOIAlertsEnabled() CopilotMgr.SetPOIAlertLocation() CopilotMgr.SetPOIAlertCategories() CopilotMgr.GetPOICategories() CopilotMgr.GetPOIAlertLocation() CopilotMgr.GetPOIAlertDistance()

CoPilotMgr.updatePOICategoriesDisplayStatus

Overview
DescriptionThis API should be used to select the POI categories displayed on the map, for instance, Restaurant, or Gas/Fuel, etc. This has the same function as the tick boxes present on the Currently Displayed POIs screen available through the CoPilot UI. This API should be used in conjunction with UIMgr.setPOIDisplaySetting to manage when these POI categories are displayed.
Please note when using this API all POIs are defaulted to be displayed on the map. As a result, the first call to CoPilot needs to include the categories that you wish to hide. Within POICategory, isDisplayedOnMap can be used to identify the categories that are being shown on the map to determine those which you wish to hide. This can be returned via CoPilotMgr.getPOICategories.
Supported on Android Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

List<POICategory - a list of POICategories that is going to be updated

Sample Code

POICategory

Overview
DescriptionObject representing a POI category in CoPilot. Examples of POI categories would be Restaurant, Gas/Fuel, Hotel & Accommodation etc.
Supported on Android Since Version10.9
TypeObject
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getID()
int
Integer ID for the POI category. This is needed for CopilotMgr.searchPOIsNearLocation and CopilotMgr.searchPOIsAlongRoute
getName()
String
String description of the POI category
isDisplayedOnMap()
boolean
Indicate this POI category is displaying in CoPilot map or not
setDisplayOnMap(boolean)
void
Set this POI category to display or hide in CoPilot map

CopilotMgr.integrateCustomPOIs

Overview
Descriptionhis API is used to draw custom POIs in JSON format on the map. Below is a complete contents of a JSON message describing CoPilot POI sets. This will expect POI images will to be preprocessed for each of the categories.
Supported on Android Since Version10.9
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Json Example

[
  {
    "Name": "my set name",
    "Persist": false,
    "Replace": true,
    "Categories": [
      {
        "Name": "Custom Fuel",
        "MaxZoomLevel": 4,
        "Options": 21
      },
      {
        "Name": "Custom Restaurant",
        "MaxZoomLevel": 4,
        "Options": 21
      }
    ],
    "Places": [
      {
        "Address": {
          "StreetAddress": "14807 Crain Hwy",
          "City": "Clinton",
          "Zip": "20735",
          "State": "MD",
          "County": null
        },
        "Coords": {
          "Lat": "38.6825",
          "Lon": "-76.87278"
        },
        "PlaceName": "My Restaurant",
        "CategoryName": "Custom Restaurant",
        "Phone": ""
      },
      {
        "Address": {
          "StreetAddress": "1720 Route 309",
          "City": "Coopersburg",
          "Zip": "18036",
          "State": "PA",
          "County": null
        },
        "Coords": {
          "Lat": "40.50306",
          "Lon": "-75.38667"
        },
        "PlaceName": "My Fuel Stop",
        "CategoryName": "Custom Fuel",
        "Info": "",
        "Phone": ""
      }
    ]
  }
]

Json Field Explanation

The JSON schema is defined below. All fields not marked as Optional are required.

  • Set (array)
    • Name (string) - The unique set name; not visible anywhere in Copilot, used for organizational purposes.
    • Persist (bool) - Whether the place set and all its data will be serialized to disk and persist through a restart of the CoPilot application. Setting this to false will keep the set in-memory only, and significantly improve the performance of this API by eliminating disk I/O.
    • Replace (bool) - Whether an existing set with this name will be replaced (all places will be deleted before adding the new places) or whether the new places will be appended to the current set.
    • Deleted (bool) Will delete a current set with the same name.
    • Categories (array)
      • Name (string) The name of the POI category. Visible in Copilot in the POI Search dialog as long as at least one place mapped to this category exists on the device.
      • Icon (string; optional) The name of the alk place category icon that will be used when display this category. If this value is not provided, CoPilot will search for user provided images within the Region/Save folder, looking for a matching category name.
      • MaxZoomLevel (integer) The maximum zoom level that POIs of this category will be visible on the map. Range is 0 (zoomed in to a very small portion of the map) to 7 (zoomed out to a much larger portion of the map.)
      • Options (integer) Bitwise OR of three possible values. Use 21 to enable all options.
        • 1 - Display on Map
        • 4 - Searchable Whether this category appears in the POI search dialog
        • 16 - Alertable Whether this category appears in the POI alert settings
    • Places (array)
      • Address (object) Displayed when viewing the POI
      • StreetAddress (string; optional; 128 char max)
      • City (string; optional; 128 char max)
      • Zip (string; optional; 16 char max)
      • State (string; optional; 4 char max) State (US) or Country (EU) abbreviation
      • County (string; optional; 64 char max)
      • Coords (object) Used to draw the POI on the map, and when routing to the POI
      • Lat (string) decimal degrees, positive for North, negative for South
      • Lon (string) decimal degrees, positive for East, negative for West
    • CategoryName (string) Assigns this POI to a category (category name must exist in the category array described above for this set).
    • PlaceName (string; 128 char max); Displayed when viewing the POI.
    • Phone (string; optional; 64 char max) Displayed when viewing the POI.

Syntax

Parameters

String - A string in JSON format with custom POI information

Return Value

PoiIntegrationResult

Sample Code

PoiIntegrationResult

Overview
DescriptionThis Enum is the return value of CopilotMgr.integrateCustomPOIs which provides the result of the API call
Supported on Android Since Version10.9
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Values

ValuesDescription
SUCCESSPOIs integration is successful
JSON_PARSE_ERRORCannot parse the JSON. The JSON is invalid
INVALID_POI_JSONThe JSON is not in a valid format for the integration of POIs, please review the format detailed within CopilotMgr.integrateCustomPOIs
UNKNOWN_ERRORUnknown Error, please contact ALK support

CopilotMgr.setConfigurationSetting

Overview
DescriptionApplies a setting specified by the given ConfigurationSetting object.
Supported on Android Since Version9.6.0.
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

configurationSetting - The ConfigurationSetting to apply in CoPilot.

Sample Code

Related APIs

CopilotMgr.getConfigurationSetting

Overview
DescriptionGet the current settings for the given configuration.
Supported on Android Since Version9.6.0.
Supported on iOS Since Version10.9
TypeMethod
Packagecom.alk.cpik

Syntax

Parameters

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

Return Value

ConfigurationSetting object representing the current setting for the given configuration.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.setConfigurationSetting()

MotionLockSpeedThreshold

Overview
DescriptionAn enum of the possible values for the driving speed required to activate Motion Lock, which locks the navigation map when the vehicle is in motion. This is a required parameter for the setMotionLockSpeedThreshold method.
Supported on Android Since Version9.6.0.
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
LEVEL_NOT_SETThe threshold is not set.
NO_SPEEDMotion Lock is controlled by the integrated application. Once set and enabled, Motion Lock functionality will be enabled when static. The widget within the UI will also be disabled and only API calls can update the Motion Lock functionality.
LEVEL_1Motion Lock enables at 5 mph.
LEVEL_2Motion Lock enables at 10 mph.
LEVEL_3Motion Lock enables at 15 mph.
LEVEL_4Motion Lock enables at 20 mph.

MotionLockSpeedThreshold

Overview
DescriptionAn enum of the possible values for the driving speed required to activate Motion Lock, which locks the navigation map when the vehicle is in motion. This is a required parameter for the setMotionLockSpeedThreshold method.
Supported on iOS Since Version10.9
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
CP_LEVEL_NOT_SETThe threshold is not set.
CP_LEVEL_1Motion Lock enables at 5 mph.
CP_LEVEL_2Motion Lock enables at 10 mph.
CP_LEVEL_3Motion Lock enables at 15 mph.
CP_LEVEL_4Motion Lock enables at 20 mph.

GeocodingError.PlaceError

Overview
DescriptionAn enum of the place error codes when geocoding a stop. Place errors deal with the city/state/postal code portion of the address.
Supported on Android Since Version9.6.0.821
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
INVALIDInvalid error code.
PLACE_PARSE_NOTOKENInput place is empty
PLACE_PARSE_STATEONLYInput is missing a city and/or postal code, only has a state
PLACE_PARSE_BADZIPPostal code in an unknown format
PLACE_CALC_BADSTATEState is in a bad format or not found in region
PLACE_CALC_BADZIPPostal code is in a bad format or not found in region
PLACE_CALC_BADCITYCity is in a bad format or is not found in region
PLACE_CALC_STATEZIPPostal code not found in input state
PLACE_CALC_CITYZIPPostal code not found in input city
PLACE_CALC_NOEXACTExact match of city name not found
PLACE_CALC_NOZIPSNo postal code found for city, state
PLACE_CALC_NOGRIDSNo addresses found for input place
PLACE_CALC_POBOXNOADDRInput has a P.O. Box postal code but no address.
PLACE_CALC_DIFFADDRLATLONGInput latitude/longitude is far from input address.
PLACE_CALC_BADSPLCInput SPLC is bad or not found in region. SPLC (Standard Point Location Code) is a 9-digit geographical code used in North America

GeocodingError.AddressError

Overview
DescriptionAn enum of address error codes when geocoding a stop. These error codes relate to the address position of the input.
Supported on Android Since Version9.6.0.821
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
INVALIDInvalid error code.
ADDR_PARSE_NOTOKENInput address is empty.
ADDR_PARSE_NONUMInput does not contain a house or building number.
ADDR_PARSE_NONAMEInput does not contain a street name.
ADDR_CALC_MULTOKMultiple best matches for input.
ADDR_CALC_NAMEMATCHNo match found for input street name.
ADDR_CALC_NAMESPELL_1Input street name spelling differs slightly from match.
ADDR_CALC_NAMESPELL_2Input street name spelling differs somewhat from match.
ADDR_CALC_NAMESPELL_3Input street name spelling differs significantly from match.
ADDR_CALC_NAMESPELLInput street name spelling differs from match.
ADDR_CALC_ZIPMATCHPostal code differs from match.
ADDR_CALC_ZIPCENTLocation is postal code centroid.
ADDR_CALC_AFXPARITYStreet name prefix/suffix differs from match.
ADDR_CALC_AFXNOINPUTInput does not contain a street name prefix/suffix but match does.
ADDR_CALC_AFXNODATAInput includes a street name prefix/suffix but name does not.
ADDR_CALC_AFXNOMATCHInput street name prefix/suffix differed from match.
ADDR_CALC_AFXBADMultiple errors regarding street name prefix/suffix.
ADDR_CALC_NUMPARSide of street is uncertain in location returned.
ADDR_CALC_NUMUNKNOWNLocation along street returned is uncertain.
ADDR_CALC_NUMRANGELocation along street is approximate.
ADDR_CALC_TYPBADInput street type differs from match.

TruckDimensions

Overview
DescriptionAn object representing the length, width, height and weight of a truck, used for setting a truck routing profile.
Supported on Android Since Version9.6.0.821
Deprecated on Android in Version10.9
Platforms SupportedAndroid, Linux
TypeObject
Packagecom.alk.cpik

Constructor

TruckDimensions(int lengthInches, int widthInches, int heightInches, int weightPounds, int nAxles)

Fields

Field NameTypeUnits
lengthInInchesintInches
widthInInchesintInches
heightInInchesintInches
weightInPoundsintPounds
numAxlesintCount
maxWeightPerAxleGroupInPoundsIntPounds

Sample Code

POICategory

Overview
DescriptionAn object representing a POI category in CoPilot. Examples of POI categories would be food, airports, hotels, etc.
Supported Since Version9.6.4.
Platforms SupportedAndroid, Linux
TypeObject
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getID()
Int
Integer ID for the POI category. This is needed for CopilotMgr.searchPOIsNearLocation and CopilotMgr.searchPOIsAlongRoute.
getName()
string
String description of the POI category.

Hooks and Callbacks

Hooks and Callbacks related to POIs can be found below.

LicenseListener
onPOISearchResults
onPOIAlert

POISearchResult

Overview
DescriptionAn object representing a result of a point of interest (POI) search.
Supported on Android Since Version9.6.4.
TypeObject
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getCategoryID()
Int
Integer ID for the POI category.
getName()
string
String description of the POI name.
getDistanceAway()
double
The distance the POI is from the current location. This distance will be in either miles or kilometers, depending on CoPilot’s unit setting.
getPhoneNumber()
string
The phone number of the POI.
getMisc()
string
Miscellaneous information about the POI.
getStop()StopA Stop representing the location of the POI

POISettings.POIAlertLocation

Overview
DescriptionAn enum of alerts for (points or interest) POIs on the route or near the route.
Supported on Android Since Version9.6.4.
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
ON_ROUTEAlert of POIs on the route.
NEAR_ROUTEAlert of POIs near the route.

POISettings.POIAlertDistance

Overview
DescriptionAn enum of how soon CoPilot will issue a point of interest (POI) alert. This is the distance away from the current location at which POI alerts will begin.
Supported on Android Since Version9.6.4.
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
TWOTENTHS_MILEAlert of POIs 2/10ths of a mile away.
HALF_MILEAlert of POIs ½ mile away.
ONE_MILEAlert of POIs 1 mile away.
THREE_MILESAlert of POIs 3 miles away.
TEN_MILESAlert of POIs 10 miles away.
TWENTYFIVE_MILESAlert of POIs 25 miles away.
HALF_KILOMETERAlert of POIs ½ km away.
ONE_KILOMETERAlert of POIs1 km away.
TWO_KILOMETERSAlert of POIs 2 km away.
FIVE_KILOMETERSAlert of POIs 5 km away.
SIXTEEN_KILOMETERSAlert of POIs 16 km away.
FOURTY_KILOMETERSAlert of POIs 40 km away.

POIAlert

Overview
DescriptionAn object representing a point of interest (POI) alert.
Supported on Android Since Version9.6.4.
TypeObject
Packagecom.alk.cpik

Methods

Method NameReturn TypeDescription
getDistanceOffRoute()
double
The distance the POI is off of the route, in miles/km depending on CoPilot’s unit setting.
getDistanceToDestination()
double
The distance the POI is away from the destination, in miles/km depending on CoPilot’s unit setting.
getDescription()
String
A string description of the POI.
getCategoryID()
Int
The category ID representing the category to which this POI belongs.
getDistanceFromCurrent()
double
The distance the POI is away from the current location, in miles/km depending on CoPilot’s unit setting.
getLon()
double
The longitude of the POI.
getLat()
double
The latitude of the POI.
getHeading()
long
The heading of the POI.

POISettings

Overview
DescriptionAn object representing POI alert settings in CoPilot. The only fields that will be set are the fields whose corresponding method is called on. If the set for a particular field is not called, that field will remain unchanged after a CopilotMgr.setPOIAlertSettings() call.
Supported on Android Since Version9.6.4.
TypeObject
Packagecom.alk.cpik

Methods

Method NameParameterReturnDescription
setPOIAlertEnabledBoolean
Void
Sets whether or not POI alerts should be enabled.
setPOIAlertLocationPOIAlertLocation
Void
Sets whether or not to alert of POIs near route or on route.
setPOIAlertDistancePOIAlertDistance
Void
Sets the distance away for which to alert of POIs.
setPOIAlertCategoriesList
Void
Sets which POI categories to alert.
getPOIAlertEnabled()none
Boolean
Returns whether or not POI alerts should be enabled.
getPOIAlertLocation()None
POIAlertLocation
Returns whether or not to alert of POIs near route or on route.
getPOIAlertDistance()None
POIAlertDistance
Returns the distance away for which to alert of POIs.
getPOIAlertCategories()None
List<POICategory>
Returns which POI categories to alert.
willPOIAlertEnabledBeSet()None
Boolean
Returns whether or not alert enabled will be changed if CopilotMgr.setPOIAlertSettings is called with this object.
willPOIAlertLocationBeSet()None
Boolean
Returns whether or not alert location will be changed if CopilotMgr.setPOIAlertSettings is called with this object.
willPOIAlertDistanceBeSet()None
Boolean
Returns whether or not alert distance will be changed if CopilotMgr.setPOIAlertSettings is called with this object.
willPOIAlertCategoriesBeSet()None
Boolean
Returns whether or not alert categories will be changed if CopilotMgr.setPOIAlertSettings is called with this object.

ConfigurationSetting

Overview
DescriptionAn object representing a configuration setting. Only certain configurations can be set or retrieved using this object. The configuration value must be created using the create method and passed in an accepted configuration name and valid value for that configuration. The below table provides explanations of the three create methods, and the table of valid values.
Supported on Android Since Version9.6.0.
Supported on iOS Since Version10.9
TypeObject
Packagecom.alk.cpik

Methods

Method NameParameter 1Parameter 2ReturnDescription
Static createString configInt valueConfigurationSettingCreates a ConfigurationSetting with an int value. Will throw an exception if the value is invalid for the config, or if the config is not valid.
Static createString configBoolean valueConfigurationSettingCreates a ConfigurationSetting with a boolean value. Will throw an exception if the value is invalid for the config, or if the config is not valid.
Static createString configString valueConfigurationSettingCreates a ConfigurationSetting with a string value. Will throw an exception if the value is invalid for the config, or if the config is not valid.
getBooleanValue()None
Boolean
Returns the boolean value associated with this configuration. If a boolean value is not associated with this configuration, will return null.
getIntegerValue()NoneIntegerReturns the integer value associated with this configuration. If an integer value is not associated with this configuration, will return null.
getStringValue()NoneStringReturns the string value associated with this configuration. If a string value is not associated with this configuration, will return null.

Settings

User.cfg Section HeaderUser.cfg Config NameTypeCPIK libraries Config Name and Description
FlowTrafficFlowTrafficEnabled
Bool
FLOW_TRAFFIC_AVAILABILITY
Whether or not traffic is enabled
FlowTrafficDisplayTrafficBar
Bool
TRAFFIC_BAR_VISIBILITY
Whether or not to show the traffic bar
ApplicationPlayWelcome
Bool
PLAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. SayWelcome must also be on.
SpeechVerboseSpeech
Int
VERBOSE_SPEECH
Whether or not to speak the full road name
SpeechSpeakCalculatingRoute
Bool
SPEAK_CALCULATING_ROUTE
Speak calculating route
User SettingsChevronDisplaySetting
Int
CHEVRON_DISPLAY
The information displayed below the chevron
User SettingsInfobarRightSideIndex
Int
INFO_BAR_RIGHT
The information to show in the right side info bar
User SettingsInfobarLeftSideIndex
Int
INFO_BAR_LEFT
The information to show in the left side info bar
User SettingsSayWelcome
Bool
SAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. PlayWelcome must also be on.
User SettingsShowArrivalPopup
Bool
SHOW_ARRIVAL_POPUP
Show a popup when arriving at your destination
User SettingsApproachingStopDistHundredths
Int
APPROACHING_STOP_DIST_HUNDREDTHS
The distance at which to change the phrase “Arriving” to “Arrived”
User SettingsRouteSyncEnabled
Bool
ROUTE_SYNC_AVAILABILITY
Whether or not routesync is enabled
User SettingsAllowEnableCompliance
Bool
ALLOW_ENABLE_COMPLIANCE
Turn on route compliance
User SettingsWifiHotSpotToken
String
WIFI_HOTSPOT_TOKEN
An SSID token name for which to block map downloads on.
User SettingsRoutingSideStreetMileCostX1000
Int
ROUTING_SIDE_STREET_MILE_X1000
The cost to apply for side of street routing. See values in below table.
User SettingsShowCompliancePopup
Deprecated in CoPilot 10.19.3.48
Bool
SHOW_COMPLIANCE_POPUP
Whether or not to show the compliance popup.
User SettingsEditAcctSettings
Bool
EDIT_ACCOUNT_SETTINGS
Whether or not to display the Account IDs dialog.
User SettingsDisplayStopNameStyle
Int
DISPLAY_STOP_NAME_STYLE
How to display the stop name. Possible displays are name only, address only, or all information.
User SettingsShowStopSide
Bool
STOP_SIDE_DISPLAY
Whether or not to display the stop side.
User SettingsEnableTurnAlert
Int
ENABLE_TURN_ALERT
Provides alerts ahead of navigation turn instructions
User SettingsSideOfStreetMatchType
Available in CoPilot 10.9.0.1180 and Higher
Int
SIDE_OF_STREET_MATCH_TYPE
Determines whether to use the side of street provided by the address or by the latitude/longitude coordinates in the event that they return conflicting information.
User Settings NavMessageDisplay
Available in CoPilot 10.9.0.1180 and Higher
Int
NAV_MESSAGE_DISPLAY
Sets the type of banner to include at the top of all navigation views. (Default is no banner.)
Fleet PortalDriverID
String
DRIVER_ID
Driver identification
Fleet PortalDeviceID
String
DEVICE_ID
Device identification
Fleet PortalPartnerID
String
PARTNER_ID
Partner identification
Fleet PortalPostToFleetPortal
Bool
POST_TO_FLEET_PORTAL
Whether or not to post to fleet portal
SpeedAlertsEnableAdvancedAlerts
Bool
ENABLE_ADVANCED_ALERTS
Enable advanced speed alerts
TruckWarningsDrivexactEnabled
Bool
DRIVEXACT_ALERTS
Whether or not DrivExact alerts are enabled.
GraphicsUseCustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Bool
USE_CUSTOM_DPI
Whether or not to use custom DPI
GraphicsCustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Int
CUSTOM_DPI
The value of custom DPI
GPSNumExtrapolationPts
Int
NUM_EXTRA_POLATION_PTS
The number of extrapolation points
GPSSpeakArrivedAtDestinationInstr
Int
SPEAK_ARRIVED_AT_DESTINATION_INSTR
The value of speak arrived at destination
GPSFrequency
Int
GPS_FREQUENCY
Change to -1 for GPS logging
GPSMessages
Int
GPS_MESSAGED
Change for 255 GPS logging
GPSInfoLogGPSTracks
bool
LOG_GPS_TRACKS
Enable GPS logging
DataRequestManagerNotificationInterval
Int
NOTIFICATION_INTERVAL
The interval, in MB, at which notifications of download progress will be sent via the onMapdataUpdate callback
DataRequestManagerDownloadDataOnSDCard
Available in CoPilot 10.14.0.425 and Higher
Bool
DOWNLOAD_DATA_ON_SD_CARD
When enabled, map data will be downloaded onto the device’s SD card. This setting will also prompt CoPilot to display “Processing” and “CoPilot is Ready!” messages during the download process.
DownloadResumeOnStartup
Bool
RESUME_DOWNLOAD_ON_STARTUP
Whether or not to resume partially complete map downloads on startup
DownloadWiFiOnly
Int
MAP_DOWNLOADS_WIFI_ONLY
Setting to restrict ap downloads to only take place over Wi-Fi
OptimizationUniqueClusterStrictness
Int
UNIQUE_CLUSTER_STRICTNESS
Sets strictness for unique clustering within Optimization
HttpProxyPort
Int
HTTP_PROXY_PORT
Sets the port number of the http proxy setting. User can choose any port number to set.
HttpProxyHost
String
HTTP_PROXY_HOST
Sets the host IP address for the http proxy setting.
HttpProxyUserName
String
HTTP_PROXY_USERNAME
Sets the user name for the http proxy setting. User name will appear in the user.cfg file in the encrypted format.
HttpProxyPassword
String
HTTP_PROXY_PASSWORD
Sets the password for the http proxy setting. Password will appear in the user.cfg file in the encrypted format.
MapDataDownloadPackageMapDataNotificationInterval
Int
MAP_DATA_NOTIFICATION_INTERVAL
Sets the interval, in MB, at which download progress notifications will be sent via the onMapdataUpdate callback if the map download is initiated through the My Maps screen.

CPIK libraries string values

Configuration NameDescriptionConfiguration Values
SIDE_OF_STREET_MATCH_TYPE
Available in CoPilot 10.9.0.1180 and Higher
Determines whether to use the side of street provided by the address or by the latitude/longitude coordinates in the event that they return conflicting information.REQUIRE_ADDRESS_AND_LAT_LON_MATCH
PREFER_ADDRESS
PREFER_LAT_LON
FLOW_TRAFFIC_AVAILABILITYWhether or not the traffic service is enabled on the device.FLOW_TRAFFIC_ENABLED
FLOW_TRAFFIC_DISABLED
TRAFFIC_BAR_VISIBILITYWhether or not to show the traffic bar.TRAFFIC_BAR_SHOW
TRAFFIC_BAR_HIDE
ALLOW_INSERT_GPS_STOP
Available in CoPilot 10.9.0.1180 and Higher
When enabled, if the current GPS location is added to an existing trip, it will be added as the first stop WITHOUT replacing any stops. By default, CoPilot will replace the first stop with your current GPS location when you add it—if you have more than one stop.ADD_GPS_STOP
DO_NOT_ADD_GPS_STOP
PLAY_WELCOMEWhether or not to play the welcome greeting when starting CoPilot. SAY_WELCOME must also be on.PLAY_WELCOME_TRUE
DO_NOT_PLAY_WELCOME
SAY_WELCOMEWhether or not to play the welcome greeting when starting CoPilot. PLAY_WELCOME must also be on.SAY_WELCOME_TRUE
DO_NOT_SAY_WELCOME
SPEAK_CALCULATING_ROUTEWhether to speak calculating route.SPEAK_CALCULATING_ROUTE_TRUE
DO_NOT_SPEAK_CALCULATING_ROUTE
CHEVRON_DISPLAYThe information displayed below the chevron.CHEVRON_DISPLAY_NONE
CHEVRON_DISPLAY_CURRENT_ROAD
CHEVRON_DISPLAY_DESTINATION
CHEVRON_DISPLAY_NEAREST_TOWN
CHEVRON_DISPLAY_HEADING
CHEVRON_DISPLAY_LAT_LON
CHEVRON_DISPLAY_NAME_ADDRESS
CHEVRON_DISPLAY_NAME_ADDRESS
CHEVRON_DISPLAY_NAME_ZIPCODE
CHEVRON_DISPLAY_INSIGHTSTOP_NOTE
CHEVRON_DISPLAY_INSIGHTSTOP_CUSTOM
INFO_BAR_LEFTThe information to show in the left side info bar.INFO_BAR_DISPLAY_ELEVATION
INFO_BAR_DISPLAY_CURRENT_TIME
INFO_BAR_DISPLAY_ETT
INFO_BAR_DISPLAY_HEADING
INFO_BAR_DISPLAY_SPEED
INFO_BAR_DISPLAY_ETA
INFO_BAR_DISPLAY_DISTANCE
INFO_BAR_RIGHTThe information to show in the right side info bar.INFO_BAR_DISPLAY_ELEVATION
INFO_BAR_DISPLAY_CURRENT_TIME
INFO_BAR_DISPLAY_ETT
INFO_BAR_DISPLAY_HEADING
INFO_BAR_DISPLAY_SPEED
INFO_BAR_DISPLAY_ETA
INFO_BAR_DISPLAY_DISTANCE
SHOW_ARRIVAL_POPUPWhether to show a popup when arriving at your destination.SHOW_ARRIVAL_POPUP_TRUE
DO_NOT_SHOW_ARRIVAL_POPUP
ALLOW_ENABLE_COMPLIANCEWhether to turn on route compliance.ENABLE_COMPLIANCE_TRUE
ENABLE_COMPLIANCE_FALSE
POST_TO_FLEET_PORTALWhether or not CoPilot should communicate with FleetPortal.POST_TO_FLEET_PORTAL_TRUE
POST_TO_FLEET_PORTAL_FALSE
ENABLE_ADVANCED_ALERTSWhether to enable advanced speed alerts.ENABLE_ADVANCE_ALERTS
DISABLE_ADVANCE_ALERTS
ROUTING_SIDE_STREET_MILE_X100The cost to apply for side of street routing.SIDEOFSTREET_OFF
SIDEOFSTREET_MINIMAL
SIDEOFSTREET_MODERATE
SIDEOFSTREET_AVERAGE
SIDEOFSTREET_STRICT
SIDEOFSTREET_ADHERE
SIDEOFSTREET_STRONGADHERE
EDIT_ACCOUNT_SETTINGSWhether or not to display the Account IDs dialog.EDIT_ACCOUNT_SETTINGS_ENABLE
EDIT_ACCOUNT_SETTINGS_DISABLE
DRIVEXACT_ALERTSWhether or not DriveExact alerts are enabled.DRIVEXACT_ALERTS_ENABLE
DRIVEXACT_ALERTS_DISABLE
DISPLAY_STOP_NAME_STYLEHow to display the stop name.STOP_DISPLAY_ALL_INFORMATION
STOP_DISPLAY_NAME_ONLY
STOP_DISPLAY_ADDRESS_ONLY
STOP_SIDE_DISPLAYWhether or not to display the stop side.SHOW_STOP_SIDE
HIDE_STOP_SIDE
RESUME_DOWNLOAD_ON_STARTUPWhether or not to resume partially complete map downloads on startup.RESUME
DO_NOT_RESUME
ENABLE_TURN_ALERTWhether or not to provide alerts ahead of navigation turn instructions.TURN_ALERT_ENABLED
TURN_ALERT_DISABLED
MAP_DOWNLOADS_WIFI_ONLYWhether or not may downloads should be restricted to only take place over Wi-FiWIFI_ONLY
ALL_CONNECTIONS_ALLOWED
UNIQUE_CLUSTER_STRICTNESSSets strictness for unique clustering within Optimization.UNIQUE_CLUSTER_OFF
UNIQUE_CLUSTER_ON
UNIQUE_CLUSTER_ONLY
NAV_MESSAGE_DISPLAY
Available in CoPilot 10.9.0.1180 and Higher
Sets the type of banner to include at the top of all navigation views. (Default is no banner.)NAV_MESSAGE_DISPLAY_NONE
NAV_MESSAGE_DISPLAY_CURRENT_ROAD
NAV_MESSAGE_DISPLAY_DESTINATION
NAV_MESSAGE_DISPLAY_NEAREST_TOWN
NAV_MESSAGE_DISPLAY_HEADING
NAV_MESSAGE_DISPLAY_LAT_LON
NAV_MESSAGE_DISPLAY_NAME_ADDRESS
NAV_MESSAGE_DISPLAY_NAME_ZIPCODE
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_NOTE
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_CUSTOM
NAV_MESSAGE_DISPLAY_CUSTOM_MESSAGE
SHOW_COMPLIANCE_POPUP
Deprecated in CoPilot 10.19.3.48
Whether or not to show the compliance popup.SHOW_COMPLIANCE_POPUP_ENABLED
SHOW_COMPLIANCE_POPUP_DISABLED

Sample Code

ConfigurationSetting.ConfigurationException

Overview
DescriptionThrown if ConfigurationSetting.create is called with an invalid config, or an invalid value for that config.
Supported on Android Since Version9.6.0.
Supported on iOS Since Version10.9
TypeObject
Packagecom.alk.cpik

Methods

Method NameParameterReturnDescription
getConfigurationErrorNone ConfigurationException.ConfigurationErrorA description of why the creation of the ConfigurationSetting failed.

ConfigurationSetting.ConfigurationException.ConfigurationError

Overview
DescriptionAn enum of error codes explaining why the creation of a ConfigurationSetting failed.
Supported on Android Since Version9.6.0.
Supported on iOS Since VersionAndroid, Linux
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
INVALID_CONFIGURATIONThe configuration is not valid.
INVALID_SETTING_FOR_CONFIGURATIONThe configuration is valid, but the value is not valid for that configuration.

CopilotStartupParams

Overview
DescriptionFunctions that can be overridden at CoPilot startup.
Supported on Android Since Version9.6.0.
TypeClass
Packagecom.alk.cpik

Methods

Method NameReturn Type
useTabletLayout
boolean
getDPIinteger

CopilotStartupParams.useTabletLayout

Overview
DescriptionAn overridable method that can be implemented to determine if CoPilot should use a tablet layout for its views.
Supported on Android Since Version9.6.0.
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

boolean

Sample Code

CopilotStartupParams.getDPI

Overview
DescriptionAn overridable method to set the dots per inch (DPI) value for the resolution of CoPilot on a device.
Supported on Android Since Version10.9.0.1049
TypeMethod
Packagecom.alk.cpik

Syntax

Return Value

integer

Sample Code

Last updated May 10, 2022.
Contents