Skip to main content

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
DescriptionA value describing how to incorporate a stop into a trip.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
NEW_TRIPClears the current trip to add the stop(s).
NEW_CURRENT_DESTINATIONInserts the stop as the current destination.
AFTER_FINAL_DESTINATIONAdds 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
DescriptionAn Android AudioStream native module constant. See android.media.AudioManager.
Supported on React Native Since Version10.14.0.TK
TypeNative Module Constant

Values

Exposed ConstantsDescription
STREAM_ALARMThe audio stream for alarms.
STREAM_DTMFThe audio stream for DTMF Tones.
STREAM_MUSICThe audio stream for music playback.
STREAM_NOTIFICATIONThe audio stream for notifications.
STREAM_RINGThe audio stream for the phone ring.
STREAM_SYSTEMThe audio stream for system sounds.
STREAM_VOICE_CALLThe 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
DescriptionThe dialogs that can be called to the forefront of the CPIK libraries application.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
MAP_NAVIGATION_VIEWMap Navigation dialog. This screen is the main navigation view where directions and the map are shown.
MAIN_MENUMain menu dialog. When calling the main menu, the settings options will be available to the user through the UI.
DRIVING_MENUDriving menu dialog. To show the driving menu, which includes a limited number of navigational view options.
FEATURES_AND_UPGRADESFeatures and upgrades. This will bring CoPilot to the “in-app” purchase screen.
PREVIEW_TRIP_PLAN_DIALOGShows a trip preview within the PLAN view.
PREVIEW_TRIP_MAP_DIALOGShows a trip preview within the MAP view.
PREVIEW_TRIP_MAP_NO_WIDGET_DIALOGShows 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_MENUThe settings menu.

DriveSide

Exposed Constants
DRIVE_SIDE_UNAVAILABLE
DRIVE_SIDE_LEFT
DRIVE_SIDE_RIGHT

EUTunnelCode

Exposed Constants
INVALID
NONE
BCDE
CDE
DE
E

FavoriteType

Exposed Constants
GENERAL
HOME
WORK

FeatureStatus

Exposed Constants
LICENSED
UNLICENSED
UNLIMITED
UNKNOWN

GateType

Exposed Constants
UNKNOWN
ENTRY
EXIT
TWO_WAY

GeocodeSearchType

Overview
DescriptionA 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 Version10.14
TypeNative Module Constants

Values

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

GeocodeType

Exposed ConstantsDescription
DEFAULTIf 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_ONLYIf latitude/longitude coordinates are provided, they will not be considered.
LAT_LON_ONLYIf an address is provided, it will not be considered. However, it will be displayed in CoPilot.

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
DescriptionThe list of all possible values that can be returned from LicenseMgr.getLicenseStatus(License).
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
ACTIVATEDLicensed and activated.
WILL_EXPIRELicensed and activated, but the license will expire.
DEACTIVATEDLicensed but not activated.
EXPIREDThe license exists, but is expired.
FAILED_INVALID_LICENSE_KEYThe provided license key is invalid.
FAILED_COPILOT_NOT_STARTEDCannot retrieve the status because CoPilot is not started.
UNKNOWNOther.

ManagedRouteState

Exposed Constants
UNKNOWN
ACTIVE
COMPLETE
CANCELLED

ManagedRouteType

Exposed Constants
ROUTESYNC
DISPATCH
USERCREATED
TRIPINSIGHT

MapDataComponent

Overview
DescriptionA component for a set of map data to optionally disable features such as POIs, Traffic, and SpeedLimit.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
COMPONENT_POIIndicates POI component in map data.
COMPONENT_TRAFFICIndicates TRAFFIC component in map data.
COMPONENT_SPEEDLIMITIndicates SPEEDLIMIT component in map data.

MapDownloadResponse

Overview
DescriptionA 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 Version10.14
TypeNative Module Constants

Values

