On-demand Rides and Deliveries Solution is currently available only to select partners. Contact sales to learn more.

GMTCTripRequest Class Reference

GMTCTripRequest Class Reference

Overview

A request object for specifying parameters to get an active trip.

Inherits GMTSRequest.

Inherited by GMTCMutableTripRequest.

Public Member Functions

(instancetype) - initWithRequestHeader:tripName:autoRefreshTimeInterval:
 Initializes the object.
(instancetype) - initWithRequestHeader:
 Initialization of the object.

Properties

NSString * tripName
 Name of the target trip.
NSTimeInterval autoRefreshTimeInterval
 Refresh time interval of the trip request.
GMTSRequestHeaderrequestHeader
 Header of the request, to specify extra request conditions.

Member Function Documentation

- (instancetype) initWithRequestHeader: (nullable GMTSRequestHeader *)  requestHeader
tripName: (nullable NSString *)  tripName
autoRefreshTimeInterval: (NSTimeInterval)  autoRefreshTimeInterval 

Initializes the object.

Parameters:
requestHeaderThe header object of the request.
tripNameName of trip, if set as nil, the property `tripName` getter will return "".
autoRefreshTimeIntervalThe refresh time interval of the trip request.
- (instancetype) initWithRequestHeader: (nullable GMTSRequestHeader *)  requestHeader

Initialization of the object.

Parameters:
requestHeaderA request header object to bind with the current request.

Property Documentation

- (NSString*) tripName [read, copy]

Name of the target trip.

The value will be an empty string("") if set as nil.

Implemented in GMTCMutableTripRequest.

- (NSTimeInterval) autoRefreshTimeInterval [read, assign]

Refresh time interval of the trip request.

Implemented in GMTCMutableTripRequest.

- (GMTSRequestHeader*) requestHeader [read, copy, inherited]

Header of the request, to specify extra request conditions.

Implemented in GMTCMutableTripRequest.