CoPilotMgr - CoPilot Cell Data and POIs (CPIK Libraries)

CopilotMgr.allowCellularDataForGlobalUsage

Syntax

void allowCellularDataForGlobalUsage(boolean bEnable)

+(void)allowCellularDataForGlobalUsage:(bool)bEnable

Parameters

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

Sample Code

try {
    boolean bEnable = true;
    CopilotMgr.allowCellularDataForGlobalUsage(bEnable);
    if(bEnable)
        System.out.println("allowCellularDataForGlobalUsage is set as enabled");
    else
        System.out.println("allowCellularDataForGlobalUsage is set as disabled");
} catch (CopilotException e) {
    e.printStackTrace();
}

[CopilotMgr allowCellularDataForGlobalUsage:true];

CopilotMgr.isAllowingCellularDataForGlobalUsage

Syntax

boolean isAllowingCellularDataForGlobalUsage ()

+(bool) isAllowingCellularDataForGlobalUsage

Return Value

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

Sample Code

try {
    boolean bEnabled = CopilotMgr.isAllowingCellularDataForGlobalUsage();
    if(bEnabled)
        System.out.println("CellularDataForGlobalUsage is allowed.");
    else
        System.out.println("CellularDataForGlobalUsage is not allowed. ");
} catch (CopilotException e) {
    e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForGlobalUsage];

CopilotMgr.allowCellularDataForFeedback

Syntax

allowCellularDataForFeedback (boolean bEnable)

+(void)allowCellularDataForFeedback:(bool)bEnable

Parameters

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

Sample Code

try {
    boolean bEnable = true;
    CopilotMgr.allowCellularDataForFeedback(bEnable);
    if(bEnable)
        System.out.println("allowCellularDataForFeedback is set as enabled" );
    else
        System.out.println("allowCellularDataForFeedback is set as disabled" );

} catch (CopilotException e) {
    e.printStackTrace();
}

[CopilotMgr allowCellularDataForFeedback:true];

CopilotMgr.isAllowingCellularDataForFeedback

Syntax

boolean isAllowingCellularDataForFeedback ()

+(bool) isAllowingCellularDataForFeedback

Return Value

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

Sample Code

try {
    boolean bEnabled = CopilotMgr.isAllowingCellularDataForFeedback();
    if(bEnabled)
        System.out.println("CellularDataForFeedback is allowed." );
    else
        System.out.println("CellularDataForFeedback is not allowed. ");
} catch (CopilotException e) {
    e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForFeedback];

CopilotMgr.allowCellularDataForMapDownloads

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

Syntax

void allowCellularDataForMapDownloads(boolean bEnable)

+(void)allowCellularDataForMapDownloads:(bool)bEnable

Parameters

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

Sample Code

try {
    boolean bEnable = true;
    CopilotMgr.allowCellularDataForMapDownloads(bEnable);
    if(bEnable)
        System.out.println("allowCellularDataForMapDownloads is set as enabled" );
    else
        System.out.println("allowCellularDataForMapDownloads is set as disabled" );

} catch (CopilotException e) {
    e.printStackTrace();
}

[CopilotMgr allowCellularDataForMapDownloads:true];

CopilotMgr.isAllowingCellularDataForMapDownloads

Syntax

boolean isAllowingCellularDataForMapDownloads()

+(bool) isAllowingCellularDataForMapDownloads

Return Value

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

Sample Code

try {
    boolean bEnabled = CopilotMgr.isAllowingCellularDataForMapDownloads();
    if(bEnabled)
        System.out.println("CellularDataForMapDownloads is allowed." );
    else
        System.out.println("CellularDataForMapDownloads is not allowed. ");
} catch (CopilotException e) {
    e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForMapDownloads];

CopilotMgr.allowCellularDataForNewsAndUpdates

Syntax

void allowCellularDataForNewsAndUpdates(boolean bEnable)

