com.hypertrack.sdk.views

Class HyperTrackViews

java.lang.Object

com.hypertrack.sdk.views.HyperTrackViews

public class HyperTrackViews
extends Object

Class provides interface for accessing HyperTrack real-time tracking data on Android. You can request one-time status snapshots and/or subscribe for updates.

Method Summary

Modifier and Type	Method and Description
void	getDeviceMovementStatus(String deviceId, <any> callback) Retrieve latest snapshot of device state, that is tracked by HyperTrack SDK.
static HyperTrackViews	getInstance(android.content.Context context, String publishableKey) Main entry point to views SDK.
void	getTrip(String tripId, QueryResultHandler<Trip> handler) Get full trip object by its id
void	stopAllUpdates() Stops all the updates, that were scheduled for this SDK instance.
void	subscribeToDeviceUpdates(String deviceId, DeviceUpdatesHandler deviceUpdatesHandler) Use this to subscribe to real-time status updates for given device status.
void	subscribeToDeviceUpdates(String deviceId, String tripId, DeviceUpdatesHandler deviceUpdatesHandler) Use this to subscribe to real-time status updates for given device status.
void	unsubscribeFromDeviceUpdates(DeviceUpdatesHandler deviceUpdatesHandler) Stop receiving updates for the specified deviceUpdatesHandler.
void	unsubscribeFromDeviceUpdates(String deviceId) Stop receiving updates for the specified device.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HyperTrackViews getInstance(android.content.Context context,
                                          String publishableKey)
                                   throws IllegalArgumentException,
                                          NullPointerException

Main entry point to views SDK.

Parameters:

context - reference to application context

publishableKey - api key from HyperTrack. You can get it at dashboard.

Returns:

instance of Views SDK that could be used to retrieve data on client side.

Throws:

IllegalArgumentException - if empty publishableKey passed as an argument.

NullPointerException - if context or publishableKey is null.

subscribeToDeviceUpdates

public void subscribeToDeviceUpdates(String deviceId,
                                     DeviceUpdatesHandler deviceUpdatesHandler)
                              throws IllegalArgumentException,
                                     NullPointerException

Use this to subscribe to real-time status updates for given device status. You can invoke it multiple times to receive updates for more than one device.

Parameters:

deviceId - identifier of device that you're subscribing for.

deviceUpdatesHandler - listener (callback) that will receive status updates.

Throws:

IllegalArgumentException - if deviceId is an empty string.

NullPointerException - if deviceId or deviceUpdatesHandler is null.

See Also:

unsubscribeFromDeviceUpdates(String), stopAllUpdates()

subscribeToDeviceUpdates

public void subscribeToDeviceUpdates(String deviceId,
                                     String tripId,
                                     DeviceUpdatesHandler deviceUpdatesHandler)
                              throws IllegalArgumentException,
                                     NullPointerException

Use this to subscribe to real-time status updates for given device status. You can invoke it multiple times to receive updates for more than one device.

Parameters:

deviceId - identifier of device that you're subscribing for.

tripId - identifier of trip, that would be used to provide updates (updates from other trips won't be passed to callback).

deviceUpdatesHandler - listener (callback) that will receive status updates.

Throws:

IllegalArgumentException - if deviceId or tripId is empty.

NullPointerException - if any of its arguments is null.

See Also:

unsubscribeFromDeviceUpdates(String), stopAllUpdates()

stopAllUpdates

public void stopAllUpdates()

Stops all the updates, that were scheduled for this SDK instance. Make sure you call it to free up network resource handles.

See Also:

unsubscribeFromDeviceUpdates(DeviceUpdatesHandler), subscribeToDeviceUpdates(String, DeviceUpdatesHandler)

unsubscribeFromDeviceUpdates

public void unsubscribeFromDeviceUpdates(String deviceId)
                                  throws IllegalArgumentException,
                                         NullPointerException

Stop receiving updates for the specified device. Use this to free up resources.

Parameters:

deviceId - identifier of device that you're subscribing for.

Throws:

IllegalArgumentException - if device id is an empty string.

NullPointerException - if deviceId is null.

See Also:

stopAllUpdates(), subscribeToDeviceUpdates(String, DeviceUpdatesHandler)

unsubscribeFromDeviceUpdates

public void unsubscribeFromDeviceUpdates(DeviceUpdatesHandler deviceUpdatesHandler)
                                  throws NullPointerException

Stop receiving updates for the specified deviceUpdatesHandler. Use this to free up resources.

Parameters:

deviceUpdatesHandler - instance of DeviceUpdatesHandler with which you have subscribed.

Throws:

NullPointerException - if deviceUpdatesHandler is null

See Also:

stopAllUpdates(), subscribeToDeviceUpdates(String, DeviceUpdatesHandler)

getDeviceMovementStatus

public void getDeviceMovementStatus(String deviceId,
                                    <any> callback)
                             throws IllegalArgumentException,
                                    NullPointerException

Retrieve latest snapshot of device state, that is tracked by HyperTrack SDK.

Parameters:

deviceId - identifier of device

callback - MovementStatus consumer that will receive latest state snapshot or null, if error happens.

Throws:

IllegalArgumentException - if deviceId is an empty string.

NullPointerException - if any of its arguments is null.

getTrip

public void getTrip(String tripId,
                    QueryResultHandler<Trip> handler)
             throws IllegalArgumentException,
                    NullPointerException

Get full trip object by its id

Parameters:

tripId - lowercased uuid of requested trip

handler - callback object to deliver query result

Throws:

IllegalArgumentException - if tripId is empty string

NullPointerException - if tripId or handler is null