com.tomtom.online.sdk.traffic

Class OnlineTrafficApi

java.lang.Object

com.tomtom.online.sdk.traffic.OnlineTrafficApi

All Implemented Interfaces:

com.tomtom.online.sdk.common.rx.RxContext, FlowSegmentDataApi, IncidentDetailsApi, TrafficApi

public class OnlineTrafficApi
extends java.lang.Object
implements TrafficApi

Main entry point for Traffic API Flow Segment Data and Traffic API Incident Details services.

Field Summary

Fields inherited from interface com.tomtom.online.sdk.traffic.TrafficApi

DEFAULT_ONLINE_TRAFFIC_API_VERSION, DEFAULT_ONLINE_TRAFFIC_ENDPOINT

Method Summary

Modifier and Type	Method and Description
static TrafficApi	create(android.content.Context context) Creates new TrafficApi object which will use provided Traffic API key.
static TrafficApi	create(android.content.Context context, java.lang.String apiKey) Creates new TrafficApi object which will use provided Traffic API key.
Single<FlowSegmentDataResponse>	findFlowSegmentData(FlowSegmentDataQuery query) Performs reactive search action based on provided FlowSegmentDataQuery object and returns the result to Observers subscribed to returned Observable.
void	findFlowSegmentData(FlowSegmentDataQuery query, FlowSegmentDataResultListener listener) Performs search action based on provided FlowSegmentDataQuery object and returns the result with usage of FlowSegmentDataResultListener implementation.
Single<IncidentDetailsResponse>	findIncidentDetails(IncidentDetailsQuery query) Performs reactive search action based on provided IncidentDetailsQuery object and returns the result to Observers subscribed to returned Observable.
void	findIncidentDetails(IncidentDetailsQuery query, IncidentDetailsResultListener listener) Performs search action based on provided IncidentDetailsQuery object and returns the result with usage of IncidentDetailsResultListener implementation.
Scheduler	getResultScheduler()
Scheduler	getWorkingScheduler()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TrafficApi create(@NonNull
                                android.content.Context context)

Creates new TrafficApi object which will use provided Traffic API key. It uses default values for Traffic API service endpoint and api version.

Parameters:

context - Android's context

Returns:

Newly created TrafficApi object for further processing.

create

public static TrafficApi create(@NonNull
                                android.content.Context context,
                                java.lang.String apiKey)

Creates new TrafficApi object which will use provided Traffic API key. It uses default values for Traffic API service endpoint and api version.

Parameters:

context - Android's context

Returns:

Newly created TrafficApi object for further processing.

findFlowSegmentData

public Single<FlowSegmentDataResponse> findFlowSegmentData(FlowSegmentDataQuery query)

Description copied from interface: FlowSegmentDataApi

Performs reactive search action based on provided FlowSegmentDataQuery object and returns the result to Observers subscribed to returned Observable.

Specified by:

findFlowSegmentData in interface FlowSegmentDataApi

Parameters:

query - Object which contains data necessary to execute search action

Returns:

FlowSegmentDataResponse's Observable object.

findFlowSegmentData

public void findFlowSegmentData(FlowSegmentDataQuery query,
                                FlowSegmentDataResultListener listener)

Description copied from interface: FlowSegmentDataApi

Performs search action based on provided FlowSegmentDataQuery object and returns the result with usage of FlowSegmentDataResultListener implementation.

Specified by:

findFlowSegmentData in interface FlowSegmentDataApi

Parameters:

query - The object which contains data necessary to execute search action.

listener - The listener which informs the subscriber when search result is available. It contains FlowSegmentDataResponse object.

findIncidentDetails

public Single<IncidentDetailsResponse> findIncidentDetails(IncidentDetailsQuery query)

Description copied from interface: IncidentDetailsApi

Performs reactive search action based on provided IncidentDetailsQuery object and returns the result to Observers subscribed to returned Observable.

Specified by:

findIncidentDetails in interface IncidentDetailsApi

Parameters:

query - Object which contains data necessary to execute search action

Returns:

IncidentDetailsResponse's Observable object.

findIncidentDetails

public void findIncidentDetails(IncidentDetailsQuery query,
                                IncidentDetailsResultListener listener)

Description copied from interface: IncidentDetailsApi

Performs search action based on provided IncidentDetailsQuery object and returns the result with usage of IncidentDetailsResultListener implementation.

Specified by:

findIncidentDetails in interface IncidentDetailsApi

Parameters:

query - The object which contains data necessary to execute search action.

listener - The listener which informs the subscriber when search result is available. It contains IncidentDetailsResponse object.

getWorkingScheduler

@NonNull
public Scheduler getWorkingScheduler()

Specified by:

getWorkingScheduler in interface com.tomtom.online.sdk.common.rx.RxContext

getResultScheduler

@NonNull
public Scheduler getResultScheduler()

Specified by:

getResultScheduler in interface com.tomtom.online.sdk.common.rx.RxContext