Added in API level 36

GetValueResult

Kotlin |Java

public final class GetValueResult
extends Object implements Parcelable

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

Result object given a corresponding GetValueRequest.

If the request was successful, getResultCode() will be RESULT_OK, getValue() will be populated with the settings preference value and getMetadata() will be populated with its metadata.
If the request is unsuccessful, getResultCode() be a value other than RESULT_OK - see documentation for those possibilities to understand the cause of the failure.

Summary

Nested classes
`class`	`GetValueResult.Builder` Builder to construct `GetValueResult`.

Constants
`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.
`int`	`RESULT_REQUIRE_APP_PERMISSION` Requested preference requires permissions not held by the calling application.
`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

From interface android.os.Parcelable

`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<GetValueResult>`	`CREATOR` Parcelable Creator for `GetValueResult`.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`SettingsPreferenceMetadata`	`getMetadata()` Returns the metadata of requested Preference if request successful.
`int`	`getResultCode()` Returns the result code indicating status of the request.
`SettingsPreferenceValue`	`getValue()` Returns the value of requested Preference if request successful.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`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.

From interface


        
          android.os.Parcelable

`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_DISALLOW

Added in API level 36

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: 4 (0x00000004)

RESULT_INTERNAL_ERROR

Added in API level 36

public static final int RESULT_INTERNAL_ERROR

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

Retry may succeed.

Constant Value: 6 (0x00000006)

RESULT_INVALID_REQUEST

Added in API level 36

public static final int RESULT_INVALID_REQUEST

Request object is not valid.

Retry not advised with current parameters.

Constant Value: 5 (0x00000005)

RESULT_OK

Added in API level 36

public static final int RESULT_OK

Request is successful.

Constant Value: 0 (0x00000000)

RESULT_REQUIRE_APP_PERMISSION

Added in API level 36

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: 3 (0x00000003)

RESULT_UNAVAILABLE

Added in API level 36

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: 2 (0x00000002)

RESULT_UNSUPPORTED

Added in API level 36

public static final int RESULT_UNSUPPORTED

Requested preference is not supported by this API.

Retry not advised.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 36

public static final Creator<GetValueResult> CREATOR

Parcelable Creator for GetValueResult.

Public methods

describeContents

Added in API level 36

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getMetadata

Added in API level 36

public SettingsPreferenceMetadata getMetadata ()

Returns the metadata of requested Preference if request successful.

Returns
`SettingsPreferenceMetadata`

getResultCode

Added in API level 36

public int getResultCode ()

Returns the result code indicating status of the request.

Returns
`int`	Value is one of the following: `RESULT_OK` `RESULT_UNSUPPORTED` `RESULT_UNAVAILABLE` `RESULT_REQUIRE_APP_PERMISSION` `RESULT_DISALLOW` `RESULT_INVALID_REQUEST` `RESULT_INTERNAL_ERROR`

getValue

Added in API level 36

public SettingsPreferenceValue getValue ()

Returns the value of requested Preference if request successful.

Returns
`SettingsPreferenceValue`

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

GetValueResult

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

RESULT_DISALLOW

RESULT_INTERNAL_ERROR

RESULT_INVALID_REQUEST

RESULT_OK

RESULT_REQUIRE_APP_PERMISSION

RESULT_UNAVAILABLE

RESULT_UNSUPPORTED

Fields

CREATOR

Public methods

describeContents

getMetadata

getResultCode

getValue

writeToParcel