SetValueResult


public final class SetValueResult
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.settings.preferences.SetValueResult


Result object given a corresponding SetValueRequest.

Summary

Nested classes

class SetValueResult.Builder

Builder to construct SetValueResult

Constants

int RESULT_DISABLED

Requested preference is disabled, thus unable to be set in this state.

int RESULT_DISALLOW

Requested preference is not allowed for access in this API under the current device policy.

int RESULT_INTERNAL_ERROR

API call failed due to an issue with the service binding.

int RESULT_INVALID_REQUEST

Request object is not valid.

int RESULT_OK

Request is successful and the value was set.

int RESULT_REQUIRE_APP_PERMISSION

Requested preference requires permissions not held by the calling application.

int RESULT_REQUIRE_USER_CONSENT

User consent was not approved for this operation.

int RESULT_RESTRICTED

Requested preference is restricted, thus unable to be set under this policy.

int RESULT_UNAVAILABLE

Preference is currently not available, likely due to device state or the state of a dependency.

int RESULT_UNSUPPORTED

Requested preference is not supported by this API.

Inherited constants

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields

public static final Creator<SetValueResult> CREATOR

Parcelable Creator for SetValueResult.

Public methods

int getResultCode()

Returns the result code indicating status of the request.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Constants

RESULT_DISABLED

public static final int RESULT_DISABLED

Requested preference is disabled, thus unable to be set in this state.

Retry may succeed if underlying conditions change.

Constant Value: 2 (0x00000002)

RESULT_DISALLOW

public static final int RESULT_DISALLOW

Requested preference is not allowed for access in this API under the current device policy.

Retry may succeed if underlying conditions change.

Constant Value: 7 (0x00000007)

RESULT_INTERNAL_ERROR

public static final int RESULT_INTERNAL_ERROR

API call failed due to an issue with the service binding.

Retry may succeed.

Constant Value: 9 (0x00000009)

RESULT_INVALID_REQUEST

public static final int RESULT_INVALID_REQUEST

Request object is not valid.

Retry not advised with current parameters.

Constant Value: 8 (0x00000008)

RESULT_OK

public static final int RESULT_OK

Request is successful and the value was set.

Constant Value: 0 (0x00000000)

RESULT_REQUIRE_APP_PERMISSION

public static final int RESULT_REQUIRE_APP_PERMISSION

Requested preference requires permissions not held by the calling application.

Retry may succeed if necessary permissions are obtained.

Constant Value: 5 (0x00000005)

public static final int RESULT_REQUIRE_USER_CONSENT

User consent was not approved for this operation.

Retry may succeed if user provides consent.

Constant Value: 6 (0x00000006)

RESULT_RESTRICTED

public static final int RESULT_RESTRICTED

Requested preference is restricted, thus unable to be set under this policy.

Retry may succeed if underlying conditions change.

Constant Value: 3 (0x00000003)

RESULT_UNAVAILABLE

public static final int RESULT_UNAVAILABLE

Preference is currently not available, likely due to device state or the state of a dependency.

Retry may succeed if underlying conditions change.

Constant Value: 4 (0x00000004)

RESULT_UNSUPPORTED

public static final int RESULT_UNSUPPORTED

Requested preference is not supported by this API.

Retry not advised.

Constant Value: 1 (0x00000001)

Fields

CREATOR

public static final Creator<SetValueResult> CREATOR

Parcelable Creator for SetValueResult.

Public methods

getResultCode

public int getResultCode ()

Returns the result code indicating status of the request.