Skip to main content

CoPilotMgr - Configs and Stops (CPIK Libraries)

Contents

CopilotVersion

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

Methods

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

Sample Code


CopilotVersion.getAppVersion

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

Syntax

Return Value

String object containing the application version.

Sample Code


CopilotVersion.getDataVersion

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

Syntax

Return Value

String object containing the map data version.

Sample Code


CopilotVersion.getDataYear

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

Syntax

Return Value

Integer value of the year of the map data version.

Sample Code


CopilotVersion.getDataQuarter

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

Syntax

Return Value

Integer value of the quarter of the map data version.

Sample Code

Related APIs


CopilotMgr.setConfigurationSetting

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

Syntax

Parameters

configurationSetting - The ConfigurationSetting to apply in CoPilot.

Sample Code

Related APIs


CopilotMgr.getConfigurationSetting

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

Syntax

Parameters

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

Return Value

ConfigurationSetting object representing the current setting for the given configuration.

Sample Code

Related APIs

CopilotMgr.isActive() CopilotMgr.setConfigurationSetting()


MotionLockSpeedThreshold

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

Values

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

MotionLockSpeedThreshold

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

Values

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

GeocodingError.PlaceError

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

Values

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

GeocodingError.AddressError

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

Values

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

TruckDimensions

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

Constructor

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

Fields

Field NameTypeUnits
lengthInInchesintInches
widthInInchesintInches
heightInInchesintInches
weightInPoundsintPounds
numAxlesintCount
maxWeightPerAxleGroupInPoundsIntPounds

Sample Code


POICategory

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

Methods

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

Hooks and Callbacks

Hooks and Callbacks related to POIs can be found below.

LicenseListener
onPOISearchResults
onPOIAlert

POISearchResult

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

Methods

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

POISettings.POIAlertLocation

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

Values

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

POISettings.POIAlertDistance

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

Values

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

POIAlert

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

Methods

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

POISettings

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

Methods

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

ConfigurationSetting

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

Methods

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

Settings

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

CPIK libraries string values

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

Sample Code


ConfigurationSetting.ConfigurationException

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

Methods

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

ConfigurationSetting.ConfigurationException.ConfigurationError

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

Values

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

CopilotStartupParams

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

Methods

Method NameReturn Type
useTabletLayout
boolean
getDPIinteger

CopilotStartupParams.useTabletLayout

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

Syntax

Return Value

boolean

Sample Code


CopilotStartupParams.getDPI

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

Syntax

Return Value

integer

Sample Code


StopBuilder

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

Methods

Method NameReturn TypeDescription
fromLatLon(Coordinate)
StopBuilder
Static method to create a StopBuilder from a latitude / longitude combination.
fromCountryAndPostalCode(String, String)
StopBuilder
Static method to create a StopBuilder from a country and postal code combination.
fromCityAndState (String, String)
StopBuilder
Static method to create a StopBuilder from a city and state combination.
setLatLong (Coordinate)
StopBuilder
Sets lat/long information for the stop to be created.
setPostalCode (String)
StopBuilder
Sets postal code for the stop to be created.
setStreetAddress (String)
StopBuilder
Sets street address for the stop to be created.
setCity (String)
StopBuilder
Sets city for the stop to be created.
setState (String)
StopBuilder
Sets state for the stop to be created.
setCountry(String)
StopBuilder
Sets country for the stop to be created.
setName(String)
StopBuilder
Sets optional name for the stop to be created.
setCounty(String)
StopBuilder
Sets optional county for the stop to be created.
setDestinationFlag(boolean)
StopBuilder
Sets optional flag to designate whether this stop is to be a waypoint.
geocode( GeocodeSearchType )
StopList
Geocodes the address and returns the list of stops.
setGeocodeType( GeocodeType )NoneSets 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.
setNote(String)
StopBuilder
Sets a custom note against the stop that will be shown on the stop details screen within the CoPilot UI.
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.)
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.
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.
setSideOfStreetAdherence(StopSideAdherenceLevel)
StopBuilder
Sets Side of Street Adherence for the stop.
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 .
setIcon
string
Sets stop icon image. The name of the image should be passed. Image of the matching name must be saved within CoPilot.
getNearbyStreets
string
Returns list of nearby streets relative to the coordinates passed to CoPilot, returned as StreetSearchResult
StreetSearchResult
string
Provides list of nearby streets relative to the coordinates passed to CoPilot via getNearbyStreets.

Notes

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

Sample Code


Stop

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

Methods

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

Example Output

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

stop.isVehicleRestricted

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

Syntax

Parameters

None

Return Values

Boolean

Sample Code


StopBuilder.getNearbyStreets

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

Syntax

Parameters

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

Return Value

Street Name - String
Distance - double

Sample Code


StopBuilder.StreetSearchResult

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

Syntax

Parameters

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

Return Value

Street Name - String
Distance - double

Sample Code


GeocodeSearchType

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

Values

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

GeocodeType

Overview
DescriptionAn 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 Version10.19.4.348
TypeEnum
Packagecom.alk.cpik

Values

ValueDescription
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.

StopSideAdherenceLevel

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

Values

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

StopSide

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

Values

ValueDescription
UNKNOWNStop Side Unknown
LEFTStop Side Left
RIGHTStop Side Right

StopArrivalStatus

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

Values

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

StopClickedInfo

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

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

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

Methods

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

getClickType

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

Syntax

Parameters

None

Return Values

A StopClickType

Sample Code


StopClickType

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

Syntax

StopClickType.ROAD

Values
ROAD
ORIGIN_STOP
DEST_STOP
WAYPOINT
INTERMEDIATE_STOP
UNKNOWN_ERROR

Sample Code


ArrivalTimeWindowInfo

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

Methods

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

Sample Code


FavoriteBuilder

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

Methods

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

Sample Code


Favorite

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

Methods

Method NameReturn TypeDescription
getFavoriteType() 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
DescriptionAn enum of the ways to define a favorite type.
Supported on Android Since Version9.6.0.821
Supported on iOS Since Version10.9
TypeEnum
Packagecom.alk.cpik.trip

Values

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

ContactBuilder

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

Public Methods

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

Sample Code

Last updated May 11, 2023.