RadarTrip

RadarTrip represents a trip that has been started with Radar’s trip tracking feature. It contains information about the trip’s destination, status, ETA, and metadata. Trip objects are returned in location callbacks and can be accessed via RadarUser.trip.

Properties

String

The Radar ID of the trip. This is assigned by the server when the trip is created.

String

The external ID of the trip. This is the unique ID you provided when creating the trip.

NSDictionary

The optional set of custom key-value pairs for the trip. This contains any custom data attached to the trip.

String

For trips with a destination, the tag of the destination geofence.

String

For trips with a destination, the external ID of the destination geofence.

RadarCoordinate

For trips with a destination, the location of the destination geofence. Contains latitude and longitude coordinates.

RadarRouteMode

The travel mode for the trip. Used to calculate ETA and distance.Values:

RadarRouteModeFoot - Walking
RadarRouteModeBike - Biking
RadarRouteModeCar - Driving
RadarRouteModeTruck - Truck
RadarRouteModeMotorbike - Motorcycle

float

For trips with a destination, the distance to the destination geofence in meters based on the travel mode for the trip.

float

For trips with a destination, the ETA to the destination geofence in minutes based on the travel mode for the trip.

RadarTripStatus

The status of the trip.Values:

RadarTripStatusUnknown - Unknown status
RadarTripStatusStarted - Trip has been started
RadarTripStatusApproaching - Device is approaching the destination (within the approaching threshold)
RadarTripStatusArrived - Device has arrived at the destination
RadarTripStatusExpired - Trip has expired
RadarTripStatusCompleted - Trip has been completed
RadarTripStatusCanceled - Trip has been canceled

NSArray<RadarTripOrder *>

The optional array of trip orders associated with this trip. Orders provide additional context about deliveries or pickups.

NSArray<RadarTripLeg *>

For multi-destination trips, the array of trip legs. Each leg represents a stop along the trip route and contains destination info, status, and metadata.Use leg._id when calling updateTripLeg.See RadarTripLeg for more details.

String

For multi-destination trips, the ID of the current active leg. This identifies which leg the device is currently traveling to.

Initializers

initWithObject

init?(object: Any)

- (instancetype _Nullable)initWithObject:(id _Nonnull)object;

Initializes a RadarTrip instance from a server response object.

required

A dictionary object from the server containing trip data.

Returns: A RadarTrip instance, or nil if the object is invalid.

Instance Methods

dictionaryValue

func dictionaryValue() -> [AnyHashable : Any]

- (NSDictionary *_Nonnull)dictionaryValue;

Converts the trip instance to a dictionary representation. Returns: A dictionary containing all trip properties.

Status Lifecycle

A trip progresses through several statuses during its lifecycle:

Started - The trip has been created and tracking has begun
Approaching - The device is within the approaching threshold of the destination
Arrived - The device has reached the destination geofence
Completed - The trip has been manually completed
Canceled - The trip has been manually canceled
Expired - The trip has expired (typically after being in arrived state)

Usage Examples

Accessing the Current Trip

// Access trip from user object
Radar.getLocation { (status, location, user, events) in
    if let trip = user?.trip {
        print("Trip ID: \(trip._id)")
        print("Trip status: \(trip.status)")
        print("ETA: \(trip.etaDuration) minutes")
        print("Distance: \(trip.etaDistance) meters")
        
        if trip.status == .approaching {
            print("Approaching destination!")
        }
    }
}

// Access trip from user object
[Radar getLocationWithCompletionHandler:^(RadarStatus status, CLLocation *location, RadarUser *user, NSArray<RadarEvent *> *events) {
    if (user.trip) {
        NSLog(@"Trip ID: %@", user.trip._id);
        NSLog(@"Trip status: %ld", (long)user.trip.status);
        NSLog(@"ETA: %.1f minutes", user.trip.etaDuration);
        NSLog(@"Distance: %.1f meters", user.trip.etaDistance);
        
        if (user.trip.status == RadarTripStatusApproaching) {
            NSLog(@"Approaching destination!");
        }
    }
}];

Monitoring Trip Status

// Implement RadarDelegate to receive trip updates
class MyClass: RadarDelegate {
    func didUpdateLocation(_ location: CLLocation, user: RadarUser) {
        guard let trip = user.trip else { return }
        
        switch trip.status {
        case .started:
            print("Trip started - ETA: \(trip.etaDuration) min")
        case .approaching:
            print("Approaching destination - \(trip.etaDistance)m away")
        case .arrived:
            print("Arrived at destination!")
            // Complete the trip
            Radar.completeTrip()
        case .completed:
            print("Trip completed")
        case .canceled:
            print("Trip canceled")
        default:
            break
        }
    }
}

// Implement RadarDelegate to receive trip updates
@interface MyClass : NSObject <RadarDelegate>
@end

@implementation MyClass

- (void)didUpdateLocation:(CLLocation *)location user:(RadarUser *)user {
    if (!user.trip) {
        return;
    }
    
    RadarTrip *trip = user.trip;
    
    switch (trip.status) {
        case RadarTripStatusStarted:
            NSLog(@"Trip started - ETA: %.1f min", trip.etaDuration);
            break;
        case RadarTripStatusApproaching:
            NSLog(@"Approaching destination - %.1fm away", trip.etaDistance);
            break;
        case RadarTripStatusArrived:
            NSLog(@"Arrived at destination!");
            // Complete the trip
            [Radar completeTrip];
            break;
        case RadarTripStatusCompleted:
            NSLog(@"Trip completed");
            break;
        case RadarTripStatusCanceled:
            NSLog(@"Trip canceled");
            break;
        default:
            break;
    }
}

@end

Working with Multi-Destination Trips

Radar.getLocation { (status, location, user, events) in
    if let trip = user?.trip, let legs = trip.legs {
        print("Trip has \(legs.count) legs")
        
        for (index, leg) in legs.enumerated() {
            print("Leg \(index + 1): \(leg.status)")
            if leg._id == trip.currentLegId {
                print("  - Current leg")
                print("  - ETA: \(leg.etaDuration) minutes")
                print("  - Distance: \(leg.etaDistance) meters")
            }
        }
    }
}

[Radar getLocationWithCompletionHandler:^(RadarStatus status, CLLocation *location, RadarUser *user, NSArray<RadarEvent *> *events) {
    if (user.trip && user.trip.legs) {
        NSLog(@"Trip has %lu legs", (unsigned long)user.trip.legs.count);
        
        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]);
            
            if ([leg._id isEqualToString:user.trip.currentLegId]) {
                NSLog(@"  - Current leg");
                NSLog(@"  - ETA: %.1f minutes", leg.etaDuration);
                NSLog(@"  - Distance: %.1f meters", leg.etaDistance);
            }
        }
    }
}];

RadarTripOptions - Configure and start trips
RadarTripLeg - Multi-destination trip legs
Trip Tracking Guide - Complete guide to trip tracking

Core

Tracking

Events & Context

Geofences & Places

Location Data

Fraud & Verification

Extensions

Properties

Initializers

initWithObject

Instance Methods

dictionaryValue

Status Lifecycle

Usage Examples

Accessing the Current Trip

Monitoring Trip Status

Working with Multi-Destination Trips

​Properties

​Initializers

​initWithObject

​Instance Methods

​dictionaryValue

​Status Lifecycle

​Usage Examples

​Accessing the Current Trip

​Monitoring Trip Status

​Working with Multi-Destination Trips

​Related

Properties

Initializers

initWithObject

Instance Methods

dictionaryValue

Status Lifecycle

Usage Examples

Accessing the Current Trip

Monitoring Trip Status

Working with Multi-Destination Trips

Related