mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 09:22:53 +00:00
823 lines
31 KiB
TypeScript
823 lines
31 KiB
TypeScript
/*
|
|
* 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 type { AsyncCallback } from './@ohos.base';
|
|
import Context from './application/Context';
|
|
import DataShareResultSet from './@ohos.data.DataShareResultSet';
|
|
import dataSharePredicates from './@ohos.data.dataSharePredicates';
|
|
import { ValuesBucket } from './@ohos.data.ValuesBucket';
|
|
|
|
/**
|
|
* This module provides the dataShare capability for consumer.
|
|
*
|
|
* @namespace dataShare
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
declare namespace dataShare {
|
|
/**
|
|
* Manages create datashare helper options.
|
|
*
|
|
* @interface DataShareHelperOptions
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface DataShareHelperOptions {
|
|
/**
|
|
* Specifies whether the {@link DataShareHelper} in proxy mode.
|
|
* If value is true, the {@link DataShareHelper} to be created is in proxy mode, and all operations will not open provider APP as possible
|
|
*
|
|
* @default false
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
isProxy?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Obtains the dataShareHelper.
|
|
*
|
|
* @param { Context } context - Indicates the application context.
|
|
* @param { string } uri - Indicates the path of the file to open.
|
|
* @param { AsyncCallback<DataShareHelper> } callback - {DataShareHelper}: The dataShareHelper for consumer.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700010 - The DataShareHelper is not initialized successfully.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
function createDataShareHelper(context: Context, uri: string, callback: AsyncCallback<DataShareHelper>): void;
|
|
/**
|
|
* Obtains the dataShareHelper.
|
|
*
|
|
* @param { Context } context - Indicates the application context.
|
|
* @param { string } uri - Indicates the path of the file to open.
|
|
* @param { DataShareHelperOptions } options - Indicates the optional config.
|
|
* @param { AsyncCallback<DataShareHelper> } callback - {DataShareHelper}: The dataShareHelper for consumer.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700010 - The DataShareHelper is not initialized successfully.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
function createDataShareHelper(
|
|
context: Context,
|
|
uri: string,
|
|
options: DataShareHelperOptions,
|
|
callback: AsyncCallback<DataShareHelper>
|
|
): void;
|
|
|
|
/**
|
|
* Obtains the dataShareHelper.
|
|
*
|
|
* @param { Context } context - Indicates the application context.
|
|
* @param { string } uri - Indicates the path of the file to open.
|
|
* @returns { Promise<DataShareHelper> } {DataShareHelper}: The dataShareHelper for consumer.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700010 - The DataShareHelper is not initialized successfully.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Obtains the dataShareHelper.
|
|
*
|
|
* @param { Context } context - Indicates the application context.
|
|
* @param { string } uri - Indicates the path of the file to open.
|
|
* @param { DataShareHelperOptions } options - Indicates the optional config.
|
|
* @returns { Promise<DataShareHelper> } {DataShareHelper}: The dataShareHelper for consumer.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700010 - The DataShareHelper is not initialized successfully.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
function createDataShareHelper(
|
|
context: Context,
|
|
uri: string,
|
|
options?: DataShareHelperOptions
|
|
): Promise<DataShareHelper>;
|
|
|
|
/**
|
|
* Specifies the {@link Template} id structure.
|
|
* A template is marked by the template id. Note that the template id is auto generated in {@link DataShareHelper#addTemplate}.
|
|
* After {@link DataShareHelper#addTemplate}, can use the template id to direct a template.
|
|
*
|
|
* @interface TemplateId
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface TemplateId {
|
|
/**
|
|
* Specifies the id of subscriber, who process the callback
|
|
* Same as subscriberId in {@link DataShareHelper#addTemplate}
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
subscriberId: string;
|
|
/**
|
|
* Specifies the bundleName of template owner, who create the template
|
|
* Same as the caller's bundleName of {@link DataShareHelper#addTemplate}
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
bundleNameOfOwner: string;
|
|
}
|
|
|
|
/**
|
|
* Specifies the published item structure.
|
|
*
|
|
* @interface PublishedItem
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface PublishedItem {
|
|
/**
|
|
* Specifies the key of the published data
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
key: string;
|
|
/**
|
|
* Specifies the published data
|
|
* If the data is large, use ArrayBuffer.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
data: string | ArrayBuffer;
|
|
/**
|
|
* Specifies the subscriber id
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
subscriberId: string;
|
|
}
|
|
|
|
/**
|
|
* Specifies the change node structure of rdb store data in callback.
|
|
*
|
|
* @interface RdbDataChangeNode
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface RdbDataChangeNode {
|
|
/**
|
|
* Specifies the uri of the callback.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
uri: string;
|
|
/**
|
|
* Specifies the templateId of the callback.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
templateId: TemplateId;
|
|
/**
|
|
* Specifies the datas of the callback.
|
|
* every node is a json, json's key is [key of {@link Template#predicates}
|
|
* and value is the query result from rdb store query by value of{@link Template#predicates}].
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
data: Array<string>;
|
|
}
|
|
|
|
/**
|
|
* Specifies the change node structure of published data in callback.
|
|
*
|
|
* @interface PublishedDataChangeNode
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface PublishedDataChangeNode {
|
|
/**
|
|
* Specifies the bundleName of the callback.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
bundleName: string;
|
|
/**
|
|
* Specifies the datas of the callback.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
data: Array<PublishedItem>;
|
|
}
|
|
|
|
/**
|
|
* Specifies the template structure in subscribe.
|
|
*
|
|
* @interface Template
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface Template {
|
|
/**
|
|
* Specifies the predicates of the template.
|
|
* When the callback in {@link DataShareHelper#on(string, Array<string>, TemplateId, AsyncCallback<ChangeNode>)}
|
|
* is called, the predicates is used to generate data in {@link ChangeNode}. Only for rdb store data.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
predicates: { [key: string]: string };
|
|
|
|
/**
|
|
* Specifies the scheduler sql of the template.
|
|
* When modify the subscribed uri's data, scheduler is auto called.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
scheduler: string;
|
|
}
|
|
/**
|
|
* Specifies the operation result structure.
|
|
*
|
|
* @interface OperationResult
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
interface OperationResult {
|
|
/**
|
|
* Specifies the key of the operation result.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
key: string;
|
|
|
|
/**
|
|
* Specifies the operation result.
|
|
*
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
result: number;
|
|
}
|
|
|
|
/**
|
|
* DataShareHelper
|
|
*
|
|
* @interface DataShareHelper
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
interface DataShareHelper {
|
|
/**
|
|
* Registers an observer to observe data specified by the given uri.
|
|
*
|
|
* @param { 'dataChange' } type - Type must be 'dataChange'.
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { AsyncCallback<void> } callback - The callback of on.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
on(type: 'dataChange', uri: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Deregisters an observer used for monitoring data specified by the given uri.
|
|
*
|
|
* @param { 'dataChange' } type - Type must be 'dataChange'.
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { AsyncCallback<void> } callback - The callback of off.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Adds a template of {@link #on(string, Array<string>, TemplateId, AsyncCallback<ChangeNode>)}.
|
|
*
|
|
* @param { string } uri - Indicates the uri to add.
|
|
* @param { string } subscriberId - The subscribe id to add..
|
|
* @param { Template } template - The template to add.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700011 - The uri is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
addTemplate(uri: string, subscriberId: string, template: Template): void;
|
|
|
|
/**
|
|
* Deletes a template of {@link #on(string, Array<string>, TemplateId, AsyncCallback<ChangeNode>)}.
|
|
*
|
|
* @param { string } uri - Indicates the uri to delete.
|
|
* @param { string } subscriberId - The subscribe id.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700011 - The uri is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
delTemplate(uri: string, subscriberId: string): void;
|
|
|
|
/**
|
|
* Registers observers to observe rdb data specified by the given uri and template.
|
|
*
|
|
* @param { 'rdbDataChange' } type - Type must be 'rdbDataChange'.
|
|
* @param { Array<string> } uris - Indicates the paths of the data to operate.
|
|
* @param { TemplateId } templateId - The template of on.
|
|
* @param { AsyncCallback<RdbDataChangeNode> } callback - The callback of on.
|
|
* @returns { Array<OperationResult> } : The operation result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
on(
|
|
type: 'rdbDataChange',
|
|
uris: Array<string>,
|
|
templateId: TemplateId,
|
|
callback: AsyncCallback<RdbDataChangeNode>
|
|
): Array<OperationResult>;
|
|
|
|
/**
|
|
* Deregisters observers used for monitoring data specified by the given uri and template.
|
|
*
|
|
* @param { 'rdbDataChange' } type - Type must be 'rdbDataChange'.
|
|
* @param { Array<string> } uris - Indicates the paths of the data to operate.
|
|
* @param { TemplateId } templateId - The template of off.
|
|
* @param { AsyncCallback<RdbDataChangeNode> } callback - The callback of off.
|
|
* @returns { Array<OperationResult> } : The operation result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
off(
|
|
type: 'rdbDataChange',
|
|
uris: Array<string>,
|
|
templateId: TemplateId,
|
|
callback?: AsyncCallback<RdbDataChangeNode>
|
|
): Array<OperationResult>;
|
|
|
|
/**
|
|
* Registers observers to observe published data specified by the given key and subscriberId.
|
|
*
|
|
* @param { 'publishedDataChange' } type - Type must be 'publishedDataChange'.
|
|
* @param { Array<string> } uris - Indicates the uris of the data to operate.
|
|
* @param { string } subscriberId - The subscriberId of on.
|
|
* @param { AsyncCallback<PublishedDataChangeNode> } callback - The callback of on.
|
|
* @returns { Array<OperationResult> } : The operation result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
on(
|
|
type: 'publishedDataChange',
|
|
uris: Array<string>,
|
|
subscriberId: string,
|
|
callback: AsyncCallback<PublishedDataChangeNode>
|
|
): Array<OperationResult>;
|
|
|
|
/**
|
|
* Deregisters observers used for monitoring data specified by the given key and subscriberId.
|
|
*
|
|
* @param { 'publishedDataChange' } type - Type must be 'publishedDataChange'.
|
|
* @param { Array<string> } uris - Indicates the uris of the data to operate.
|
|
* @param { string } subscriberId - The template of off.
|
|
* @param { AsyncCallback<PublishedDataChangeNode> } callback - The callback of off.
|
|
* @returns { Array<OperationResult> } : The operation result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
off(
|
|
type: 'publishedDataChange',
|
|
uris: Array<string>,
|
|
subscriberId: string,
|
|
callback?: AsyncCallback<PublishedDataChangeNode>
|
|
): Array<OperationResult>;
|
|
|
|
/**
|
|
* Update a single data into host data area.
|
|
*
|
|
* @param { Array<PublishedItem> } data - Indicates the data to publish.
|
|
* @param { string } bundleName - Indicates the bundleName of data to publish.
|
|
* @param { number } version - Indicates the version of data to publish, larger is newer.
|
|
* @param { AsyncCallback<Array<OperationResult>> } callback
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700012 - The data area is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
publish(
|
|
data: Array<PublishedItem>,
|
|
bundleName: string,
|
|
version: number,
|
|
callback: AsyncCallback<Array<OperationResult>>
|
|
): void;
|
|
|
|
/**
|
|
* Update a single data into host data area.
|
|
*
|
|
* @param { Array<PublishedItem> } data - Indicates the data to publish.
|
|
* @param { string } bundleName - Indicates the bundleName of data to publish.
|
|
* @param { AsyncCallback<Array<OperationResult>> } callback
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700012 - The data area is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
publish(
|
|
data: Array<PublishedItem>,
|
|
bundleName: string,
|
|
callback: AsyncCallback<Array<OperationResult>>
|
|
): void;
|
|
|
|
/**
|
|
* Update a single data into host data area.
|
|
*
|
|
* @param { Array<PublishedItem> } data - Indicates the data to publish.
|
|
* @param { string } bundleName - Indicates the bundleName of data to publish.
|
|
* @param { number } version - Indicates the version of data to publish, larger is newer.
|
|
* @returns { Promise<Array<OperationResult>> }
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700012 - The data area is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
publish(data: Array<PublishedItem>, bundleName: string, version?: number): Promise<Array<OperationResult>>;
|
|
|
|
/**
|
|
* Registers a one-time observer to observe data specified by the given uri and template.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundleName of data to publish.
|
|
* @param { AsyncCallback<Array<PublishedItem>> } callback
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700012 - The data area is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
getPublishedData(bundleName: string, callback: AsyncCallback<Array<PublishedItem>>): void;
|
|
|
|
/**
|
|
* Registers a one-time observer to observe data specified by the given uri and template.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundleName of data to publish.
|
|
* @returns { Promise<Array<PublishedItem>> }
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 15700012 - The data area is not exist.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
getPublishedData(bundleName: string): Promise<Array<PublishedItem>>;
|
|
|
|
/**
|
|
* Inserts a single data record into the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { ValuesBucket } value - Indicates the data record to insert. If this parameter is null,
|
|
* a blank row will be inserted.
|
|
* @param { AsyncCallback<number> } callback - {number}: the index of the inserted data record.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
insert(uri: string, value: ValuesBucket, callback: AsyncCallback<number>): void;
|
|
|
|
/**
|
|
* Inserts a single data record into the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { ValuesBucket } value - Indicates the data record to insert. If this parameter is null,
|
|
* a blank row will be inserted.
|
|
* @returns { Promise<number> } {number}: the index of the inserted data record.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
insert(uri: string, value: ValuesBucket): Promise<number>;
|
|
|
|
/**
|
|
* Deletes one or more data records from the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @param { AsyncCallback<number> } callback - {number}: the number of data records deleted.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>): void;
|
|
|
|
/**
|
|
* Deletes one or more data records from the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @returns { Promise<number> } {number}: the number of data records deleted.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promise<number>;
|
|
|
|
/**
|
|
* Queries data in the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of data to query.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @param { Array<string> } columns - Indicates the columns to query.
|
|
* If this parameter is null, all columns are queried.
|
|
* @param { AsyncCallback<DataShareResultSet> } callback - {DataShareResultSet}: the query result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
query(
|
|
uri: string,
|
|
predicates: dataSharePredicates.DataSharePredicates,
|
|
columns: Array<string>,
|
|
callback: AsyncCallback<DataShareResultSet>
|
|
): void;
|
|
|
|
/**
|
|
* Queries data in the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of data to query.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @param { Array<string> } columns - Indicates the columns to query.
|
|
* If this parameter is null, all columns are queried.
|
|
* @returns { Promise<DataShareResultSet> } {DataShareResultSet}: the query result.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
query(
|
|
uri: string,
|
|
predicates: dataSharePredicates.DataSharePredicates,
|
|
columns: Array<string>
|
|
): Promise<DataShareResultSet>;
|
|
|
|
/**
|
|
* Updates data records in the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of data to update.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @param { ValuesBucket } value - Indicates the data to update. This parameter can be null.
|
|
* @param { AsyncCallback<number> } callback - {number}: the number of data records updated.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
update(
|
|
uri: string,
|
|
predicates: dataSharePredicates.DataSharePredicates,
|
|
value: ValuesBucket,
|
|
callback: AsyncCallback<number>
|
|
): void;
|
|
|
|
/**
|
|
* Updates data records in the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of data to update.
|
|
* @param { dataSharePredicates.DataSharePredicates } predicates - Indicates filter criteria.
|
|
* You should define the processing logic when this parameter is null.
|
|
* @param { ValuesBucket } value - Indicates the data to update. This parameter can be null.
|
|
* @returns { Promise<number> } {number}: the number of data records updated.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise<number>;
|
|
|
|
/**
|
|
* Inserts multiple data records into the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { Array<ValuesBucket> } values - Indicates the data records to insert.
|
|
* @param { AsyncCallback<number> } callback - {number}: the number of data records inserted.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
batchInsert(uri: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>): void;
|
|
|
|
/**
|
|
* Inserts multiple data records into the database.
|
|
*
|
|
* @param { string } uri - Indicates the path of the data to operate.
|
|
* @param { Array<ValuesBucket> } values - Indicates the data records to insert.
|
|
* @returns { Promise<number> } {number}: the number of data records inserted.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
batchInsert(uri: string, values: Array<ValuesBucket>): Promise<number>;
|
|
|
|
/**
|
|
* Converts the given {@code uri} that refers to the DataShare into a normalized {@link ohos.utils.net.Uri}.
|
|
* A normalized uri can be used across devices, persisted, backed up, and restored.
|
|
* <p>To transfer a normalized uri from another environment to the current environment, you should call this
|
|
* method again to re-normalize the uri for the current environment or call {@link #denormalizeUri(Uri)}
|
|
* to convert it to a denormalized uri that can be used only in the current environment.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to normalize.
|
|
* @param { AsyncCallback<string> } callback - {string}: the normalized Uri,
|
|
* if the DataShare supports uri normalization.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
normalizeUri(uri: string, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Converts the given {@code uri} that refers to the DataShare into a normalized {@link ohos.utils.net.Uri}.
|
|
* A normalized uri can be used across devices, persisted, backed up, and restored.
|
|
* <p>To transfer a normalized uri from another environment to the current environment, you should call this
|
|
* method again to re-normalize the uri for the current environment or call {@link #denormalizeUri(Uri)}
|
|
* to convert it to a denormalized uri that can be used only in the current environment.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to normalize.
|
|
* @returns { Promise<string> } {string}: the normalized Uri if the DataShare supports uri normalization;
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
normalizeUri(uri: string): Promise<string>;
|
|
|
|
/**
|
|
* Converts the given normalized {@code uri} generated by {@link #normalizeUri(Uri)} into a denormalized one.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to denormalize.
|
|
* @param { AsyncCallback<string> } callback - {string}: the denormalized {@code Uri} object if
|
|
* the denormalization is successful; returns the original {@code Uri} passed to this method if
|
|
* there is nothing to do; returns {@code null} if the data identified by the normalized {@code Uri}
|
|
* cannot be found in the current environment.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
denormalizeUri(uri: string, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Converts the given normalized {@code uri} generated by {@link #normalizeUri(Uri)} into a denormalized one.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to denormalize.
|
|
* @returns { Promise<string> } {string}: the denormalized {@code Uri} object if the denormalization
|
|
* is successful; returns the original {@code Uri} passed to this method if there is nothing to do;
|
|
* returns {@code null} if the data identified by the normalized {@code Uri} cannot be found in the
|
|
* current environment.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
denormalizeUri(uri: string): Promise<string>;
|
|
|
|
/**
|
|
* Notifies the registered observers of a change to the data resource specified by Uri.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to notifyChange.
|
|
* @param { AsyncCallback<void> } callback - The callback of notifyChange.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
notifyChange(uri: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Notifies the registered observers of a change to the data resource specified by Uri.
|
|
*
|
|
* @param { string } uri - Indicates the {@link ohos.utils.net.Uri} object to notifyChange.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 9
|
|
*/
|
|
notifyChange(uri: string): Promise<void>;
|
|
}
|
|
}
|
|
|
|
export default dataShare;
|