+(void)allowCellularDataForNewsAndUpdates:(bool)bEnable

Parameters

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

Sample Code

try {
    boolean bEnable = true;
    CopilotMgr.allowCellularDataForNewsAndUpdates(bEnable);
    if(bEnable)
        System.out.println("allowCellularDataForNewsAndUpdates is set as enabled" );
    else
        System.out.println("allowCellularDataForNewsAndUpdates is set as disabled" );
} catch (CopilotException e) {
    e.printStackTrace();
}

[CopilotMgr allowCellularDataForNewsAndUpdates:true];

CopilotMgr.isAllowingCellularDataForNewsAndUpdates

Syntax

boolean isAllowingCellularDataForNewsAndUpdates()

+(bool) isAllowingCellularDataForNewsAndUpdates

Return Value

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

Sample Code

try {
  boolean bEnabled = CopilotMgr.isAllowingCellularDataForNewsAndUpdates();
  if(bEnabled)
  System.out.println("CellularDataForNewsAndUpdates is allowed.");
  else
  System.out.println("CellularDataForNewsAndUpdates is not allowed.");
} catch (CopilotException e) {
  e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForNewsAndUpdates];

CopilotMgr.allowCellularDataForSearch

Syntax

void allowCellularDataForSearch(boolean bEnable)

+(void)allowCellularDataForSearch:(bool)bEnable

Parameters

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

Sample Code

try {
  boolean bEnable = true;
  CopilotMgr.allowCellularDataForSearch(bEnable);
  if(bEnable)
  System.out.println("allowCellularDataForSearch is set as enabled");
  else
  System.out.println("allowCellularDataForSearch is set as disabled");
} catch (CopilotException e) {
  e.printStackTrace();
}

[CopilotMgr allowCellularDataForSearch:true];

CopilotMgr.isAllowingCellularDataForSearch

Syntax

boolean isAllowingCellularDataForSearch()

+(bool) isAllowingCellularDataForSearch

Return Value

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

Sample Code

try {
  boolean bEnabled = CopilotMgr.isAllowingCellularDataForSearch();
  if(bEnabled)
  System.out.println("CellularDataForSearch is allowed.");
  else
  System.out.println("CellularDataForSearch is not allowed.");
} catch (CopilotException e) {
  e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForSearch];

Related APIs

• CopilotMgr.isActive()
• CopilotMgr.allowCellularDataForGlobalUsage(boolean)
• CopilotMgr.allowCellularDataForSearch

CopilotMgr.allowCellularDataForSystemFiles

Syntax

void allowCellularDataForSystemFiles(boolean bEnable)

+(void)allowCellularDataForSystemFiles:(bool)bEnable

Parameters

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

Sample Code

try {
  boolean bEnable = true;
  CopilotMgr.allowCellularDataForSystemFiles(bEnable);
  if(bEnable)
  System.out.println("allowCellularDataForSystemFiles is set as enabled");
  else
  System.out.println("allowCellularDataForSystemFiles is set as disabled");
} catch (CopilotException e) {
  e.printStackTrace();
}

[CopilotMgr allowCellularDataForSystemFiles:true];

CopilotMgr.isAllowingCellularDataForSystemFiles

Syntax

boolean isAllowingCellularDataForSystemFiles()

+(bool) isAllowingCellularDataForSystemFiles

Return Value

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

Sample Code

try {
  boolean bEnabled = CopilotMgr.isAllowingCellularDataForSystemFiles();
  if(bEnabled)
  System.out.println("CellularDataForSystemFiles is allowed.");
  else
  System.out.println("CellularDataForSystemFiles is not allowed. ");
} catch (CopilotException e) {
  e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForSystemFiles];

Related APIs

• CopilotMgr.isActive()
• CopilotMgr.allowCellularDataForGlobalUsage(boolean)
• CopilotMgr.allowCellularDataForSystemFiles()

CopilotMgr.allowCellularDataForTrafficServices