Return CodeDescription
SUCCESSRequest successfully enqueued.
FAILURE_INVALID_CONNECTIONDevice is using cellular data, but the “WiFiOnly” option is enabled.
FAILURE_INVALID_ARGUMENTArguments are invalid. Either the map set IDs are not valid, URL doesn’t exist or the input list is empty.
FAILURE_MANAGER_BUSYLimitations of certain operations allow for only one request to be processed at a time.
FAILURE_PREPROCESSINGDialed to retrieve URL, inputs were invalid, the connection was invalid, or the manager is handling an operation. Check log for details.
FAILURE_VALIDATIONFailed to validate request. This flag gets expanded on the codes below.
FAILURE_VERSIONThere was a version mismatch with what is being downloaded and the new request, or if performing a map addition, what is already installed.
FAILURE_INSTALLEDThe requested set is already installed. Please note this is only returned if all members of a set are installed.
FAILURE_DOWNLOADINGThe requested set is already downloading.
FAILURE_DOWNLOADEDThe requested set is already downloaded, pending installation.
FAILURE_PAUSEDThe requested set is paused.
FAILURE_CANCELLEDThe requested set is cancelled.
FAILURE_UNLICENSEDThe requested set is unlicensed for the user.
FAILURE_ENQUEUEFailed to add download to the download queue.
FAILURE_INSUFFICIENT_DISK_SPACEInsufficient disk space for the triggered download.
FAILURE_PREINSTALLEDAttempted download request with pre-installed data.
FAILED_GENERIC_ERRORGeneric error, which should not be triggered unless no additional information could be collected.

MapDownloadStatus

Overview
DescriptionThe 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 Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
STATUS_UNKNOWNIndicates map download status is unknown.
DOWNLOADINGIndicates the map is currently downloading.
SUCCEEDEDIndicates map download succeeded.
CANCELLEDIndicates map download has been cancelled.
FAILEDIndicates map download failed.
PAUSEDIndicates map download is currently paused.
NOT_INITIATEDIndicates 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
DescriptionCorresponds 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 Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
ErrorReturns error for any MapRegion error.
AFRICA_Southern_AfricaReturns MapRegion for Southern Africa.
ASIA_Southeast_AsiaReturns MapRegion for South East Asia.
ASIA_IndiaReturns MapRegion for India.
AUSTRALASIA_AustralasiaReturns MapRegion for Australasia.
AUSTRALASIA_AustraliaReturns MapRegion for Australia.
AUSTRALASIA_New_ZealandReturns MapRegion for New Zealand.
CENTRAL_AND_SOUTH_AMERICA_BrazilReturns MapRegion for Brazil.
EUROPE_EuropeReturns MapRegion for Europe.
EUROPE_Eastern_EuropeReturns MapRegion for Eastern Europe.
EUROPE_Western_EuropeReturns MapRegion for Western Europe
EUROPE_UK_and_IrelandReturns MapRegion for UK and Ireland.
EUROPE_BalkansReturns MapRegion for Balkans.
EUROPE_BeNeLuxReturns MapRegion for Belgium Netherlands and Luxembourg.
EUROPE_Central_Eastern_EuropeReturns MapRegion for Central Eastern Europe.
EUROPE_DACHReturns MapRegion for Germany, Austria, Switzerland and Liechtenstein.
EUROPE_FranceReturns MapRegion for France.
EUROPE_GreeceReturns MapRegion for Greece.
EUROPE_IberiaReturns MapRegion for Iberia.
EUROPE_ItalyReturns MapRegion for Italy.
EUROPE_NordicsReturns MapRegion for Nordics.
EUROPE_PolandReturns MapRegion for Poland.
EUROPE_RomaniaReturns MapRegion for Romania.
EUROPE_RussiaReturns MapRegion for Russia.
EUROPE_TurkeyReturns MapRegion for Turkey.
EUROPE_UkraineReturns MapRegion for Ukraine.
MIDDLE_EAST_Middle_EastReturns MapRegion for Middle East.
NORTH_AMERICA_North_AmericaReturns MapRegion for North America.
NORTH_AMERICA_United_StatesReturns MapRegion for United States.
NORTH_AMERICA_CanadaReturns MapRegion for Canada.
NORTH_AMERICA_EasternReturns MapRegion for Eastern.
NORTH_AMERICA_SouthReturns MapRegion for South.
NORTH_AMERICA_MidwestReturns MapRegion for Midwest.
NORTH_AMERICA_Plains_and_RockiesReturns MapRegion for Plains And Rockies.
NORTH_AMERICA_SouthwestReturns MapRegion for South West.
NORTH_AMERICA_NorthwestReturns MapRegion for North West.
NORTH_AMERICA_AlaskaReturns MapRegion for Alaska.
NORTH_AMERICA_HawaiiReturns MapRegion for Hawaii.
NORTH_AMERICA_Puerto_RicoReturns MapRegion for Puerto Rico.

MapViewType

