CoPilotMgr - Configs and Stops (CPIK Libraries)
Contents
CopilotVersion
Overview | |
---|---|
Description | A 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 Version | 9.6.0.821 |
Type | Class |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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 | |
---|---|
Description | Returns the CoPilot application version currently installed on the device. |
Supported Since CoPilot Version | 9.6.0.867 |
Supported in following Platforms | Android |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
String object containing the application version.
Sample Code
CopilotVersion.getDataVersion
Overview | |
---|---|
Description | Returns the CoPilot map data version that is downloaded on the device. |
Supported Since Version | 9.6.0.867 |
Platforms Supported | Android |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
String object containing the map data version.
Sample Code
CopilotVersion.getDataYear
Overview | |
---|---|
Description | Returns an integer representing the year of the map data version that is currently in use on the device (e.g. 2014). |
Supported Since Version | 9.6.0.867 |
Platforms Supported | Android |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
Integer value of the year of the map data version.
Sample Code
CopilotVersion.getDataQuarter
Overview | |
---|---|
Description | Returns an integer representing the quarter that the map data version was released (1, 2, 3, or 4). |
Supported Since Version | 9.6.0.867 |
Platforms Supported | Android |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
Integer value of the quarter of the map data version.
Sample Code
Related APIs
CopilotMgr.setConfigurationSetting
Overview | |
---|---|
Description | Applies a setting specified by the given ConfigurationSetting object. |
Supported on Android Since Version | 9.6.0. |
Supported on iOS Since Version | 10.9 |
Type | Method |
Package | com.alk.cpik |
Syntax
Parameters
configurationSetting - The ConfigurationSetting to apply in CoPilot.
Sample Code
Related APIs
CopilotMgr.getConfigurationSetting
Overview | |
---|---|
Description | Get the current settings for the given configuration. |
Supported on Android Since Version | 9.6.0. |
Supported on iOS Since Version | 10.9 |
Type | Method |
Package | com.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 | |
---|---|
Description | An 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 Version | 9.6.0. |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
LEVEL_NOT_SET | The threshold is not set. |
NO_SPEED | Motion 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_1 | Motion Lock enables at 5 mph. |
LEVEL_2 | Motion Lock enables at 10 mph. |
LEVEL_3 | Motion Lock enables at 15 mph. |
LEVEL_4 | Motion Lock enables at 20 mph. |
MotionLockSpeedThreshold
Overview | |
---|---|
Description | An 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 Version | 10.9 |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
CP_LEVEL_NOT_SET | The threshold is not set. |
CP_LEVEL_1 | Motion Lock enables at 5 mph. |
CP_LEVEL_2 | Motion Lock enables at 10 mph. |
CP_LEVEL_3 | Motion Lock enables at 15 mph. |
CP_LEVEL_4 | Motion Lock enables at 20 mph. |
GeocodingError.PlaceError
Overview | |
---|---|
Description | An 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 Version | 9.6.0.821 |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
INVALID | Invalid error code. |
PLACE_PARSE_NOTOKEN | Input place is empty |
PLACE_PARSE_STATEONLY | Input is missing a city and/or postal code, only has a state |
PLACE_PARSE_BADZIP | Postal code in an unknown format |
PLACE_CALC_BADSTATE | State is in a bad format or not found in region |
PLACE_CALC_BADZIP | Postal code is in a bad format or not found in region |
PLACE_CALC_BADCITY | City is in a bad format or is not found in region |
PLACE_CALC_STATEZIP | Postal code not found in input state |
PLACE_CALC_CITYZIP | Postal code not found in input city |
PLACE_CALC_NOEXACT | Exact match of city name not found |
PLACE_CALC_NOZIPS | No postal code found for city, state |
PLACE_CALC_NOGRIDS | No addresses found for input place |
PLACE_CALC_POBOXNOADDR | Input has a P.O. Box postal code but no address. |
PLACE_CALC_DIFFADDRLATLONG | Input latitude/longitude is far from input address. |
PLACE_CALC_BADSPLC | Input 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 | |
---|---|
Description | An enum of address error codes when geocoding a stop. These error codes relate to the address position of the input. |
Supported on Android Since Version | 9.6.0.821 |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
INVALID | Invalid error code. |
ADDR_PARSE_NOTOKEN | Input address is empty. |
ADDR_PARSE_NONUM | Input does not contain a house or building number. |
ADDR_PARSE_NONAME | Input does not contain a street name. |
ADDR_CALC_MULTOK | Multiple best matches for input. |
ADDR_CALC_NAMEMATCH | No match found for input street name. |
ADDR_CALC_NAMESPELL_1 | Input street name spelling differs slightly from match. |
ADDR_CALC_NAMESPELL_2 | Input street name spelling differs somewhat from match. |
ADDR_CALC_NAMESPELL_3 | Input street name spelling differs significantly from match. |
ADDR_CALC_NAMESPELL | Input street name spelling differs from match. |
ADDR_CALC_ZIPMATCH | Postal code differs from match. |
ADDR_CALC_ZIPCENT | Location is postal code centroid. |
ADDR_CALC_AFXPARITY | Street name prefix/suffix differs from match. |
ADDR_CALC_AFXNOINPUT | Input does not contain a street name prefix/suffix but match does. |
ADDR_CALC_AFXNODATA | Input includes a street name prefix/suffix but name does not. |
ADDR_CALC_AFXNOMATCH | Input street name prefix/suffix differed from match. |
ADDR_CALC_AFXBAD | Multiple errors regarding street name prefix/suffix. |
ADDR_CALC_NUMPAR | Side of street is uncertain in location returned. |
ADDR_CALC_NUMUNKNOWN | Location along street returned is uncertain. |
ADDR_CALC_NUMRANGE | Location along street is approximate. |
ADDR_CALC_TYPBAD | Input street type differs from match. |
TruckDimensions
Overview | |
---|---|
Description | An object representing the length, width, height and weight of a truck, used for setting a truck routing profile. |
Supported on Android Since Version | 9.6.0.821 |
Deprecated on Android in Version | 10.9 |
Platforms Supported | Android, Linux |
Type | Object |
Package | com.alk.cpik |
Constructor
TruckDimensions(int lengthInches, int widthInches, int heightInches, int weightPounds, int nAxles)
Fields
Field Name | Type | Units |
---|---|---|
lengthInInches | int | Inches |
widthInInches | int | Inches |
heightInInches | int | Inches |
weightInPounds | int | Pounds |
numAxles | int | Count |
maxWeightPerAxleGroupInPounds | Int | Pounds |
Sample Code
POICategory
Overview | |
---|---|
Description | An object representing a POI category in CoPilot. Examples of POI categories would be food, airports, hotels, etc. |
Supported Since Version | 9.6.4. |
Platforms Supported | Android, Linux |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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. |
POI Category IDs
Category Name | Category ID |
---|---|
Vehicle Dealership & Repair | 5006 |
Truck Services | 48 |
Truck Repair | 70 |
Sport & Entertainment | 5004 |
Retail | 42 |
Restaurant | 41 |
Recent Destination | 91 |
Parking & Rest Area | 34 |
Miscellaneous | 31 |
Medical & Emergency | 5002 |
Hotel & Accommodation | 5008 |
Gas Station | 22 |
Favorite | 90 |
Company Places | 1803 |
Commercial & Industrial | 60 |
Bank & ATM | 5001 |
Alternate Fuel | 4003 |
Airport & Transportation | 5005 |
Hooks and Callbacks
Hooks and Callbacks related to POIs can be found below.
LicenseListener | |
---|---|
onPOISearchResults | |
onPOIAlert |
POISearchResult
Overview | |
---|---|
Description | An object representing a result of a point of interest (POI) search. |
Supported on Android Since Version | 9.6.4. |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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() | Stop
| A Stop representing the location of the POI |
POISettings.POIAlertLocation
Overview | |
---|---|
Description | An enum of alerts for (points or interest) POIs on the route or near the route. |
Supported on Android Since Version | 9.6.4. |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
ON_ROUTE | Alert of POIs on the route. |
NEAR_ROUTE | Alert of POIs near the route. |
POISettings.POIAlertDistance
Overview | |
---|---|
Description | An 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 Version | 9.6.4. |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
TWOTENTHS_MILE | Alert of POIs 2/10ths of a mile away. |
HALF_MILE | Alert of POIs ½ mile away. |
ONE_MILE | Alert of POIs 1 mile away. |
THREE_MILES | Alert of POIs 3 miles away. |
TEN_MILES | Alert of POIs 10 miles away. |
TWENTYFIVE_MILES | Alert of POIs 25 miles away. |
HALF_KILOMETER | Alert of POIs ½ km away. |
ONE_KILOMETER | Alert of POIs1 km away. |
TWO_KILOMETERS | Alert of POIs 2 km away. |
FIVE_KILOMETERS | Alert of POIs 5 km away. |
SIXTEEN_KILOMETERS | Alert of POIs 16 km away. |
FOURTY_KILOMETERS | Alert of POIs 40 km away. |
POIAlert
Overview | |
---|---|
Description | An object representing a point of interest (POI) alert. |
Supported on Android Since Version | 9.6.4. |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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 | |
---|---|
Description | An 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 Version | 9.6.4. |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Parameter | Return | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
setPOIAlertEnabled | Boolean |
Void | Sets whether or not POI alerts should be enabled. | ||||||||||||||||||||||||||||||||
setPOIAlertLocation | POIAlertLocation |
Void | Sets whether or not to alert of POIs near route or on route. | ||||||||||||||||||||||||||||||||
setPOIAlertDistance | POIAlertDistance |
Void | Sets the distance away for which to alert of POIs. | ||||||||||||||||||||||||||||||||
setPOIAlertCategories | List
| 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 | |
---|---|
Description | An 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 Version | 9.6.0. |
Supported on iOS Since Version | 10.9 |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Parameter 1 | Parameter 2 | Return | Description |
---|---|---|---|---|
Static create | String config | Int value | ConfigurationSetting | Creates 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 create | String config | Boolean value | ConfigurationSetting | Creates 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 create | String config | String value | ConfigurationSetting | Creates 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() | None | Integer | Returns the integer value associated with this configuration. If an integer value is not associated with this configuration, will return null. | |
getStringValue() | None | String | Returns the string value associated with this configuration. If a string value is not associated with this configuration, will return null. |
Settings
Product.cfg/User.cfg Section Header | Product.cfg/User.cfg Config Name | Type | CPIK libraries Config Name and Description |
---|---|---|---|
FlowTraffic | FlowTrafficEnabled |
Bool | FLOW_TRAFFIC_AVAILABILITY Whether or not traffic is enabled |
FlowTraffic | DisplayTrafficBar |
Bool | TRAFFIC_BAR_VISIBILITY Whether or not to show the traffic bar |
FlowTraffic | EnableClosureAvailable in CoPilot 10.27.0.2909 and Later
|
Bool | When set to 1 CoPilot retrieves information about major traffic closures, whether or not your devices are licensed for live traffic. CoPilot then avoids any closures when it calculates a route. This setting is not necessary if you are licensed for traffic and it is enabled. |
Application | PlayWelcome |
Bool | PLAY_WELCOME Whether or not to play the welcome greeting when starting CoPilot. SayWelcome must also be on. |
Application | AllowEditTripAvailable in CoPilot 10.26.1.300 and Later
|
Bool | Not available via CPIK API call. This setting allows you to prohibit drivers from editing trips that were sent to CoPilot via API or URL launch. This setting is 1 (trips can be edited) by default. It does not affect routes manually entered by a driver into CoPilot. Also, it will not affect RouteSync integrated routes, as those prevent drivers from editing a trip by default. |
POI | ShowCustomPlacesOnlyAvailable in CoPilot 10.26.1.300 and Later
|
Bool | Not available via CPIK API call. This allows you to limit the POIs available to add as stops in the Find Location screen to only your company’s custom places. Default is 0, show all places. |
POI | DisplayPOICategoriesOnMapAvailable in CoPilot 10.28.2.166 and Later
|
String | Determines which category IDs to display on the map. By default, this configuration is set to “-1”, which means that the config is disabled, and CoPilot uses the categories set in the UI. When this configuration is set, the driver can still view the active selections in the UI, but will not be able to change them. The format of the configuration is to list the Category IDs, separated by semicolon. |
POI | AlertPOICategoriesAvailable in CoPilot 10.28.2.166 and Later
|
String | Determines which category IDs to alert the driver while driving. By default, this configuration is set to “-1”, which means that the config is disabled, and CoPilot uses the categories set in the UI. When this configuration is set, the driver can still view the active selections in the UI, but will not be able to change them. The format of the configuration is to list the Category IDs, separated by semicolon. |
Speech | VerboseSpeech |
Int | VERBOSE_SPEECH Whether or not to speak the full road name |
Speech | SpeakCalculatingRoute |
Bool | SPEAK_CALCULATING_ROUTE Speak calculating route |
Traffic | TruckSelectFastestTrafficDurationAvailable in CoPilot 10.28.2.264 and Later
|
Bool | Sets whether CoPilot selects the route with the lowest traffic-based estimated time of travel (ETT) as the preferred route. By default (0-false), CoPilot gives preference to the primary practical route, whether or not it has the lowest traffic-based ETT. (The preferred route displays in the CoPilot UI as a blue route line.) |
User Settings | PopupAutoCloseTimeAvailable in CoPilot 10.26.1.517 and Later
|
Int | Sets how long pop-up messages are displayed in CoPilot before they automatically close without the driver tapping OK. You can set it to any length in seconds between 1 and 15. The default value (-1), leaves the closing time unchanged. The default time varies by pop-up if this value is not set. |
User Settings | ChevronDisplaySetting |
Int | CHEVRON_DISPLAY The information displayed below the chevron |
User Settings | InfobarRightSideIndex |
Int | INFO_BAR_RIGHT The information to show in the right side info bar |
User Settings | InfobarLeftSideIndex |
Int | INFO_BAR_LEFT The information to show in the left side info bar |
User Settings | SayWelcome |
Bool | SAY_WELCOME Whether or not to play the welcome greeting when starting CoPilot. PlayWelcome must also be on. |
User Settings | ShowArrivalPopup |
Bool | SHOW_ARRIVAL_POPUP Show a popup when arriving at your destination |
User Settings | ApproachingStopDistHundredths |
Int | APPROACHING_STOP_DIST_HUNDREDTHS The distance at which to change the phrase “Arriving” to “Arrived” |
User Settings | RouteSyncEnabled |
Bool | ROUTE_SYNC_AVAILABILITY Whether or not routesync is enabled |
User Settings | AllowEnableCompliance |
Bool | ALLOW_ENABLE_COMPLIANCE Turn on route compliance |
User Settings | WifiFilterTypeAvailable in CoPilot 10.26.1.187 and Later
|
Int | WIFI_FILTER_TYPE Choose a Wi-Fi SSID filter type for filtering out SSIDs that are not allowed to download map data. Only one filter type can be active at a time. 0 - WIFI_FILTER_NOT_CONFIGURED - No Wi-Fi filtering. 1- WIFI_FILTER_HOTSPOT_TOKEN - SSIDs listed will not be allowed to download maps (Default). 2 - WIFI_FILTER_ALLOWLIST_TOKEN - Only SSIDs listed will be allowed to download maps. |
User Settings | WifiHotSpotToken |
String | WIFI_HOTSPOT_TOKEN An SSID token name or names for which to block map downloads. The string can be semicolon delimited to support multiple SSIDs. To enable this config, WIFI_FILTER_TYPE must be set to WIFI_FILTER_HOTSPOT_TOKEN . Note: We reserve the string value “unknown ssid”. Do not use that value for this config or CoPilot will not download map data.
|
User Settings | WifiAllowListTokenAvailable in CoPilot 10.26.1.187 and Later
|
String | WIFI_ALLOWLIST_TOKEN An SSID token name or names for which to allow map downloads. The string can be semicolon delimited to support multiple SSIDs. To enable the config, WIFI_FILTER_TYPE must be set to WIFI_FILTER_ALLOWLIST_TOKEN . Note: We reserve the string value “unknown ssid”. Do not use that value for this config or CoPilot will not download map data.
|
User Settings | RoutingSideStreetMileCostX1000 |
Int | ROUTING_SIDE_STREET_MILE_X1000 The cost to apply for side of street routing. See values in below table. |
User Settings | ShowCompliancePopup Deprecated in CoPilot 10.19.3.48
|
Bool | SHOW_COMPLIANCE_POPUP Whether or not to show the compliance popup. |
User Settings | EditAcctSettings |
Bool | EDIT_ACCOUNT_SETTINGS Whether or not to display the Account IDs dialog. |
User Settings | DisplayStopNameStyle |
Int | DISPLAY_STOP_NAME_STYLE How to display the stop name. Possible displays are name only, address only, or all information. |
User Settings | ShowStopSide |
Bool | STOP_SIDE_DISPLAY Whether or not to display the stop side. |
User Settings | EnableTurnAlert |
Int | ENABLE_TURN_ALERT Provides alerts ahead of navigation turn instructions |
User Settings | SideOfStreetMatchTypeAvailable in CoPilot 10.9.0.1180 and Later
|
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 | NavMessageDisplayAvailable in CoPilot 10.9.0.1180 and Later
|
Int | NAV_MESSAGE_DISPLAY Sets the type of banner to include at the top of all navigation views. (Default is no banner.) |
User Settings | AvoidCountryAvailable in CoPilot 10.28.2.142 and Later
|
String | A comma-separated list of ISO2 codes for countries that should be avoided when generating a route. |
User Settings | AvoidStateAvailable in CoPilot 10.28.2.142 and Later
|
String | A comma-separated list of ISO2 codes for states that should be avoided when generating a route. |
User Settings | FavorCountryAvailable in CoPilot 10.28.2.142 and Later
|
String | A comma-separated list of ISO2 codes for countries that should be favored when generating a route. |
User Settings | FavorStateAvailable in CoPilot 10.28.2.142 and Later
|
String | A comma-separated list of ISO2 codes for states that should be favored when generating a route. |
Fleet Portal | DriverID |
String | DRIVER_ID Driver identification |
Fleet Portal | DeviceID |
String | DEVICE_ID Device identification |
Fleet Portal | PartnerID |
String | PARTNER_ID Partner identification |
Fleet Portal | PostToFleetPortal |
Bool | POST_TO_FLEET_PORTAL Whether or not to post to fleet portal |
SpeedAlerts | EnableAdvancedAlerts |
Bool | ENABLE_ADVANCED_ALERTS Enable advanced speed alerts |
TruckWarnings | DrivexactEnabled |
Bool | DRIVEXACT_ALERTS Whether or not DrivExact alerts are enabled. |
Graphics | UseCustomDPIDeprecated in CoPilot 10.9.0.1049
|
Bool | USE_CUSTOM_DPI Whether or not to use custom DPI |
Graphics | CustomDPIDeprecated in CoPilot 10.9.0.1049
|
Int | CUSTOM_DPI The value of custom DPI |
GPS | NumExtrapolationPts |
Int | NUM_EXTRA_POLATION_PTS The number of extrapolation points |
GPS | SpeakArrivedAtDestinationInstr |
Int | SPEAK_ARRIVED_AT_DESTINATION_INSTR The value of speak arrived at destination |
GPS | Frequency |
Int | GPS_FREQUENCY Change to -1 for GPS logging |
GPS | Messages |
Int | GPS_MESSAGED Change for 255 GPS logging |
GPSInfo | LogGPSTracks |
bool | LOG_GPS_TRACKS Enable GPS logging |
DataRequestManager | NotificationInterval |
Int | NOTIFICATION_INTERVAL The interval, in MB, at which notifications of download progress will be sent via the onMapdataUpdate callback |
DataRequestManager | DownloadDataOnSDCardAvailable in CoPilot 10.14.0.425 and Later
|
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. |
Download | ResumeOnStartup |
Bool | RESUME_DOWNLOAD_ON_STARTUP Whether or not to resume partially complete map downloads on startup |
Download | WiFiOnly |
Int | MAP_DOWNLOADS_WIFI_ONLY Setting to restrict map downloads to only take place over Wi-Fi. Note: This setting does not apply to Windows laptop versions of CoPilot, which cannot detect if a device is connected to the internet via Wi-Fi or a cellular network. |
Optimization | UniqueClusterStrictness |
Int | UNIQUE_CLUSTER_STRICTNESS Sets strictness for unique clustering within Optimization |
HttpProxy | Port |
Int | HTTP_PROXY_PORT Sets the port number of the http proxy setting. User can choose any port number to set. |
HttpProxy | Host |
String | HTTP_PROXY_HOST Sets the host IP address for the http proxy setting. |
HttpProxy | UserName |
String | HTTP_PROXY_USERNAME Sets the Username for the http proxy setting. Username will appear in the user.cfg file in the encrypted format. |
HttpProxy | Password |
String | HTTP_PROXY_PASSWORD Sets the password for the http proxy setting. Password will appear in the user.cfg file in the encrypted format. |
MapDataDownloadPackage | MapDataNotificationInterval |
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. |
CellDataUsage | DisableCellUsagePrompt |
Bool | Sets whether CoPilot prompts the user to select whether cellular data should be enabled for features that require data downloads, including map updates and traffic information. The prompt is shown by default, which is a “false” (0) value for this setting. |
SingleSearchUI | ForceOfflineSearchWizardAvailable in CoPilot 10.27.0.2909 and Later
|
Bool | The default setting is 0, which enables (online) single search. Switching it to 1 reverts to (offline) classic search. |
Features | ChevronOneTouchToggleAvailable in CoPilot 10.28.2.142 and Later
|
Bool | Gives the driver the ability to tap the chevron that displays the truck’s location to toggle the information displayed below it. The toggle is off by default. Set this config to 1 to add the toggle. |
Features | ChevronOneTouchToggleValueAvailable in CoPilot 10.28.2.142 and Later
|
Int | Sets what is displayed below the chevron when the driver taps it. The default value is 2 (Destination), but it can be set to any of 10 values available for ChevronDisplaySetting .
|
CPIK libraries string values
Configuration Name | Description | Configuration Values |
---|---|---|
WIFI_FILTER_TYPEAvailable in CoPilot 10.26.1.187 and Later
| A Wi-Fi SSID filter type to filter out SSIDs that are not allowed to download map data. Only one filter type can be active at a time. | WIFI_FILTER_NOT_CONFIGURED - No Wi-Fi filtering WIFI_FILTER_HOTSPOT_TOKEN - SSIDs listed will not be allowed to download maps (Default). WIFI_FILTER_ALLOWLIST_TOKEN - Only SSIDs listed will be allowed to download maps. |
WIFI_HOTSPOT_TOKEN | An SSID token name or names for which to block map downloads. The string can be semicolon delimited to support multiple SSIDs. To enable this config, WIFI_FILTER_TYPE must be set to WIFI_FILTER_HOTSPOT_TOKEN . Note: We reserve the string value “unknown ssid”. Do not use that value for this config or CoPilot will not download map data.
| A string with the token name or names. |
WIFI_ALLOWLIST_TOKENAvailable in CoPilot 10.26.1.187 and Later
| An SSID token name or names for which to allow map downloads. The string can be semicolon delimited to support multiple SSIDs. To enable the config, WIFI_FILTER_TYPE must be set to WIFI_FILTER_ALLOWLIST_TOKEN . Note: We reserve the string value “unknown ssid”. Do not use that value for this config or CoPilot will not download map data.
| A string with the token name or names. |
SIDE_OF_STREET_MATCH_TYPEAvailable in CoPilot 10.9.0.1180 and Later
| 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_AVAILABILITY | Whether or not the traffic service is enabled on the device. | FLOW_TRAFFIC_ENABLED FLOW_TRAFFIC_DISABLED |
TRAFFIC_BAR_VISIBILITY | Whether or not to show the traffic bar. | TRAFFIC_BAR_SHOW TRAFFIC_BAR_HIDE |
PLAY_WELCOME | Whether or not to play the welcome greeting when starting CoPilot. SAY_WELCOME must also be on. | PLAY_WELCOME_TRUE DO_NOT_PLAY_WELCOME |
SAY_WELCOME | Whether 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_ROUTE | Whether to speak calculating route. | SPEAK_CALCULATING_ROUTE_TRUE DO_NOT_SPEAK_CALCULATING_ROUTE |
CHEVRON_DISPLAY | The 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_LEFT | The 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_RIGHT | The 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_POPUP | Whether to show a popup when arriving at your destination. | SHOW_ARRIVAL_POPUP_TRUE DO_NOT_SHOW_ARRIVAL_POPUP |
ALLOW_ENABLE_COMPLIANCE | Whether to turn on route compliance. | ENABLE_COMPLIANCE_TRUE ENABLE_COMPLIANCE_FALSE |
POST_TO_FLEET_PORTAL | Whether or not CoPilot should communicate with Account Manager (formerly FleetPortal). | POST_TO_FLEET_PORTAL_TRUE POST_TO_FLEET_PORTAL_FALSE |
ENABLE_ADVANCED_ALERTS | Whether to enable advanced speed alerts. | ENABLE_ADVANCE_ALERTS DISABLE_ADVANCE_ALERTS |
ROUTING_SIDE_STREET_MILE_X100 | The cost to apply for side of street routing. | SIDEOFSTREET_OFF SIDEOFSTREET_MINIMAL SIDEOFSTREET_MODERATE SIDEOFSTREET_AVERAGE SIDEOFSTREET_STRICT SIDEOFSTREET_ADHERE SIDEOFSTREET_STRONGADHERE |
EDIT_ACCOUNT_SETTINGS | Whether or not to display the Account IDs dialog. | EDIT_ACCOUNT_SETTINGS_ENABLE EDIT_ACCOUNT_SETTINGS_DISABLE |
DRIVEXACT_ALERTS | Whether or not DriveExact alerts are enabled. | DRIVEXACT_ALERTS_ENABLE DRIVEXACT_ALERTS_DISABLE |
DISPLAY_STOP_NAME_STYLE | How to display the stop name. | STOP_DISPLAY_ALL_INFORMATION STOP_DISPLAY_NAME_ONLY STOP_DISPLAY_ADDRESS_ONLY |
STOP_SIDE_DISPLAY | Whether or not to display the stop side. | SHOW_STOP_SIDE HIDE_STOP_SIDE |
RESUME_DOWNLOAD_ON_STARTUP | Whether or not to resume partially complete map downloads on startup. | RESUME DO_NOT_RESUME |
ENABLE_TURN_ALERT | Whether or not to provide alerts ahead of navigation turn instructions. | TURN_ALERT_ENABLED TURN_ALERT_DISABLED |
MAP_DOWNLOADS_WIFI_ONLY | Whether or not may downloads should be restricted to only take place over Wi-Fi | WIFI_ONLY ALL_CONNECTIONS_ALLOWED |
UNIQUE_CLUSTER_STRICTNESS | Sets strictness for unique clustering within Optimization. | UNIQUE_CLUSTER_OFF UNIQUE_CLUSTER_ON UNIQUE_CLUSTER_ONLY |
NAV_MESSAGE_DISPLAYAvailable in CoPilot 10.9.0.1180 and Later
| 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 |
ALTERNATE_ROUTES_ALLOWED | Set to DO_NOT_ALLOW_ALTERNATE_ROUTES if you do not want CoPilot to suggest any alternate routes to the driver when it plans a route. (For example, if you want CoPilot to match a route planned in the back office.) Default is allow. If you are licensed for ActiveTraffic, CoPilot will still provide detours to avoid heavy traffic if the traffic ahead is causing a significant delay of more than 10 minutes AND CoPilot finds an alternate route that is quicker. | ALLOW_ALTERNATE_ROUTES DO_NOT_ALLOW_ALTERNATE_ROUTES |
SHOW_COMPLIANCE_POPUPDeprecated in CoPilot 10.19.3.48
| Whether or not to show the compliance popup. | SHOW_COMPLIANCE_POPUP_ENABLED SHOW_COMPLIANCE_POPUP_DISABLED |
EXTERNAL_TRIP_IDAvailable in CoPilot 10.28.2.142 and Later
| Your own unique identifier for trips passed into CoPilot. That ID can then be used to help you better identify trips when reviewing them for safety and route compliance in RouteReporter. Important: You must call RouteMgr.removeAllStops() prior to setting EXTERNAL_TRIP_ID, which is then followed by the trip that should be integrated via API.
| A string with the external ID. |
Sample Code
ConfigurationSetting.ConfigurationException
Overview | |
---|---|
Description | Thrown if ConfigurationSetting.create is called with an invalid config, or an invalid value for that config. |
Supported on Android Since Version | 9.6.0. |
Supported on iOS Since Version | 10.9 |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Parameter | Return | Description |
---|---|---|---|
getConfigurationError | None | ConfigurationException.ConfigurationError | A description of why the creation of the ConfigurationSetting failed. |
ConfigurationSetting.ConfigurationException.ConfigurationError
Overview | |
---|---|
Description | An enum of error codes explaining why the creation of a ConfigurationSetting failed. |
Supported on Android Since Version | 9.6.0. |
Supported on iOS Since Version | Android, Linux |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
INVALID_CONFIGURATION | The configuration is not valid. |
INVALID_SETTING_FOR_CONFIGURATION | The configuration is valid, but the value is not valid for that configuration. |
CopilotStartupParams
Overview | |
---|---|
Description | Functions that can be overridden at CoPilot startup. |
Supported on Android Since Version | 9.6.0. |
Type | Class |
Package | com.alk.cpik |
Methods
Method Name | Return Type |
---|---|
useTabletLayout |
boolean |
getDPI | integer |
CopilotStartupParams.useTabletLayout
Overview | |
---|---|
Description | An overridable method that can be implemented to determine if CoPilot should use a tablet layout for its views. |
Supported on Android Since Version | 9.6.0. |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
boolean
Sample Code
CopilotStartupParams.getDPI
Overview | |
---|---|
Description | An overridable method to set the dots per inch (DPI) value for the resolution of CoPilot on a device. |
Supported on Android Since Version | 10.9.0.1049 |
Type | Method |
Package | com.alk.cpik |
Syntax
Return Value
integer
Sample Code
StopBuilder
Overview | |
---|---|
Description | Builds stops using some of the optional parameters for creating stops. |
Supported on Android Since Version | 9.6.0.821 |
Supported on iOS Since Version | 10.9 |
Type | Class |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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. |
setGeocodeType(GeocodeType) | None | Sets the way CoPilot will geocode a stop depending on whether the stop is entered as an address, latitude/longitude coordinates, or both. |
setID(String) |
StopBuilder | Sets a custom ID for the stop. Available in CoPilot 10.9 and Later
|
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 CoPilot 10.9 and Later
|
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 CoPilot 10.9 and Later
|
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 CoPilot 10.9 and Later
|
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.Available in CoPilot 10.9 and Later
|
setSideOfStreetAdherence(StopSideAdherenceLevel) |
StopBuilder | Sets Side of Street Adherence for the stop. Available in CoPilot 10.9 and Later
|
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 CoPilot 10.9 and Later
|
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 CoPilot 10.9 and Later
|
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 | |
---|---|
Description | The 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 Version | 9.6.0.821 |
Supported on iOS Since Version | 10.9 |
Type | Class |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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 CoPilot 10.9 and Later
|
getNote() |
string | Gets the note associated with the stop object. This is an optional field.Available in CoPilot 10.9 and Later
|
getEarliestArrivalTime() |
ArrivalTimeWindowInfo | Gets the optional early time for the time window where a stop should be reached.Available in CoPilot 10.9 and Later
|
getLatestArrivalTime() |
ArrivalTimeWindowInfo | Gets the latest time for the time window where a stop should be reached. This is an optional field.Available in CoPilot 10.9 and Later
|
getPlannedDurationMinutes() |
Int | Gets the expected Dwell/Wait time that is added to a stop. This is an optional field.Available in CoPilot 10.9 and Later
|
getSideOfStreet() |
StopSide | Gets the side of the street that the stop is on.Available in CoPilot 10.9 and Later
|
getSideOfStreetAdherence() |
StopSideAdherenceLevel | Gets the side of street adherence level that the routing uses to calculate its route to this stop.Available in CoPilot 10.9 and Later
|
getETA() |
string | Gets the current ETA for this stop.Available in CoPilot 10.9 and Later
|
getCustomFields() |
Hashmap<String,String> | Gets a Hashmap of the optional custom fields for this stop.Available in CoPilot 10.9 and Later
|
getIcon() |
string | Get the stop icon image name for the stop object.Available in CoPilot 10.9 and Later
|
getTimeZoneOffset() |
Int | Get time zone offset for the stop object.Available in CoPilot 10.9 and Later
|
Example Output
- Name:
myStop
- Address:
Hallenstraat 19
- City:
Brussels
- State:
- Zip:
1000
- Country:
BE
- Waypoint:
false
- Location:
- Coordinates:
50.85N, 4.35E
- Coordinates:
- 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 | |
---|---|
Description | Returns 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 Version | 10.14 |
Supported on iOS Since Version | 10.14 |
Type | Method |
Package | com.alk.cpik |
Syntax
Parameters
None
Return Values
Boolean
Sample Code
StopBuilder.getNearbyStreets
Overview | |
---|---|
Description | This 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 Version | 10.9 |
Supported on iOS Since Version | 10.9 |
Type | Method |
Package | com.alk.cpik.stopbuilder |
Syntax
Parameters
Parameter | Description |
---|---|
distance | Maximum distance to return street names from, maximum distance of 1 mile. |
maxResults | Number of results to be returned. Maximum of 10. |
Return Value
Street Name - String
Distance - double
Sample Code
StopBuilder.StreetSearchResult
Overview | |
---|---|
Description | This 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 Version | 10.9 |
Supported on iOS Since Version | 10.9 |
Type | Method |
Package | com.alk.cpik.stopbuilder |
Syntax
Parameters
Parameter | Description |
---|---|
distanceThreshold | Maximum distance to return street names from, maximum distance of 1 mile. |
maxResults | Number of results to be returned |
Return Value
Street Name - String
Distance - double
Sample Code
GeocodeSearchType
Overview | |
---|---|
Description | An 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 Version | 9.6.0.1000 |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
EXACT_MATCH_ONLY | Return only one stop. Will only return a stop that is an exact match to the input. |
MULTI_MATCH | Will return a list of stops which are closest to the given information. |
BEST_MATCH | Returns the best match geocoded stop from the given information. |
GeocodeType
Overview | |
---|---|
Description | An enum for the ways CoPilot will geocode a stop depending on whether the stop is entered as an address, latitude/longitude coordinates, or both. |
Supported on Android Since Version | 10.19.4.348 |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
DEFAULT | If a user provides an address only, CoPilot will geocode the address (latitude/longitude coordinates will be generated). CoPilot will navigate to the closest road link to the coordinates and display the address entered. If a user provides latitude/longitude coordinates only, CoPilot will reverse geocode the coordinates (an address will be generated). CoPilot will navigate to the closest road link to the coordinates and display the geocoded address. If a user provides both an address and coordinates, CoPilot will:
|
ADDRESS_ONLY | If latitude/longitude coordinates are provided, they will not be considered. |
LAT_LON_ONLY | If an address is provided, it will not be considered. However, it will be displayed in CoPilot. |
StopSideAdherenceLevel
Overview | |
---|---|
Description | An 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 Version | 10.9 |
Platforms Supported | Android, Linux |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
OFF | Will not reroute according to side of the street. |
MINIMAL | Will increase the route by up to a maximum of 1⁄4 mile to avoid ending up on the wrong side of the street. |
MODERATE | Will increase the route by up to a maximum of 1/2 mile to avoid ending up on the wrong side of the street. |
AVERAGE | Will increase the route by up to a maximum of 1 mile to avoid ending up on the wrong side of the street. |
STRICT | Will increase the route by up to a maximum of 5 miles to avoid ending up on the wrong side of the street. |
ADHERE | Will increase the route by up to a maximum of 10 miles to avoid ending up on the wrong side of the street. |
STRONGLY_ADHERE | Will route the driver by any possible means to reach the correct side of the street. |
StopSide
Overview | |
---|---|
Description | An 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 Version | 10.9 |
Platforms Supported | Android, Linux |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
UNKNOWN | Stop Side Unknown |
LEFT | Stop Side Left |
RIGHT | Stop Side Right |
StopArrivalStatus
Overview | |
---|---|
Description | An enumerated value that indicates the status of the stop relative to the defined time window. |
Supported Since Version | 10.9 |
Platforms Supported | Android, Linux |
Type | Enum |
Package | com.alk.cpik |
Values
Value | Description |
---|---|
UNKNOWN | Arrival window status unknown |
EARLY | Stop arrival time early and expected before the defined window |
ON_TIME | On time with the defined arrival time window |
AT_RISK | Current ETA is at risk of the arrival time window |
LATE | Current ETA is later than the defined window |
StopClickedInfo
Overview | |
---|---|
Description | The 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 Version | 10.14 |
Platforms Supported | Android, iOS Linux |
Type | Class |
Package | com.alk.cpik |
Methods
Method Name | Return Type | Description |
---|---|---|
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 | |
---|---|
Description | Lets you distinguish whether a click on the map was a road, origin, destination, waypoint or intermediate stop. |
Supported Since Version | 10.9.0.958 |
Platforms Supported | Android, iOS Linux |
Type | Method |
Package | com.alk.cpik |
Syntax
Parameters
None
Return Values
A StopClickType
Sample Code
StopClickType
Overview | |
---|---|
Description | A value that represents the type for the location a user clicked on the map. |
Supported Since Version | 10.9.0.958 |
Platforms Supported | Android, iOS Linux |
Type | Method |
Package | com.alk.cpik.ui |
Syntax
StopClickType.ROAD
Values |
---|
ROAD |
ORIGIN_STOP |
DEST_STOP |
WAYPOINT |
INTERMEDIATE_STOP |
UNKNOWN_ERROR |
Sample Code
ArrivalTimeWindowInfo
Overview | |
---|---|
Description | ArrivalTimeWindowInfo 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 Version | 10.9 |
Platforms Supported | Android, Linux |
Type | Object |
Package | com.alk.cpik |
Methods
Method Name | Return Type |
---|---|
getDay() | int |
getMonth() | int |
getYear() | int |
getMinutesFromMidnight() | int |
setDate(int, int, int) | void |
setMinutesFromMidnight(int) | void |
toString() |
String |
Sample Code
FavoriteBuilder
Overview | |
---|---|
Description | Favorite 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 Version | 9.6.0.821 |
Supported on iOS Since Version | Android, Linux |
Type | Class |
Package | com.alk.cpik.trip |
Methods
Method Name | Return Type | Description |
---|---|---|
setName(String) | FavoriteBuilder
| Sets name of the favorite. |
setStreetAddress(String) | FavoriteBuilder
| Sets street address of the favorite. |
setCity(String) | FavoriteBuilder
| Sets city of the favorite. |
setState(String) | FavoriteBuilder
| Sets state of the favorite. |
setCountry(String) | FavoriteBuilder
| Sets country of the favorite. |
setZip(String) | FavoriteBuilder
| Sets zip code of the favorite. |
setFavoriteType(FavoriteType) | FavoriteBuilder
| Sets FavoriteType of the favorite. |
setFavoriteType(int) | FavoriteBuilder
| Sets FavoriteType of the int. |
setCoordinates(LocationCoordinate) | FavoriteBuilder
| Sets coordinates of the favorite. |
build() | Favorite
| Constructs and returns a new favorite object with the information that has been set using a FavoriteBuilder object. |
Sample Code
Favorite
Overview | |
---|---|
Description | Favorite 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 Version | 9.6.0.821 |
Supported on iOS Since Version | 10.9 |
Type | Object |
Package | com.alk.cpik.trip |
Methods
Method Name | Return Type | Description |
---|---|---|
getFavoriteType() | FavoriteType
| Gets 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 | |
---|---|
Description | An enum of the ways to define a favorite type. |
Supported on Android Since Version | 9.6.0.821 |
Supported on iOS Since Version | 10.9 |
Type | Enum |
Package | com.alk.cpik.trip |
Values
Value | Description |
---|---|
GENERAL | The favorite is a general favorite. |
HOME | The favorite is the Home location. |
WORK | The favorite is the Work location. |
ContactBuilder
Overview | |
---|---|
Description | Builder to create Contact objects |
Supported on Android Since Version | 9.6.0 |
Supported on iOS Since Version | 10.9 |
Type | Method |
Package | com.alk.cpik |
Public Methods
Method Name | Return 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