GoogleRidesharingConsumer Framework Reference

  • GMTCTripRequest is a request object used to specify parameters for retrieving an active trip.

  • The tripName property specifies the target trip's name, and it defaults to an empty string if set to nil.

  • The autoRefreshTimeInterval property defines the refresh time interval for the trip request.

  • The -initWithRequestHeader:tripName:autoRefreshTimeInterval: method initializes a GMTCTripRequest object with a request header, trip name, and refresh time interval.

  • The -init method is unavailable, and the -initWithRequestHeader:providerId:tripId:autoRefreshTimeInterval: method should be used instead.

GMTCTripRequest

@interface GMTCTripRequest : GMTSRequest <NSCopying, NSMutableCopying>

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

  • Name of the target trip. The value will be an empty string(@“”) if set as nil.

    Declaration

    Swift

    var tripName: String! { get }

    Objective-C

    @property (nonatomic, copy, readonly, null_resettable) NSString *tripName;

  • Refresh time interval of the trip request.

    Declaration

    Swift

    var autoRefreshTimeInterval: TimeInterval { get }

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval autoRefreshTimeInterval;

  • Initializes the object.

    Declaration

    Swift

    init(requestHeader: GMTSRequestHeader?, tripName: String?, autoRefreshTimeInterval: TimeInterval)

    Objective-C

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

    Parameters

    requestHeader

    The header object of the request.
    tripName

    Name of trip, if set as nil, the property tripName getter will return @“”.
    autoRefreshTimeInterval

    The refresh time interval of the trip request.

  • Unavailable

    Use -initWithRequestHeader:providerId:tripId:autoRefreshTimeInterval: instead.

    Declaration

    Objective-C

    - (nonnull instancetype)init;