harmony 鸿蒙@ohos.application.DataShareExtensionAbility (数据共享扩展能力)

  • 2022-08-09
  • 浏览 (767)

@ohos.application.DataShareExtensionAbility (数据共享扩展能力)

DataShareExtensionAbility基于ExtensionAbility框架，提供支持数据共享业务的能力。

说明：

本模块首批接口从API version 9开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口为系统接口。

本模块接口仅可在Stage模型下使用。

导入模块

import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility';

属性

系统能力：SystemCapability.DistributedDataManager.DataShare.Provider

名称 类型 可读 可写 说明
context10+ ExtensionContext 是 否 表示数据共享扩展能力上下文。

onCreate

onCreate?(want: Want, callback: AsyncCallback<void>): void

DataShare客户端连接DataShareExtensionAbility服务端时，服务端回调此接口，执行初始化业务逻辑操作。该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
want Want 是 Want类型信息，包括Ability名称、Bundle名称等。
callback AsyncCallback<void> 是 回调函数。无返回值。

示例：

import relationalStore from '@ohos.data.relationalStore'
import Want from '@ohos.app.ability.Want'

let DB_NAME = 'DB00.db';
let TBL_NAME = 'TBL00';
let DDL_TBL_CREATE = 'CREATE TABLE IF NOT EXISTS '
  + TBL_NAME
  + ' (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, phoneNumber DOUBLE, isStudent BOOLEAN, Binary BINARY)';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  onCreate(want: Want, callback: Function) {
    relationalStore.getRdbStore(this.context, {
      name: DB_NAME,
      securityLevel: relationalStore.SecurityLevel.S1
    }, (err, data) => {
      console.info(`getRdbStore done, data : ${data}`);
      rdbStore = data;
      rdbStore.executeSql(DDL_TBL_CREATE, [], (err) => {
        console.error(`executeSql done, error message : ${err}`);
      });
      if (callback) {
        callback();
      }
    });
  }
};

insert

insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void

在数据库插入时回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示要插入的数据的路径。
valueBucket ValuesBucket 是 指示要插入的数据。
callback AsyncCallback<number> 是 回调函数。返回插入数据记录的索引。

示例：

import relationalStore from '@ohos.data.relationalStore'
import { ValuesBucket } from '@ohos.data.ValuesBucket'

let TBL_NAME = 'TBL00';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  insert(uri: string, valueBucket: ValuesBucket, callback: Function) {
    if (valueBucket === null) {
      console.error('invalid valueBuckets');
      return;
    }
    rdbStore.insert(TBL_NAME, valueBucket, (err, ret) => {
      console.info(`callback ret: ${ret}`);
      if (callback !== undefined) {
        callback(err, ret);
      }
    });
  }
};

update

update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void

在数据库更新时服务端回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示要更新的数据的路径。
predicates dataSharePredicates.DataSharePredicates 是 指示筛选条件。
valueBucket ValuesBucket 是 指示要更新的数据。
callback AsyncCallback<number> 是 回调函数。返回更新的数据记录数。

示例：

import relationalStore from '@ohos.data.relationalStore';
import dataSharePredicates from '@ohos.data.dataSharePredicates';
import { ValuesBucket } from '@ohos.data.ValuesBucket'

let TBL_NAME = 'TBL00';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  update(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBucket: ValuesBucket, callback: Function) {
    if (predicates === null||predicates === undefined) {
      return;
    }
    rdbStore.update(TBL_NAME, valueBucket, predicates, (err, ret) => {
      if (callback !== undefined) {
        callback(err, ret);
      }
    });
  }
};

delete

delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>): void

在删除数据库记录时服务端回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示要删除的数据的路径。
predicates dataSharePredicates.DataSharePredicates 是 指示筛选条件。
callback AsyncCallback<number> 是 回调函数。返回已删除的数据记录数。

示例：

import relationalStore from '@ohos.data.relationalStore';
import dataSharePredicates from '@ohos.data.dataSharePredicates';

let TBL_NAME = 'TBL00';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: Function) {
    if (predicates === null||predicates === undefined) {
      return;
    }
    rdbStore.delete(TBL_NAME, predicates, (err, ret) => {
      if (callback !== undefined) {
        callback(err, ret);
      }
    });
  }
};

query

query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>): void

在查询数据库时服务端回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示要查询的数据的路径。
predicates dataSharePredicates.DataSharePredicates 是 指示筛选条件。
columns Array<string> 是 指示要查询的列。如果此参数为空，则查询所有列。
callback AsyncCallback<Object> 是 回调函数。返回查询到的结果集。

示例：

import relationalStore from '@ohos.data.relationalStore';
import dataSharePredicates from '@ohos.data.dataSharePredicates';

let TBL_NAME = 'TBL00';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: Function) {
    if (predicates === null||predicates === undefined) {
      return;
    }
    rdbStore.query(TBL_NAME, predicates, columns, (err, resultSet) => {
      if (resultSet !== undefined) {
        console.info(`resultSet.rowCount: ${resultSet.rowCount}`);
      }
      if (callback !== undefined) {
        callback(err, resultSet);
      }
    });
  }
};

batchInsert

batchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void

在数据库批量插入时服务端回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示要批量插入的数据的路径。
valueBuckets Array&lt;ValuesBucket&gt; 是 指示要批量插入的数据。
callback AsyncCallback&lt;number&gt; 是 回调函数。返回插入的数据记录数。

示例：

import relationalStore from '@ohos.data.relationalStore';
import { ValuesBucket } from '@ohos.data.ValuesBucket'

let TBL_NAME = 'TBL00';
let rdbStore: relationalStore.RdbStore;

export default class DataShareExtAbility extends DataShareExtensionAbility {
  batchInsert(uri: string, valueBuckets: Array<ValuesBucket>, callback: Function) {
    if (valueBuckets === null||valueBuckets.length === undefined) {
      console.error('invalid valueBuckets');
      return;
    }
    rdbStore.batchInsert(TBL_NAME, valueBuckets, (err, ret) => {
      if (callback !== undefined) {
        callback(err, ret);
      }
    });
  };
};

normalizeUri

normalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void

用户给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示用户传入的URI。
callback AsyncCallback&lt;string&gt; 是 回调函数。如果支持URI规范化，则返回规范化URI，否则返回空。

示例：

import { BusinessError } from '@ohos.base'

export default class DataShareExtAbility extends DataShareExtensionAbility {
  normalizeUri(uri: string, callback: Function) {
    let key = 'code';
    let value = 0;
    let err: BusinessError = {
      code: value,
      name: key,
      message: key
    };
    let ret: string = `normalize: ${uri}`;
    callback(err, ret);
  }
};

denormalizeUri

denormalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void

服务端使用的URI转换为用户传入的初始URI时服务端回调此接口，该方法可以选择性重写。

系统能力： SystemCapability.DistributedDataManager.DataShare.Provider

参数：

参数名 类型 必填 说明
uri string 是 指示服务端使用的URI。
callback AsyncCallback&lt;string&gt; 是 回调函数。如果反规范化成功，则返回反规范化的URI；如果无需进行反规范化，则返回原始URI；若不支持则返回空。

示例：

import { BusinessError } from '@ohos.base'

export default class DataShareExtAbility extends DataShareExtensionAbility {
  denormalizeUri(uri: string, callback: Function) {
    let key = 'code';
    let value = 0;
    let err: BusinessError = {
      code: value,
      name: key,
      message: key
    };
      let ret = `denormalize ${uri}`;
      callback(err, ret);
  }
};

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞
  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/3dad9c8b589b49fd9a82c409c89c4beb
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录