CoPilot Navigation

Native Module Constants

Contents

The following Native Module Constants are shared among the APIs in our React Native module.

AddressGeocodingError

Exposed Constants
INVALID
ADDR_PARSE_NOTOKEN
ADDR_PARSE_NONUM
ADDR_PARSE_NONAME
ADDR_PARSE_INVALID
ADDR_CALC_MULTOK
ADDR_CALC_NAMEMATCH
ADDR_CALC_NAMESPELL_1
ADDR_CALC_NAMESPELL_2
ADDR_CALC_NAMESPELL_3
ADDR_CALC_NAMESPELL
ADDR_CALC_ZIPMATCH
ADDR_CALC_ZIPCENT
ADDR_CALC_AFXPARITY
ADDR_CALC_AFXNOINPUT
ADDR_CALC_AFXNODATA
ADDR_CALC_AFXNOMATCH
ADDR_CALC_AFXBAD
ADDR_CALC_NUMPAR
ADDR_CALC_NUMUNKNOWN
ADDR_CALC_NUMRANGE
ADDR_CALC_TYPBAD

AddStopPurpose

Overview
Description A value describing how to incorporate a stop into a trip.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
NEW_TRIP Clears the current trip to add the stop(s).
NEW_CURRENT_DESTINATION Inserts the stop as the current destination.
AFTER_FINAL_DESTINATION Adds the stop to the end of the trip.

Examples

Current trip: > Y -> Z
stopList: A B

addStops(AddStopPurpose.NEW_TRIP, stopList)

Trip after API call: A -> B

addStops(AddStopPurpose.NEW_CURRENT_DESTINATION, stopList)

Trip after API call: A -> Y -> Z -> B

addStops(AddStopPurpose.AFTER_FINAL_DESTINATION, stopList)

Trip after API call: Y -> Z -> A -> B

AllowedVehicleType

Exposed Constants
NONE
COMMUTER
TRUCK
EMERGENCY
PEDESTRIAN

AlternateRouteSelectionResult

Exposed Constants
SELECTION_SUCCESS
SELECTION_FAILED_INVALID_TRIPID
SELECTION_FAILED_ROUTE_PREVIEW_SCREEN
SELECTION_FAILED_COPILOT_NOT_STARTED
SELECTION_FAILED_UNKNOWN

ArrivalStatus

Exposed Constants
APPROACHING
ARRIVED

AudioStream

Overview
Description An Android AudioStream native module constant. See android.media.AudioManager.
Supported on React Native Since Version 10.14
Type Native Module Constant

Values

Exposed Constants Description
STREAM_ALARM The audio stream for alarms.
STREAM_DTMF The audio stream for DTMF Tones.
STREAM_MUSIC The audio stream for music playback.
STREAM_NOTIFICATION The audio stream for notifications.
STREAM_RING The audio stream for the phone ring.
STREAM_SYSTEM The audio stream for system sounds.
STREAM_VOICE_CALL The audio stream for phone calls.

AvoidRouting

Exposed Constants
STRONGLY_AVOID
AVOID
NEUTRAL
FAVOR
STRONGLY_FAVOR

ChevronDisplayType

Exposed Constants
NONE
CURRENT_ROAD
DESTINATION
NEAREST_TOWN
HEADING
LAT_LON
NAME_ADDRESS
NAME_ZIPCODE
INSIGHTSTOP_NOTE
CUSTOM

ComplianceLevel

Exposed Constants
STRICT
MODERATE
NONE

ConfigValidationResult

Exposed Constants
CONFIG_PAIR_OK
CONFIG_KEY_NOT_ON_WHITELIST
CONFIG_VALUE_INVALID_FOR_KEY

Dialog

Overview
Description The dialogs that can be called to the forefront of the CPIK libraries application.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
MAP_NAVIGATION_VIEW Map Navigation dialog. This screen is the main navigation view where directions and the map are shown.
MAIN_MENU Main menu dialog. When calling the main menu, the settings options will be available to the user through the UI.
DRIVING_MENU Driving menu dialog. To show the driving menu, which includes a limited number of navigational view options.
FEATURES_AND_UPGRADES Features and upgrades. This will bring CoPilot to the “in-app” purchase screen.
PREVIEW_TRIP_PLAN_DIALOG Shows a trip preview within the PLAN view.
PREVIEW_TRIP_MAP_DIALOG Shows a trip preview within the MAP view.
PREVIEW_TRIP_MAP_NO_WIDGET_DIALOG Shows a trip preview within the MAP view without widgets (map only—no buttons, menus or labels.) Only available when there are 2 or more stops.
SETTINGS_MENU The settings menu.

