Added in API level Baklava

SetValueResult

---

Kotlin |Java

class SetValueResult : Parcelable

kotlin.Any
↳	android.service.settings.preferences.SetValueResult

Result object given a corresponding SetValueRequest.

• If the request was successful, getResultCode will be RESULT_OK.
• 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
	Builder Builder to construct SetValueResult.

Constants
static Int	RESULT_DISABLED Requested preference is disabled, thus unable to be set in this state.
static Int	RESULT_DISALLOW Requested preference is not allowed for access in this API under the current device policy.
static Int	RESULT_INTERNAL_ERROR API call failed due to an issue with the service binding.
static Int	RESULT_INVALID_REQUEST Request object is not valid.
static Int	RESULT_OK Request is successful and the value was set.
static Int	RESULT_REQUIRE_APP_PERMISSION Requested preference requires permissions not held by the calling application.
static Int	RESULT_REQUIRE_USER_CONSENT User consent was not approved for this operation.
static Int	RESULT_RESTRICTED Requested preference is restricted, thus unable to be set under this policy.
static Int	RESULT_UNAVAILABLE Preference is currently not available, likely due to device state or the state of a dependency.
static Int	RESULT_UNSUPPORTED Requested preference is not supported by this API.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	getResultCode() Returns the result code indicating status of the request.

Properties
static Parcelable.Creator<SetValueResult!>	CREATOR Parcelable Creator for SetValueResult.

Constants

RESULT_DISABLED

Added in API level Baklava

static val RESULT_DISABLED: Int

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

Retry may succeed if underlying conditions change.

Value: 2

RESULT_DISALLOW

Added in API level Baklava

static val RESULT_DISALLOW: Int

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

Retry may succeed if underlying conditions change.

Value: 7

RESULT_INTERNAL_ERROR

Added in API level Baklava

static val RESULT_INTERNAL_ERROR: Int

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

Retry may succeed.

Value: 9

RESULT_INVALID_REQUEST

Added in API level Baklava

static val RESULT_INVALID_REQUEST: Int

Request object is not valid.

Retry not advised with current parameters.

Value: 8

RESULT_OK

Added in API level Baklava

static val RESULT_OK: Int

Request is successful and the value was set.

Value: 0

RESULT_REQUIRE_APP_PERMISSION

Added in API level Baklava

static val RESULT_REQUIRE_APP_PERMISSION: Int

Requested preference requires permissions not held by the calling application.

Retry may succeed if necessary permissions are obtained.

Value: 5

RESULT_REQUIRE_USER_CONSENT

Added in API level Baklava

static val RESULT_REQUIRE_USER_CONSENT: Int

User consent was not approved for this operation.

Retry may succeed if user provides consent.

Value: 6

RESULT_RESTRICTED

Added in API level Baklava

static val RESULT_RESTRICTED: Int

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

Retry may succeed if underlying conditions change.

Value: 3

RESULT_UNAVAILABLE

Added in API level Baklava

static val RESULT_UNAVAILABLE: Int

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

Retry may succeed if underlying conditions change.

Value: 4

RESULT_UNSUPPORTED

Added in API level Baklava

static val RESULT_UNSUPPORTED: Int

Requested preference is not supported by this API.

Retry not advised.

Value: 1

Public methods

getResultCode

Added in API level Baklava

fun getResultCode(): Int

Returns the result code indicating status of the request.

Return

Int

Value is android.service.settings.preferences.SetValueResult#RESULT_OK, android.service.settings.preferences.SetValueResult#RESULT_UNSUPPORTED, android.service.settings.preferences.SetValueResult#RESULT_DISABLED, android.service.settings.preferences.SetValueResult#RESULT_RESTRICTED, android.service.settings.preferences.SetValueResult#RESULT_UNAVAILABLE, android.service.settings.preferences.SetValueResult#RESULT_REQUIRE_APP_PERMISSION, android.service.settings.preferences.SetValueResult#RESULT_REQUIRE_USER_CONSENT, android.service.settings.preferences.SetValueResult#RESULT_DISALLOW, android.service.settings.preferences.SetValueResult#RESULT_INVALID_REQUEST, or android.service.settings.preferences.SetValueResult#RESULT_INTERNAL_ERROR

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<SetValueResult!>

Parcelable Creator for SetValueResult.