ExecuteOutput
class ExecuteOutput
| kotlin.Any | |
| ↳ | android.adservices.ondevicepersonalization.ExecuteOutput |
The result returned by IsolatedWorker.onExecute(ExecuteInput, android.os.OutcomeReceiver) in response to a call to OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) from a client app.
Summary
| Nested classes | |
|---|---|
|
A builder for |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
An integer value that an |
| MutableList<EventLogRecord!> |
A list of |
| ByteArray? |
A byte array that an |
| RenderingConfig? |
A |
| RequestLogRecord? |
Persistent data to be written to the REQUESTS table after |
| Int |
hashCode() |
Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getBestValue
fun getBestValue(): Int
An integer value that an IsolatedService may optionally return to a calling app, by setting this field to the value between 0 and android.adservices.ondevicepersonalization.ExecuteInIsolatedServiceRequest.OutputSpec#getMaxIntValue(). The noise will be added to the value of this field before returned to the caller of android.adservices.ondevicepersonalization.OnDevicePersonalizationManager#executeInIsolatedService. In order to get this field, the (calling app package, isolated service package) pair must be present in an allowlist that permits data to be returned and android.adservices.ondevicepersonalization.ExecuteInIsolatedServiceRequest.OutputSpec#buildBestValueSpec is set.
| Return | |
|---|---|
Int |
Value is DEFAULT_BEST_VALUE or greater |
getEventLogRecords
fun getEventLogRecords(): MutableList<EventLogRecord!>
A list of EventLogRecord objects to be written to the EVENTS table. Each EventLogRecord must be associated with an existing RequestLogRecord in the REQUESTS table, specified using EventLogRecord.Builder.setRequestLogRecord(RequestLogRecord). If the RequestLogRecord is not specified, the EventLogRecord will not be written.
| Return | |
|---|---|
MutableList<EventLogRecord!> |
This value cannot be null. |
getOutputData
fun getOutputData(): ByteArray?
A byte array that an IsolatedService may optionally return to a calling app, by setting this field to a non-null value. The contents of this array will be returned to the caller of OnDevicePersonalizationManager.execute if returning data from isolated processes is allowed by policy and the (calling app package, isolated service package) pair is present in an allowlist that permits data to be returned.
getRenderingConfig
fun getRenderingConfig(): RenderingConfig?
A RenderingConfig object that contains information about the content to be rendered in the client app view. Can be null if no content is to be rendered.
getRequestLogRecord
fun getRequestLogRecord(): RequestLogRecord?
Persistent data to be written to the REQUESTS table after IsolatedWorker.onExecute(ExecuteInput, android.os.OutcomeReceiver) completes. If null, no persistent data will be written.