IsolatedWorker
interface IsolatedWorker
| android.adservices.ondevicepersonalization.IsolatedWorker |
Interface with methods that need to be implemented to handle requests from the OnDevicePersonalization service to an IsolatedService. The IsolatedService creates an instance of IsolatedWorker on each request and calls one of the methods below, depending the type of the request. The IsolatedService calls the method on a Binder thread and the IsolatedWorker should offload long running operations to a worker thread. The IsolatedWorker should use the receiver parameter of each method to return results. If any of these methods throws a RuntimeException, the platform treats it as an unrecoverable error in the IsolatedService and ends processing the request.
Summary
Public methods
onDownloadCompleted
open fun onDownloadCompleted(
input: DownloadCompletedInput,
receiver: OutcomeReceiver<DownloadCompletedOutput!, IsolatedServiceException!>
): Unit
Handles a completed download. The platform downloads content using the parameters defined in the package manifest of the IsolatedService, calls this function after the download is complete, and updates the REMOTE_DATA table from IsolatedService.getRemoteData(RequestToken) with the result of this method.
| Parameters | |
|---|---|
input |
DownloadCompletedInput: Download handler parameters. This value cannot be null. |
receiver |
OutcomeReceiver<DownloadCompletedOutput!, IsolatedServiceException!>: Callback that receives the result DownloadCompletedOutput or an IsolatedServiceException.
If this method returns a |
onEvent
open fun onEvent(
input: EventInput,
receiver: OutcomeReceiver<EventOutput!, IsolatedServiceException!>
): Unit
Handles an event triggered by a request to a platform-provided tracking URL EventUrlProvider that was embedded in the HTML output returned by onRender(android.adservices.ondevicepersonalization.RenderInput,android.os.OutcomeReceiver). The platform updates the EVENTS table with EventOutput.getEventLogRecord().
| Parameters | |
|---|---|
input |
EventInput: The parameters needed to compute event data. This value cannot be null. |
receiver |
OutcomeReceiver<EventOutput!, IsolatedServiceException!>: Callback that receives the result EventOutput or an IsolatedServiceException.
If this method returns a |
onExecute
open fun onExecute(
input: ExecuteInput,
receiver: OutcomeReceiver<ExecuteOutput!, IsolatedServiceException!>
): Unit
Handles a request from an app. This method is called when an app calls OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) that refers to a named IsolatedService.
| Parameters | |
|---|---|
input |
ExecuteInput: Request Parameters from the calling app. This value cannot be null. |
receiver |
OutcomeReceiver<ExecuteOutput!, IsolatedServiceException!>: Callback that receives the result ExecuteOutput or an IsolatedServiceException. If this method throws a RuntimeException or returns either null or IsolatedServiceException, the error is indicated to the calling app as an OnDevicePersonalizationException with error code OnDevicePersonalizationException.ERROR_ISOLATED_SERVICE_FAILED. To avoid leaking private data to the calling app, more detailed errors are not reported to the caller. If the IsolatedService needs to report additional data beyond the error code to its backend servers, it should populate the logging fields in ExecuteOutput with the additional error data for logging, and rely on Federated Analytics for the stats. |
onRender
open fun onRender(
input: RenderInput,
receiver: OutcomeReceiver<RenderOutput!, IsolatedServiceException!>
): Unit
Generates HTML for the results that were returned as a result of onExecute(android.adservices.ondevicepersonalization.ExecuteInput,android.os.OutcomeReceiver). Called when a client app calls android.adservices.ondevicepersonalization.OnDevicePersonalizationManager#requestSurfacePackage(android.adservices.ondevicepersonalization.SurfacePackageToken,IBinder,int,int,int,java.util.concurrent.Executor,android.os.OutcomeReceiver). The platform will render this HTML in an android.webkit.WebView inside a fenced frame.
| Parameters | |
|---|---|
input |
RenderInput: Parameters for the render request. This value cannot be null. |
receiver |
OutcomeReceiver<RenderOutput!, IsolatedServiceException!>: Callback that receives the result RenderOutput or an IsolatedServiceException.
If this method returns a |
onTrainingExamples
open fun onTrainingExamples(
input: TrainingExamplesInput,
receiver: OutcomeReceiver<TrainingExamplesOutput!, IsolatedServiceException!>
): Unit
Generate a list of training examples used for federated compute job. The platform will call this function when a federated compute job starts. The federated compute job is scheduled by an app through FederatedComputeScheduler.schedule.
| Parameters | |
|---|---|
input |
TrainingExamplesInput: The parameters needed to generate the training example. This value cannot be null. |
receiver |
OutcomeReceiver<TrainingExamplesOutput!, IsolatedServiceException!>: Callback that receives the result TrainingExamplesOutput or an IsolatedServiceException.
If this method returns a |
onWebTrigger
open fun onWebTrigger(
input: WebTriggerInput,
receiver: OutcomeReceiver<WebTriggerOutput!, IsolatedServiceException!>
): Unit
Handles a Web Trigger event from a browser. A Web Trigger event occurs when a browser registers a web trigger event with the OS using the Attribution and Reporting API. If the data in the web trigger payload indicates that the event should be forwarded to an IsolatedService, the platform will call this function with the web trigger data.
| Parameters | |
|---|---|
input |
WebTriggerInput: The parameters needed to process Web Trigger event. This value cannot be null. |
receiver |
OutcomeReceiver<WebTriggerOutput!, IsolatedServiceException!>: Callback that receives the result WebTriggerOutput or an IsolatedServiceException. Should be called with a WebTriggerOutput object populated with a set of records to be written to the REQUESTS or EVENTS tables.
If this method returns a |