Platforms and setup
Native platforms: ios, android.
- Provider documentation restricts URL launch to the Truck-licensed application.
Public actions
Copilot.open
factory Copilot.open({final bool fallbackToStore = false})
Launch with DeeplinkX.launchApp. Native platforms: ios, android. Action web fallback: available. Store-fallback flag: supported; opt in explicitly.
| Parameter | Type | Required | Default |
|---|---|---|---|
fallbackToStore | bool | No | false |
Copilot.view
static CopilotViewAction view({ required final Coordinate coordinate, final String? title, final bool fallbackToStore = false, })
Launch with DeeplinkX.launchAction. Native platforms: ios, android. Action web fallback: available. Store-fallback flag: supported; opt in explicitly.
| Parameter | Type | Required | Default |
|---|---|---|---|
coordinate | Coordinate | Yes | — |
title | String? | No | — |
fallbackToStore | bool | No | false |
Copilot.directionsWithCoords
static CopilotDirectionsWithCoordsAction directionsWithCoords({ required final Coordinate destination, final String? destinationTitle, final bool fallbackToStore = false, })
Launch with DeeplinkX.launchAction. Native platforms: ios, android. Action web fallback: available. Store-fallback flag: supported; opt in explicitly.
| Parameter | Type | Required | Default |
|---|---|---|---|
destination | Coordinate | Yes | — |
destinationTitle | String? | No | — |
fallbackToStore | bool | No | false |
Provider setup and examples
DeeplinkX supports CoPilot GPS Navigation on iOS and Android for opening the app, showing a coordinate, and starting coordinate navigation. Trimble's URL launch guide says URL launch is supported only by its Truck-licensed application; availability and features depend on the installed CoPilot license.
References
- Trimble CoPilot URL launch documentation: URI format, supported platforms,
VIEWandGOTOactions, coordinate parameters, and Truck-license limitation. - Official Google Play listing: Android package
com.alk.copilot.mapviewer. - Official App Store listing: iOS store ID
504677517.
Available Actions
Launch CoPilot
final deeplinkX = DeeplinkX();
await deeplinkX.launchApp(Copilot.open());
View Map
await deeplinkX.launchAction(
Copilot.view(
coordinate: const Coordinate(latitude: 52.5163, longitude: 13.3777),
title: 'Fleet Yard',
),
);
Directions With Coordinates
await deeplinkX.launchAction(
Copilot.directionsWithCoords(
destination: const Coordinate(latitude: 52.5163, longitude: 13.3777),
destinationTitle: 'Warehouse',
),
);
CoPilot route links are coordinate based, so DeeplinkX does not expose a text-only directions action for this app.
Platform Configuration
iOS
Add the CoPilot scheme to the LSApplicationQueriesSchemes array in ios/Runner/Info.plist:
<string>copilot</string>
Android
Allow querying the package in android/app/src/main/AndroidManifest.xml:
<queries>
<package android:name="com.alk.copilot.mapviewer" />
</queries>
URI Formats
- View:
copilot://mydestination?type=LOCATION&action=VIEW&lat={latitude}&long={longitude}&name={title} - Directions with coordinates:
copilot://mydestination?type=LOCATION&action=GOTO&name={destinationTitle}&lat={latitude}&long={longitude}
Fallback Behavior
- DeeplinkX opens the native app when installed.
- If the app is missing and
fallbackToStoreistrue, we redirect to the appropriate store listing. - Otherwise each action falls back to the CoPilot website.
- Set
disableFallback: truewhen callinglaunchActionto skip both store and web fallbacks.
Fallback Support Matrix
| Action | Store Fallback | Web Fallback |
|---|---|---|
| Open app | Yes | Yes |
| View map | Yes | Yes |
| Directions with coordinates | Yes | Yes |