Added in API level 35

Builder


class Builder
kotlin.Any
   ↳ android.adservices.ondevicepersonalization.ExecuteOutput.Builder

A builder for ExecuteOutput

Summary

Public constructors

Public methods
ExecuteOutput.Builder

ExecuteOutput

Builds the instance.

ExecuteOutput.Builder
setBestValue(value: 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().

ExecuteOutput.Builder

A list of EventLogRecord objects to be written to the EVENTS table.

ExecuteOutput.Builder
setOutputData(vararg value: Byte)

A byte array that an IsolatedService may optionally return to a calling app, by setting this field to a non-null value.

ExecuteOutput.Builder

A RenderingConfig object that contains information about the content to be rendered in the client app view.

ExecuteOutput.Builder

Persistent data to be written to the REQUESTS table after IsolatedWorker.onExecute(ExecuteInput, android.os.OutcomeReceiver) completes.

Public constructors

Builder

Added in API level 35
Builder()

Public methods

addEventLogRecord

Added in API level 35
fun addEventLogRecord(value: EventLogRecord): ExecuteOutput.Builder
Parameters
value EventLogRecord: This value cannot be null.
Return
ExecuteOutput.Builder This value cannot be null.

build

Added in API level 35
fun build(): ExecuteOutput

Builds the instance. This builder should not be touched after calling this!

Return
ExecuteOutput This value cannot be null.

setBestValue

fun setBestValue(value: Int): ExecuteOutput.Builder

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.

Parameters
value Int: Value is 0 or greater
Return
ExecuteOutput.Builder This value cannot be null.

setEventLogRecords

Added in API level 35
fun setEventLogRecords(value: MutableList<EventLogRecord!>): ExecuteOutput.Builder

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.

Parameters
value MutableList<EventLogRecord!>: This value cannot be null.
Return
ExecuteOutput.Builder This value cannot be null.

setOutputData

Added in API level 35
fun setOutputData(vararg value: Byte): ExecuteOutput.Builder

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(ComponentName, 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.

Parameters
value Byte: This value may be null.

setRenderingConfig

Added in API level 35
fun setRenderingConfig(value: RenderingConfig?): ExecuteOutput.Builder

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.

Parameters
value RenderingConfig?: This value may be null.

setRequestLogRecord

Added in API level 35
fun setRequestLogRecord(value: RequestLogRecord?): ExecuteOutput.Builder

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.

Parameters
value RequestLogRecord?: This value may be null.