GoogleRidesharingConsumer Framework Reference

  • GMTCTripModelOptions configures the GMTCTripModel for managing trip information.

  • autoRefreshTimeInterval specifies the time interval for automatically refreshing trip data from the server.

  • tripRequestHeader defines the header information that will be included in each trip data request.

  • The initWithAutoRefreshTimeInterval:tripRequestHeader: method initializes an instance, setting both the refresh interval and request header.

  • The init method provides a convenience initializer, defaulting the refresh interval to 0.0 and the trip request header to nil.

GMTCTripModelOptions

@interface GMTCTripModelOptions : GMTSRequestOptions <NSMutableCopying>

Object that for configuring the GMTCTripModel.

  • Returns the current refresh time interval between the repeated trip info polling from server.

    Declaration

    Swift

    var autoRefreshTimeInterval: TimeInterval { get }

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval autoRefreshTimeInterval;

  • Returns the request header that will be appended to each trip info polling call.

    Declaration

    Swift

    var tripRequestHeader: GMTSRequestHeader? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) GMTSRequestHeader *tripRequestHeader;

  • Initializes the instance.

    Declaration

    Swift

    init(autoRefreshTimeInterval: TimeInterval, trip tripRequestHeader: GMTSRequestHeader?)

    Objective-C

    - (nonnull instancetype)
    initWithAutoRefreshTimeInterval:(NSTimeInterval)autoRefreshTimeInterval
                  tripRequestHeader:
                      (nullable GMTSRequestHeader *)tripRequestHeader;

    Parameters

    autoRefreshTimeInterval

    A refresh time inverval between the repeated trip info polling.
    tripRequestHeader

    A trip request header that will be appended to each trip info polling call.

  • Initializes the instance. Calling this is equivalent to calling initWithAutoRefreshTimeInterval:0.0 tripRequestHeader:nil.

    Declaration

    Swift

    convenience init()

    Objective-C

    - (nonnull instancetype)init;