com.here.mobility.sdk.demand

Class DemandClient

java.lang.Object

com.here.mobility.sdk.demand.DemandClient

All Implemented Interfaces:

INetworkClient

public class DemandClient
extends Object
implements INetworkClient

The client class for accessing the Demand API, used for requesting, booking and managing rides.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DemandClient.RideUpdateListener The listener interface to be implemented by the caller, to get notifications about Ride updates.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DemandClient(com.here.mobility.sdk.demand.C2SDemandClient c2sDemandClient, com.here.mobility.sdk.demand.RideStatusPoller statusPoller, com.here.mobility.sdk.demand.VerifiedDemandClient verifiedDemandClient) Generate new demand Client.

Method Summary

Modifier and Type	Method and Description
void	cancelAllActiveRequests() Cancels all active requests this client has running.
ResponseFuture<CancellationInfo>	cancelRide(CancelRideRequest cancelRideRequest) Cancels the given ride.
ResponseFuture<CancellationInfo>	cancelRide(String rideId, String reason) Deprecated. This field is deprecated, please use DemandClient.cancelRide(CancelRideRequest) instead. This request can throw the following exceptions: HMAuthException
ResponseFuture<Ride>	createRide(CreateRideRequest request) Create a new ride.
ResponseFuture<Ride>	getRide(String rideId) Get a ride's details.
ResponseFuture<List<RideOffer>>	getRideOffers(RideOffersRequest request) Get ride offers from multiple suppliers.
ResponseFuture<RidePayment>	getRidePayment(String rideId) Get payment details of the given ride.
ResponseFuture<RideQueryResponse>	getRides(RideQuery query) Query for rides of the current user.
ResponseFuture<VerticalsCoverageResponse>	getVerticalsCoverage(VerticalsCoverageRequest verticalsCoverageRequest) Get the verticals (transit types) coverage available around a specific location.
static DemandClient	newInstance() Returns a new DemandClient.
static DemandClient	newInstance(Context context) Deprecated. Use DemandClient.newInstance() instead.
ResponseFuture<Void>	registerToRideUpdates(DemandClient.RideUpdateListener listener) Register for ride updates.
ResponseFuture<Void>	registerToRideUpdates(DemandClient.RideUpdateListener listener, Handler handler) Register for ride updates.
ResponseFuture<Void>	registerToRideUpdates(String rideId, DemandClient.RideUpdateListener listener) Register for updates of the ride with the given ID.
ResponseFuture<Void>	registerToRideUpdates(String rideId, DemandClient.RideUpdateListener listener, Handler handler) Register for updates of the ride with the given ID.
void	shutdown() Shuts down this INetworkClient.
void	shutdownNow() Shuts down this INetworkClient immediately, forcefully closing even preexisting calls.
void	unregisterFromRideUpdates(DemandClient.RideUpdateListener listener) Unregister from ride updates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DemandClient

protected DemandClient(com.here.mobility.sdk.demand.C2SDemandClient c2sDemandClient,
                       com.here.mobility.sdk.demand.RideStatusPoller statusPoller,
                       com.here.mobility.sdk.demand.VerifiedDemandClient verifiedDemandClient)

Generate new demand Client.

Method Detail

newInstance

public static DemandClient newInstance()

Returns a new DemandClient.

newInstance

@Deprecated
public static DemandClient newInstance(Context context)

Deprecated. Use DemandClient.newInstance() instead.

Returns a new DemandClient.

getRideOffers

public ResponseFuture<List<RideOffer>> getRideOffers(RideOffersRequest request)

Get ride offers from multiple suppliers. This request can throw the following exceptions: HMDemandInternalException HMDemandPickupTimeTooFarAheadException HMDemandPickupTimeInThePastException HMDemandMaximumWalkingDistanceNotSupportedException HMDemandInvalidNumberOfChangesException HMAuthException except HMAuthPhoneNotVerifiedException

createRide

public ResponseFuture<Ride> createRide(CreateRideRequest request)

Create a new ride. This request can throw the following exceptions: HMDemandInternalException HMDemandOfferExpiredException HMDemandMissingPaymentIdForOnlineOfferException HMDemandPaymentIdProvidedForOfflineOfferException

getRides

public ResponseFuture<RideQueryResponse> getRides(RideQuery query)

Query for rides of the current user. This request can throw the following exceptions: HMDemandInternalException HMAuthException

getRide

public ResponseFuture<Ride> getRide(String rideId)

Get a ride's details.

Parameters:

rideId - ID of the requested ride

Returns:

Ride object This request can throw the following exceptions: HMDemandInternalException HMDemandRideNotFoundException HMAuthException