Syntax

void allowCellularDataForTrafficServices(boolean bEnable)

+(void)allowCellularDataForTrafficServices:(bool)bEnable

Parameters

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

Sample Code

try {
  boolean bEnable = true;
  CopilotMgr.allowCellularDataForTrafficServices(bEnable);
  if(bEnable)
  System.out.println("allowCellularDataForTrafficServices is set as enabled");
  else
  System.out.println("allowCellularDataForTrafficServices is set as disabled" );
} catch (CopilotException e) {
  e.printStackTrace();
}

[CopilotMgr allowCellularDataForTrafficServices:true];

CopilotMgr.isAllowingCellularDataTrafficServices

Syntax

boolean isAllowingCellularDataForTrafficServices()

+(bool) isAllowingCellularDataForTrafficServices

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

Sample Code

try {
  boolean bEnabled = CopilotMgr.isAllowingCellularDataForTrafficServices();
  if(bEnabled)
  System.out.println("CellularDataForTrafficServices is allowed.");
  else
  System.out.println("CellularDataForTrafficServices is not allowed. ");
} catch (CopilotException e) {
  e.printStackTrace();
}

bool b = [CopilotMgr isAllowingCellularDataForTrafficServices];

Related APIs

• CopilotMgr.isActive()
• CopilotMgr.allowCellularDataForTrafficServices()

CopilotMgr.getPOICategories

Syntax

List getPOICategories()

+(NSArray*) getPOICategories

Return Value

List - The list of CoPilot’s POI categories.

Sample Code

List<POICategory> poiCategoryList = CopilotMgr.getPOICategories();
for (POICategory poiCategory : poiCategoryList)
  System.out.println("POI Category ID: " + String.valueOf(poiCategory.getID()) + "\n POI Category Name :" + poiCategory.getName());

CopilotMgr.searchPOIsNearLocation

Syntax

void searchPOIsNearLocation(String poiSearchName, ArrayList<Integer> typeIDs, Stop stopToSearchNear, int radius, int maxResults, List<POIListener> resultCallbacks)

Parameters

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

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

stopToSearchNear - A stop representing the location to search near.

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

maxResults - The maximum number of results to return.

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

Sample Code

List<POIListener> listenerList = new ArrayList<POIListener>();
POIListener mPOIListener = new POIListener() {
  @Override
  public void onPOISearchResults(List<POISearchResult> poiSearchResult, boolean bSearchComplete) {
  }
};
POIListener.registerListener(mPOIListener);
listenerList.add(mPOIListener);
int allCategoryID = 2;
int radius = 5;
int maxResults = 5;
try {
  double latitude = 40.368420;
  double longitude = -74.655036;
  StopBuilder stopBuilder = StopBuilder.fromLatLon(new Coordinate(latitude, longitude));
  Stop stop = stopBuilder.setName("Trimble Maps").geocode(GeocodeSearchType.BEST_MATCH).get(0);
  ArrayList<Integer> poiCatList = new ArrayList<Integer>();
  poiCatList.add(allCategoryID);
  CopilotMgr.searchPOIsNearLocation("", poiCatList, stop, radius, maxResults, listenerList);
}
catch(GeocodingException e){
  e.printStackTrace();
}

CopilotMgr.searchPOIsAlongRoute

Syntax

void searchPOIsAlongRoute(String poiSearchName, int typeID, int maxResults,List resultCallbacks)

+(void)searchPOIsAlongRoute: (NSString *)poiName poiTypeID:(int)typeID maxNumberOfResults:(int)maxResults;

Parameters

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

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

maxResults - The maximum number of results to return.

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

Sample Code

List<POIListener> listenerList = new ArrayList<POIListener>();
POIListener mPOIListener = new POIListener() {
  @Override
  public void onPOISearchResults(List<POISearchResult> poiSearchResult, boolean bSearchComplete) {
  }
};
POIListener.registerListener(mPOIListener);
listenerList.add(mPOIListener);
int allCategoryID = 2;
int maxResults = 10;