DriveSide

Exposed Constants
DRIVE_SIDE_UNAVAILABLE
DRIVE_SIDE_LEFT
DRIVE_SIDE_RIGHT

EnvironmentalZoneType

Exposed Constants
ZONE_NONE
ZONE_CONGESTION_ROUTE_THROUGH
ZONE_CONGESTION_STOP
ZONE_ENVIRONMENTAL_ROUTE_THROUGH
ZONE_ENVIRONMENTAL_STOP
ZONE_ULEZ_ROUTE_THROUGH
ZONE_ULEZ_STOP_THROUGH

EUTunnelCode

Exposed Constants
INVALID
NONE
BCDE
CDE
DE
E

FavoriteType

Exposed Constants
GENERAL
HOME
WORK

FeatureStatus

Exposed Constants
LICENSED
UNLICENSED
UNLIMITED
UNKNOWN

GateType

Overview
Description Describes the entry/exit characteristics of a Gate for a Site.
Supported on React Native Since Version 10.26
Type Native Module Constants

Values

Exposed Constants Description
UNKNOWN Entry/exit characteristics are not known.
ENTRY Gate is used for entering the Site only.
EXIT Gate is used for exiting the Site only.
TWO_WAY Gate can be used to enter or exit the Site.

GeocodeSearchType

Overview
Description A native module that allows different types of geocoding. Geocoding attempts to match user input with actual locations in the CoPilot map database.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants 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

Exposed Constants 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:

  • Geocode the address and compare the air distance between the geocoded address coordinates and the input latitude/longitude coordinates.
  • If the street name in the address is within 1 mile of the input latitude/longitude coordinates, then CoPilot will navigate to the closest road link to the coordinates—on the road that matches the input street name. The input address is displayed in CoPilot.
  • If the street name in the address is not within 1 mile of the input latitude/longitude coordinates, then CoPilot will send the error, “ERROR_STREET_NOT_FOUND.” It will navigate to the closest road link to the input latitude/longitude coordinates, and display the input address.
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.

GeofenceActiveState

Overview
Description A native module of how routing through a geofence will be handled by CoPilot. setRouteThroughEvent() must also be set to true if GeofenceActiveState is set to WARN or AVOID.
Supported on React Native Since Version 10.26
Type Native Module Constants

Values

Exposed Constants Description
NONE Do not take the geofence into account while routing.
WARN Warn before routing through the geofence.
AVOID Avoid routing through the geofence.

GeofenceNotification

Overview
Description A native module of notifications sent when the position enters or exits a geofence.
Supported on React Native Since Version 10.26
Type Native Module Constants

Values

Exposed Constants Description
NONE No callbacks will be sent.
ENTER Send a callback when entering the geofence, but not when exiting.
EXIT Send a callback when exiting the geofence, but not when entering.
ENTER_AND_EXIT Send callbacks both when entering and exiting the geofence.

GeofenceShape

Overview
Description An enum of the possible shapes of a geofence.
Supported on React Native Since Version 10.26
Type Native Module Constants

Values

Exposed Constants Description
CIRCLE Defined by exactly two points. These points define the bounding square in which the circle lies.
POLYGON Must have three or more points. Each point is connected in order, then closed to form the polygon.

GPSFixQuality

Exposed Constants
FIX_NONE
FIX_2D
AUTO

GPSStatus

Exposed Constants
NO_FIX
FIX_2D
FIX_3D

HazmatType

Exposed Constants
NONE
GENERAL
EXPLOSIVE
INHALANT
RADIOACTIVE
CAUSTIC
FLAMMABLE
HARMFUL_TO_WATER

LaneMarker

Exposed Constants
DASHED
SOLID

LicenseActivationResponse

Exposed Constants
SUCCESS
FAILED_DEVICEID_TOO_LONG
FAILED_LICENSE_EXPIRED
FAILED_LICENSING_NOT_READY
FAILED_GENERAL_ERROR
FAILED_INVALID_LICENSE_KEY
FAILED_ROUTE_IN_PROGRESS
FAILED_COPILOT_NOT_STARTED
FAILED_AMS_IN_USE
FAILED_LOGIN_CANT_REACH_SERVER
FAILED_LOGIN_WILL_EXPIRE
FAILED_LOGIN_INVALID_CREDS
FAILED_LOGIN_DEVICE_LIMIT_REACHED
FAILED_LOGIN_NO_ACTIVE_LICENSES

