PccEgressException

Kotlin |Java

class PccEgressException : Exception, Parcelable

kotlin.Any
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	android.app.privatecompute.PccEgressException

Exception thrown when an egress request fails inside the PCC sandbox. Contains the android.app.privatecompute.PccEgressException.StatusCode detailing the failure.

Summary

Nested classes
	`SensitiveCategoryInfo` Details about the detected sensitive content that caused an egress request to be rejected.

Constants
static Int	`ERROR_CONTENT_SENSITIVE` Indicates that the request failed because the content was classified as sensitive.
static Int	`ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` Indicates that the request failed because the proxy service did not respond or timed out.
static Int	`ERROR_UNABLE_TO_DELIVER_REQUEST` Indicates that the request failed because the system was unable to deliver the egress.
static Int	`ERROR_UNKNOWN` Indicates an unspecified or unexpected failure.

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 constructors
`PccEgressException(statusCode: Int)` Creates a new PccEgressException with a given android.
`PccEgressException(statusCode: Int, sensitiveCategoryInfo: PccEgressException.SensitiveCategoryInfo)` Creates a new PccEgressException with a given android.
`PccEgressException(statusCode: Int, message: String)` Creates a new PccEgressException with a given android.
`PccEgressException(statusCode: Int, message: String, sensitiveCategoryInfo: PccEgressException.SensitiveCategoryInfo)` Creates a new PccEgressException with a given android.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
PccEgressException.SensitiveCategoryInfo?	`getSensitiveCategoryInfo()` Returns the `SensitiveCategoryInfo` detailing the sensitive content detected during egress screening.
Int	`getStatusCode()` Returns the status code detailing the egress failure.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PccEgressException!>	`CREATOR` Standard parcelable creator for `PccEgressException`.

Constants

ERROR_CONTENT_SENSITIVE

Added in API level 10000

static val ERROR_CONTENT_SENSITIVE: Int

Indicates that the request failed because the content was classified as sensitive.

Value: 3

ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE

Added in API level 10000

static val ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE: Int

Indicates that the request failed because the proxy service did not respond or timed out.

Value: 2

ERROR_UNABLE_TO_DELIVER_REQUEST

Added in API level 10000

static val ERROR_UNABLE_TO_DELIVER_REQUEST: Int

Indicates that the request failed because the system was unable to deliver the egress.

Value: 1

ERROR_UNKNOWN

Added in API level 10000

static val ERROR_UNKNOWN: Int

Indicates an unspecified or unexpected failure.

Value: -1

Public constructors

PccEgressException

Added in API level 10000

PccEgressException(statusCode: Int)

Creates a new PccEgressException with a given android.app.privatecompute.PccEgressException.StatusCode.

Parameters
`statusCode`	Int: The android.app.privatecompute.PccEgressException.StatusCode of the egress failure. Value is one of the following: `ERROR_UNABLE_TO_DELIVER_REQUEST` `ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` `ERROR_CONTENT_SENSITIVE` `ERROR_UNKNOWN`

PccEgressException

Added in API level 10000

PccEgressException(
    statusCode: Int, 
    sensitiveCategoryInfo: PccEgressException.SensitiveCategoryInfo)

Creates a new PccEgressException with a given android.app.privatecompute.PccEgressException.StatusCode and SensitiveCategoryInfo.

Parameters
`statusCode`	Int: The android.app.privatecompute.PccEgressException.StatusCode of the egress failure. Value is one of the following: `ERROR_UNABLE_TO_DELIVER_REQUEST` `ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` `ERROR_CONTENT_SENSITIVE` `ERROR_UNKNOWN`
`sensitiveCategoryInfo`	PccEgressException.SensitiveCategoryInfo: The `SensitiveCategoryInfo` detailing the sensitive content screening result. This value cannot be `null`.

PccEgressException

Added in API level 10000

PccEgressException(
    statusCode: Int, 
    message: String)

Creates a new PccEgressException with a given android.app.privatecompute.PccEgressException.StatusCode and detailed error message.

Parameters
`statusCode`	Int: The android.app.privatecompute.PccEgressException.StatusCode of the egress failure. Value is one of the following: `ERROR_UNABLE_TO_DELIVER_REQUEST` `ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` `ERROR_CONTENT_SENSITIVE` `ERROR_UNKNOWN`
`message`	String: The detailed error message description. This value cannot be `null`.

PccEgressException

Added in API level 10000

PccEgressException(
    statusCode: Int, 
    message: String, 
    sensitiveCategoryInfo: PccEgressException.SensitiveCategoryInfo)

Creates a new PccEgressException with a given android.app.privatecompute.PccEgressException.StatusCode, detailed error message, and SensitiveCategoryInfo.

Parameters
`statusCode`	Int: The android.app.privatecompute.PccEgressException.StatusCode of the egress failure. Value is one of the following: `ERROR_UNABLE_TO_DELIVER_REQUEST` `ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` `ERROR_CONTENT_SENSITIVE` `ERROR_UNKNOWN`
`message`	String: The detailed error message description. This value cannot be `null`.
`sensitiveCategoryInfo`	PccEgressException.SensitiveCategoryInfo: The `SensitiveCategoryInfo` detailing the sensitive content screening result. This value cannot be `null`.

Public methods

describeContents

Added in API level 10000

fun describeContents(): Int

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(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getSensitiveCategoryInfo

Added in API level 10000

fun getSensitiveCategoryInfo(): PccEgressException.SensitiveCategoryInfo?

Returns the SensitiveCategoryInfo detailing the sensitive content detected during egress screening.

Return
`PccEgressException.SensitiveCategoryInfo?`	The `SensitiveCategoryInfo`, or `null` if not set or if the egress failure was not due to sensitive content.

getStatusCode

Added in API level 10000

fun getStatusCode(): Int

Returns the status code detailing the egress failure.

Return
`Int`	The android.app.privatecompute.PccEgressException.StatusCode of the egress failure. Value is one of the following: `ERROR_UNABLE_TO_DELIVER_REQUEST` `ERROR_NO_RESPONSE_FROM_EGRESS_SERVICE` `ERROR_CONTENT_SENSITIVE` `ERROR_UNKNOWN`

writeToParcel

Added in API level 10000

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

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

Properties

CREATOR

Added in API level 10000

static val CREATOR: Parcelable.Creator<PccEgressException!>

Standard parcelable creator for PccEgressException.