com.mapzen.android.lost.api

Class Status

java.lang.Object

com.mapzen.android.lost.api.Status

All Implemented Interfaces:

android.os.Parcelable, Result

public class Status
extends java.lang.Object
implements Result, android.os.Parcelable

Represents the result of a LocationServices API call.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCELLED
static android.os.Parcelable.Creator<Status>	CREATOR
static int	INTERNAL_ERROR
static int	INTERRUPTED
static int	RESOLUTION_REQUIRED
static int	SETTINGS_CHANGE_UNAVAILABLE
static int	SUCCESS
static int	TIMEOUT

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Status(int statusCode)
	Status(int statusCode, DialogDisplayer dialogDisplayer)
	Status(int statusCode, DialogDisplayer dialogDisplayer, android.app.PendingIntent pendingIntent)
protected	Status(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
android.app.PendingIntent	getResolution() Get the PendingIntent if there is one.
Status	getStatus()
int	getStatusCode() Get the status code.
java.lang.String	getStatusMessage() Get the detailed status message for this Status.
boolean	hasResolution() Is there a resolution for this Status.
boolean	isCanceled() Is the status code for this object CANCELLED.
boolean	isInterrupted() Is the status code for this object INTERRUPTED.
boolean	isSuccess() Is the status code for this object SUCCESS.
void	startResolutionForResult(android.app.Activity activity, int requestCode) If the status code is RESOLUTION_REQUIRED, then this method can be called to start the resolution.
void	writeToParcel(android.os.Parcel parcel, int i)

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

RESOLUTION_REQUIRED

public static final int RESOLUTION_REQUIRED

See Also:

Constant Field Values

INTERRUPTED

public static final int INTERRUPTED

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

See Also:

Constant Field Values

CANCELLED

public static final int CANCELLED

See Also:

Constant Field Values

SETTINGS_CHANGE_UNAVAILABLE

public static final int SETTINGS_CHANGE_UNAVAILABLE

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<Status> CREATOR

Constructor Detail

Status

public Status(int statusCode)

Status

public Status(int statusCode,
              DialogDisplayer dialogDisplayer)

Status

public Status(int statusCode,
              DialogDisplayer dialogDisplayer,
              android.app.PendingIntent pendingIntent)

Status

protected Status(android.os.Parcel in)

Method Detail

startResolutionForResult

public void startResolutionForResult(android.app.Activity activity,
                                     int requestCode)
                              throws android.content.IntentSender.SendIntentException

If the status code is RESOLUTION_REQUIRED, then this method can be called to start the resolution. For example, it will launch the Settings Activity so that the user can update location settings when used with SettingsApi.checkLocationSettings( LostApiClient, LocationSettingsRequest). This activity will finish with Activity.onActivityResult(int, int, android.content.Intent) but the resultCode will never be Activity#RESULT_OK. You should instead rely on the requestCode to determine application flow and assume that the result is Activity#RESULT_OK.

Parameters:

activity - to launch for resolution.

requestCode - associated with activity.

Throws:

IntentSender.SendIntentException

getStatusMessage

public java.lang.String getStatusMessage()

Get the detailed status message for this Status.

Returns:

status message.

hasResolution

public boolean hasResolution()

Is there a resolution for this Status.

Returns:

whether or not there is a resolution.

isSuccess

public boolean isSuccess()

Is the status code for this object SUCCESS.

Returns:

whether or not the status code is SUCCESS.

isCanceled

public boolean isCanceled()

Is the status code for this object CANCELLED.

Returns:

whether or not the status code is CANCELLED.

isInterrupted

public boolean isInterrupted()

Is the status code for this object INTERRUPTED.

Returns:

whether or not the status code is INTERRUPTED.

getStatusCode

public int getStatusCode()

Get the status code.

Returns:

the status code.

getResolution

public android.app.PendingIntent getResolution()

Get the PendingIntent if there is one. This method can return null.

Returns:

the PendingIntent.

getStatus

public Status getStatus()

Specified by:

getStatus in interface Result

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel parcel,
                          int i)

Specified by:

writeToParcel in interface android.os.Parcelable