Overview
DescriptionAn value that represents the options available for the navigational views within CoPilot.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
INVALIDInvalid view type, usually indicating that CoPilot service is in some invalid state.
SAFETYSafety View
TWO_DIMENSIONALCoPilot 2D Map View
THREE_DIMENSIONALCoPilot 3D Map View
ITINERARYCoPilot Itinerary View
TWO_DIMENSIONAL_ITINERARY_SPLITCoPilot 2D and Itinerary split view. Only valid on tablet layouts. (Please note this Value is not supported in CoPilot V10)
TWO_DIMENSIONAL_SAFETY_SPLITCoPilot 2D and Safety split view. Only valid on tablet layouts.
THREE_DIMENSIONAL_ITINERARY_SPLITCoPilot 3D and Itinerary split view. Only valid on tablet layouts. (Please note this Value is not supported in CoPilot V10)
THREE_DIMENSIONAL_SAFETY_SPLITCoPilot 3D and Safety split view. Only valid on tablet layouts.
TWO_DIMENSIONAL_NO_WIDGETSCoPilot 2D view with no widgets. (Map only, no buttons, menus or labels)
THREE_DIMENSIONAL_NO_WIDGETSCoPilot 3D view with no widgets. (Map only, no buttons, menus or labels)

MapZoomLevel

Exposed Constants
LEVEL_1 - LEVEL_20

MapZoomLevelChangeResult

Exposed Constants
SUCCESS
FAILED_INVALID_MAPVIEW_TYPE
FAILED_INVALID_LEVEL_FOR_REGION

MotionLockMode

Overview
DescriptionA value representing the Motion Lock UI mode that CoPilot will apply when motion lock is activated.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

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

MotionLockSpeedThreshold

Overview
DescriptionThe 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 Version10.14
TypeNative Module Constants

Values

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

NoteType

Exposed Constants
UNKNOWN
NONE
VISUAL
TTS
VISUAL_AND_TTS

OptimizationDeliveryType

Overview
DescriptionA 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 Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
OPT_WITH_SINGLE_TIMEWINDOWStop having single time window…Second time window parameter will be ignored.
OPT_WITH_DUAL_TIMEWINDOWStop having dual time window. OptInStop.mOpt2ndTimeOrBlockWindowStart and OptInStop.mOpt2ndTimeOrBlockWindowEnd contain the second time window.
OPT_WITH_BLOCKTIMEWINDOWStop having single time window with block time window. OptInStop.mOpt2ndTimeOrBlockWindowStart and OptInStop.mOpt2ndTimeOrBlockWindowEnd contain the block time window.

OptimizationError

Overview
DescriptionThis 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 Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
OPT_NONGEOCODABLE_HEADER_STOPSStart/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_TIMEOUTOptimization timed out before optimization finished.
OPT_CANCELOptimization is stopped by calling Optimization.stop() method before optimization finished.

OptimizationNotification

Overview
DescriptionThis is being sent by the optimization engine to the CPIK libraries application to provide optimization progress.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
OPT_GEOCODE_STARTEDOptimization engine started geocoding of the stops.
OPT_GEOCODE_FINISHEDOptimization engine finished geocoding of the stops.
OPT_DELIVERY_24HOURSDelivery time for all the stops are more than 24 hours.

OptimizationStatus

Overview
DescriptionResponses from a request for optimization.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
SUCCESSRequest to optimization is successful.
FAILED_OPT_ALREADY_RUNNINGOptimization is already running. Cannot initiate second instance of the optimization.
FAILED_OPT_UNLICENSEDOptimization feature is not licensed in CoPilot.
FAILED_GENERAL_ERROROptimization request failed due to unknown error.

OptimizationStopError

Overview
DescriptionThis 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 Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
ERROR_MAXDISTANCEStop 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_MIDNIGHTDelivery time for the given stop is passing through midnight.
ERROR_TIME_WINDOWStop’s end time is earlier than its own start time or the start time of the trip.
ERROR_WAIT_TIMEWait time for a regular stop is more than 30 minutes or wait time for a break stop is more than 2 hours.

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
DescriptionA return value specifying the result of an attempt to add a routing profile.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
SUCCESSThe addition was successful.
FAILED_CANNOT_ADD_DEFAULTThe addition failed, you cannot add a profile named “default”.
FAILED_PROFILE_EXISTSThe addition failed, the profile name already exists, and the overwrite parameter was set to false.
FAILED_UNKNOWN_ERRORThe addition failed, due to an unknown error.
FAILED_VEHICLE_TYPE_NOT_LICENSEDThe vehicle type of the added profile is not licensed.
FAILED_COPILOT_NOT_STARTEDThe addition failed because CoPilot has not yet started.
FAILED_UNKNOWNThe addition failed, due to an unknown error.

RoutingProfileDeletionResult

Overview
DescriptionA return value specifying the result of an attempt to delete a routing profile.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