LicenseFeature

Exposed Constants
FULL_NAVIGATION
TRAFFIC
ADVANCED_OPTIMIZATION
MAJOR_REGION
FULL_REGION
TRUCK_HEAVY_DUTY
TRUCK_MEDIUM_DUTY
TRUCK_LIGHT_DUTY
UNKNOWN

LicenseStatus

Overview
Description The list of all possible values that can be returned from LicenseMgr.getLicenseStatus(License).
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
ACTIVATED Licensed and activated.
WILL_EXPIRE Licensed and activated, but the license will expire.
DEACTIVATED Licensed but not activated.
EXPIRED The license exists, but is expired.
FAILED_INVALID_LICENSE_KEY The provided license key is invalid.
FAILED_COPILOT_NOT_STARTED Cannot retrieve the status because CoPilot is not started.
UNKNOWN Other.

ManagedRouteState

Exposed Constants
UNKNOWN
ACTIVE
COMPLETE
CANCELLED

ManagedRouteType

Exposed Constants
ROUTESYNC
DISPATCH
USERCREATED
TRIPINSIGHT

MapDataComponent

Overview
Description A component for a set of map data to optionally disable features such as POIs, Traffic, and SpeedLimit.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
COMPONENT_POI Indicates POI component in map data.
COMPONENT_TRAFFIC Indicates TRAFFIC component in map data.
COMPONENT_SPEEDLIMIT Indicates SPEEDLIMIT component in map data.

MapDownloadResponse

Overview
Description A response to a request to download, pause, cancel, or delete a map. Responses provide information about the request’s result including specific reasons if it fails.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Return Code Description
SUCCESS Request successfully enqueued.
FAILURE_INVALID_CONNECTION Device is using cellular data, but the “WiFiOnly” option is enabled.
FAILURE_INVALID_ARGUMENT Arguments are invalid. Either the map set IDs are not valid, URL doesn’t exist or the input list is empty.
FAILURE_MANAGER_BUSY Limitations of certain operations allow for only one request to be processed at a time.
FAILURE_PREPROCESSING Dialed to retrieve URL, inputs were invalid, the connection was invalid, or the manager is handling an operation. Check log for details.
FAILURE_VALIDATION Failed to validate request. This flag gets expanded on the codes below.
FAILURE_VERSION There was a version mismatch with what is being downloaded and the new request, or if performing a map addition, what is already installed.
FAILURE_INSTALLED The requested set is already installed. Please note this is only returned if all members of a set are installed.
FAILURE_DOWNLOADING The requested set is already downloading.
FAILURE_DOWNLOADED The requested set is already downloaded, pending installation.
FAILURE_PAUSED The requested set is paused.
FAILURE_CANCELLED The requested set is cancelled.
FAILURE_UNLICENSED The requested set is unlicensed for the user.
FAILURE_ENQUEUE Failed to add download to the download queue.
FAILURE_INSUFFICIENT_DISK_SPACE Insufficient disk space for the triggered download.
FAILURE_PREINSTALLED Attempted download request with pre-installed data.
FAILED_GENERIC_ERROR Generic error, which should not be triggered unless no additional information could be collected.
WAITING_ON_STORAGE_SPACE This response is returned when:
  • A map download is initiated.
  • The user copies additional files to the device that reduce the available storage space to less than what is needed to complete the map download.
  • The map download fails.

MapDownloadStatus

Overview
Description The status of a current download. This can be used to identify the status at any stage through the download map status process.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
STATUS_UNKNOWN Indicates map download status is unknown.
DOWNLOADING Indicates the map is currently downloading.
SUCCEEDED Indicates map download succeeded.
CANCELLED Indicates map download has been cancelled.
FAILED Indicates map download failed.
PAUSED Indicates map download is currently paused.
NOT_INITIATED Indicates map download wasn’t started yet.

MapFeedbackClearStatus

Exposed Constants
SUCCESS
FAILURE

MapFeedbackSendStatus

Exposed Constants
SUCCESS
FAILURE_JSON_PARSE
FAILURE_INVALID_POI_JSON
FAILURE_STOPINFO_NOT_PROVIDED
FAILURE_GENERIC_ERROR

MapImageImportStatus

Exposed Constants
SUCCESS
FAILURE

MapMode

Exposed Constants
DAY
NIGHT
AUTO

MapOrientation

Exposed Constants
HEADING_UP
NORTH_UP

MapRegion

