程序包 ohos.data.async

类 DataAbilityAsyncHandler

java.lang.Object

ohos.eventhandler.EventHandler

ohos.data.async.DataAbilityAsyncHandler

public class DataAbilityAsyncHandler
extends EventHandler

Provides interfaces to asynchronously add, delete, modify, and query data of the database in the cross-process or cross-device scenario with a DataAbilityHelper instance.

This class provides two threads, a work thread and a callback thread. The work thread implements data operations; the callback thread processes data operation results.

从以下版本开始:

3

SystemCapability

SystemCapability.Data#DATA_APPDATAMGR

嵌套类概要

从类继承的嵌套类/接口 ohos.eventhandler.EventHandler

EventHandler.Priority

构造器概要

构造器

构造器	说明
DataAbilityAsyncHandler(Context context)	Creates a DataAbilityAsyncHandler instance using a Context.
DataAbilityAsyncHandler(Context context, Uri uri)	Creates a DataAbilityAsyncHandler instance using a Context and Uri.

方法概要

限定符和类型	方法	说明
void	addDeleteJob(JobParams jobParams, Uri uri, DataAbilityPredicates dataAbilityPredicates, DeleteCallback deleteCallback)	Deletes data from the database asynchronously and processes the deletion result.
void	addInsertJob(JobParams jobParams, Uri uri, ValuesBucket valuesBucket, InsertCallback insertCallback)	Inserts data into the database asynchronously and processes the insertion result.
void	addQueryJob(JobParams jobParams, Uri uri, String[] columns, DataAbilityPredicates dataAbilityPredicates, QueryCallback queryCallback)	Queries data in the database asynchronously and processes the query result.
void	addUpdateJob(JobParams jobParams, Uri uri, ValuesBucket valuesBucket, DataAbilityPredicates dataAbilityPredicates, UpdateCallback updateCallback)	Updates data in the database asynchronously and processes the update result.
void	cancelJob(int token)	Cancels asynchronous tasks with the same token.
protected void	finalize()	When we do not use current instance, we should release dataAbilityHelper.

从类继承的方法 ohos.eventhandler.EventHandler

current, distributeEvent, dump, getEventName, getEventRunner, hasInnerEvent, hasInnerEvent, hasInnerEvent, hasInnerEvent, hasInnerEvent, isIdle, postSyncTask, postSyncTask, postTask, postTask, postTask, postTask, postTask, postTimingTask, postTimingTask, postTimingTask, processEvent, removeAllEvent, removeEvent, removeEvent, removeEvent, removeEvent, removeTask, removeTask, sendEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendSyncEvent, sendSyncEvent, sendSyncEvent, sendSyncEvent, sendTimingEvent, sendTimingEvent, sendTimingEvent, sendTimingEvent, toString

从类继承的方法 java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

DataAbilityAsyncHandler

public DataAbilityAsyncHandler(Context context)

Creates a DataAbilityAsyncHandler instance using a Context.

This constructor is used if the asynchronous Uri points to a different device or provider.

参数:

context - Indicates the application context.

从以下版本开始:

3

DataAbilityAsyncHandler

public DataAbilityAsyncHandler(Context context,
                               Uri uri)

Creates a DataAbilityAsyncHandler instance using a Context and Uri.

This constructor is more efficient and recommended if the asynchronous Uri points to the same device or provider.

参数:

context - Indicates the application context.

uri - Indicates the resource URI.

从以下版本开始:

3

方法详细资料

addQueryJob

public final void addQueryJob(JobParams jobParams,
                              Uri uri,
                              String[] columns,
                              DataAbilityPredicates dataAbilityPredicates,
                              QueryCallback queryCallback)

Queries data in the database asynchronously and processes the query result.

Use this method when querying a large amount of data in the database in the cross-process or cross-device scenario.

参数:

jobParams - Indicates mandatory parameters of the task. For details, see JobParams.

uri - Indicates the resource URI. It cannot be null.

columns - Indicates the columns where the data to be queried resides. If it is null, data in all the columns will be queried.

dataAbilityPredicates - Indicates the DataAbilityPredicates. It is mandatory and cannot be null.

queryCallback - Indicates the QueryCallback used to process the query result. It is mandatory and cannot be null.

抛出:

IllegalArgumentException - Throws this exception if a parameter is illegal.

从以下版本开始:

3

addInsertJob

public final void addInsertJob(JobParams jobParams,
                               Uri uri,
                               ValuesBucket valuesBucket,
                               InsertCallback insertCallback)

Inserts data into the database asynchronously and processes the insertion result.

Use this method when inserting a large amount of data into the database in the cross-process or cross-device scenario.

参数:

jobParams - Indicates mandatory parameters of the task. For details, see JobParams.

uri - Indicates the resource URI. It cannot be null.

valuesBucket - Indicates a bucket that stores and manages values. It is mandatory and cannot be null. For details, see ValuesBucket.

insertCallback - Indicates the InsertCallback used to process the insertion result. It is mandatory and cannot be null.

抛出:

IllegalArgumentException - Throws this exception if a parameter is illegal.

从以下版本开始:

3

addUpdateJob

public final void addUpdateJob(JobParams jobParams,
                               Uri uri,
                               ValuesBucket valuesBucket,
                               DataAbilityPredicates dataAbilityPredicates,
                               UpdateCallback updateCallback)

Updates data in the database asynchronously and processes the update result.

Use this method when updating a large amount of data in the database in the cross-process or cross-device scenario.

参数:

jobParams - Indicates mandatory parameters of the task. For details, see JobParams.

uri - Indicates the resource URI. It cannot be null.

valuesBucket - Indicates a bucket that stores and manages values. It is mandatory and cannot be null. For details, see ValuesBucket.

dataAbilityPredicates - Indicates the DataAbilityPredicates. It is mandatory and cannot be null.

updateCallback - Indicates the UpdateCallback used to process the update result. It is mandatory and cannot be null.

抛出:

IllegalArgumentException - Throws this exception if a parameter is illegal.

从以下版本开始:

3

addDeleteJob

public final void addDeleteJob(JobParams jobParams,
                               Uri uri,
                               DataAbilityPredicates dataAbilityPredicates,
                               DeleteCallback deleteCallback)

Deletes data from the database asynchronously and processes the deletion result.

Use this method when deleting a large amount of data from the database in the cross-process or cross-device scenario.

参数:

jobParams - Indicates mandatory parameters of the task. For details, see JobParams.

uri - Indicates the resource URI. It cannot be null.

dataAbilityPredicates - Indicates the DataAbilityPredicates. It is mandatory and cannot be null.

deleteCallback - Indicates the DeleteCallback used to process the deletion result. It is mandatory and cannot be null.

抛出:

IllegalArgumentException - Throws this exception if a parameter is illegal.

从以下版本开始:

3

finalize

protected void finalize()

When we do not use current instance, we should release dataAbilityHelper.

覆盖:

finalize 在类中 Object

从以下版本开始:

3

另请参阅:

WeakReference, PhantomReference

cancelJob

public final void cancelJob(int token)

Cancels asynchronous tasks with the same token.

If different tasks share a token, use this method to cancel these tasks.

参数:

token - Indicates the token shared by the tasks. It must be consistent with that in the input parameter jobParams of the addDeleteJob, addInsertJob, addQueryJob, and addUpdateJob methods.

从以下版本开始:

3