Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 aed19735 编写于 作者: G ge-yafang
浏览文件
操作

update docs 

Signed-off-by: Nge-yafang <geyafang@huawei.com>
上级 f3dc9f8d
展开全部 显示空白变更内容
内联 并排
Showing with 565 addition and 464 deletion
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @ aed19735
......@@ -311,7 +311,6 @@ class EntryAbility extends UIAbility {
}
```
## data_preferences.deletePreferences
deletePreferences(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
......@@ -733,11 +732,11 @@ class EntryAbility extends UIAbility {
}
```
## data_preferences.removePreferencesFromCacheSync<sup>10+</sup>
## data_preferences.removePreferencesFromCache<sup>10+</sup>
removePreferencesFromCacheSync(context: Context, name: string): void
removePreferencesFromCache(context: Context, options: Options, callback: AsyncCallback&lt;void&gt;): void
从缓存中移出指定的Preferences实例，此为同步接口。
从缓存中移出指定的Preferences实例，使用callback异步回调。
应用首次调用[getPreferences](#data_preferencesgetpreferences)接口获取某个Preferences实例后，该实例会被会被缓存起来，后续再次[getPreferences](#data_preferencesgetpreferences)时不会再次从持久化文件中读取，直接从缓存中获取Preferences实例。调用此接口移出缓存中的实例之后，再次getPreferences将会重新读取持久化文件，生成新的Preferences实例。
......@@ -748,9 +747,19 @@ removePreferencesFromCacheSync(context: Context, name: string): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------- | ---- | ----------------------- |
| -------- | ------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| context | Context | 是 | 应用上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| name | string | 是 | Preferences实例的名称。 |
| options | [Options](#options10) | 是 | 与Preferences实例相关的配置选项。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[用户首选项错误码](../errorcodes/errorcode-preferences.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------ |
| 15501001 | Only supported in stage mode. |
| 15501002 | The data group id is not valid. |
**示例：**
......@@ -761,8 +770,14 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
try {
data_preferences.removePreferencesFromCacheSync(context, 'mystore');
} catch(err) {
data_preferences.removePreferencesFromCache(context, { name: 'mystore' }, function (err) {
if (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in removing preferences.");
})
} catch (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
......@@ -775,8 +790,14 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
try {
data_preferences.removePreferencesFromCacheSync(this.context, 'mystore');
} catch(err) {
data_preferences.removePreferencesFromCache(this.context, { name: 'mystore', dataGroupId:'myId' }, function (err) {
if (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in removing preferences.");
})
} catch (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
}
......@@ -785,9 +806,9 @@ class EntryAbility extends UIAbility {
## data_preferences.removePreferencesFromCache<sup>10+</sup>
removePreferencesFromCache(context: Context, options: Options, callback: AsyncCallback&lt;void&gt;): void
removePreferencesFromCache(context: Context, options: Options): Promise&lt;void&gt;
从缓存中移出指定的Preferences实例，使用callback异步回调。
从缓存中移出指定的Preferences实例，使用Promise异步回调。
应用首次调用[getPreferences](#data_preferencesgetpreferences)接口获取某个Preferences实例后，该实例会被会被缓存起来，后续再次[getPreferences](#data_preferencesgetpreferences)时不会再次从持久化文件中读取，直接从缓存中获取Preferences实例。调用此接口移出缓存中的实例之后，再次getPreferences将会重新读取持久化文件，生成新的Preferences实例。
......@@ -798,10 +819,15 @@ removePreferencesFromCache(context: Context, options: Options, callback: AsyncCa
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ------- | ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| context | Context | 是 | 应用上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| options | [Options](#options10) | 是 | 与Preferences实例相关的配置选项。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功，err为undefined，否则为错误对象。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
......@@ -821,14 +847,13 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
try {
data_preferences.removePreferencesFromCache(context, { name: 'mystore' }, function (err) {
if (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
let promise = data_preferences.removePreferencesFromCache(context, { name: 'mystore' });
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
} catch (err) {
} catch(err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
......@@ -841,25 +866,24 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
try {
data_preferences.removePreferencesFromCache(this.context, { name: 'mystore', dataGroupId:'myId' }, function (err) {
if (err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
let promise = data_preferences.removePreferencesFromCache(this.context, { name: 'mystore', dataGroupId:'myId' });
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
} catch (err) {
} catch(err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
}
}
```
## data_preferences.removePreferencesFromCache<sup>10+</sup>
## data_preferences.removePreferencesFromCacheSync<sup>10+</sup>
removePreferencesFromCache(context: Context, options: Options): Promise&lt;void&gt;
removePreferencesFromCacheSync(context: Context, options: Options):void
从缓存中移出指定的Preferences实例，使用Promise异步回调。
从缓存中移出指定的Preferences实例，此为同步接口。
应用首次调用[getPreferences](#data_preferencesgetpreferences)接口获取某个Preferences实例后，该实例会被会被缓存起来，后续再次[getPreferences](#data_preferencesgetpreferences)时不会再次从持久化文件中读取，直接从缓存中获取Preferences实例。调用此接口移出缓存中的实例之后，再次getPreferences将会重新读取持久化文件，生成新的Preferences实例。
......@@ -870,22 +894,16 @@ removePreferencesFromCache(context: Context, options: Options): Promise&lt;void&
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ------- | --------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| options | [Options](#options10) | 是 | 与Preferences实例相关的配置选项。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[用户首选项错误码](../errorcodes/errorcode-preferences.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------ |
| -------- | ------------------------------- |
| 15501001 | Only supported in stage mode. |
| 15501002 | The data group id is not valid. |
......@@ -898,12 +916,7 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
try {
let promise = data_preferences.removePreferencesFromCache(context, { name: 'mystore' });
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
data_preferences.removePreferencesFromCacheSync(context, { name: 'mystore' });
} catch(err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
......@@ -917,12 +930,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
try {
let promise = data_preferences.removePreferencesFromCache(this.context, { name: 'mystore', dataGroupId:'myId' });
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
data_preferences.removePreferencesFromCacheSync(this.context, { name: 'mystore', dataGroupId:'myId' });
} catch(err) {
console.error("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
......
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ aed19735
......@@ -18,6 +18,8 @@
```js
import data_rdb from '@ohos.data.rdb';
import { BusinessError } from "@ohos.base"
import window from '@ohos.window';
```
## data_rdb.getRdbStore
......@@ -43,11 +45,11 @@ FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
let context: Context;
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
data_rdb.getRdbStore(context, STORE_CONFIG, 1, (err, rdbStore) => {
if (err) {
console.info("Get RdbStore failed, err: " + err)
return
......@@ -62,22 +64,23 @@ Stage模型示例：
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
let context;
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
context = this.context
}
let context: Context;
interface storeConfig {
name: string
}
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage){
let STORE_CONFIG: storeConfig = { name: "RdbTest.db"};
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, (err: BusinessError, rdbStore: data_rdb.RdbStore) => {
if (err) {
console.info("Get RdbStore failed, err: " + err)
return
}
console.log("Get RdbStore successfully.")
})
})
}
}
```
## data_rdb.getRdbStore
......@@ -109,7 +112,7 @@ FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
let context: Context;
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
......@@ -127,19 +130,22 @@ Stage模型示例：
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
let context;
let context: Context;
interface storeConfig {
name: string
}
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
onWindowStageCreate(windowStage: window.WindowStage){
context = this.context
}
}
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
let STORE_CONFIG: storeConfig = { name: "RdbTest.db"};
let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {
promise.then(async (rdbStore: data_rdb.RdbStore) => {
console.log("Get RdbStore successfully.")
}).catch((err) => {
}).catch((err: BusinessError) => {
console.log("Get RdbStore failed, err: " + err)
})
```
......@@ -167,10 +173,10 @@ FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
let context: Context;
// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
data_rdb.deleteRdbStore(context, "RdbTest.db", (err) => {
if (err) {
console.info("Delete RdbStore failed, err: " + err)
return
......@@ -185,15 +191,15 @@ Stage模型示例：
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
let context;
let context: Context;
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
onWindowStageCreate(windowStage: window.WindowStage){
context = this.context
}
}
// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
data_rdb.deleteRdbStore(context, "RdbTest.db", (err) => {
if (err) {
console.info("Delete RdbStore failed, err: " + err)
return
......@@ -230,7 +236,7 @@ FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
let context: Context;
// 获取context后调用deleteRdbStore
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
......@@ -247,9 +253,9 @@ Stage模型示例：
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
let context;
let context: Context;
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
onWindowStageCreate(windowStage: window.WindowStage){
context = this.context
}
}
......@@ -258,7 +264,7 @@ class EntryAbility extends UIAbility {
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
promise.then(()=>{
console.log("Delete RdbStore successfully.")
}).catch((err) => {
}).catch((err: BusinessError) => {
console.info("Delete RdbStore failed, err: " + err)
})
```
......@@ -371,8 +377,8 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates
```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
let deviceIds = [];
let dmInstance: deviceManager.DeviceManager = null;
let deviceIds: Array<string> = [];
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
......@@ -381,7 +387,7 @@ deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager)
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
for (var i = 0; i < devices.length; i++) {
for (let i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或