Overview
Description Corresponds to a particular map data region. Once this information has been requested, the result can be used to identify a map data region.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
Error Returns error for any MapRegion error.
AFRICA_Southern_Africa Returns MapRegion for Southern Africa.
ASIA_Southeast_Asia Returns MapRegion for South East Asia.
ASIA_India Returns MapRegion for India.
AUSTRALASIA_Australasia Returns MapRegion for Australasia.
AUSTRALASIA_Australia Returns MapRegion for Australia.
AUSTRALASIA_New_Zealand Returns MapRegion for New Zealand.
CENTRAL_AND_SOUTH_AMERICA_Brazil Returns MapRegion for Brazil.
EUROPE_Europe Returns MapRegion for Europe.
EUROPE_Eastern_Europe Returns MapRegion for Eastern Europe.
EUROPE_Western_Europe Returns MapRegion for Western Europe
EUROPE_UK_and_Ireland Returns MapRegion for UK and Ireland.
EUROPE_Balkans Returns MapRegion for Balkans.
EUROPE_BeNeLux Returns MapRegion for Belgium Netherlands and Luxembourg.
EUROPE_Central_Eastern_Europe Returns MapRegion for Central Eastern Europe.
EUROPE_DACH Returns MapRegion for Germany, Austria, Switzerland and Liechtenstein.
EUROPE_France Returns MapRegion for France.
EUROPE_Greece Returns MapRegion for Greece.
EUROPE_Iberia Returns MapRegion for Iberia.
EUROPE_Italy Returns MapRegion for Italy.
EUROPE_Nordics Returns MapRegion for Nordics.
EUROPE_Poland Returns MapRegion for Poland.
EUROPE_Romania Returns MapRegion for Romania.
EUROPE_Russia Returns MapRegion for Russia.
EUROPE_Turkey Returns MapRegion for Turkey.
EUROPE_Ukraine Returns MapRegion for Ukraine.
MIDDLE_EAST_Middle_East Returns MapRegion for Middle East.
NORTH_AMERICA_North_America Returns MapRegion for North America.
NORTH_AMERICA_United_States Returns MapRegion for United States.
NORTH_AMERICA_Canada Returns MapRegion for Canada.
NORTH_AMERICA_Eastern Returns MapRegion for Eastern.
NORTH_AMERICA_South Returns MapRegion for South.
NORTH_AMERICA_Midwest Returns MapRegion for Midwest.
NORTH_AMERICA_Plains_and_Rockies Returns MapRegion for Plains And Rockies.
NORTH_AMERICA_Southwest Returns MapRegion for South West.
NORTH_AMERICA_Northwest Returns MapRegion for North West.
NORTH_AMERICA_Alaska Returns MapRegion for Alaska.
NORTH_AMERICA_Hawaii Returns MapRegion for Hawaii.
NORTH_AMERICA_Puerto_Rico Returns MapRegion for Puerto Rico.

MapViewType

Overview
Description An value that represents the options available for the navigational views within CoPilot.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
INVALID Invalid view type, usually indicating that CoPilot service is in some invalid state.
SAFETY Safety View
TWO_DIMENSIONAL CoPilot 2D Map View
THREE_DIMENSIONAL CoPilot 3D Map View
ITINERARY CoPilot Itinerary View
TWO_DIMENSIONAL_ITINERARY_SPLIT CoPilot 2D and Itinerary split view. Only valid on tablet layouts. (Please note this Value is not supported in CoPilot v10)
TWO_DIMENSIONAL_SAFETY_SPLIT CoPilot 2D and Safety split view. Only valid on tablet layouts.
THREE_DIMENSIONAL_ITINERARY_SPLIT CoPilot 3D and Itinerary split view. Only valid on tablet layouts. (Please note this Value is not supported in CoPilot v10)
THREE_DIMENSIONAL_SAFETY_SPLIT CoPilot 3D and Safety split view. Only valid on tablet layouts.
TWO_DIMENSIONAL_NO_WIDGETS CoPilot 2D view with no widgets. (Map only, no buttons, menus or labels)
THREE_DIMENSIONAL_NO_WIDGETS CoPilot 3D view with no widgets. (Map only, no buttons, menus or labels)

MapZoomLevel

LEVEL_18 is the maximum level for CoPilot 11 and later

Exposed Constants
LEVEL_1 - LEVEL_20

MapZoomLevelChangeResult

Exposed Constants
SUCCESS
FAILED_INVALID_MAPVIEW_TYPE
FAILED_INVALID_LEVEL_FOR_REGION

MotionLockMode