Exposed ConstantsDescription
SUCCESSThe profile was successfully deleted.
FAILED_NAME_EMPTYThe deletion failed, because the name provided was empty.
FAILED_PROFILE_NOT_FOUNDThe deletion failed because a profile with the given name was not found.
FAILED_CANNOT_DELETE_DEFAULTThe deletion failed because you cannot delete the default profile.
FAILED_DB_ERRORThe deletion failed due to an internal database error.
FAILED_COPILOT_NOT_STARTEDThe deletion failed because CoPilot has not yet started.
FAILED_UNKNOWNThe deletion failed due to an unknown error.

RoutingType

Exposed Constants
QUICKEST
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
DescriptionAn native module constant of sounds.
Supported on React Native Since Version10.14.0.TK
TypeNative Module Constant

Values

Exposed ConstantsDescription
BUTTON_CLICKButton click sound.
SPEED_LIMIT_WARNINGSpeed limit warning sound.
AT_TURN_WARNINGAt turn warning sound.
RESTRICTEDRestriction warning sound.
WARNINGWarning sound.
CP_WELCOMECoPilot welcome sound.
CP_WELCOME_LIVECoPilot welcome sound.
CP_WELCOME_PROCoPilot welcome sound.
CP_WELCOME_LIVE_PROCoPilot live welcome sound.
CP_WELCOME_TRUCKCoPilot Truck welcome sound.
CP_WELCOME_LIVE_TRUCKCoPilot Truck live welcome sound.
DETOURDetour sound.
CANCEL_DETOURCancel Detour sound.
AVOID_ROADAvoid road warning sound.
AVOID_CANCELAvoid canceled warning sound.
NEW_MESSAGENew message received sound.
MESSAGE_SENTMessage sent sound.
ARRIVEDArrived sound.
OFF_ROUTEOff route warning sound.
LONDON_CONGESTIONLondon Congestion zone warning sound.
CONGESTIONCongestion warning sound.
LOW_EMISSIONLow Emission warning sound.
NO_SOUNDNo 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

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
DescriptionThe turn arrow images used by CoPilot.
Supported on React Native Since Version10.14
TypeNative Module Constants

Values

IDExposed ConstantsV9 ImageV10 Image
0NONE
1STRAIGHTimage1 image1
2TURN_LEFTimage2 image2
3TURN_RIGHTimage3 image3
4SLIGHT_LEFTimage4 image4
5SLIGHT_RIGHTimage5 image5
6SHARP_LEFTimage6 image6
7SHARP_RIGHTimage7 image7
8LEFTSIDE_UTURNimage8 image8
9WAYPOINT_FLAGimage9 image10
10START_POINT_FLAGimage11 image12
11END_POINT_FLAGimage13 image14
12ROUNDABOUT_LEFTSIDE_STRAIGHTimage15 image15
13ROUNDABOUT_LEFTSIDE_LEFTimage16 image16
14ROUNDABOUT_LEFTSIDE_RIGHTimage17 image17
15ROUNDABOUT_LEFTSIDE_SLIGHT_LEFTimage18 image18
16ROUNDABOUT_LEFTSIDE_SLIGHT_RIGHTimage19 image19
17ROUNDABOUT_LEFTSIDE_SHARP_LEFTimage20 image20
18ROUNDABOUT_LEFTSIDE_SHARP_RIGHTimage21 image21
19ROUNDABOUT_LEFTSIDE_UTURNimage22 image22
20ROUNDABOUT_RIGHTSIDE_STRAIGHTimage23 image23
21ROUNDABOUT_RIGHTSIDE_LEFTimage24 image24
22ROUNDABOUT_RIGHTSIDE_RIGHTimage25 image25
23ROUNDABOUT_RIGHTSIDE_SLIGHT_LEFTimage26 image26
24ROUNDABOUT_RIGHTSIDE_SLIGHT_RIGHTimage27 image27
25ROUNDABOUT_RIGHTSIDE_SHARP_LEFTimage28 image28
26ROUNDABOUT_RIGHTSIDE_SHARP_RIGHTimage29 image29
27ROUNDABOUT_RIGHTSIDE_UTURNimage30 image30
28RIGHTSIDE_UTURNimage31 image31
29MERGE_LEFTimage32 image32
30MERGE_RIGHTimage33 image33
31LEFTSIDE_OFFRAMPimage34 image34
32RIGHTSIDE_OFFRAMPimage35 image35
33INTERMEDIATE_STOP_FLAGimage36 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

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 August 1, 2022.