GoogleRidesharingConsumer Framework Reference

Classes

The following classes are available globally.

  • An immutable object representing the context needed to fetch an auth token.

    Declaration

    Swift

    class GMTCAuthorizationContext : GMTCImmutableData

    Objective-C

    @interface GMTCAuthorizationContext : GMTCImmutableData

  • Container class for the custom UI options for elements of the GMTCMapView.

    Declaration

    Swift

    class GMTCConsumerMapStyleCoordinator : NSObject

    Objective-C

    @interface GMTCConsumerMapStyleCoordinator : NSObject

  • A base class of immutable data, subclass must implement the isEqual: and hash of the NSObject protocol.

    Declaration

    Swift

    class GMTCImmutableData : NSObject, NSCopying, NSSecureCoding

    Objective-C

    @interface GMTCImmutableData : NSObject <NSCopying, NSSecureCoding>

  • Declaration

    Swift

    class GMTCJourneySharingSession : NSObject, GMTCMapViewSession

    Objective-C

    @interface GMTCJourneySharingSession : NSObject <GMTCMapViewSession>

/** Delegate of the current journey sharing session. */
@property(nonatomic, nullable, weak) id<GMTCMapViewSessionDelegate> delegate;

/**
 * Returns the current session state. The possible state can be referenced from
 * `GMTCMapViewSessionState`.
 */
@property(nonatomic, readonly) GMTCMapViewSessionState state;

/** Returns the host map view of the current session. */
@property(nonatomic, nullable, weak, readonly) GMTCMapView *hostMapView;

/** Returns the associated trip session. */
@property(nonatomic, readonly) GMTCTripModel *tripModel;

/**
 * Initializes the session object.
 *
 * @param tripModel The target trip request.
 */
- (instancetype)initWithTripModel:(GMTCTripModel *)tripModel;

- (instancetype)init NS_UNAVAILABLE;

@end

