com.amazonaws.mobileconnectors.geo.tracker

Class TrackingError

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.amazonaws.mobileconnectors.geo.tracker.TrackingError

All Implemented Interfaces:

java.io.Serializable

public final class TrackingError
extends java.lang.Exception

Describes an error which occurred during use of AWSLocationTracker.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrackingError.Type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRecoverySuggestion() Returns a helpful, practical suggestion for how to address the error.
TrackingError.Type	getType() Returns an enumerated value of the type of error which occurred.
static TrackingError	invalidTrackerName() Create an instance of TrackingError in the case of an invalid tracker name.
static TrackingError	missingLocationPermissions() Create an instance of TrackingError in the case where the user hasn't previously obtained location permissions.
static TrackingError	serviceError(java.lang.Throwable error) Create an instance of TrackingError for the case an error came back from a service call.
static TrackingError	trackerAlreadyStarted() Create an instance of TrackingError in the case of the tracking already being started.
static TrackingError	unauthorized() Create an instance of TrackingError in the case of the user being unauthorized.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getType

public TrackingError.Type getType()

Returns an enumerated value of the type of error which occurred.

Returns:

an enumerated value of the type of error which occurred.

getRecoverySuggestion

public java.lang.String getRecoverySuggestion()

Returns a helpful, practical suggestion for how to address the error.

Returns:

a helpful, practical suggestion for how to address the error.

invalidTrackerName

public static TrackingError invalidTrackerName()

Create an instance of TrackingError in the case of an invalid tracker name.

Returns:

an instance of TrackingError in the case of an invalid tracker name.

trackerAlreadyStarted

public static TrackingError trackerAlreadyStarted()

Create an instance of TrackingError in the case of the tracking already being started.

Returns:

an instance of TrackingError in the case of the tracking already being started.

missingLocationPermissions

public static TrackingError missingLocationPermissions()

Create an instance of TrackingError in the case where the user hasn't previously obtained location permissions.

Returns:

an instance of TrackingError in the case where the user hasn't previously obtained location permissions.

unauthorized

public static TrackingError unauthorized()

Create an instance of TrackingError in the case of the user being unauthorized.

Returns:

an instance of TrackingError in the case of the user being unauthorized.

serviceError

public static TrackingError serviceError(java.lang.Throwable error)

Create an instance of TrackingError for the case an error came back from a service call.

Parameters:

error - The error returned from the service call.

Returns:

an instance of TrackingError for the case an error came back from a service call.