Overview
Description A value representing the Motion Lock UI mode that CoPilot will apply when motion lock is activated.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
ALL_UI_UNLOCK Unlock all UI, do not lock any UI elements when traveling above the threshold speed.
ALL_UI_LOCK Lock 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_ACCESS Only 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_EXTEND ONLY_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_MODE Allow 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.

MotionLockSpeedThreshold

Overview
Description 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 React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants 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.

NoteType

Overview
Description Describes how a Note will be shared with the driver in the CoPilot UI.
Supported on React Native Since Version 10.26
Type Native Module Constants

Values

Exposed Constants Description
UNKNOWN Default uninitialized type. No action.
NONE Do nothing in the CoPilot UI.
VISUAL Display message screen with note title and content.
TTS Play Text-to-Speech (TTS) using note content.
VISUAL_AND_TTS Display VISUAL and play TTS asynchronously.

OptimizationDeliveryType

Overview
Description A native module representing the type of optimization delivery, whether single time window, dual time window or single time window with block time.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
OPT_WITH_SINGLE_TIMEWINDOW Stop having single time window…Second time window parameter will be ignored.
OPT_WITH_DUAL_TIMEWINDOW Stop having dual time window. OptInStop.mOpt2ndTimeOrBlockWindowStart and OptInStop.mOpt2ndTimeOrBlockWindowEnd contain the second time window.
OPT_WITH_BLOCKTIMEWINDOW Stop having single time window with block time window. OptInStop.mOpt2ndTimeOrBlockWindowStart and OptInStop.mOpt2ndTimeOrBlockWindowEnd contain the block time window.

OptimizationError

Overview
Description This is being sent by the optimization engine when encountering an error with the optimization process. Optimization will stop after receiving any of these errors.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
OPT_NONGEOCODABLE_HEADER_STOPS Start/End stop cannot be used in the optimization. It means either it is an incorrect latitude/longitude, in the wrong format, outside of the CoPilot map region or the distance between the start and end locations is outside of our MaxAirTravelMile configuration.
OPT_TIMEOUT Optimization timed out before optimization finished.
OPT_CANCEL Optimization is stopped by calling Optimization.stop() method before optimization finished.

OptimizationNotification

Overview
Description This is being sent by the optimization engine to the CPIK libraries application to provide optimization progress.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
OPT_GEOCODE_STARTED Optimization engine started geocoding of the stops.
OPT_GEOCODE_FINISHED Optimization engine finished geocoding of the stops.
OPT_DELIVERY_24HOURS Delivery time for all the stops are more than 24 hours.

OptimizationStatus

Overview
Description Responses from a request for optimization.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
SUCCESS Request to optimization is successful.
FAILED_OPT_ALREADY_RUNNING Optimization is already running. Cannot initiate second instance of the optimization.
FAILED_OPT_UNLICENSED Optimization feature is not licensed in CoPilot.
FAILED_GENERAL_ERROR Optimization request failed due to unknown error.

OptimizationStopError

Overview
Description This is being sent by the optimization engine when encountering an error with an individual stop. Optimization will still continue after sending the stop error.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
ERROR_MAXDISTANCE Stop is more than 100 miles away from route. This stop will be removed from the optimization list. “Max Distance” configuration: By default CoPilot sets the max distance as 100 miles, which is measured as a matrix of all stops to identify any that are potentially incorrect locations. This means that if a destination is over 100 miles away from all other stops, it will be removed from the optimization. To change the default value add the following section to the user.cfg file
[Optimization]
"MaxAirTravelMile"=100
ERROR_DELIVERY_MIDNIGHT Delivery time for the given stop is passing through midnight.
ERROR_TIME_WINDOW Stop’s end time is earlier than its own start time or the start time of the trip.
ERROR_WAIT_TIME Wait time for a regular stop is more than 30 minutes or wait time for a break stop is more than 2 hours.
ERROR_GEOCODE Stop could not be geocoded.
ERROR_BREAK_INSERT Stop was marked as a break stop but could not be inserted into the end sequence.
ERROR_INVALID_STATIC Stop was marked as static but was not placed in the beginning or at the end of the input sequence.

PlaceGeocodingError

Exposed Constants
INVALID
PLACE_PARSE_NOTOKEN
PLACE_PARSE_STATEONLY
PLACE_PARSE_BADZIP
PLACE_CALC_BADSTATE
PLACE_CALC_BADZIP
PLACE_CALC_BADCITY
PLACE_CALC_STATEZIP
PLACE_CALC_CITYZIP
PLACE_CALC_NOEXACT
PLACE_CALC_NOZIPS
PLACE_CALC_NOGRIDS
PLACE_CALC_POBOXNOADDR
PLACE_CALC_DIFFADDRLATLONG
PLACE_CALC_BADSPLC

