HereSDKDemandRideOffersRequest Class Reference


                    
                    
                    route

The route for the requested ride.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) HereSDKDemandRoute *_Nonnull route;

Swift

var route: HereSDKDemandRoute { get set }


                    
                    
                    constraints

Ride constraints such as:

Number of passengers
Number of suitcases

Declaration

Objective-C

@property (assign, readwrite, nonatomic, nullable)
    HereSDKDemandBookingConstraints *constraints;

Swift

var constraints: HereSDKDemandBookingConstraints? { get set }


                    
                    
                    prebookPickupTime

The pre-booked time of pickup, if the ride is requested for more than 30 minutes in the future. It’s important to calculate the pre-book time by using the correct pickup TimeZone to prevent mismatch timezone.

Declaration

Objective-C

@property (assign, readwrite, nonatomic, nullable) NSDate *prebookPickupTime;

Swift

var prebookPickupTime: Date? { get set }


                    
                    
                    priceRange

Acceptable price range for the rides

Declaration

Objective-C

@property (assign, readwrite, nonatomic, nullable)
    HereSDKDemandPriceRange *priceRange;

Swift

var priceRange: HereSDKDemandPriceRange? { get set }


                    
                    
                    sortType

Sort order for ride offer results. Default is HereDemandRideOffersRequestSortTypeByPrice

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    HereDemandRideOffersRequestSortType sortType;

Swift

var sortType: HereDemandRideOffersRequestSortType { get set }


                    
                    
                    passengerNote

A free text note for the passenger

Declaration

Objective-C

@property (assign, readwrite, nonatomic, nullable) NSString *passengerNote;

Swift

var passengerNote: String? { get set }


                    
                    
                    transitOptions

Parameters for transit offers.

Declaration

Objective-C

@property (assign, readwrite, nonatomic, nullable)
    HereSDKDemandTransitOptions *transitOptions;

Swift

var transitOptions: HereSDKDemandTransitOptions? { get set }


                    
                    
                    transportTypeFilterMask

Parameters for transport type preference. Default is HereSDKDemandTransportTypeAll

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    HereSDKDemandTransportType transportTypeFilterMask;

Swift

var transportTypeFilterMask: HereSDKDemandTransportType { get set }


                    
                    
                    locale

The client’s locale. Complies with the ISO 639-1 standard and defaults to [HereSDKManager userPreferences].locale.

Declaration

Objective-C

@property (assign, readwrite, nonatomic, null_resettable) NSString *locale;

Swift

var locale: String! { get set }


                    
                    
                    maxOffers

The maximum number of offers to be returned by the request. Defaults to 0, which returns all available offers.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) NSUInteger maxOffers;

Swift

var maxOffers: UInt { get set }


                    
                    
                    paymentOptions

Payment option preference. Defaults to HereSDKDemandPaymentOptionOffline, which returns offers that support offline payments.

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    HereSDKDemandPaymentOption paymentOptions;

Swift

var paymentOptions: HereSDKDemandPaymentOption { get set }


                    
                    
                    +rideOffersRequestWithRoute:

Creates a request for ride offer

Declaration

Objective-C

+ (nonnull instancetype)rideOffersRequestWithRoute:
    (nonnull HereSDKDemandRoute *)route;

Swift

convenience init(route: HereSDKDemandRoute)

Parameters


                                route

The route for the requested ride


                    
                    
                    +rideOffersWithRoute:constraints:prebookPickupTime:priceRange:sortType:passengerNote:transitOptions:transportTypeFilter:

Creates a request for ride offers

Declaration

Objective-C

+ (nonnull instancetype)
rideOffersWithRoute:(nonnull HereSDKDemandRoute *)route
        constraints:(HereSDKDemandBookingConstraints *_Nullable)constraints
  prebookPickupTime:(NSDate *_Nullable)prebookPickupTime
         priceRange:(HereSDKDemandPriceRange *_Nullable)priceRange
           sortType:(HereDemandRideOffersRequestSortType)sortType
      passengerNote:(NSString *_Nullable)passengerNote
     transitOptions:(HereSDKDemandTransitOptions *_Nullable)transitOptions
transportTypeFilter:(HereSDKDemandTransportType)transportTypeFilter;

Swift

class func rideOffers(with route: HereSDKDemandRoute, constraints: HereSDKDemandBookingConstraints?, prebookPickupTime: Date?, priceRange: HereSDKDemandPriceRange?, sortType: HereDemandRideOffersRequestSortType, passengerNote: String?, transitOptions: HereSDKDemandTransitOptions?, transportTypeFilter: HereSDKDemandTransportType) -> Self

Parameters

`route`	The route for the requested ride
`constraints`	The constraints for the requested ride
`prebookPickupTime`	The pre-booked time of pickup
`priceRange`	The price range of the requested ride
`sortType`	The sorting order of the ride offers response
`passengerNote`	Free text for passenger notes
`transitOptions`	Added constraints for public transport offers
`transportTypeFilter`	Transport type preference


                    
                    
                    +rideOffersWithRoute:constraints:prebookPickupTime:priceRange:sortType:passengerNote:transitOptions:

Creates a request for ride offers Get all transportation Types in the response

Declaration

Objective-C

+ (nonnull instancetype)
rideOffersWithRoute:(nonnull HereSDKDemandRoute *)route
        constraints:(HereSDKDemandBookingConstraints *_Nullable)constraints
  prebookPickupTime:(NSDate *_Nullable)prebookPickupTime
         priceRange:(HereSDKDemandPriceRange *_Nullable)priceRange
           sortType:(HereDemandRideOffersRequestSortType)sortType
      passengerNote:(NSString *_Nullable)passengerNote
     transitOptions:(HereSDKDemandTransitOptions *_Nullable)transitOptions;

Swift

class func rideOffers(with route: HereSDKDemandRoute, constraints: HereSDKDemandBookingConstraints?, prebookPickupTime: Date?, priceRange: HereSDKDemandPriceRange?, sortType: HereDemandRideOffersRequestSortType, passengerNote: String?, transitOptions: HereSDKDemandTransitOptions?) -> Self

Parameters

`route`	The route for the requested ride
`constraints`	The constraints for the requested ride
`prebookPickupTime`	The pre-booked time of pickup
`priceRange`	The price range of the requested ride
`sortType`	The sorting order of the ride offers response
`passengerNote`	Free text for passenger notes
`transitOptions`	Added constraints for public transport offers


                    
                    
                    +rideOffersWithRoute:constraints:prebookPickupTime:priceRange:sortType:passengerNote:transitOptions:locale:

Creates a request for ride offers Set the response locale

Declaration

Objective-C

+ (nonnull instancetype)
rideOffersWithRoute:(nonnull HereSDKDemandRoute *)route
        constraints:(HereSDKDemandBookingConstraints *_Nullable)constraints
  prebookPickupTime:(NSDate *_Nullable)prebookPickupTime
         priceRange:(HereSDKDemandPriceRange *_Nullable)priceRange
           sortType:(HereDemandRideOffersRequestSortType)sortType
      passengerNote:(NSString *_Nullable)passengerNote
     transitOptions:(HereSDKDemandTransitOptions *_Nullable)transitOptions
             locale:(NSString *_Nullable)locale;

Swift

class func rideOffers(with route: HereSDKDemandRoute, constraints: HereSDKDemandBookingConstraints?, prebookPickupTime: Date?, priceRange: HereSDKDemandPriceRange?, sortType: HereDemandRideOffersRequestSortType, passengerNote: String?, transitOptions: HereSDKDemandTransitOptions?, locale: String?) -> Self

Parameters

`route`	The route for the requested ride
`constraints`	The constraints for the requested ride
`prebookPickupTime`	The pre-booked time of pickup
`priceRange`	The price range of the requested ride
`sortType`	The sorting order of the ride offers response
`passengerNote`	Free text for passenger notes
`transitOptions`	Added constraints for public transport offers
`locale`	The client’s locale. Complies with the ISO 639-1 standard.


                    
                    
                    +rideOffersWithRoute:constraints:prebookPickupTime:priceRange:sortType:passengerNote:transitOptions:transportTypeFilter:locale:maxOffers:

Creates a request for ride offers Set the response locale

Declaration

Objective-C

+ (nonnull instancetype)
rideOffersWithRoute:(nonnull HereSDKDemandRoute *)route
        constraints:(HereSDKDemandBookingConstraints *_Nullable)constraints
  prebookPickupTime:(NSDate *_Nullable)prebookPickupTime
         priceRange:(HereSDKDemandPriceRange *_Nullable)priceRange
           sortType:(HereDemandRideOffersRequestSortType)sortType
      passengerNote:(NSString *_Nullable)passengerNote
     transitOptions:(HereSDKDemandTransitOptions *_Nullable)transitOptions
transportTypeFilter:(HereSDKDemandTransportType)transportTypeFilter
             locale:(NSString *_Nullable)locale
          maxOffers:(NSUInteger)maxOffers;

Swift

class func rideOffers(with route: HereSDKDemandRoute, constraints: HereSDKDemandBookingConstraints?, prebookPickupTime: Date?, priceRange: HereSDKDemandPriceRange?, sortType: HereDemandRideOffersRequestSortType, passengerNote: String?, transitOptions: HereSDKDemandTransitOptions?, transportTypeFilter: HereSDKDemandTransportType, locale: String?, maxOffers: UInt) -> Self

Parameters

`route`	The route for the requested ride
`constraints`	The constraints for the requested ride
`prebookPickupTime`	The pre-booked time of pickup
`priceRange`	The price range of the requested ride
`sortType`	The sorting order of the ride offers response
`passengerNote`	Free text for passenger notes
`transitOptions`	Added constraints for public transport offers
`transportTypeFilter`	Transport type preference
`locale`	The client’s locale. Complies with the ISO 639-1 standard.
`maxOffers`	The maximum number of offers to be returned by the request.