getVerticalsCoverage

public ResponseFuture<VerticalsCoverageResponse> getVerticalsCoverage(VerticalsCoverageRequest verticalsCoverageRequest)

Get the verticals (transit types) coverage available around a specific location.

Parameters:

verticalsCoverageRequest - the verticals coverage request

Returns:

VerticalsCoverageResponse the response, contains a list of all available RideOffer.TransitType around the given location This request can throw the following exceptions: HMDemandInternalException HMAuthException except HMAuthPhoneNotVerifiedException

cancelRide

@Deprecated
public ResponseFuture<CancellationInfo> cancelRide(String rideId,
                                                               String reason)

Deprecated. This field is deprecated, please use DemandClient.cancelRide(CancelRideRequest) instead. This request can throw the following exceptions: HMAuthException

Cancels the given ride.

Parameters:

rideId - the ride to cancel

reason - Why the ride is cancelled

Returns:

information about the cancellation request (e.g. whether the request was accepted or rejected)

cancelRide

public ResponseFuture<CancellationInfo> cancelRide(CancelRideRequest cancelRideRequest)

Cancels the given ride.

Parameters:

cancelRideRequest - the ride request to cancel.

Returns:

information about the cancellation request (e.g. whether the request was accepted or rejected) This request can throw the following exceptions: HMDemandRideNotFoundException HMAuthException

getRidePayment

public ResponseFuture<RidePayment> getRidePayment(String rideId)

Get payment details of the given ride.

Parameters:

rideId - the ride to get payment details for This request can throw the following exceptions: HMDemandInternalException HMAuthException

registerToRideUpdates

public ResponseFuture<Void> registerToRideUpdates(DemandClient.RideUpdateListener listener)

Register for ride updates. The listener is called on the looper of the thread calling this method.

Parameters:

listener - DemandClient.RideUpdateListener to be called on updates

Returns:

This request has no return value. This request can throw the following exceptions: HMAuthException

registerToRideUpdates

public ResponseFuture<Void> registerToRideUpdates(DemandClient.RideUpdateListener listener,
                                                  Handler handler)

Register for ride updates.

Parameters:

listener - DemandClient.RideUpdateListener to be called on updates

handler - The handler on which to call the listener.

Returns:

This request has no return value. This request can throw the following exceptions: HMAuthException

registerToRideUpdates

public ResponseFuture<Void> registerToRideUpdates(String rideId,
                                                  DemandClient.RideUpdateListener listener)

Register for updates of the ride with the given ID. The listener is called on the looper of the thread calling this method.

Parameters:

rideId - ID of the ride in whose updates you're interested

listener - DemandClient.RideUpdateListener to be called on updates

Returns:

This request has no return value. This request can throw the following exceptions: HMAuthException

registerToRideUpdates

public ResponseFuture<Void> registerToRideUpdates(String rideId,
                                                  DemandClient.RideUpdateListener listener,
                                                  Handler handler)

Register for updates of the ride with the given ID. The listener will be called on the looper of the thread calling this method.

Parameters:

rideId - The ID of the ride in whose updates you're interested

listener - DemandClient.RideUpdateListener to be called on updates

handler - the handler on which to call the listener

Returns:

This request has no return value. This request can throw the following exceptions: HMAuthException

unregisterFromRideUpdates

public void unregisterFromRideUpdates(DemandClient.RideUpdateListener listener)

Unregister from ride updates.

Parameters:

listener - DemandClient.RideUpdateListener to unregister.

cancelAllActiveRequests

public void cancelAllActiveRequests()

Description copied from interface: INetworkClient

Cancels all active requests this client has running. Note that this doesn't necessarily stop any underlying sending of data through the network. The only guarantee is that no response listeners will be called. Implementation note: unfortunately, GRPC stream requests provide no way to cancel them, so these are not currently cancelled.

Specified by:

cancelAllActiveRequests in interface INetworkClient

shutdown

public void shutdown()

Description copied from interface: INetworkClient

Shuts down this INetworkClient. All active requests are cancelled, and the underlying channel is shutdown cleanly (requests in progress will finish, but no new ones will be accepted). Note that any streaming requests may continue indefinitely.

Specified by:

shutdown in interface INetworkClient

shutdownNow

public void shutdownNow()

Description copied from interface: INetworkClient

Shuts down this INetworkClient immediately, forcefully closing even preexisting calls. This is the preferred method to call when using INetworkClient from an Android activity or service that is finishing, because it should guarantee that no further callbacks will be invoked.

Specified by:

shutdownNow in interface INetworkClient