POIAlertDistance

Exposed Constants
INVALID
TWOTENTHS_MILE
HALF_MILE
ONE_MILE
THREE_MILES
TEN_MILES
TWENTYFIVE_MILES
HALF_KILOMETER
ONE_KILOMETER
TWO_KILOMETERS
FIVE_KILOMETERS
SIXTEEN_KILOMETERS
FOURTY_KILOMETERS

POIAlertLocation

Exposed Constants
INVALID
ON_ROUTE
NEAR_ROUTE

POIDisplayType

Exposed Constants
NEVER
WHEN_STOPPED
ALWAYS

POIIntegrationResult

Exposed Constants
SUCCESS
JSON_PARSE_ERROR
INVALID_POI_JSON

RestrictedZonePreference

Exposed Constants
AVOID
ALLOW
WARN

RoadArea

Exposed Constants
URBAN
RURAL

RoadClass

Exposed Constants
NONE
CLOSED
INTERSTATE
DIVIDED_HIGHWAY
PRIMARY
FERRY
SECONDARY
RAMP
LOCAL

RoadPriority

Exposed Constants
HIGH
LOW
VERY

RoadSubClass

Exposed Constants
NONE
ROUNDABOUT
BRIDGE
TUNNEL

RoutePreviewMode

Exposed Constants
NO_PREVIEW
PREVIEW_TRIP_PLAN
PREVIEW_TRIP_MAP
PREVIEW_TRIP_MAP_NO_WIDGET

RouteSyncError

Exposed Constants
LICENSING_ERROR
ROUTING_ERROR
UNKNOWN_ERROR

RoutingProfileAdditionResult

Overview
Description A return value specifying the result of an attempt to add a routing profile.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
SUCCESS The addition was successful.
FAILED_CANNOT_ADD_DEFAULT The addition failed, you cannot add a profile named “default”.
FAILED_PROFILE_EXISTS The addition failed, the profile name already exists, and the overwrite parameter was set to false.
FAILED_UNKNOWN_ERROR The addition failed, due to an unknown error.
FAILED_VEHICLE_TYPE_NOT_LICENSED The vehicle type of the added profile is not licensed.
FAILED_COPILOT_NOT_STARTED The addition failed because CoPilot has not yet started.
FAILED_UNKNOWN The addition failed, due to an unknown error.

RoutingProfileDeletionResult

Overview
Description A return value specifying the result of an attempt to delete a routing profile.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

Exposed Constants Description
SUCCESS The profile was successfully deleted.
FAILED_NAME_EMPTY The deletion failed, because the name provided was empty.
FAILED_PROFILE_NOT_FOUND The deletion failed because a profile with the given name was not found.
FAILED_CANNOT_DELETE_DEFAULT The deletion failed because you cannot delete the default profile.
FAILED_DB_ERROR The deletion failed due to an internal database error.
FAILED_COPILOT_NOT_STARTED The deletion failed because CoPilot has not yet started.
FAILED_UNKNOWN The deletion failed due to an unknown error.

RoutingType

Exposed Constants
QUICKEST “Practical”
SHORTEST
FASTEST

SafetyCameraAlertRange

Exposed Constants
SHORT
MEDIUM
LONG

SideBarDisplayType

Exposed Constants
ELEVATION
ESTIMATED_TRAVEL_TIME
HEADING
SPEED
ESTIMATED_TIME_ARRIVAL
DISTANCE

SingleSearchError

Exposed Constants
OK
FAILURE_INIT
FAILURE_WEBSERVICE
FAILURE_CONNECT
FAILURE_INVALID_JSON
FAILURE_DATA_NOT_LICENSED_OR_NOT_INSTALLED
FAILURE_DATA_NOT_AVAILABLE_FOR_RESULT
FAILURE_GENERIC

SoundType

Overview
Description An native module constant of sounds.
Supported on React Native Since Version 10.14
Type Native Module Constant

Values