GMTCMapView

  • This class represents the main view in the Consumer SDK for iOS. You can use this class to create a customizable map so that your users can use the consumerMapStylecoordinator to create custom markers and polylines.

    Note: You should instantiate this map via the default constructor [[GMTCMapView alloc] initWithFrame:].

    GMTCMapView can be read and modified only from the main thread, similar to GMSMapView and all UIKit objects. Calling these methods from another thread results in an exception or undefined behavior.

    Declaration

    Swift

    class GMTCMapView : GMSMapView

    Objective-C

    @interface GMTCMapView : GMSMapView

  • Data object that holds custom marker properties from the client application.

    Declaration

    Swift

    class GMTCMarkerStyleOptions : GMTCImmutableData, NSCopying, NSMutableCopying

    Objective-C

    @interface GMTCMarkerStyleOptions
    : GMTCImmutableData <NSCopying, NSMutableCopying>

  • Mutable data object that holds marker’s customization properties. Note: When applying the style options for a marker with the GMTCCustomizableMarkerTypeTripVehicle type, you must explicitly set the isFlat property to YES. Otherwise, when the map is rotated in 3D mode, the vehicle heading won’t be aligned with the rotated direction.

    Declaration

    Swift

    class GMTCMutableMarkerStyleOptions : GMTCMarkerStyleOptions

    Objective-C

    @interface GMTCMutableMarkerStyleOptions : GMTCMarkerStyleOptions

  • Data object that holds polyline customization properties.

    Declaration

    Swift

    class GMTCPolylineStyleOptions : GMTCImmutableData, NSCopying, NSMutableCopying

    Objective-C

    @interface GMTCPolylineStyleOptions
    : GMTCImmutableData <NSCopying, NSMutableCopying>

  • Mutable data object that holds polyline customization properties.

    Declaration

    Swift

    class GMTCMutablePolylineStyleOptions : GMTCPolylineStyleOptions

    Objective-C

    @interface GMTCMutablePolylineStyleOptions : GMTCPolylineStyleOptions

  • Service class for the Google Consumer Ridesharing SDK for iOS.

    Declaration

    Swift

    class GMTCServices : NSObject

    Objective-C

    @interface GMTCServices : NSObject

  • A class representing a trip session. A trip session will provide trip info update periodically after started, it can be either a ridesharing or a delivery trip, and each trip session is identified by a TripName.

    Declaration

    Swift

    class GMTCTripModel : NSObject

    Objective-C

    @interface GMTCTripModel : NSObject

  • Object that for configuring the GMTCTripModel.

    Declaration

    Swift

    class GMTCTripModelOptions : GMTSRequestOptions, NSMutableCopying

    Objective-C

    @interface GMTCTripModelOptions : GMTSRequestOptions <NSMutableCopying>

  • Mutable version of GMTCTripModelOptions.

    Declaration

    Swift

    class GMTCMutableTripModelOptions : GMTCTripModelOptions

    Objective-C

    @interface GMTCMutableTripModelOptions : GMTCTripModelOptions

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

    Declaration

    Swift

    class GMTCTripRequest : GMTSRequest, NSCopying, NSMutableCopying

    Objective-C

    @interface GMTCTripRequest : GMTSRequest <NSCopying, NSMutableCopying>

  • Mutable version of GMTCTripRequest.

    Declaration

    Swift

    class GMTCMutableTripRequest : GMTCTripRequest

    Objective-C

    @interface GMTCMutableTripRequest : GMTCTripRequest

  • Provides methods for accessing trip session(s).

    Declaration

    Swift

    class GMTCTripService : NSObject

    Objective-C

    @interface GMTCTripService : NSObject

  • Object representing the latitude and longitude.

    Declaration

    Swift

    class GMTSLatLng : GMTCImmutableData

    Objective-C

    @interface GMTSLatLng : GMTCImmutableData

  • Request object that is an abstract class.

    Declaration

    Swift

    class GMTSRequest : NSObject, NSCopying, NSMutableCopying

    Objective-C

    @interface GMTSRequest : NSObject <NSCopying, NSMutableCopying>

  • A request header object contains common fields for a request.

    Declaration

    Swift

    class GMTSRequestHeader : GMTCImmutableData

    Objective-C

    @interface GMTSRequestHeader : GMTCImmutableData

  • An object for defining the request options. This is an abstract class. This object can be a part of a GMTSRequest, to specify extra prarameters of a request.

    Declaration

    Swift

    class GMTSRequestOptions : NSObject, NSCopying, NSMutableCopying

    Objective-C

    @interface GMTSRequestOptions : NSObject <NSCopying, NSMutableCopying>

  • A data object that holds the traffic conditions for a contiguous segment of a polyline.

    Declaration

    Swift

    class GMTSSpeedReadingSpan : GMTCImmutableData

    Objective-C

    @interface GMTSSpeedReadingSpan : GMTCImmutableData

  • Object representing information that identifies a terminal location.

    Declaration

    Swift

    class GMTSTerminalLocation : GMTCImmutableData

    Objective-C

    @interface GMTSTerminalLocation : GMTCImmutableData

  • Object representing a timestamp.

    Declaration

    Swift

    class GMTSTimestamp : GMTCImmutableData

    Objective-C

    @interface GMTSTimestamp : GMTCImmutableData

  • An object that holds the traffic data for a stretch of road.

    Declaration

    Swift

    class GMTSTrafficData : GMTCImmutableData

    Objective-C

    @interface GMTSTrafficData : GMTCImmutableData

  • Object that contains logistical information about a trip such as vehicleId, type of trip, pickup or dropoff times, and route.

    Declaration

    Swift

    class GMTSTrip : GMTCImmutableData

    Objective-C

    @interface GMTSTrip : GMTCImmutableData

  • Object that describes a vehicle stop on its route. For a trip with multiple passengers, this point might be an intermediate stop or the end of a trip.

    Declaration

    Swift

    class GMTSTripWaypoint : GMTCImmutableData

    Objective-C

    @interface GMTSTripWaypoint : GMTCImmutableData

GMTSVehicleAttributeKeyValuePair

GMTSVehicle

  • Object that contains functional data related to a vehicle. This data can be profile data, such as the max capacity, or tracking data, such as current trips and location.

    Declaration

    Swift

    class GMTSVehicle : GMTCImmutableData

    Objective-C

    @interface GMTSVehicle : GMTCImmutableData

  • Object that contains the location information for the vehicle that describes the heading, speed, and time when this information was retrieved.

    Declaration

    Swift

    class GMTSVehicleLocation : GMTCImmutableData

    Objective-C

    @interface GMTSVehicleLocation : GMTCImmutableData

  • This class defines initialization-time options for GMTSVehicleLocation.

    Declaration

    Swift

    class GMTSVehicleLocationOptions : NSObject

    Objective-C

    @interface GMTSVehicleLocationOptions : NSObject

  • Object that contains the vehicle’s information, ETA, and distance calculations for a vehicle that matches the SearchVehiclesRequest.

    Declaration

    Swift

    class GMTSVehicleMatch : GMTCImmutableData

    Objective-C

    @interface GMTSVehicleMatch : GMTCImmutableData

  • Data object containing information about the type of the vehicle.

    Declaration

    Swift

    class GMTSVehicleType : GMTCImmutableData

    Objective-C

    @interface GMTSVehicleType : GMTCImmutableData

  • Object representing an intermediate point along a route.

    Declaration

    Swift

    class GMTSWaypoint : GMTCImmutableData

    Objective-C

    @interface GMTSWaypoint : GMTCImmutableData