RadarTripLeg represents a single destination within a multi-destination trip. Each leg can have its own destination (geofence, address, or coordinates), status, ETA, and metadata. Trip legs allow you to track progress through a route with multiple stops.
Initializers
initWithDestinationGeofenceTag:destinationGeofenceExternalId:
init(destinationGeofenceTag: String?,
destinationGeofenceExternalId: String?)
- (instancetype)initWithDestinationGeofenceTag:(NSString *_Nullable)destinationGeofenceTag
destinationGeofenceExternalId:(NSString *_Nullable)destinationGeofenceExternalId;
The tag of the destination geofence.
destinationGeofenceExternalId
The external ID of the destination geofence.
initWithDestinationGeofenceId:
init(destinationGeofenceId: String)
- (instancetype)initWithDestinationGeofenceId:(NSString *_Nonnull)destinationGeofenceId;
The Radar ID of the destination geofence.
initWithAddress:
- (instancetype)initWithAddress:(NSString *_Nonnull)address;
The address string for the destination.
initWithCoordinates:
init(coordinates: CLLocationCoordinate2D)
- (instancetype)initWithCoordinates:(CLLocationCoordinate2D)coordinates;
coordinates
CLLocationCoordinate2D
required
The coordinates for the destination (latitude and longitude).
Response Properties
These properties are populated from server responses and are read-only.
The Radar ID of the leg. Set from server response. Use this ID when calling updateTripLeg or completeTripLeg.
The status of the leg. Set from server response.Values:
RadarTripLegStatusUnknown - Unknown statusRadarTripLegStatusPending - Leg is queued but not yet activeRadarTripLegStatusStarted - Device is traveling to this leg’s destinationRadarTripLegStatusApproaching - Device is approaching the destinationRadarTripLegStatusArrived - Device has arrived at the destinationRadarTripLegStatusCompleted - Leg has been completedRadarTripLegStatusCanceled - Leg has been canceledRadarTripLegStatusExpired - Leg has expired
destinationType
RadarTripLegDestinationType
The destination type for this leg. When parsed from a server response, reflects the server’s destination.type. Otherwise, inferred from which properties are set (geofence > address > coordinates).Values:
RadarTripLegDestinationTypeUnknown - Unknown destination typeRadarTripLegDestinationTypeGeofence - Destination is a geofenceRadarTripLegDestinationTypeAddress - Destination is an addressRadarTripLegDestinationTypeCoordinates - Destination is a coordinate pair
The date when the leg was created. Set from server response.
The date when the leg was last updated. Set from server response.
The ETA duration in minutes to this leg’s destination. Set from server response.
The ETA distance in meters to this leg’s destination. Set from server response.
Geofence Destination Properties
The tag of the destination geofence for this leg. Use with destinationGeofenceExternalId for geofence-based destinations.
destinationGeofenceExternalId
The external ID of the destination geofence for this leg. Use with destinationGeofenceTag for geofence-based destinations.
The Radar ID of the destination geofence for this leg. Alternative to using destinationGeofenceTag + destinationGeofenceExternalId.
Address Destination Properties
The address string for the destination of this leg. Use for address-based destinations.
Coordinate Destination Properties
The coordinates for the destination of this leg. Use for coordinate-based destinations. Set latitude and longitude.
Whether coordinates have been explicitly set and are valid.
The arrival radius in meters for coordinate-based destinations. Only used when coordinates are set. Defines how close the device needs to be to the coordinates to be considered arrived.
Common Properties
The stop duration in minutes for this leg. Indicates how long the device should remain at this destination before moving to the next leg.
An optional set of custom key-value pairs for this leg. Use this to attach any custom data to the leg.
Class Methods
legFromDictionary
class func leg(from dictionary: [AnyHashable : Any]?) -> RadarTripLeg?
+ (RadarTripLeg *_Nullable)legFromDictionary:(NSDictionary *_Nullable)dict;
RadarTripLeg from a dictionary representation.
The dictionary containing leg data.
RadarTripLeg instance, or nil if the dictionary is invalid.
legsFromArray
class func legs(from array: [Any]?) -> [RadarTripLeg]?
+ (NSArray<RadarTripLeg *> *_Nullable)legsFromArray:(NSArray *_Nullable)array;
RadarTripLeg objects from an array of dictionaries.
The array of dictionaries containing leg data.
RadarTripLeg instances, or nil if the array is invalid.
arrayForLegs
class func array(for legs: [RadarTripLeg]?) -> [[AnyHashable : Any]]?
+ (NSArray<NSDictionary *> *_Nullable)arrayForLegs:(NSArray<RadarTripLeg *> *_Nullable)legs;
The array of RadarTripLeg instances.
stringForStatus
class func string(for status: RadarTripLegStatus) -> String
+ (NSString *)stringForStatus:(RadarTripLegStatus)status;
statusForString
class func status(for string: String) -> RadarTripLegStatus
+ (RadarTripLegStatus)statusForString:(NSString *)string;
stringForDestinationType
class func string(forDestinationType destinationType: RadarTripLegDestinationType) -> String
+ (NSString *)stringForDestinationType:(RadarTripLegDestinationType)destinationType;
destinationTypeForString
class func destinationType(for string: String) -> RadarTripLegDestinationType
+ (RadarTripLegDestinationType)destinationTypeForString:(NSString *)string;
Instance Methods
dictionaryValue
func dictionaryValue() -> [AnyHashable : Any]
- (NSDictionary *)dictionaryValue;
Usage Examples
Creating Trip Legs with Different Destination Types
// Geofence destination
let leg1 = RadarTripLeg(
destinationGeofenceTag: "store",
destinationGeofenceExternalId: "store-123"
)
leg1.stopDuration = 15 // 15 minutes
leg1.metadata = ["orderId": "abc123"]
// Address destination
let leg2 = RadarTripLeg(address: "123 Main St, San Francisco, CA")
leg2.stopDuration = 10
// Coordinate destination
let leg3 = RadarTripLeg(
coordinates: CLLocationCoordinate2D(latitude: 37.7749, longitude: -122.4194)
)
leg3.arrivalRadius = 100 // 100 meters
leg3.stopDuration = 20
// Geofence destination
RadarTripLeg *leg1 = [[RadarTripLeg alloc]
initWithDestinationGeofenceTag:@"store"
destinationGeofenceExternalId:@"store-123"];
leg1.stopDuration = 15; // 15 minutes
leg1.metadata = @{@"orderId": @"abc123"};
// Address destination
RadarTripLeg *leg2 = [[RadarTripLeg alloc]
initWithAddress:@"123 Main St, San Francisco, CA"];
leg2.stopDuration = 10;
// Coordinate destination
RadarTripLeg *leg3 = [[RadarTripLeg alloc]
initWithCoordinates:CLLocationCoordinate2DMake(37.7749, -122.4194)];
leg3.arrivalRadius = 100; // 100 meters
leg3.stopDuration = 20;
Creating a Multi-Stop Route
// Create multiple legs for a delivery route
let legs = [
RadarTripLeg(
destinationGeofenceTag: "customer",
destinationGeofenceExternalId: "customer-1"
),
RadarTripLeg(
destinationGeofenceTag: "customer",
destinationGeofenceExternalId: "customer-2"
),
RadarTripLeg(
destinationGeofenceTag: "customer",
destinationGeofenceExternalId: "customer-3"
)
]
// Set stop duration for each leg
legs.forEach { $0.stopDuration = 5 }
// Create trip options with legs
let tripOptions = RadarTripOptions(
externalId: "delivery-route-456",
destinationGeofenceTag: nil,
destinationGeofenceExternalId: nil
)
tripOptions.legs = legs
tripOptions.mode = .car
Radar.startTrip(options: tripOptions)
// Create multiple legs for a delivery route
NSArray<RadarTripLeg *> *legs = @[
[[RadarTripLeg alloc]
initWithDestinationGeofenceTag:@"customer"
destinationGeofenceExternalId:@"customer-1"],
[[RadarTripLeg alloc]
initWithDestinationGeofenceTag:@"customer"
destinationGeofenceExternalId:@"customer-2"],
[[RadarTripLeg alloc]
initWithDestinationGeofenceTag:@"customer"
destinationGeofenceExternalId:@"customer-3"]
];
// Set stop duration for each leg
for (RadarTripLeg *leg in legs) {
leg.stopDuration = 5;
}
// Create trip options with legs
RadarTripOptions *tripOptions = [[RadarTripOptions alloc]
initWithExternalId:@"delivery-route-456"
destinationGeofenceTag:nil
destinationGeofenceExternalId:nil];
tripOptions.legs = legs;
tripOptions.mode = RadarRouteModeCar;
[Radar startTripWithOptions:tripOptions];
Monitoring Leg Progress
Radar.getLocation { (status, location, user, events) in
guard let trip = user?.trip, let legs = trip.legs else { return }
for (index, leg) in legs.enumerated() {
print("Leg \(index + 1): \(RadarTripLeg.string(for: leg.status))")
// Check if this is the current active leg
if leg._id == trip.currentLegId {
print(" Current leg - ETA: \(leg.etaDuration) min, Distance: \(leg.etaDistance) m")
switch leg.status {
case .started:
print(" En route to destination")
case .approaching:
print(" Approaching destination")
case .arrived:
print(" Arrived! Completing leg...")
if let legId = leg._id {
Radar.completeTripLeg(legId: legId)
}
case .completed:
print(" Leg completed")
default:
break
}
}
}
}
[Radar getLocationWithCompletionHandler:^(RadarStatus status, CLLocation *location, RadarUser *user, NSArray<RadarEvent *> *events) {
if (!user.trip || !user.trip.legs) {
return;
}
for (NSInteger i = 0; i < user.trip.legs.count; i++) {
RadarTripLeg *leg = user.trip.legs[i];
NSLog(@"Leg %ld: %@", (long)(i + 1), [RadarTripLeg stringForStatus:leg.status]);
// Check if this is the current active leg
if ([leg._id isEqualToString:user.trip.currentLegId]) {
NSLog(@" Current leg - ETA: %.1f min, Distance: %.1f m", leg.etaDuration, leg.etaDistance);
switch (leg.status) {
case RadarTripLegStatusStarted:
NSLog(@" En route to destination");
break;
case RadarTripLegStatusApproaching:
NSLog(@" Approaching destination");
break;
case RadarTripLegStatusArrived:
NSLog(@" Arrived! Completing leg...");
if (leg._id) {
[Radar completeTripLegWithLegId:leg._id];
}
break;
case RadarTripLegStatusCompleted:
NSLog(@" Leg completed");
break;
default:
break;
}
}
}
}];
Updating a Trip Leg
// Update leg metadata or properties
if let currentLegId = user?.trip?.currentLegId {
let updatedMetadata = ["status": "delayed", "reason": "traffic"]
Radar.updateTripLeg(
legId: currentLegId,
metadata: updatedMetadata
) { (status, user, events) in
if status == .success {
print("Leg updated successfully")
}
}
}
// Update leg metadata or properties
if (user.trip.currentLegId) {
NSDictionary *updatedMetadata = @{@"status": @"delayed", @"reason": @"traffic"};
[Radar updateTripLegWithLegId:user.trip.currentLegId
metadata:updatedMetadata
completionHandler:^(RadarStatus status, RadarUser *user, NSArray<RadarEvent *> *events) {
if (status == RadarStatusSuccess) {
NSLog(@"Leg updated successfully");
}
}];
}