Exposed Constants Description
BUTTON_CLICK Button click sound.
SPEED_LIMIT_WARNING Speed limit warning sound.
AT_TURN_WARNING At turn warning sound.
RESTRICTED Restriction warning sound.
WARNING Warning sound.
CP_WELCOME CoPilot welcome sound.
CP_WELCOME_LIVE CoPilot welcome sound.
CP_WELCOME_PRO CoPilot welcome sound.
CP_WELCOME_LIVE_PRO CoPilot live welcome sound.
CP_WELCOME_TRUCK CoPilot Truck welcome sound.
CP_WELCOME_LIVE_TRUCK CoPilot Truck live welcome sound.
DETOUR Detour sound.
CANCEL_DETOUR Cancel Detour sound.
AVOID_ROAD Avoid road warning sound.
AVOID_CANCEL Avoid canceled warning sound.
NEW_MESSAGE New message received sound.
MESSAGE_SENT Message sent sound.
ARRIVED Arrived sound.
OFF_ROUTE Off route warning sound.
LONDON_CONGESTION London Congestion zone warning sound.
CONGESTION Congestion warning sound.
LOW_EMISSION Low Emission warning sound.
NO_SOUND No sound type.

SpeedThreshold

Exposed Constants
LEVEL_0
LEVEL_1
LEVEL_2
LEVEL_3
LEVEL_4
LEVEL_5

StopArrivalStatus

Exposed Constants
UNKNOWN
EARLY
ON_TIME
AT_RISK
LATE

StopSide

Exposed Constants
UNKNOWN
LEFT
RIGHT

StopSideAdherenceLevel

Exposed Constants
OFF
MINIMAL
MODERATE
AVERAGE
STRICT
ADHERE
STRONGLY_ADHERE

TollRoads

Exposed Constants
ALWAYS_AVOID
IF_NECESSARY
NO_RESTRICTION

TruckRestrictionType

Exposed Constants
TRUCK_RESTRICTION_UNKNOWN
TRUCK_RESTRICTION_ROAD
TRUCK_RESTRICTION_DESTINATION
TRUCK_COMMERCIALLY_PROHIBITED_DESTINATION
TRUCK_HAZMAT_RESTRICTION_ROAD
TRUCK_LOW_BRIDGE

TruckWarningType

Exposed Constants
NO_UTURN
NO_LEFT
NO_RIGHT
PROTECTED_OVERTAKING_EXTRA_LANE
PROTECTED_OVERTAKING_EXTRA_LANE_RIGHTSIDE
PROTECTED_OVERTAKING_EXTRA_LANE_LEFTSIDE
LANE_MERGE_RIGHT
LANE_MERGE_LEFT
LANE_MERGE_CENTER
RAILWAY_CROSSING_PROTECTED
RAILWAY_CROSSING_UNPROTECTED
ROAD_NARROWS
SHARP_CURVE_RIGHT
SHARP_CURVE_LEFT
STEEP_HILL_UPWARDS
STEEP_HILL_DOWNWARDS
LATERAL_WIND
RISK_OF_GROUNDING
ACCIDENTAL_HAZARD
TREE_OVERHANG
TRUCK_PETROL_STATION
TRUCK_RESTAURANT

TurnArrowImage

Overview
Description The turn arrow images used by CoPilot.
Supported on React Native Since Version 10.14
Type Native Module Constants

Values

ID Exposed Constants V9 Image V10 Image
0 NONE
1 STRAIGHT image1 image1
2 TURN_LEFT image2 image2
3 TURN_RIGHT image3 image3
4 SLIGHT_LEFT image4 image4
5 SLIGHT_RIGHT image5 image5
6 SHARP_LEFT image6 image6
7 SHARP_RIGHT image7 image7
8 LEFTSIDE_UTURN image8 image8
9 WAYPOINT_FLAG image9 image10
10 START_POINT_FLAG image11 image12
11 END_POINT_FLAG image13 image14
12 ROUNDABOUT_LEFTSIDE_STRAIGHT image15 image15
13 ROUNDABOUT_LEFTSIDE_LEFT image16 image16
14 ROUNDABOUT_LEFTSIDE_RIGHT image17 image17
15 ROUNDABOUT_LEFTSIDE_SLIGHT_LEFT image18 image18
16 ROUNDABOUT_LEFTSIDE_SLIGHT_RIGHT image19 image19
17 ROUNDABOUT_LEFTSIDE_SHARP_LEFT image20 image20
18 ROUNDABOUT_LEFTSIDE_SHARP_RIGHT image21 image21
19 ROUNDABOUT_LEFTSIDE_UTURN image22 image22
20 ROUNDABOUT_RIGHTSIDE_STRAIGHT image23 image23
21 ROUNDABOUT_RIGHTSIDE_LEFT image24 image24
22 ROUNDABOUT_RIGHTSIDE_RIGHT image25 image25
23 ROUNDABOUT_RIGHTSIDE_SLIGHT_LEFT image26 image26
24 ROUNDABOUT_RIGHTSIDE_SLIGHT_RIGHT image27 image27
25 ROUNDABOUT_RIGHTSIDE_SHARP_LEFT image28 image28
26 ROUNDABOUT_RIGHTSIDE_SHARP_RIGHT image29 image29
27 ROUNDABOUT_RIGHTSIDE_UTURN image30 image30
28 RIGHTSIDE_UTURN image31 image31
29 MERGE_LEFT image32 image32
30 MERGE_RIGHT image33 image33
31 LEFTSIDE_OFFRAMP image34 image34
32 RIGHTSIDE_OFFRAMP image35 image35
33 INTERMEDIATE_STOP_FLAG image36 image37

