2022-01-28 07:35:41 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2022 Huawei Device Co., Ltd.
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"),
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
import { AsyncCallback } from "./basic";
|
|
|
|
import ExtensionContext from "./application/ExtensionContext";
|
|
|
|
import Want from './@ohos.application.Want';
|
2022-06-16 11:21:04 +00:00
|
|
|
import dataSharePredicates from './@ohos.data.dataSharePredicates';
|
2022-05-11 11:14:07 +00:00
|
|
|
import { ValuesBucket } from './@ohos.data.ValuesBucket';
|
2022-01-28 07:35:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* class of datashare extension ability.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-04-11 06:24:53 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
|
|
|
export default class DataShareExtensionAbility {
|
|
|
|
/**
|
|
|
|
* Indicates datashare extension ability context.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
|
|
|
context?: ExtensionContext;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called back when a datashare extension ability is started for initialization.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param want Indicates connection information about the datashare extension ability.
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns -
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-05-13 03:22:00 +00:00
|
|
|
onCreate?(want: Want, callback: AsyncCallback<void>): void;
|
|
|
|
|
2022-01-28 07:35:41 +00:00
|
|
|
/**
|
|
|
|
* Inserts a data record into the database. This method should be implemented by a data share.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the position where the data is to insert.
|
|
|
|
* @param valueBucket Indicates the data to insert.
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the index of the newly inserted data record.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-05-11 11:14:07 +00:00
|
|
|
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void;
|
2022-01-28 07:35:41 +00:00
|
|
|
|
2022-05-13 03:22:00 +00:00
|
|
|
/**
|
|
|
|
* Updates one or more data records in the database. This method should be implemented by a data share.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the database table storing the data to update.
|
|
|
|
* @param predicates Indicates filter criteria. If this parameter is null, all data records will be updated by
|
|
|
|
* default.
|
2022-05-17 03:50:41 +00:00
|
|
|
* @param valueBucket Indicates the data to update. This parameter can be null.
|
2022-05-13 03:22:00 +00:00
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the number of data records updated.
|
2022-05-13 03:22:00 +00:00
|
|
|
* @StageModelOnly
|
|
|
|
*/
|
2022-06-16 11:21:04 +00:00
|
|
|
update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBucket: ValuesBucket,
|
2022-05-13 03:22:00 +00:00
|
|
|
callback: AsyncCallback<number>): void;
|
|
|
|
|
2022-01-28 07:35:41 +00:00
|
|
|
/**
|
|
|
|
* Deletes one or more data records. This method should be implemented by a data share.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the database table storing the data to delete.
|
|
|
|
* @param predicates Indicates filter criteria. If this parameter is null, all data records will be deleted by
|
|
|
|
* default.
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the number of data records deleted.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-06-16 11:21:04 +00:00
|
|
|
delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>): void;
|
2022-01-28 07:35:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Queries one or more data records in the database. This method should be implemented by a data share.
|
2022-11-16 02:44:42 +00:00
|
|
|
* Only RDB and distributed KVDB resultsets are supported. The current version does not support custom resultsets.
|
2022-01-28 07:35:41 +00:00
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the database table storing the data to query.
|
|
|
|
* @param predicates Indicates filter criteria. If this parameter is null, all data records will be queried by
|
|
|
|
* default.
|
2022-05-11 11:14:07 +00:00
|
|
|
* @param columns Indicates the columns to be queried, in array, for example, {"name","age"}. You should define
|
|
|
|
* the processing logic when this parameter is null.
|
2022-01-28 07:35:41 +00:00
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the queried data, only support result set of rdb or kvstore.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-06-16 11:21:04 +00:00
|
|
|
query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>,
|
2022-05-13 03:42:51 +00:00
|
|
|
callback: AsyncCallback<Object>): void;
|
2022-05-11 11:14:07 +00:00
|
|
|
|
2022-01-28 07:35:41 +00:00
|
|
|
/**
|
2022-05-13 03:22:00 +00:00
|
|
|
* Inserts multiple data records into the database. This method should be implemented by a data share.
|
2022-01-28 07:35:41 +00:00
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
2022-05-13 03:22:00 +00:00
|
|
|
* @param uri Indicates the position where the data is to insert.
|
|
|
|
* @param valueBuckets Indicates the data to insert.
|
2022-01-28 07:35:41 +00:00
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the number of data records inserted.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-05-17 03:50:41 +00:00
|
|
|
batchInsert?(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>): void;
|
2022-01-28 07:35:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts the given {@code uri} that refer to the data share into a normalized URI. A normalized URI can be
|
|
|
|
* used across devices, persisted, backed up, and restored. It can refer to the same item in the data share
|
|
|
|
* even if the context has changed.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the uri to normalize.
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the normalized uri if the data share supports URI normalization;
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-03-01 02:13:25 +00:00
|
|
|
normalizeUri?(uri: string, callback: AsyncCallback<string>): void;
|
2022-01-28 07:35:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts the given normalized {@code uri} generated by {@link #normalizeUri(uri)} into a denormalized one.
|
|
|
|
* The default implementation of this method returns the original uri passed to it.
|
|
|
|
*
|
|
|
|
* @since 9
|
|
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
|
|
|
|
* @param uri Indicates the uri to denormalize.
|
|
|
|
* @systemapi Hide this for inner system use.
|
2022-11-16 02:44:42 +00:00
|
|
|
* @returns Returns the denormalized {@code uri} object if the denormalization is successful; returns the original
|
2022-01-28 07:35:41 +00:00
|
|
|
* {@code uri} passed to this method if there is nothing to do; returns {@code null} if the data identified by
|
|
|
|
* the original {@code uri} cannot be found in the current environment.
|
2022-04-11 08:08:29 +00:00
|
|
|
* @StageModelOnly
|
2022-01-28 07:35:41 +00:00
|
|
|
*/
|
2022-03-01 02:13:25 +00:00
|
|
|
denormalizeUri?(uri: string, callback: AsyncCallback<string>): void;
|
2022-01-28 07:35:41 +00:00
|
|
|
}
|