IsolatedWorker

public interface IsolatedWorker

android.adservices.ondevicepersonalization.IsolatedWorker

该接口包含为处理从操作系统向 IsolatedService 所发送请求而需实现的方法。IsolatedService 会针对每个请求创建一个 IsolatedWorker 实例，并根据请求类型调用以下方法之一。IsolatedService 会在 binder 线程上调用该方法，而 IsolatedWorker 应将长时间运行的操作分流到工作器线程。每个方法的使用方参数都用于返回结果。

摘要

公共方法

default void onDownloadCompleted(DownloadCompletedInput input, Consumer<DownloadCompletedOutput> consumer)

处理已完成的下载。

default void onEvent(EventInput input, Consumer<EventOutput> consumer)

处理对平台提供的跟踪网址 EventUrlProvider 的请求触发的事件。该网址嵌入在 onRender(android.adservices.ondevicepersonalization.RenderInput, java.util.function.Consumer) 返回的 HTML 输出中。

default void onExecute(ExecuteInput input, Consumer<ExecuteOutput> consumer)

处理来自应用的请求。

default void onRender(RenderInput input, Consumer<RenderOutput> consumer)

为 onExecute(android.adservices.ondevicepersonalization.ExecuteInput, java.util.function.Consumer) 返回的结果生成 HTML。

default void onTrainingExample(TrainingExampleInput input, Consumer<TrainingExampleOutput> consumer)

生成用于联邦计算作业的单个训练示例。

公共方法

onDownloadCompleted（下载完成）

public void onDownloadCompleted (DownloadCompletedInput input, 
                Consumer<DownloadCompletedOutput> consumer)

处理已完成的下载。平台使用 IsolatedService 软件包清单中定义的参数下载内容，在下载完成后调用此函数，并使用此方法的结果更新 IsolatedService#getRemoteData(RequestToken) 中的 REMOTE_DATA 表。

参数
input DownloadCompletedInput：下载处理脚本参数。 此值不能为 null。
consumer Consumer：用于接收结果的回调。发生错误时应使用 null 调用此方法。如果使用 null 调用，系统不会对 REMOTE_DATA 表进行任何更新。

如果此方法抛出 RuntimeException，则不会对 REMOTE_DATA 表进行任何更新。

onEvent

public void onEvent (EventInput input, 
                Consumer<EventOutput> consumer)

处理对平台提供的跟踪网址 EventUrlProvider 的请求触发的事件。该网址嵌入在 onRender(android.adservices.ondevicepersonalization.RenderInput, java.util.function.Consumer) 返回的 HTML 输出中。平台使用 EventOutput#getEventLogRecord() 更新 EVENTS 表。

参数
input EventInput：计算事件数据所需的参数。此值不能为 null。
consumer Consumer：用于接收结果的回调。发生错误时应使用 null 调用此方法。如果使用 null 调用，则不会向 EVENTS 表写入任何数据。

如果此方法抛出 RuntimeException，则不会将任何数据写入 EVENTS 表。

onExecute

public void onExecute (ExecuteInput input, 
                Consumer<ExecuteOutput> consumer)

处理来自应用的请求。当应用调用引用已命名 IsolatedService 的 OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) 时，系统会调用此方法。

参数
input ExecuteInput：调用应用的请求参数。此值不能为 null。
consumer Consumer：接收结果 ExecuteOutput 的回调。发生错误时应使用 null 调用此方法。系统会将错误作为错误代码为 OnDevicePersonalizationException.ERROR_ISOLATED_SERVICE_FAILED 的 OnDevicePersonalizationException 传播给调用应用。为避免向发起调用的应用泄露私密数据，系统不会提供更详细的错误报告。如果 IsolatedService 需要向其后端报告错误统计信息，则应使用错误数据填充 ExecuteOutput 以进行日志记录，并依赖联邦分析来汇总错误报告。

如果此方法抛出 RuntimeException，系统也会将其作为错误代码为 OnDevicePersonalizationException.ERROR_ISOLATED_SERVICE_FAILED 的 OnDevicePersonalizationException 报告给调用应用。

onRender

public void onRender (RenderInput input, 
                Consumer<RenderOutput> consumer)

为 onExecute(android.adservices.ondevicepersonalization.ExecuteInput, java.util.function.Consumer) 返回的结果生成 HTML。当客户端应用调用 OnDevicePersonalizationManager#requestSurfacePackage(SurfacePackageToken, IBinder, int, int, int, java.util.concurrent.Executor, OutcomeReceiver) 时调用。 平台将在 fenced 帧内的 WebView 中呈现此 HTML。

参数
input RenderInput：渲染请求的参数。此值不能为 null。
consumer Consumer：用于接收结果的回调。发生错误时应使用 null 进行调用。系统会将错误作为错误代码为 OnDevicePersonalizationException.ERROR_ISOLATED_SERVICE_FAILED 的 OnDevicePersonalizationException 传播给调用应用。

如果此方法抛出 RuntimeException，系统也会将其作为错误代码为 OnDevicePersonalizationException.ERROR_ISOLATED_SERVICE_FAILED 的 OnDevicePersonalizationException 报告给调用应用。

onTrainingExample

public void onTrainingExample (TrainingExampleInput input, 
                Consumer<TrainingExampleOutput> consumer)

生成用于联合计算作业的单个训练示例。

参数
input TrainingExampleInput：生成训练示例所需的参数。此值不能为 null。
consumer Consumer：完成时要调用的回调。 此值不能为 null。