// Support only in 9.6.8 version
CopilotMgr.searchPOIsAlongRoute("All Categories", allCategoryID, maxResults, listenerList);

CopilotMgr.cancelPOISearch

Syntax

 void cancelPOISearch()

+(void)cancelPOISearch;

Sample Code

List<POIListener> listenerList = new ArrayList<POIListener>();
POIListener mPOIListener = new POIListener() {
  @Override
  public void onPOISearchResults(List<POISearchResult> poiSearchResult, boolean bSearchComplete) {
  }
};
int allCategoryID = 2;
CopilotMgr.searchPOIsAlongRoute("All Categories", allCategoryID, maxResults, listenerList);
CopilotMgr.cancelPOISearch();
  CopilotMgr.searchPOIsAlongRoute("All Categories", poiCatList, maxResults, listenerList);
  CopilotMgr.cancelPOISearch();

CopilotMgr.setPOIAlertSettings

Syntax

void setPOIAlertSettings(POIAlertSettings poiSettings)

+(void)setPOIAlertSettings: (POISettings*) settingsToSet;

Parameters

poiSettings - The POISettings to set in CoPilot.

Sample Code

//for disable POI alerts
POISettings disablePOIAlerts = new POISettings();
disablePOIAlerts.setPOIAlertEnabled(false);
CopilotMgr.setPOIAlertSettings(disablePOIAlerts);
System.out.println("POIAlert disabled.");

//for enable POI alerts
POISettings enablePOIAlerts = new POISettings();
enablePOIAlerts.setPOIAlertEnabled(true);
CopilotMgr.setPOIAlertSettings(enablePOIAlerts);
System.out.println("POI Alerts Enabled");

CopilotMgr.getPOIAlertSettings

Syntax

POISettings getPOIAlertSettings()

+(POISettings*)getPOIAlertSettings;

Return Value

POISettings - representing current CoPilot POI alert settings.

Sample Code

POISettings currentSettings = CopilotMgr.getPOIAlertSettings();

System.out.println("POI Alerts " + (currentSettings.getPOIAlertEnabled()? "Enabled":"Disabled"));
System.out.println("Location " + currentSettings.getPOIAlertLocation());
System.out.println("Distance " + currentSettings.getPOIAlertDistance());
System.out.println("Category " + currentSettings.getPOIAlertCategories());

//and to print all at the same time we can use
System.out.println("POI Alerts all values " + currentSettings.getPOIAlertCategories());

CopilotMgr.updatePOICategoriesDisplayStatus

Syntax

static void updatePOICategoriesDisplayStatus(List<POICategory> categories)

Parameters

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

Sample Code

 // Hide a POI Category in CoPilot UI
List<POICategory> poiCates = CopilotMgr.getPOICategories();
List<POICategory> poiCatesToUpdate = new List<POICategory>();
POICategory cat = poiCates.get(0);
cat.setDisplayOnMap(false);
poiCatesToUpdate.add(cat);
CopilotMgr.updatePOICategoriesDisplayStatus(poiCatesToUpdate);

POICategory

Methods

int

String

boolean

void

CopilotMgr.integrateCustomPOIs

JSON Example

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

JSON Field Explanation

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

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

Syntax

static PoiIntegrationResult integrateCustomPOIs(String poiJSON)

+(enum PoiIntegrationResult ) integrateCustomPOIs:(NSString*)poiJSON

Parameters

String - A string in JSON format with custom POI information

Return Value

PoiIntegrationResult

Sample Code

String poiJSON = “your custom poi json string”;
PoiIntegrationResult res = CopilotMgr.integrateCustomPOIs(poiJSON );

NSString *poiJSON = @“your custom poi json string”;
enum PoiIntegrationResult res = [CopilotMgr integrateCustomPOIs:poiJSON]

PoiIntegrationResult

Values