TurnCode

Exposed Constants
None
STRAIGHT
LEFT
RIGHT
BEAR_LEFT
BEAR_RIGHT
SHARP_LEFT
SHARP_RIGHT
UTURN
WAYPOINT
START_POINT
END_POINT
UK_ROUNDABOUT_STRAIGHT
UK_ROUNDABOUT_LEFT
UK_ROUNDABOUT_RIGHT
UK_ROUNDABOUT_BEAR_LEFT
UK_ROUNDABOUT_BEAR_RIGHT
UK_ROUNDABOUT_SHARP_LEFT
UK_ROUNDABOUT_SHARP_RIGHT
UK_ROUNDABOUT_UTURN
ROUNDABOUT_STRIGHT
ROUNDABOUT_LEFT
ROUNDABOUT_RIGHT
ROUNDABOUT_BEAR_LEFT
ROUNDABOUT_BEAR_RIGHT
ROUNDABOUT_SHARP_LEFT
ROUNDABOUT_SHARP_RIGHT
ROUNDABOUT_UTURN
RIGHTSIDE_UTURN
EU_OFFRAMP
OFFRAMP
INTERMEDIATE_STOP

UnitsOfMeasure

Exposed Constants
METRIC
IMPERIAL

VehicleProfileModificationResult

Exposed Constants
SUCCESS
FAILED_OPTION_NOT_SUPPORTED_FOR_VEHICLE_TYPE
FAILED_OPTION_NOT_SUPPORTED_FOR_REGION
LENGTH_OUT_OF_RANGE_FOR_VEHICLE_TYPE
WIDTH_OUT_OF_RANGE_FOR_VEHICLE_TYPE
HEIGHT_OUT_OF_RANGE_FOR_VEHICLE_TYPE
TOTAL_WEIGHT_OUT_OF_RANGE_FOR_VEHICLE_TYPE
WEIGHT_PER_AXLE_OUT_OF_RANGE_FOR_VEHICLE_TYPE
ELEVATION_OUT_OF_RANGE
GOVERNOR_SPEED_OUT_OF_RANGE

VehicleRoutingProfileSource


Available in CoPilot 10.26.1.300 and Later

Exposed Constants Description
DEFAULT One of the preset, default Vehicle Routing Profiles available in CoPilot.
MANUAL A Vehicle Routing Profile created by a driver in the CoPilot UI.
FLEET_PORTAL A Vehicle Routing Profile created in Account Manager (formerly FleetPortal).
API A Vehicle Routing Profile created by a CPIK or SDK APIs.

VehicleType

Exposed Constants
AUTO
RV
MOTORCYCLE
BICYCLE
WALKING
COMMERCIAL_PLATE
TRUCK
TRUCK_LIGHT_DUTY
TRUCK_MEDIUM_DUTY
TRUCK_HEAVY_DUTY
BUS US Only
INVALID

VoiceDownloadResult

Exposed Constants
VOICE_DOWNLOAD_QUEUED_SUCCESSFULLY
VOICE_DOWNLOAD_FAILED_ALREADY_DOWNLOADING
VOICE_DOWNLOAD_FAILED_ALREADY_DOWNLOADED
VOICE_DOWNLOAD_FAILED_CELLULAR_DOWNLOADING_DISABLED
VOICE_DOWNLOAD_FAILED_GENERIC_ERROR

VoiceDownloadStatus

Exposed Constants
VOICE_DOWNLOAD_STATUS_SUCCESS
VOICE_DOWNLOAD_STATUS_CANCELED
VOICE_DOWNLOAD_STATUS_FAILED

VoiceStorage

Exposed Constants
DOWNLOADING
NEED_DOWNLOADING
ON_DEVICE

ZoomAction

Exposed Constants
ZOOM_IN
ZOOM_OUT
Last updated May 2, 2025.
CoPilot Version:
v10 v11
Contents