Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 23949e52 编写于 作者: S swx1239486
浏览文件
操作

Merge branch 'master' of https://gitee.com/playing-song/docs

上级 ca00e7f4 06d2605c
展开全部 显示空白变更内容
内联 并排
Showing with 15183 addition and 11657 deletion
.gitattributes
浏览文件 @ 23949e52
...@@ -17,3 +17,4 @@ OpenHarmony_Icons.zip filter=lfs diff=lfs merge=lfs -text ...@@ -17,3 +17,4 @@ OpenHarmony_Icons.zip filter=lfs diff=lfs merge=lfs -text
zip filter=lfs diff=lfs merge=lfs -text zip filter=lfs diff=lfs merge=lfs -text
figures/OpenHarmony_Icons.zip filter=lfs diff=lfs merge=lfs -text figures/OpenHarmony_Icons.zip filter=lfs diff=lfs merge=lfs -text
figures/OpenHarmony应用图标模版.zip filter=lfs diff=lfs merge=lfs -text figures/OpenHarmony应用图标模版.zip filter=lfs diff=lfs merge=lfs -text
figures/OpenHarmony_天气应用UX设计交付件_V1.0.zip filter=lfs diff=lfs merge=lfs -text
en/application-dev/file-management/app-file-access.md
浏览文件 @ 23949e52
...@@ -36,7 +36,7 @@ You can use [ohos.file.fs](../reference/apis/js-apis-file-fs.md) to implement ac ...@@ -36,7 +36,7 @@ You can use [ohos.file.fs](../reference/apis/js-apis-file-fs.md) to implement ac
First, obtain the [application file path](../application-models/application-context-stage.md#obtaining-application-file-paths). The following example shows how to obtain a HAP file path using **UIAbilityContext**. For details about how to obtain **UIAbilityContext**, see [Obtaining the Context of UIAbility](../application-models/uiability-usage.md#obtaining-the-context-of-uiability). First, obtain the [application file path](../application-models/application-context-stage.md#obtaining-application-file-paths). The following example shows how to obtain a HAP file path using **UIAbilityContext**. For details about how to obtain **UIAbilityContext**, see [Obtaining the Context of UIAbility](../application-models/uiability-usage.md#obtaining-the-context-of-uiability).
Then, perform common file operations. Then, perform file operations.
### Creating, Reading, and Writing a File ### Creating, Reading, and Writing a File
...@@ -46,21 +46,29 @@ The following example demonstrates how to create a file, read data from it, and ...@@ -46,21 +46,29 @@ The following example demonstrates how to create a file, read data from it, and
// pages/xxx.ets // pages/xxx.ets
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
import buffer from '@ohos.buffer';
function createFile() { // Obtain the application file path.
// Obtain the application file path. let context = getContext(this) as common.UIAbilityContext;
let context = getContext(this) as common.UIAbilityContext; let filesDir = context.filesDir;
let filesDir = context.filesDir;
function createFile() {
// Create a file and open it. // Create a file and open it.
let file = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); let file = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
// Write data to the file. // Write data to the file.
let writeLen = fs.writeSync(file.fd, "Try to write str."); let writeLen = fs.writeSync(file.fd, "Try to write str.");
console.info("The length of str is: " + writeLen); console.info("The length of str is: " + writeLen);
// Read data from the file. // Read data from the file.
let buf = new ArrayBuffer(1024); let arrayBuffer = new ArrayBuffer(1024);
let readLen = fs.readSync(file.fd, buf, { offset: 0 }); class Option {
console.info("the content of file: " + String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen)))); public offset: number = 0;
public length: number;
}
let option = new Option();
option.length = arrayBuffer.byteLength;
let readLen = fs.readSync(file.fd, arrayBuffer, option);
let buf = buffer.from(arrayBuffer, 0, readLen);
console.info("the content of file: " + buf.toString());
// Close the file. // Close the file.
fs.closeSync(file); fs.closeSync(file);
} }
...@@ -75,11 +83,11 @@ function createFile() { ...@@ -75,11 +83,11 @@ function createFile() {
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
function readWriteFile() { // Obtain the application file path.
// Obtain the application file path. let context = getContext(this) as common.UIAbilityContext;
let context = getContext(this) as common.UIAbilityContext; let filesDir = context.filesDir;
let filesDir = context.filesDir;
function readWriteFile() {
// Open the source and destination files. // Open the source and destination files.
let srcFile = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE); let srcFile = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE);
let destFile = fs.openSync(filesDir + '/destFile.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); let destFile = fs.openSync(filesDir + '/destFile.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
...@@ -87,11 +95,18 @@ function readWriteFile() { ...@@ -87,11 +95,18 @@ function readWriteFile() {
let bufSize = 4096; let bufSize = 4096;
let readSize = 0; let readSize = 0;
let buf = new ArrayBuffer(bufSize); let buf = new ArrayBuffer(bufSize);
let readLen = fs.readSync(srcFile.fd, buf, { offset: readSize }); class Option {
public offset: number = 0;
public length: number = bufSize;
}
let option = new Option();
option.offset = readSize;
let readLen = fs.readSync(srcFile.fd, buf, option);
while (readLen > 0) { while (readLen > 0) {
readSize += readLen; readSize += readLen;
fs.writeSync(destFile.fd, buf); fs.writeSync(destFile.fd, buf);
readLen = fs.readSync(srcFile.fd, buf, { offset: readSize }); option.offset = readSize;
readLen = fs.readSync(srcFile.fd, buf, option);
} }
// Close the files. // Close the files.
fs.closeSync(srcFile); fs.closeSync(srcFile);
...@@ -112,11 +127,11 @@ The following example demonstrates how to read and write file data using a strea ...@@ -112,11 +127,11 @@ The following example demonstrates how to read and write file data using a strea
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
async function readWriteFileWithStream() { // Obtain the application file path.
// Obtain the application file path. let context = getContext(this) as common.UIAbilityContext;
let context = getContext(this) as common.UIAbilityContext; let filesDir = context.filesDir;
let filesDir = context.filesDir;
async function readWriteFileWithStream() {
// Open the file streams. // Open the file streams.
let inputStream = fs.createStreamSync(filesDir + '/test.txt', 'r+'); let inputStream = fs.createStreamSync(filesDir + '/test.txt', 'r+');
let outputStream = fs.createStreamSync(filesDir + '/destFile.txt', "w+"); let outputStream = fs.createStreamSync(filesDir + '/destFile.txt', "w+");
...@@ -124,11 +139,18 @@ async function readWriteFileWithStream() { ...@@ -124,11 +139,18 @@ async function readWriteFileWithStream() {
let bufSize = 4096; let bufSize = 4096;
let readSize = 0; let readSize = 0;
let buf = new ArrayBuffer(bufSize); let buf = new ArrayBuffer(bufSize);
let readLen = await inputStream.read(buf, { offset: readSize }); class Option {
public offset: number = 0;
public length: number = bufSize;
}
let option = new Option();
option.offset = readSize;
let readLen = await inputStream.read(buf, option);
readSize += readLen; readSize += readLen;
while (readLen > 0) { while (readLen > 0) {
await outputStream.write(buf); await outputStream.write(buf);
readLen = await inputStream.read(buf, { offset: readSize }); option.offset = readSize;
readLen = await inputStream.read(buf, option);
readSize += readLen; readSize += readLen;
} }
// Close the streams. // Close the streams.
...@@ -148,8 +170,7 @@ async function readWriteFileWithStream() { ...@@ -148,8 +170,7 @@ async function readWriteFileWithStream() {
The following example demonstrates how to list files that meet the specified conditions. The following example demonstrates how to list files that meet the specified conditions.
```ts ```ts
// List files. import fs, { Filter } from '@ohos.file.fs';
import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
// Obtain the application file path. // Obtain the application file path.
...@@ -157,18 +178,20 @@ let context = getContext(this) as common.UIAbilityContext; ...@@ -157,18 +178,20 @@ let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir; let filesDir = context.filesDir;
// List files that meet the specified conditions. // List files that meet the specified conditions.
let options = { function getListFile() {
recursion: false, class ListFileOption {
listNum: 0, public recursion: boolean = false;
filter: { public listNum: number = 0;
suffix: ['.png', '.jpg', '.txt'], // The filename extension can be '.png', '.jpg', or '.txt'. public filter: Filter
displayName: ['test%'], // The filename starts with 'test'. }
fileSizeOver: 0, // The file size is greater than or equal to 0. let option = new ListFileOption();
lastModifiedAfter: new Date(0).getTime(), // The latest modification time of the file is later than January 1, 1970. option.filter.suffix = ['.png', '.jpg', '.txt']; // The filen ame extension can be '.png', '.jpg', or '.txt'.
}, option.filter.displayName = ['test%']; // The file name starts with 'test'.
} option.filter.fileSizeOver = 0; // The file size is greater than or equal to 0.
let files = fs.listFileSync(filesDir, options); option.filter.lastModifiedAfter = new Date(0).getTime(); // The latest modification time of the file is later than January 1, 1970.
for (let i = 0; i < files.length; i++) { let files = fs.listFileSync(filesDir, option);
for (let i = 0; i < files.length; i++) {
console.info(`The name of file: ${files[i]}`); console.info(`The name of file: ${files[i]}`);
}
} }
``` ```
en/application-dev/file-management/app-file-backup.md
浏览文件 @ 23949e52
...@@ -32,17 +32,25 @@ The capability file of an application contains the device type, device version, ...@@ -32,17 +32,25 @@ The capability file of an application contains the device type, device version,
Use **backup.getLocalCapabilities()** to obtain capability files. Use **backup.getLocalCapabilities()** to obtain capability files.
```js ```ts
import backup from '@ohos.file.backup';
import common from '@ohos.app.ability.common';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
// Obtain the application file path.
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;
async function getLocalCapabilities() { async function getLocalCapabilities() {
try { try {
let fileData = await backup.getLocalCapabilities(); let fileData = await backup.getLocalCapabilities();
console.info('getLocalCapabilities success'); console.info('getLocalCapabilities success');
let fpath = await globalThis.context.filesDir + '/localCapabilities.json'; let fpath = filesDir + '/localCapabilities.json';
fs.copyFileSync(fileData.fd, fpath); fs.copyFileSync(fileData.fd, fpath);
fs.closeSync(fileData.fd); fs.closeSync(fileData.fd);
} catch (err) { } catch (error) {
console.error('getLocalCapabilities failed with err: ' + err); let err: BusinessError = error as BusinessError;
console.error('getLocalCapabilities failed with err: ' + JSON.stringify(err));
} }
} }
``` ```
...@@ -88,17 +96,24 @@ You can save the file to a local directory as required. ...@@ -88,17 +96,24 @@ You can save the file to a local directory as required.
**Example** **Example**
```ts ```ts
import backup from '@ohos.file.backup';
import common from '@ohos.app.ability.common';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
// Obtain the sandbox path.
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;
// Create a SessionBackup instance for data backup. // Create a SessionBackup instance for data backup.
let g_session; let g_session: backup.SessionBackup;
function createSessionBackup() { function createSessionBackup() {
let sessionBackup = new backup.SessionBackup({ let generalCallbacks: backup.GeneralCallbacks = {
onFileReady: async (err, file) => { onFileReady: (err: BusinessError, file: backup.File) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + JSON.stringify(err));
} }
try { try {
let bundlePath = await globalThis.context.filesDir + '/' + file.bundleName; let bundlePath = filesDir + '/' + file.bundleName;
if (!fs.accessSync(bundlePath)) { if (!fs.accessSync(bundlePath)) {
fs.mkdirSync(bundlePath); fs.mkdirSync(bundlePath);
} }
...@@ -109,23 +124,23 @@ You can save the file to a local directory as required. ...@@ -109,23 +124,23 @@ You can save the file to a local directory as required.
console.error('onFileReady failed with err: ' + e); console.error('onFileReady failed with err: ' + e);
} }
}, },
onBundleBegin: (err, bundleName) => { onBundleBegin: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.info('onBundleBegin err: ' + err); console.info('onBundleBegin err: ' + JSON.stringify(err));
} else { } else {
console.info('onBundleBegin bundleName: ' + bundleName); console.info('onBundleBegin bundleName: ' + bundleName);
} }
}, },
onBundleEnd: (err, bundleName) => { onBundleEnd: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.info('onBundleEnd err: ' + err); console.info('onBundleEnd err: ' + JSON.stringify(err));
} else { } else {
console.info('onBundleEnd bundleName: ' + bundleName); console.info('onBundleEnd bundleName: ' + bundleName);
} }
}, },
onAllBundlesEnd: (err) => { onAllBundlesEnd: (err: BusinessError) => {
if (err) { if (err) {
console.info('onAllBundlesEnd err: ' + err); console.info('onAllBundlesEnd err: ' + JSON.stringify(err));
} else { } else {
console.info('onAllBundlesEnd'); console.info('onAllBundlesEnd');
} }
...@@ -133,16 +148,16 @@ You can save the file to a local directory as required. ...@@ -133,16 +148,16 @@ You can save the file to a local directory as required.
onBackupServiceDied: () => { onBackupServiceDied: () => {
console.info('onBackupServiceDied'); console.info('onBackupServiceDied');
}, },
}); }
let sessionBackup = new backup.SessionBackup(generalCallbacks);
return sessionBackup; return sessionBackup;
} }
async function sessionBackup () async function sessionBackup () {
{
g_session = createSessionBackup(); g_session = createSessionBackup();
// Select the application to be backed up based on the capability file obtained by backup.getLocalCapabilities(). // Select the application to be backed up based on the capability file obtained by backup.getLocalCapabilities().
// You can also back up data based on the application bundle name. // You can also back up data based on the application bundle name.
const backupApps = [ const backupApps: string[] = [
"com.example.hiworld", "com.example.hiworld",
] ]
await g_session.appendBundles(backupApps); await g_session.appendBundles(backupApps);
...@@ -161,24 +176,26 @@ When all the data of the application is ready, the service starts to restore the ...@@ -161,24 +176,26 @@ When all the data of the application is ready, the service starts to restore the
**Example** **Example**
```ts ```ts
import backup from '@ohos.file.backup';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
// Create a SessionRestore instance for data restoration. // Create a SessionRestore instance for data restoration.
let g_session; let g_session: backup.SessionRestore;
async function publishFile(file) async function publishFile(file: backup.File) {
{ let fileMeta: backup.FileMeta = {
await g_session.publishFile({
bundleName: file.bundleName, bundleName: file.bundleName,
uri: file.uri uri: file.uri
}); }
await g_session.publishFile(fileMeta);
} }
function createSessionRestore() { function createSessionRestore() {
let sessionRestore = new backup.SessionRestore({ let generalCallbacks: backup.GeneralCallbacks = {
onFileReady: (err, file) => { onFileReady: (err: BusinessError, file: backup.File) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + JSON.stringify(err));
} }
// Set bundlePath based on the actual situation. // Set bundlePath based on the actual situation.
let bundlePath; let bundlePath: string;
if (!fs.accessSync(bundlePath)) { if (!fs.accessSync(bundlePath)) {
console.info('onFileReady bundlePath err : ' + bundlePath); console.info('onFileReady bundlePath err : ' + bundlePath);
} }
...@@ -188,52 +205,51 @@ When all the data of the application is ready, the service starts to restore the ...@@ -188,52 +205,51 @@ When all the data of the application is ready, the service starts to restore the
publishFile(file); publishFile(file);
console.info('onFileReady success'); console.info('onFileReady success');
}, },
onBundleBegin: (err, bundleName) => { onBundleBegin: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.error('onBundleBegin failed with err: ' + err); console.error('onBundleBegin failed with err: ' + JSON.stringify(err));
} }
console.info('onBundleBegin success'); console.info('onBundleBegin success');
}, },
onBundleEnd: (err, bundleName) => { onBundleEnd: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.error('onBundleEnd failed with err: ' + err); console.error('onBundleEnd failed with err: ' + JSON.stringify(err));
} }
console.info('onBundleEnd success'); console.info('onBundleEnd success');
}, },
onAllBundlesEnd: (err) => { onAllBundlesEnd: (err: BusinessError) => {
if (err) { if (err) {
console.error('onAllBundlesEnd failed with err: ' + err); console.error('onAllBundlesEnd failed with err: ' + JSON.stringify(err));
} }
console.info('onAllBundlesEnd success'); console.info('onAllBundlesEnd success');
}, },
onBackupServiceDied: () => { onBackupServiceDied: () => {
console.info('service died'); console.info('service died');
} }
}); }
let sessionRestore = new backup.SessionRestore(generalCallbacks);
return sessionRestore; return sessionRestore;
} }
async function restore () async function restore01 () {
{
g_session = createSessionRestore(); g_session = createSessionRestore();
const backupApps = [ const restoreApps: string[] = [
"com.example.hiworld", "com.example.hiworld",
] ]
// You can obtain the capability file based on actual situation. The following is an example only. // You can obtain the capability file based on actual situation. The following is an example only.
// You can also construct capability files as required. // You can also construct capability files as required.
let fileData = await backup.getLocalCapabilities(); let fileData = await backup.getLocalCapabilities();
await g_session.appendBundles(fileData.fd, backupApps); await g_session.appendBundles(fileData.fd, restoreApps);
console.info('appendBundles success'); console.info('appendBundles success');
// After the applications to be restored are added, call getFileHandle() to obtain the handles of the application files to be restored based on the application name. // After the applications to be restored are added, call getFileHandle() to obtain the handles of the application files to be restored based on the application name.
// The number of application data files to be restored varies depending on the number of backup files. The following is only an example. // The number of application data files to be restored varies depending on the number of backup files. The following is only an example.
await g_session.getFileHandle({ let handle: backup.FileMeta = {
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "manage.json" uri: "manage.json"
}); }
await g_session.getFileHandle({ await g_session.getFileHandle(handle);
bundleName: restoreApps[0], handle.uri = "1.tar";
uri: "1.tar" await g_session.getFileHandle(handle);
});
console.info('getFileHandle success'); console.info('getFileHandle success');
} }
``` ```
...@@ -249,23 +265,30 @@ If the application has not been installed, you can install the application and t ...@@ -249,23 +265,30 @@ If the application has not been installed, you can install the application and t
**Example** **Example**
```ts ```ts
import backup from '@ohos.file.backup';
import common from '@ohos.app.ability.common';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
// Obtain the sandbox path.
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;
// Create a SessionRestore instance for data restoration. // Create a SessionRestore instance for data restoration.
let g_session; let g_session: backup.SessionRestore;
async function publishFile(file) async function publishFile(file: backup.File) {
{ let fileMeta: backup.FileMeta = {
await g_session.publishFile({
bundleName: file.bundleName, bundleName: file.bundleName,
uri: file.uri uri: file.uri
}); }
await g_session.publishFile(fileMeta);
} }
function createSessionRestore() { function createSessionRestore() {
let sessionRestore = new backup.SessionRestore({ let generalCallbacks: backup.GeneralCallbacks = {
onFileReady: (err, file) => { onFileReady: (err: BusinessError, file: backup.File) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + JSON.stringify(err));
} }
let bundlePath; let bundlePath: string;
if( file.uri == "/data/storage/el2/restore/bundle.hap" ) if( file.uri == "/data/storage/el2/restore/bundle.hap" )
{ {
// Set the path of the application installation package based on actual situation. // Set the path of the application installation package based on actual situation.
...@@ -281,61 +304,57 @@ If the application has not been installed, you can install the application and t ...@@ -281,61 +304,57 @@ If the application has not been installed, you can install the application and t
publishFile(file); publishFile(file);
console.info('onFileReady success'); console.info('onFileReady success');
}, },
onBundleBegin: (err, bundleName) => { onBundleBegin: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.error('onBundleBegin failed with err: ' + err); console.error('onBundleBegin failed with err: ' + JSON.stringify(err));
} }
console.info('onBundleBegin success'); console.info('onBundleBegin success');
}, },
onBundleEnd: (err, bundleName) => { onBundleEnd: (err: BusinessError, bundleName: string) => {
if (err) { if (err) {
console.error('onBundleEnd failed with err: ' + err); console.error('onBundleEnd failed with err: ' + JSON.stringify(err));
} }
console.info('onBundleEnd success'); console.info('onBundleEnd success');
}, },
onAllBundlesEnd: (err) => { onAllBundlesEnd: (err: BusinessError) => {
if (err) { if (err) {
console.error('onAllBundlesEnd failed with err: ' + err); console.error('onAllBundlesEnd failed with err: ' + JSON.stringify(err));
} }
console.info('onAllBundlesEnd success'); console.info('onAllBundlesEnd success');
}, },
onBackupServiceDied: () => { onBackupServiceDied: () => {
console.info('service died'); console.info('service died');
} }
}); }
let sessionRestore = new backup.SessionRestore(generalCallbacks);
return sessionRestore; return sessionRestore;
} }
async function restore () async function restore02 () {
{
g_session = createSessionRestore(); g_session = createSessionRestore();
const backupApps = [ const restoreApps: string[] = [
"com.example.hiworld", "com.example.hiworld",
] ]
let fpath = await globalThis.context.filesDir + '/localCapabilities.json'; let fpath = filesDir + '/localCapabilities.json';
let file = fs.openSync(fpath, fileIO.OpenMode.CREATE | fileIO.OpenMode.READ_WRITE); let file = fs.openSync(fpath, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
let content = "{\"bundleInfos\" :[{\"allToBackup\" : false,\"extensionName\" : \"\"," + let content = "{\"bundleInfos\" :[{\"allToBackup\" : false,\"extensionName\" : \"\"," +
"\"name\" : \"cn.openharmony.inputmethodchoosedialog\",\"needToInstall\" : true,\"spaceOccupied\" : 0," + "\"name\" : \"cn.openharmony.inputmethodchoosedialog\",\"needToInstall\" : true,\"spaceOccupied\" : 0," +
"\"versionCode\" : 1000000,\"versionName\" : \"1.0.0\"}],\"deviceType\" : \"default\",\"systemFullName\" : \"OpenHarmony-4.0.6.2(Canary1)\"}"; "\"versionCode\" : 1000000,\"versionName\" : \"1.0.0\"}],\"deviceType\" : \"default\",\"systemFullName\" : \"OpenHarmony-4.0.6.2(Canary1)\"}";
fs.writeSync(file.fd, content); fs.writeSync(file.fd, content);
fs.fsyncSync(file.fd); fs.fsyncSync(file.fd);
await g_session.appendBundles(file.fd, backupApps); await g_session.appendBundles(file.fd, restoreApps);
console.info('appendBundles success'); console.info('appendBundles success');
// Obtain the file handle of the application to be installed. // Obtain the file handle of the application to be installed.
await g_session.getFileHandle({ let handle: backup.FileMeta = {
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "/data/storage/el2/restore/bundle.hap" uri: "/data/storage/el2/restore/bundle.hap"
}); }
await g_session.getFileHandle(handle);
await g_session.getFileHandle({ handle.uri = "manage.json";
bundleName: restoreApps[0], await g_session.getFileHandle(handle);
uri: "manage.json" handle.uri = "1.tar";
}); await g_session.getFileHandle(handle);
await g_session.getFileHandle({
bundleName: restoreApps[0],
uri: "1.tar"
});
console.info('getFileHandle success'); console.info('getFileHandle success');
} }
``` ```
......
en/application-dev/file-management/app-file-upload-download.md
浏览文件 @ 23949e52
...@@ -19,6 +19,7 @@ The following example demonstrates how to upload a file in the **cache** directo ...@@ -19,6 +19,7 @@ The following example demonstrates how to upload a file in the **cache** directo
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import request from '@ohos.request'; import request from '@ohos.request';
import { BusinessError } from '@ohos.base';
// Obtain the application file path. // Obtain the application file path.
let context = getContext(this) as common.UIAbilityContext; let context = getContext(this) as common.UIAbilityContext;
...@@ -30,32 +31,36 @@ fs.writeSync(file.fd, 'upload file test'); ...@@ -30,32 +31,36 @@ fs.writeSync(file.fd, 'upload file test');
fs.closeSync(file); fs.closeSync(file);
// Configure the upload task. // Configure the upload task.
let uploadConfig = { let header = new Map<Object, string>();
header.set('key1', 'value1');
header.set('key2', 'value2');
let files: Array<request.File> = [
{ filename: 'test.txt', name: 'test', uri: 'internal://cache/test.txt', type: 'txt' }
]
let data: Array<request.RequestData> = [{ name: 'name', value: 'value' }];
let uploadConfig: request.UploadConfig = {
url: 'https://xxx', url: 'https://xxx',
header: { key1: 'value1', key2: 'value2' }, header: header,
method: 'POST', method: 'POST',
files: [ files: files,
{ filename: 'test.txt', name: 'test', uri: 'internal://cache/test.txt', type: 'txt' } data: data
],
data: [
{ name: 'name', value: 'value' }
]
} }
// Upload the created application file to the network server. // Upload the created application file to the network server.
try { try {
request.uploadFile(context, uploadConfig) request.uploadFile(context, uploadConfig)
.then((uploadTask) => { .then((uploadTask: request.UploadTask) => {
uploadTask.on('complete', (taskStates) => { uploadTask.on('complete', (taskStates: Array<request.TaskState>) => {
for (let i = 0; i < taskStates.length; i++) { for (let i = 0; i < taskStates.length; i++) {
console.info(`upload complete taskState: ${JSON.stringify(taskStates[i])}`); console.info(`upload complete taskState: ${JSON.stringify(taskStates[i])}`);
} }
}); });
}) })
.catch((err) => { .catch((err: BusinessError) => {
console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`);
}) })
} catch (err) { } catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -78,6 +83,8 @@ The following example demonstrates how to download a network resource file to a ...@@ -78,6 +83,8 @@ The following example demonstrates how to download a network resource file to a
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import request from '@ohos.request'; import request from '@ohos.request';
import { BusinessError } from '@ohos.base';
import buffer from '@ohos.buffer';
// Obtain the application file path. // Obtain the application file path.
let context = getContext(this) as common.UIAbilityContext; let context = getContext(this) as common.UIAbilityContext;
...@@ -87,19 +94,21 @@ try { ...@@ -87,19 +94,21 @@ try {
request.downloadFile(context, { request.downloadFile(context, {
url: 'https://xxxx/xxxx.txt', url: 'https://xxxx/xxxx.txt',
filePath: filesDir + '/xxxx.txt' filePath: filesDir + '/xxxx.txt'
}).then((downloadTask) => { }).then((downloadTask: request.DownloadTask) => {
downloadTask.on('complete', () => { downloadTask.on('complete', () => {
console.info('download complete'); console.info('download complete');
let file = fs.openSync(filesDir + '/xxxx.txt', fs.OpenMode.READ_WRITE); let file = fs.openSync(filesDir + '/xxxx.txt', fs.OpenMode.READ_WRITE);
let buf = new ArrayBuffer(1024); let arrayBuffer = new ArrayBuffer(1024);
let readLen = fs.readSync(file.fd, buf); let readLen = fs.readSync(file.fd, arrayBuffer);
console.info(`The content of file: ${String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen)))}`); let buf = buffer.from(arrayBuffer, 0, readLen);
console.info(`The content of file: ${buf.toString()}`);
fs.closeSync(file); fs.closeSync(file);
}) })
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke downloadTask failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke downloadTask failed, code is ${err.code}, message is ${err.message}`);
}); });
} catch (err) { } catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Invoke downloadFile failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke downloadFile failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
en/application-dev/file-management/app-fs-space-statistics.md
浏览文件 @ 23949e52
...@@ -28,9 +28,10 @@ For details about the APIs, see [ohos.file.statvfs](../reference/apis/js-apis-fi ...@@ -28,9 +28,10 @@ For details about the APIs, see [ohos.file.statvfs](../reference/apis/js-apis-fi
```ts ```ts
import statvfs from '@ohos.file.statvfs'; import statvfs from '@ohos.file.statvfs';
import { BusinessError } from '@ohos.base';
let path = "/data"; let path = "/data";
statvfs.getFreeSize(path, (err, number) => { statvfs.getFreeSize(path, (err: BusinessError, number: number) => {
if (err) { if (err) {
console.error(`Invoke getFreeSize failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke getFreeSize failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -43,8 +44,9 @@ For details about the APIs, see [ohos.file.statvfs](../reference/apis/js-apis-fi ...@@ -43,8 +44,9 @@ For details about the APIs, see [ohos.file.statvfs](../reference/apis/js-apis-fi
```ts ```ts
import storageStatistics from "@ohos.file.storageStatistics"; import storageStatistics from "@ohos.file.storageStatistics";
import { BusinessError } from '@ohos.base';
storageStatistics.getCurrentBundleStats((err, bundleStats) => { storageStatistics.getCurrentBundleStats((err: BusinessError, bundleStats: storageStatistics.BundleStats) => {
if (err) { if (err) {
console.error(`Invoke getCurrentBundleStats failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke getCurrentBundleStats failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
......
en/application-dev/file-management/dev-user-file-manager.md
浏览文件 @ 23949e52
...@@ -8,46 +8,52 @@ For details about the APIs used to develop a file manager application, see [User ...@@ -8,46 +8,52 @@ For details about the APIs used to develop a file manager application, see [User
## How to Develop ## How to Develop
1. Apply for permissions required.<br> 1. Apply for permissions required.
Apply for the **ohos.permission.FILE_ACCESS_MANAGER** and **ohos.permission.GET_BUNDLE_INFO_PRIVILEGED** permissions. For details, see [Applying for Permissions](../security/accesstoken-guidelines.md).
Apply for the **ohos.permission.FILE_ACCESS_MANAGER** and **ohos.permission.GET_BUNDLE_INFO_PRIVILEGED** permissions. For details, see [Applying for Permissions](../security/accesstoken-guidelines.md).
> **NOTE** > **NOTE**
> >
> **ohos.permission.FILE_ACCESS_MANAGER** allows your application to use the user file access framework APIs. > - **ohos.permission.FILE_ACCESS_MANAGER** allows your application to use the user file access framework APIs.
> >- **ohos.permission.GET_BUNDLE_INFO_PRIVILEGED** allows your application to obtain information about file management server applications supported by the system.
> **ohos.permission.GET_BUNDLE_INFO_PRIVILEGED** allows your application to obtain information about file management server applications supported by the system.
2. Import dependent modules. 2. Import dependent modules.
```ts ```ts
import fileAccess from '@ohos.file.fileAccess'; import fileAccess from '@ohos.file.fileAccess';
import fileExtensionInfo from '@ohos.file.fileExtensionInfo'; import fileExtensionInfo from '@ohos.file.fileExtensionInfo';
import { Filter } from '@ohos.file.fs';
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
``` ```
The **fileAccess** module provides APIs for basic file operations, and the **fileExtensionInfo** module provides key structs for application development. The **fileAccess** module provides APIs for basic file operations, and the **fileExtensionInfo** module provides key structs for application development.
3. Query device information.<br> 3. Query device information.
You can obtain attributes of the devices managed by one or all file management servers in the system. You can also filter devices as required. You can obtain attributes of the devices managed by one or all file management servers in the system. You can also filter devices as required.
In the user file access framework, **RootInfo** indicates the attribute information of a device. For example, obtain **RootInfo** of all devices. In the user file access framework, **RootInfo** indicates the attribute information of a device. For example, obtain **RootInfo** of all devices.
```ts ```ts
// Obtain the application context.
let context = getContext(this) as common.UIAbilityContext;
// Create a helper object for connecting to all file management servers in the system. // Create a helper object for connecting to all file management servers in the system.
let fileAccessHelperAllServer = null; let fileAccessHelperAllServer: fileAccess.FileAccessHelper;
createFileAccessHelper() { function createFileAccessHelper() {
try { // this.context is the context passed from EntryAbility. try { // this.context is the context passed from EntryAbility.
fileAccessHelperAllServer = fileAccess.createFileAccessHelper(this.context); fileAccessHelperAllServer = fileAccess.createFileAccessHelper(context);
if (!fileAccessHelperAllServer) { if (!fileAccessHelperAllServer) {
console.error("createFileAccessHelper interface returns an undefined object"); console.error("createFileAccessHelper interface returns an undefined object");
} }
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
} }
async getRoots() { let rootInfos: Array<fileAccess.RootInfo> = [];
let rootIterator = null; async function getRoots() {
let rootInfos = []; let rootIterator: fileAccess.RootIterator;
let isDone = false; let isDone: boolean = false;
try { try {
rootIterator = await fileAccessHelperAllServer.getRoots(); rootIterator = await fileAccessHelperAllServer.getRoots();
if (!rootIterator) { if (!rootIterator) {
...@@ -59,31 +65,32 @@ For details about the APIs used to develop a file manager application, see [User ...@@ -59,31 +65,32 @@ For details about the APIs used to develop a file manager application, see [User
console.info("next result = " + JSON.stringify(result)); console.info("next result = " + JSON.stringify(result));
isDone = result.done; isDone = result.done;
if (!isDone) if (!isDone)
rootinfos.push(result.value); rootInfos.push(result.value);
} }
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
} }
``` ```
4. View directories. 4. View directories.
In the user file access framework, **FileInfo** indicates basic information about a file (directory). You can use **listfile()** to obtain a **FileIterator** object that traverses all files (directories) of the next level or use **scanfile()** to obtain a **FileIterator** object that meets the specified conditions. In the user file access framework, **FileInfo** indicates basic information about a file (directory). You can use **listfile()** to obtain a **FileIterator** object that traverses all files (directories) of the next level or use **scanfile()** to obtain a **FileIterator** object that meets the specified conditions.
Currently, **listfile()** and **scanfile()** can be called by the **RootInfo** object to traverse the next-level files or filter the entire directory tree. In addition, **listfile()** and **scanfile()** can be called by the **FileInfo** object to traverse the next-level files or filter the specified directories. Currently, **listfile()** and **scanfile()** can be called by the **RootInfo** object to traverse the next-level files or filter the entire directory tree. In addition, **listfile()** and **scanfile()** can be called by the **FileInfo** object to traverse the next-level files or filter the specified directories.
```ts ```ts
// Start from the root directory. // Start from the root directory.
let rootInfo = rootinfos[0]; let rootInfo = rootInfos[0];
let fileInfos = []; let fileInfos: Array<fileAccess.FileInfo> = [];
let isDone = false; let isDone: boolean = false;
let filter = {suffix: [".txt", ".jpg", ".xlsx"]}; // Set filter criteria. let filter: Filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // Set the filter.
try { try {
let fileIterator = rootInfo.listFile(); // Traverse the root directory of rootinfos[0] and return an iterator object. let fileIterator = rootInfo.listFile(); // Traverse the root directory of rootinfos[0] and return an iterator object.
// let fileIterator = rootInfo.scanFile(filter); // Filter device rootinfos[0] files that meet the specified conditions and return an iteration object. // let fileIterator = rootInfo.scanFile(filter); // Filter device rootinfos[0] files that meet the specified conditions and return an iteration object.
if (!fileIterator) { if (!fileIterator) {
console.error("listFile interface returns an undefined object"); console.error("listFile interface returns an undefined object");
return;
} }
while (!isDone) { while (!isDone) {
let result = fileIterator.next(); let result = fileIterator.next();
...@@ -92,35 +99,37 @@ For details about the APIs used to develop a file manager application, see [User ...@@ -92,35 +99,37 @@ For details about the APIs used to develop a file manager application, see [User
if (!isDone) if (!isDone)
fileInfos.push(result.value); fileInfos.push(result.value);
} }
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
// Start from the specified directory. // Start from the specified directory.
let fileInfoDir = fileInfos[0]; // fileInfoDir indicates information about a directory. let fileInfoDir = fileInfos[0]; // fileInfoDir indicates information about a directory.
let subFileInfos = []; let subFileInfos: Array<fileAccess.FileInfo> = [];
let isDone = false; let isDone02: boolean = false;
let filter = {suffix: [".txt", ".jpg", ".xlsx"]}; // Set filter criteria. let filter02: Filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // Set the filter.
try { try {
let fileIterator = fileInfoDir.listFile(); // Traverse files in the specified directory and return an iterator object. let fileIterator = fileInfoDir.listFile(); // Traverse files in the specified directory and return an iterator object.
// let fileIterator = rootInfo.scanFile(filter); // Filter the files in the specified directory and return an iterator object. // let fileIterator = rootInfo.scanFile(filter02); // Filter the files in the specified directory and return an iterator object.
if (!fileIterator) { if (!fileIterator) {
console.error("listFile interface returns an undefined object"); console.error("listFile interface returns an undefined object");
return;
} }
while (!isDone) { while (!isDone02) {
let result = fileIterator.next(); let result = fileIterator.next();
console.info("next result = " + JSON.stringify(result)); console.info("next result = " + JSON.stringify(result));
isDone = result.done; isDone02 = result.done;
if (!isDone) if (!isDone02)
subfileInfos.push(result.value); subFileInfos.push(result.value);
} }
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
``` ```
5. Perform operations on files or directories. 5. Perform operations on files or directories.
You can integrate APIs of the user file access framework to implement user behaviors, such as deleting, renaming, creating, and moving a file (directory). The following example shows how to create a file. For details about other APIs, see [User File Access and Management](../reference/apis/js-apis-fileAccess.md). You can integrate APIs of the user file access framework to implement user behaviors, such as deleting, renaming, creating, and moving a file (directory). The following example shows how to create a file. For details about other APIs, see [User File Access and Management](../reference/apis/js-apis-fileAccess.md).
```ts ```ts
...@@ -128,18 +137,20 @@ For details about the APIs used to develop a file manager application, see [User ...@@ -128,18 +137,20 @@ For details about the APIs used to develop a file manager application, see [User
// Create a file. // Create a file.
// sourceUri is the URI in fileinfo of the Download directory. // sourceUri is the URI in fileinfo of the Download directory.
// You need to use the obtained URI for development. // You need to use the obtained URI for development.
let sourceUri = "file://media/file/6"; async function creatFile() {
let displayName = "file1"; let sourceUri: string = "file://docs/storage/Users/currentUser/Download";
let fileUri = null; let displayName: string = "file1";
let fileUri: string;
try { try {
// Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper. // Obtain fileAccessHelperAllServer by referring to the sample code of fileAccess.createFileAccessHelper.
fileUri = await fileAccessHelper.createFile(sourceUri, displayName); fileUri = await fileAccessHelperAllServer.createFile(sourceUri, displayName);
if (!fileUri) { if (!fileUri) {
console.error("createFile return undefined object"); console.error("createFile return undefined object");
return;
} }
console.info("createFile sucess, fileUri: " + JSON.stringify(fileUri)); console.info("createFile sucess, fileUri: " + JSON.stringify(fileUri));
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error("createFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("createFile failed, errCode:" + error.code + ", errMessage:" + error.message);
}; };
}
``` ```
en/application-dev/file-management/file-access-across-devices.md
浏览文件 @ 23949e52
...@@ -8,8 +8,7 @@ For example, device A and device B are installed with the same application. Afte ...@@ -8,8 +8,7 @@ For example, device A and device B are installed with the same application. Afte
1. Connect the devices to form a Super Device. 1. Connect the devices to form a Super Device.
Connect the devices to a LAN, and complete authentication of the devices. The devices must have the same account number. Connect the devices to a LAN, and complete authentication of the devices. The devices must have the same account number.
2. Implement cross-device access to the files of the same application. 2. Implement cross-device access to the files of the same application.
Place the files in the **distributedfiles/** directory of the application sandbox to implement access from difference devices. Place the files in the **distributedfiles/** directory of the application sandbox to implement access from difference devices.
...@@ -18,11 +17,13 @@ Connect the devices to a LAN, and complete authentication of the devices. The de ...@@ -18,11 +17,13 @@ Connect the devices to a LAN, and complete authentication of the devices. The de
```ts ```ts
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
let context =...; // Obtain the UIAbilityContext information of device A. let context = getContext(this) as common.UIAbilityContext; // Obtain the UIAbilityContext of device A.
let pathDir = context.distributedFilesDir; let pathDir: string = context.distributedFilesDir;
// Obtain the file path of the distributed directory. // Obtain the file path of the distributed directory.
let filePath = pathDir + '/test.txt'; let filePath: string = pathDir + '/test.txt';
try { try {
// Create a file in the distributed directory. // Create a file in the distributed directory.
...@@ -32,7 +33,8 @@ Connect the devices to a LAN, and complete authentication of the devices. The de ...@@ -32,7 +33,8 @@ Connect the devices to a LAN, and complete authentication of the devices. The de
fs.writeSync(file.fd, 'content'); fs.writeSync(file.fd, 'content');
// Close the file. // Close the file.
fs.closeSync(file.fd); fs.closeSync(file.fd);
} catch (err) { } catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to openSync / writeSync / closeSync. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to openSync / writeSync / closeSync. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
...@@ -41,24 +43,33 @@ Connect the devices to a LAN, and complete authentication of the devices. The de ...@@ -41,24 +43,33 @@ Connect the devices to a LAN, and complete authentication of the devices. The de
```ts ```ts
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import common from '@ohos.app.ability.common';
import buffer from '@ohos.buffer';
import { BusinessError } from '@ohos.base';
let context =...; // Obtain the UIAbilityContext information of device B. let context = getContext(this) as common.UIAbilityContext; // Obtain the UIAbilityContext of device B.
let pathDir = context.distributedFilesDir; let pathDir: string = context.distributedFilesDir;
// Obtain the file path of the distributed directory. // Obtain the file path of the distributed directory.
let filePath = pathDir + '/test.txt'; let filePath: string = pathDir + '/test.txt';
try { try {
// Open the file in the distributed directory. // Open the file in the distributed directory.
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE); let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE);
// Set the buffer for receiving the read data. // Set the buffer for receiving the read data.
let buffer = new ArrayBuffer(4096); let arrayBuffer = new ArrayBuffer(4096);
// Read the file. The return value is the number of read bytes. // Read the file. The return value is the number of read bytes.
let num = fs.readSync(file.fd, buffer, { class Option {
offset: 0 public offset: number = 0;
}); public length: number;
}
let option = new Option();
option.length = arrayBuffer.byteLength;
let num = fs.readSync(file.fd, arrayBuffer, option);
// Print the read data. // Print the read data.
console.info('read result: ' + String.fromCharCode.apply(null, new Uint8Array(buffer.slice(0, num)))); let buf = buffer.from(arrayBuffer, 0, num);
} catch (err) { console.info('read result: ' + buf.toString());
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to openSync / readSync. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to openSync / readSync. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
en/application-dev/file-management/manage-external-storage.md
浏览文件 @ 23949e52
...@@ -55,8 +55,11 @@ You can subscribe to broadcast events to observe the insertion and removal of ex ...@@ -55,8 +55,11 @@ You can subscribe to broadcast events to observe the insertion and removal of ex
```ts ```ts
import CommonEvent from '@ohos.commonEventManager'; import CommonEvent from '@ohos.commonEventManager';
import volumeManager from '@ohos.file.volumeManager'; import volumeManager from '@ohos.file.volumeManager';
import { BusinessError } from '@ohos.base';
const subscribeInfo = { let subscriber: CommonEvent.CommonEventSubscriber;
async function example() {
const subscribeInfo: CommonEvent.CommonEventSubscribeInfo = {
events: [ events: [
"usual.event.data.VOLUME_REMOVED", "usual.event.data.VOLUME_REMOVED",
"usual.event.data.VOLUME_UNMOUNTED", "usual.event.data.VOLUME_UNMOUNTED",
...@@ -65,19 +68,20 @@ You can subscribe to broadcast events to observe the insertion and removal of ex ...@@ -65,19 +68,20 @@ You can subscribe to broadcast events to observe the insertion and removal of ex
"usual.event.data.VOLUME_EJECT" "usual.event.data.VOLUME_EJECT"
] ]
}; };
let subscriber = await CommonEvent.createSubscriber(subscribeInfo); subscriber = await CommonEvent.createSubscriber(subscribeInfo);
}
``` ```
3. Obtain volume information from the broadcast. 3. Obtain volume information from the broadcast.
```ts ```ts
CommonEvent.subscribe(subscriber, function (err, data) { CommonEvent.subscribe(subscriber, (err: BusinessError, data: CommonEvent.CommonEventData) => {
if (data.event === 'usual.event.data.VOLUME_MOUNTED') { if (data.event === 'usual.event.data.VOLUME_MOUNTED') {
// Manage the volume device based on the information obtained from the broadcast. // Manage the volume device based on the information obtained from the broadcast.
let volId = data.parameters.id; let volId: string = data.parameters.id;
volumeManager.getVolumeById(volId, function(error, vol) { volumeManager.getVolumeById(volId, (error: BusinessError, vol: volumeManager.Volume) => {
if (error) { if (error) {
console.error('volumeManager getVolumeById failed'); console.error('volumeManager getVolumeById failed for ' + JSON.stringify(error));
} else { } else {
console.info('volumeManager getVolumeById successfully, the volume state is ' + vol.state); console.info('volumeManager getVolumeById successfully, the volume state is ' + vol.state);
} }
......
en/application-dev/file-management/save-user-file.md
浏览文件 @ 23949e52
...@@ -18,37 +18,41 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -18,37 +18,41 @@ For example, select an image from **Gallery** and save it to the file manager.
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import photoAccessHelper from '@ohos.file.photoAccessHelper'; import photoAccessHelper from '@ohos.file.photoAccessHelper';
import dataSharePredicates from '@ohos.data.dataSharePredicates'; import dataSharePredicates from '@ohos.data.dataSharePredicates';
import common from '@ohos.app.ability.common';
import image from '@ohos.multimedia.image';
import { BusinessError } from '@ohos.base';
``` ```
2. Obtain the thumbnail of the first image on the device. Before performing this operation, ensure that at least one image exists on the device. 2. Obtain the thumbnail of the first image on the device. Before performing this operation, ensure that at least one image exists on the device.
```ts ```ts
const context = getContext(this); let context = getContext(this) as common.UIAbilityContext;
let photoAccessHelper = photoAccessHelper.getPhotoAccessHelper(context); let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
let pixelmapArrayBuffer; let pixelmapArrayBuffer: ArrayBuffer;
async getPixelmap() { async function getPixelmap() {
try { try {
let predicates = new dataSharePredicates.DataSharePredicates(); let predicates = new dataSharePredicates.DataSharePredicates();
let fetchOption = { let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [], fetchColumns: [],
predicates: predicates predicates: predicates
}; };
let fetchResult = await photoAccessHelper.getAssets(fetchOption); let fetchResult = await phAccessHelper.getAssets(fetchOption);
console.info('[picker] getThumbnail fetchResult: ' + fetchResult); console.info('[picker] getThumbnail fetchResult: ' + fetchResult);
const asset = await fetchResult.getFirstObject(); const asset = await fetchResult.getFirstObject();
console.info('[picker] getThumbnail asset displayName = ', asset.displayName); console.info('[picker] getThumbnail asset displayName = ', asset.displayName);
asset.getThumbnail().then((pixelMap) => { asset.getThumbnail().then((pixelMap: image.PixelMap) => {
let pixelBytesNumber = pixelMap.getPixelBytesNumber(); let pixelBytesNumber = pixelMap.getPixelBytesNumber();
const readBuffer = new ArrayBuffer(pixelBytesNumber); const readBuffer = new ArrayBuffer(pixelBytesNumber);
pixelMap.readPixelsToBuffer(readBuffer).then(() => { pixelMap.readPixelsToBuffer(readBuffer).then(() => {
pixelmapArrayBuffer = readBuffer; pixelmapArrayBuffer = readBuffer;
}) })
}).catch((err) => { }).catch((err: BusinessError) => {
console.error('[picker] getThumbnail failed with error: ' + err); console.error('[picker] getThumbnail failed with error: ' + JSON.stringify(err));
}); });
} catch (error) { } catch (error) {
console.error('[picker] getThumbnail error = ' + error); let err: BusinessError = error as BusinessError;
console.error('[picker] getThumbnail error = ' + JSON.stringify(err));
} }
} }
``` ```
...@@ -58,8 +62,8 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -58,8 +62,8 @@ For example, select an image from **Gallery** and save it to the file manager.
The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening. The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening.
```ts ```ts
let uri:string; let uris: Array<string>;
async photoViewPickerSave() { async function photoViewPickerSave() {
try { try {
const photoSaveOptions = new picker.PhotoSaveOptions(); // Create a photoSaveOptions instance. const photoSaveOptions = new picker.PhotoSaveOptions(); // Create a photoSaveOptions instance.
photoSaveOptions.newFileNames = ["PhotoViewPicker01.png"]; // (Optional) Name of the file to be saved. The file name in the square brackets can be customized and must be unique. If the file name already exists on the device, change the file name. Otherwise, an error will be returned. photoSaveOptions.newFileNames = ["PhotoViewPicker01.png"]; // (Optional) Name of the file to be saved. The file name in the square brackets can be customized and must be unique. If the file name already exists on the device, change the file name. Otherwise, an error will be returned.
...@@ -68,15 +72,16 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -68,15 +72,16 @@ For example, select an image from **Gallery** and save it to the file manager.
try { try {
let photoSaveResult = await photoViewPicker.save(photoSaveOptions); let photoSaveResult = await photoViewPicker.save(photoSaveOptions);
if (photoSaveResult != undefined) { if (photoSaveResult != undefined) {
console.info("[picker] photoViewPickerSave photoSaveResult = " + JSON.stringify(photoSaveResult)); uris = photoSaveResult;
this.uri = photoSaveResult[0]; console.info('photoViewPicker.save to file succeed and uris are:' + uris);
console.info('photoViewPicker.save to file succeed and uri is:' + photoSaveResult[0]);
} }
} catch (err) { } catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`[picker] Invoke photoViewPicker.save failed, code is ${err.code}, message is ${err.message}`); console.error(`[picker] Invoke photoViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
} }
} catch (error) { } catch (error) {
console.info("[picker] photoViewPickerSave error = " + error); let err: BusinessError = error as BusinessError;
console.info("[picker] photoViewPickerSave error = " + JSON.stringify(err));
} }
} }
``` ```
...@@ -86,14 +91,15 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -86,14 +91,15 @@ For example, select an image from **Gallery** and save it to the file manager.
Then, use [fs.write](../reference/apis/js-apis-file-fs.md#fswrite) to modify the file based on the FD, and close the FD after the modification is complete. Then, use [fs.write](../reference/apis/js-apis-file-fs.md#fswrite) to modify the file based on the FD, and close the FD after the modification is complete.
```ts ```ts
async writeOnly(uri) { async function writeOnly(uri: string) {
try { try {
let file = fs.openSync(uri, fs.OpenMode.WRITE_ONLY); let file = fs.openSync(uri, fs.OpenMode.WRITE_ONLY);
let writeLen = await fs.write(file.fd, pixelmapArrayBuffer); let writeLen = await fs.write(file.fd, pixelmapArrayBuffer);
fs.closeSync(file); fs.closeSync(file);
console.info("[picker] writeOnly writeLen = " + writeLen); console.info("[picker] writeOnly writeLen = " + writeLen);
} catch (error) { } catch (error) {
console.info("[picker] writeOnly error: " + error); let err: BusinessError = error as BusinessError;
console.info("[picker] writeOnly error: " + JSON.stringify(err));
} }
} }
``` ```
...@@ -105,6 +111,7 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -105,6 +111,7 @@ For example, select an image from **Gallery** and save it to the file manager.
```ts ```ts
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
``` ```
2. Create a **documentSaveOptions** instance. 2. Create a **documentSaveOptions** instance.
...@@ -112,6 +119,7 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -112,6 +119,7 @@ For example, select an image from **Gallery** and save it to the file manager.
```ts ```ts
const documentSaveOptions = new picker.DocumentSaveOptions(); // Create a documentSaveOptions instance. const documentSaveOptions = new picker.DocumentSaveOptions(); // Create a documentSaveOptions instance.
documentSaveOptions.newFileNames = ["DocumentViewPicker01.txt"]; // (Optional) Set the name of the document to save. documentSaveOptions.newFileNames = ["DocumentViewPicker01.txt"]; // (Optional) Set the name of the document to save.
documentSaveOptions.fileSuffixChoices = ['.png', '.txt', '.mp4']; // (Optional) Types of the documents to save.
``` ```
3. Create a **documentViewPicker** instance, and call [save()](../reference/apis/js-apis-file-picker.md#save-3) to open the **FilePicker** page to save the document. After the user selects the destination folder, the document is saved and the URI of the document saved is returned. 3. Create a **documentViewPicker** instance, and call [save()](../reference/apis/js-apis-file-picker.md#save-3) to open the **FilePicker** page to save the document. After the user selects the destination folder, the document is saved and the URI of the document saved is returned.
...@@ -119,12 +127,12 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -119,12 +127,12 @@ For example, select an image from **Gallery** and save it to the file manager.
The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening. The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening.
```ts ```ts
let uri = null; let uris: Array<string>;
const documentViewPicker = new picker.DocumentViewPicker(); // Create a documentViewPicker instance. const documentViewPicker = new picker.DocumentViewPicker(); // Create a documentViewPicker instance.
documentViewPicker.save(documentSaveOptions).then((documentSaveResult) => { documentViewPicker.save(documentSaveOptions).then((documentSaveResult: Array<string>) => {
uri = documentSaveResult[0]; uris = documentSaveResult;
console.info('documentViewPicker.save to file succeed and uri is:' + uri); console.info('documentViewPicker.save to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -151,6 +159,7 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -151,6 +159,7 @@ For example, select an image from **Gallery** and save it to the file manager.
```ts ```ts
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
``` ```
2. Create an **audioSaveOptions** instance. 2. Create an **audioSaveOptions** instance.
...@@ -160,17 +169,17 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -160,17 +169,17 @@ For example, select an image from **Gallery** and save it to the file manager.
audioSaveOptions.newFileNames = ['AudioViewPicker01.mp3']; // (Optional) Set the name of the audio file to save. audioSaveOptions.newFileNames = ['AudioViewPicker01.mp3']; // (Optional) Set the name of the audio file to save.
``` ```
3. Create an **audioViewPicker** instance, and call [save()](../reference/apis/js-apis-file-picker.md#save-6) to open the **FilePicker** page to save the file. After the user selects the destination folder, the audio file is saved and the URI of the file saved is returned. 3. Create an **audioViewPicker** instance, and call [save()](../reference/apis/js-apis-file-picker.md#save-6) to open the **FilePicker** page to save the file. After the user selects the destination folder, the audio file is saved and the URI of the document saved is returned.
The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening. The permission on the URI returned by **save()** is read/write. Further operations on the file can be performed based on the URI in the result set. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening.
```ts ```ts
let uri = null; let uri: string;
const audioViewPicker = new picker.AudioViewPicker(); const audioViewPicker = new picker.AudioViewPicker();
audioViewPicker.save(audioSaveOptions).then((audioSelectResult) => { audioViewPicker.save(audioSaveOptions).then((audioSelectResult: Array<string>) => {
uri = audioSelectResult[0]; uri = audioSelectResult[0];
console.info('audioViewPicker.save to file succeed and uri is:' + uri); console.info('audioViewPicker.save to file succeed and uri is:' + uri);
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke audioViewPicker.save failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke audioViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -182,7 +191,7 @@ For example, select an image from **Gallery** and save it to the file manager. ...@@ -182,7 +191,7 @@ For example, select an image from **Gallery** and save it to the file manager.
console.info('file fd: ' + file.fd); console.info('file fd: ' + file.fd);
``` ```
5. Use [fs.writeSync()](../reference/apis/js-apis-file-fs.md#writesync) to edit the file based on the FD, and then close the FD. 5. Use [fs.writeSync()](../reference/apis/js-apis-file-fs.md#writesync) to edit the document based on the FD, and then close the FD.
```ts ```ts
let writeLen = fs.writeSync(file.fd, 'hello, world'); let writeLen = fs.writeSync(file.fd, 'hello, world');
......
en/application-dev/file-management/select-user-file.md
浏览文件 @ 23949e52
...@@ -17,6 +17,7 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -17,6 +17,7 @@ The **FilePicker** provides the following interfaces by file type:
```ts ```ts
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
``` ```
2. Create a **photoSelectOptions** instance. 2. Create a **photoSelectOptions** instance.
...@@ -38,12 +39,12 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -38,12 +39,12 @@ The **FilePicker** provides the following interfaces by file type:
The permission on the URIs returned by **select()** is read-only. Further file operations can be performed based on the URIs in the **PhotoSelectResult**. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening. The permission on the URIs returned by **select()** is read-only. Further file operations can be performed based on the URIs in the **PhotoSelectResult**. Note that the URI cannot be directly used in the **picker** callback to open a file. You need to define a global variable to save the URI and use a button to trigger file opening.
```ts ```ts
let uri = null; let uris: Array<string>;
const photoViewPicker = new picker.PhotoViewPicker(); const photoViewPicker = new picker.PhotoViewPicker();
photoViewPicker.select(photoSelectOptions).then((photoSelectResult) => { photoViewPicker.select(photoSelectOptions).then((photoSelectResult: picker.PhotoSelectResult) => {
uri = photoSelectResult.photoUris[0]; uris = photoSelectResult.photoUris;
console.info('photoViewPicker.select to file succeed and uri is:' + uri); console.info('photoViewPicker.select to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke photoViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke photoViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -71,12 +72,17 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -71,12 +72,17 @@ The **FilePicker** provides the following interfaces by file type:
```ts ```ts
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
``` ```
2. Create a **documentSelectOptions** instance. 2. Create a **documentSelectOptions** instance.
```ts ```ts
const documentSelectOptions = new picker.DocumentSelectOptions(); const documentSelectOptions = new picker.DocumentSelectOptions();
documentSelectOptions.maxSelectNumber = 5; // (Optional) Maximum number of documents to select.
documentSelectOptions.defaultFilePathUri = "file://docs/storage/Users/currentUser/test"; // (Optional) Path of the file or directory to select.
documentSelectOptions.fileSuffixFilters = ['.png', '.txt', '.mp4']; // (Optional) File name extensions of the documents to select.
``` ```
3. Create a **documentViewPicker** instance, and call [**select()**](../reference/apis/js-apis-file-picker.md#select-3) to open the **FilePicker** page for the user to select documents. After the documents are selected, a result set containing the file URIs is returned. 3. Create a **documentViewPicker** instance, and call [**select()**](../reference/apis/js-apis-file-picker.md#select-3) to open the **FilePicker** page for the user to select documents. After the documents are selected, a result set containing the file URIs is returned.
...@@ -85,17 +91,13 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -85,17 +91,13 @@ The **FilePicker** provides the following interfaces by file type:
For example, you can use [file management APIs](../reference/apis/js-apis-file-fs.md) to obtain file attributes, such as the file size, access time, and last modification time, based on the URI. If you need to obtain the file name, use [startAbilityForResult](../../application-dev/application-models/uiability-intra-device-interaction.md). For example, you can use [file management APIs](../reference/apis/js-apis-file-fs.md) to obtain file attributes, such as the file size, access time, and last modification time, based on the URI. If you need to obtain the file name, use [startAbilityForResult](../../application-dev/application-models/uiability-intra-device-interaction.md).
> **NOTE**
>
> Currently, **DocumentSelectOptions** is not configurable. By default, all types of user files are selected.
```ts ```ts
let uri = null; let uris: Array<string>;
const documentViewPicker = new picker.DocumentViewPicker(); // Create a documentViewPicker instance. const documentViewPicker = new picker.DocumentViewPicker(); // Create a documentViewPicker instance.
documentViewPicker.select(documentSelectOptions).then((documentSelectResult) => { documentViewPicker.select(documentSelectOptions).then((documentSelectResult: Array<string>) => {
uri = documentSelectResult[0]; uris = documentSelectResult;
console.info('documentViewPicker.select to file succeed and uri is:' + uri); console.info('documentViewPicker.select to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -105,7 +107,8 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -105,7 +107,8 @@ The **FilePicker** provides the following interfaces by file type:
> Currently, **DocumentSelectOptions** cannot be used to obtain the file name. To obtain the file name, use **startAbilityForResult()**. > Currently, **DocumentSelectOptions** cannot be used to obtain the file name. To obtain the file name, use **startAbilityForResult()**.
```ts ```ts
let config = { async function example() {
let config: Want = {
action: 'ohos.want.action.OPEN_FILE', action: 'ohos.want.action.OPEN_FILE',
parameters: { parameters: {
startMode: 'choose', startMode: 'choose',
...@@ -121,9 +124,11 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -121,9 +124,11 @@ The **FilePicker** provides the following interfaces by file type:
let select_item_list = result.want.parameters.select_item_list; let select_item_list = result.want.parameters.select_item_list;
// Obtain the name of the document. // Obtain the name of the document.
let file_name_list = result.want.parameters.file_name_list; let file_name_list = result.want.parameters.file_name_list;
} catch (err) { } catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
} }
}
``` ```
4. After the UI is returned from the **FilePicker** page, use a button to trigger API calling. Use [fs.openSync()](../reference/apis/js-apis-file-fs.md#fsopensync) to open the file based on the URI and obtain the FD. Note that the **mode** parameter of **fs.openSync()** must be **fs.OpenMode.READ_ONLY**. 4. After the UI is returned from the **FilePicker** page, use a button to trigger API calling. Use [fs.openSync()](../reference/apis/js-apis-file-fs.md#fsopensync) to open the file based on the URI and obtain the FD. Note that the **mode** parameter of **fs.openSync()** must be **fs.OpenMode.READ_ONLY**.
...@@ -150,6 +155,7 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -150,6 +155,7 @@ The **FilePicker** provides the following interfaces by file type:
```ts ```ts
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';
``` ```
2. Create an **audioSelectOptions** instance. 2. Create an **audioSelectOptions** instance.
...@@ -169,12 +175,12 @@ The **FilePicker** provides the following interfaces by file type: ...@@ -169,12 +175,12 @@ The **FilePicker** provides the following interfaces by file type:
> Currently, **AudioSelectOptions** is not configurable. By default, all types of user files are selected. > Currently, **AudioSelectOptions** is not configurable. By default, all types of user files are selected.
```ts ```ts
let uri = null; let uri: string;
const audioViewPicker = new picker.AudioViewPicker(); const audioViewPicker = new picker.AudioViewPicker();
audioViewPicker.select(audioSelectOptions).then(audioSelectResult => { audioViewPicker.select(audioSelectOptions).then((audioSelectResult: Array<string>) => {
uri = audioSelectOptions[0]; uri = audioSelectResult[0];
console.info('audioViewPicker.select to file succeed and uri is:' + uri); console.info('audioViewPicker.select to file succeed and uri is:' + uri);
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Invoke audioViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke audioViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
}) })
``` ```
......
en/application-dev/file-management/set-security-label.md
浏览文件 @ 23949e52
...@@ -13,7 +13,7 @@ For details about the APIs, see [ohos.file.securityLabel](../reference/apis/js-a ...@@ -13,7 +13,7 @@ For details about the APIs, see [ohos.file.securityLabel](../reference/apis/js-a
| setSecurityLabel | Sets a security label for a file.| Method| √ | √ | | setSecurityLabel | Sets a security label for a file.| Method| √ | √ |
| getSecurityLabel | Obtains the security label of a file.| Method| √ | √ | | getSecurityLabel | Obtains the security label of a file.| Method| √ | √ |
> **NOTE** > **NOTICE**
> >
> - In distributed networking, a device can view the files that do not match its security level but cannot access them. > - In distributed networking, a device can view the files that do not match its security level but cannot access them.
> >
...@@ -26,16 +26,18 @@ Obtain the sandbox path of a file and set the data security label. For details a ...@@ -26,16 +26,18 @@ Obtain the sandbox path of a file and set the data security label. For details a
```ts ```ts
import securityLabel from '@ohos.file.securityLabel'; import securityLabel from '@ohos.file.securityLabel';
import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';
// Obtain the sandbox path of the file. // Obtain the sandbox path of the file.
let context =...; // Obtain UIAbilityContext information. let context = getContext(this) as common.UIAbilityContext; // Obtain UIAbilityContext.
let pathDir = context.filesDir; let pathDir = context.filesDir;
let filePath = pathDir + '/test.txt'; let filePath = pathDir + '/test.txt';
// Set the data level of the file to S0. // Set the data level of the file to S0.
securityLabel.setSecurityLabel(filePath, 's0').then(() => { securityLabel.setSecurityLabel(filePath, 's0').then(() => {
console.info('Succeeded in setSecurityLabeling.'); console.info('Succeeded in setSecurityLabeling.');
}).catch((err) => { }).catch((err: BusinessError) => {
console.error(`Failed to setSecurityLabel. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to setSecurityLabel. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
en/application-dev/file-management/share-app-file.md
浏览文件 @ 23949e52
...@@ -12,7 +12,7 @@ You can use the related APIs to [share a file with another application](#sharing ...@@ -12,7 +12,7 @@ You can use the related APIs to [share a file with another application](#sharing
The file URIs are in the following format: The file URIs are in the following format:
**file**://&lt;*bundleName*&gt;/&lt;*path*&gt; **file://**&lt;bundleName&gt;/&lt;path&gt;
- **file**: indicates a file URI. - **file**: indicates a file URI.
...@@ -43,6 +43,7 @@ Before sharing application files, you need to [obtain the application file path] ...@@ -43,6 +43,7 @@ Before sharing application files, you need to [obtain the application file path]
``` ```
2. Set the target application, with which you want to share the file, and grant permissions on the file. 2. Set the target application, with which you want to share the file, and grant permissions on the file.
Use [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) to share the file with the target application. You need to pass in the obtained URI in **uri** of the **want** parameter, set the type of the file to share, set **action** to **ohos.want.action.sendData**, and set the granted permission on the file in **flags**. For details, see [Want](../reference/apis/js-apis-app-ability-want.md#attributes). Use [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) to share the file with the target application. You need to pass in the obtained URI in **uri** of the **want** parameter, set the type of the file to share, set **action** to **ohos.want.action.sendData**, and set the granted permission on the file in **flags**. For details, see [Want](../reference/apis/js-apis-app-ability-want.md#attributes).
> **NOTE** > **NOTE**
...@@ -54,6 +55,8 @@ Before sharing application files, you need to [obtain the application file path] ...@@ -54,6 +55,8 @@ Before sharing application files, you need to [obtain the application file path]
import window from '@ohos.window'; import window from '@ohos.window';
import wantConstant from '@ohos.app.ability.wantConstant'; import wantConstant from '@ohos.app.ability.wantConstant';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) { onWindowStageCreate(windowStage: window.WindowStage) {
...@@ -61,7 +64,7 @@ Before sharing application files, you need to [obtain the application file path] ...@@ -61,7 +64,7 @@ Before sharing application files, you need to [obtain the application file path]
let filePath = this.context.filesDir + '/test.txt'; let filePath = this.context.filesDir + '/test.txt';
// Convert the application sandbox path into a URI. // Convert the application sandbox path into a URI.
let uri = fileuri.getUriFromPath(filePath); let uri = fileuri.getUriFromPath(filePath);
let want = { let want: Want = {
// Grant the read and write permissions on the shared file to the target application. // Grant the read and write permissions on the shared file to the target application.
flags: wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
// Set the implicit startup rule for the application that shares the file. // Set the implicit startup rule for the application that shares the file.
...@@ -73,15 +76,15 @@ Before sharing application files, you need to [obtain the application file path] ...@@ -73,15 +76,15 @@ Before sharing application files, you need to [obtain the application file path]
.then(() => { .then(() => {
console.info('Invoke getCurrentBundleStats succeeded.'); console.info('Invoke getCurrentBundleStats succeeded.');
}) })
.catch((err) => { .catch((err: BusinessError) => {
console.error(`Invoke startAbility failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke startAbility failed, code is ${err.code}, message is ${err.message}`);
}); });
} }
// ...
...
} }
``` ```
## Using Shared Files ## Using Shared Files
In the [**module.json5** file](../quick-start/module-configuration-file.md) of the application, which wants to use the shared file, set **actions** to **ohos.want.action.sendData** to allow the application to receive files shared by another application and set **uris** to the type of the URI to receive. In the following example, the application receives only .txt files with **scheme** of **file**. In the [**module.json5** file](../quick-start/module-configuration-file.md) of the application, which wants to use the shared file, set **actions** to **ohos.want.action.sendData** to allow the application to receive files shared by another application and set **uris** to the type of the URI to receive. In the following example, the application receives only .txt files with **scheme** of **file**.
...@@ -120,10 +123,12 @@ After obtaining the URI of the shared file from **want**, the application can ca ...@@ -120,10 +123,12 @@ After obtaining the URI of the shared file from **want**, the application can ca
```ts ```ts
// xxx.ets // xxx.ets
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
function getShareFile() { function getShareFile() {
try { try {
let want =...; // Obtain the want information sent from the application that shares the file. let want: Want = ...; // Obtain the want sent from the application that shares the file.
// Obtain the uri field from the want information. // Obtain the uri field from the want information.
let uri = want.uri; let uri = want.uri;
...@@ -135,11 +140,13 @@ function getShareFile() { ...@@ -135,11 +140,13 @@ function getShareFile() {
// Perform operations on the URI of the shared file as required. For example, open the URI to obtain the file object in read/write mode. // Perform operations on the URI of the shared file as required. For example, open the URI to obtain the file object in read/write mode.
let file = fs.openSync(uri, fs.OpenMode.READ_WRITE); let file = fs.openSync(uri, fs.OpenMode.READ_WRITE);
console.info('open file successfully!'); console.info('open file successfully!');
} catch (error) { } catch (err) {
let error: BusinessError = err as BusinessError;
console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`); console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`);
} }
} catch (error) { } catch (error) {
console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`); let err: BusinessError = error as BusinessError;
console.error(`Invoke openSync failed, code is ${err.code}, message is ${err.message}`);
} }
} }
``` ```
en/application-dev/notification/notification-with-wantagent.md
浏览文件 @ 23949e52
...@@ -40,7 +40,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -40,7 +40,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
Scenario 1: Create a [WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md) object for starting a UIAbility component. Scenario 1: Create a [WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md) object for starting a UIAbility component.
```typescript ```typescript
let wantAgentObj:WantAgent = null; // Save the WantAgent object created. It will be used to complete the trigger operations. let wantAgentObj:WantAgent; // Save the WantAgent object created. It will be used to complete the trigger operations.
// Set the action type through operationType of WantAgentInfo. // Set the action type through operationType of WantAgentInfo.
let wantAgentInfo:wantAgent.WantAgentInfo = { let wantAgentInfo:wantAgent.WantAgentInfo = {
...@@ -64,7 +64,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -64,7 +64,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
Scenario 2: Create a [WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md) object for publishing a [common event](../application-models/common-event-overview.md). Scenario 2: Create a [WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md) object for publishing a [common event](../application-models/common-event-overview.md).
```typescript ```typescript
let wantAgentObj:WantAgent = null; // Save the WantAgent object created. It will be used to complete the trigger operations. let wantAgentObj:WantAgent; // Save the WantAgent object created. It will be used to complete the trigger operations.
// Set the action type through operationType of WantAgentInfo. // Set the action type through operationType of WantAgentInfo.
let wantAgentInfo:wantAgent.WantAgentInfo = { let wantAgentInfo:wantAgent.WantAgentInfo = {
......
en/application-dev/reference/apis/js-apis-bluetooth-ble.md
浏览文件 @ 23949e52
...@@ -744,7 +744,7 @@ Subscribes to characteristic write request events. ...@@ -744,7 +744,7 @@ Subscribes to characteristic write request events.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type | string | Yes | Event type. The value **characteristicWrite** indicates a characteristic write request event.| | type | string | Yes | Event type. The value is **characteristicWrite**, which indicates a characteristic write request event.|
| callback | Callback&lt;[CharacteristicWriteRequest](#characteristicwriterequest)&gt; | Yes | Callback invoked to return a characteristic write request from the GATT client. | | callback | Callback&lt;[CharacteristicWriteRequest](#characteristicwriterequest)&gt; | Yes | Callback invoked to return a characteristic write request from the GATT client. |
**Example** **Example**
...@@ -983,6 +983,66 @@ gattServer.off('connectionStateChange'); ...@@ -983,6 +983,66 @@ gattServer.off('connectionStateChange');
``` ```
### on('BLEMtuChange')
on(type: 'BLEMtuChange', callback: Callback&lt;number&gt;): void
Subscribes to MTU status changes for the server.
**Required permissions**: ohos.permission.ACCESS_BLUETOOTH
**System capability**: SystemCapability.Communication.Bluetooth.Core
**Parameters**
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Type of event to subscribe to. The value is **BLEMtuChange**, which indicates the MTU status changes. If this parameter is not set correctly, the callback cannot be registered.|
| callback | Callback&lt;number&gt; | Yes | Callback invoked to return the number of MTU bytes.|
**Example**
```js
try {
let gattServer = ble.createGattServer();
gattServer.on('BLEMtuChange', (mtu) => {
console.info('BLEMtuChange, mtu: ' + mtu);
});
} catch (err) {
console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```
### off('BLEMtuChange')
off(type: 'BLEMtuChange', callback?: Callback&lt;number&gt;): void
Unsubscribes from MTU status changes for the server.
**Required permissions**: ohos.permission.ACCESS_BLUETOOTH
**System capability**: SystemCapability.Communication.Bluetooth.Core
**Parameters**
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Type of event to unsubscribe from. The value is **BLEMtuChange**, which indicates the MTU status changes. If this parameter is not set correctly, the callback cannot be unregistered.|
| callback | Callback&lt;number&gt; | No | Callback for the MTU status changes. If this parameter is not set, this API unsubscribes from all callbacks corresponding to **type**.|
**Example**
```js
try {
let gattServer = ble.createGattServer();
gattServer.off('BLEMtuChange');
} catch (err) {
console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```
## GattClientDevice ## GattClientDevice
Implements the GATT client. Before using an API of this class, you must create a **GattClientDevice** instance using **createGattClientDevice(deviceId: string)**. Implements the GATT client. Before using an API of this class, you must create a **GattClientDevice** instance using **createGattClientDevice(deviceId: string)**.
...@@ -2179,7 +2239,7 @@ try { ...@@ -2179,7 +2239,7 @@ try {
on(type: 'BLEMtuChange', callback: Callback&lt;number&gt;): void on(type: 'BLEMtuChange', callback: Callback&lt;number&gt;): void
Subscribes to MTU status changes. Subscribes to MTU status changes for the client.
**Required permissions**: ohos.permission.ACCESS_BLUETOOTH **Required permissions**: ohos.permission.ACCESS_BLUETOOTH
...@@ -2189,8 +2249,8 @@ Subscribes to MTU status changes. ...@@ -2189,8 +2249,8 @@ Subscribes to MTU status changes.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Event type. The value is **BLEMtuChange**, which indicates a MTU status change event.| | type | string | Yes | Type of event to subscribe to. The value is **BLEMtuChange**, which indicates the MTU status changes. If this parameter is not set correctly, the callback cannot be registered.|
| callback | Callback&lt;number&gt; | Yes | Callback invoked to return the MTU status, which can be connected or disconnected.| | callback | Callback&lt;number&gt; | Yes | Callback invoked to return the number of MTU bytes.|
**Example** **Example**
...@@ -2210,7 +2270,7 @@ try { ...@@ -2210,7 +2270,7 @@ try {
off(type: 'BLEMtuChange', callback?: Callback&lt;number&gt;): void off(type: 'BLEMtuChange', callback?: Callback&lt;number&gt;): void
Unsubscribes from MTU status changes. Unsubscribes from MTU status changes for the client.
**Required permissions**: ohos.permission.ACCESS_BLUETOOTH **Required permissions**: ohos.permission.ACCESS_BLUETOOTH
...@@ -2220,8 +2280,8 @@ Unsubscribes from MTU status changes. ...@@ -2220,8 +2280,8 @@ Unsubscribes from MTU status changes.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Event type. The value is **BLEMtuChange**, which indicates a MTU status change event.| | type | string | Yes | Type of event to unsubscribe from. The value is **BLEMtuChange**, which indicates the MTU status changes. If this parameter is not set correctly, the callback cannot be unregistered.|
| callback | Callback&lt;number&gt; | No | Callback for MTU status changes. If this parameter is not set, this API unsubscribes from all callbacks corresponding to **type**.| | callback | Callback&lt;number&gt; | No | Callback for the MTU status changes. If this parameter is not set, this API unsubscribes from all callbacks corresponding to **type**.|
**Example** **Example**
......
en/application-dev/reference/apis/js-apis-cardEmulation.md
浏览文件 @ 23949e52
...@@ -100,6 +100,182 @@ Checks whether an application is the default application of the specified servic ...@@ -100,6 +100,182 @@ Checks whether an application is the default application of the specified servic
| ------- | ------------------------------------ | | ------- | ------------------------------------ |
| boolean | Returns **true** if the application is the default payment application; returns **false** otherwise.| | boolean | Returns **true** if the application is the default payment application; returns **false** otherwise.|
## HceService<sup>8+</sup>
Implements HCE, including receiving Application Protocol Data Units (APDUs) from the peer card reader and sending a response. Before using HCE-related APIs, check whether the device supports HCE. This API is used only for declaration and cannot be used currently.
### startHCE<sup>8+</sup>
startHCE(aidList: string[]): boolean
Starts HCE, including setting the application to be foreground preferred and dynamically registering the application identifier (AID) list. This API is used only for declaration and cannot be used currently.
> **NOTE**
> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [start](#start9).
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------- | -------- | ---- | ----------------------- |
| aidList | string[] | Yes | AID list to register.|
### start<sup>9+</sup>
start(elementName: ElementName, aidList: string[]): void
Starts HCE, including setting the application to be foreground preferred and dynamically registering the application identifier (AID) list. This API is used only for declaration and cannot be used currently.
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------- | -------- | ---- | ----------------------- |
| elementName | ElementName | Yes | Element name of a service capability.|
| aidList | string[] | Yes | AID list to register.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message |
| ------- | -------|
| 3100301 | Card emulation running state is abnormal in service. |
### stopHCE<sup>8+</sup>
stopHCE(): boolean
Stops HCE, including removing the foreground preferred attribute and releasing the dynamically registered AID list. This API is used only for declaration and cannot be used currently.
> **NOTE**
> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [stop](#stop).
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
### stop<sup>9+</sup>
stop(elementName: ElementName): void;
Stops HCE, including removing the foreground preferred attribute and releasing the dynamically registered AID list. This API is used only for declaration and cannot be used currently.
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------- | -------- | ---- | ----------------------- |
| elementName | ElementName | Yes | Element name of a service capability.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message |
| ------- | -------|
| 3100301 | Card emulation running state is abnormal in service. |
### on<sup>8+</sup>
on(type: "hceCmd", callback: AsyncCallback<number[]>): void;
Registers a callback to receive APDUs from the peer card reader. This API is used only for declaration and cannot be used currently.
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ----------------------- | ---- | -------------------------------------------- |
| type | string | Yes | Event type to subscribe to. The value is **hceCmd**. |
| callback | AsyncCallback<number[]> | Yes | Callback invoked to return the APDU, which consists of hexadecimal numbers ranging from **0x00** to **0xFF**.|
### sendResponse<sup>8+</sup>
sendResponse(responseApdu: number[]): void;
Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.
> **NOTE**
> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [transmit](#transmit9).
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------------ | -------- | ---- | -------------------------------------------------- |
| responseApdu | number[] | Yes | Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from **0x00** to **0xFF**.|
### transmit<sup>9+</sup>
transmit(response: number[]): Promise\<void>;
Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------------ | -------- | ---- | -------------------------------------------------- |
| responseApdu | number[] | Yes | Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from **0x00** to **0xFF**.|
**Return value**
| **Type** | **Description** |
| ------- | -------------------------------------- |
| Promise\<void> | Promise that returns no value.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message |
| ------- | -------|
| 3100301 | Card emulation running state is abnormal in service. |
### transmit<sup>9+</sup>
transmit(response: number[], callback: AsyncCallback\<void>): void;
Sends a response to the peer card reader. This API is used only for declaration and cannot be used currently.
**Required permissions**: ohos.permission.NFC_CARD_EMULATION
**System capability**: SystemCapability.Communication.NFC.CardEmulation
**Parameters**
| Name | Type | Mandatory| Description |
| ------- | -------- | ---- | ----------------------- |
| responseApdu | number[] | Yes | Response APDU sent to the peer card reader. The value consists of hexadecimal numbers ranging from **0x00** to **0xFF**.|
| callback | AsyncCallback\<void> | Yes | Callback that returns no value.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message |
| ------- | -------|
| 3100301 | Card emulation running state is abnormal in service. |
**Example** **Example**
```js ```js
......
en/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 23949e52
...@@ -60,7 +60,8 @@ function publishCB(err:Base.BusinessError) { ...@@ -60,7 +60,8 @@ function publishCB(err:Base.BusinessError) {
// Publish a common event. // Publish a common event.
try { try {
CommonEventManager.publish("event", publishCB); CommonEventManager.publish("event", publishCB);
} catch(err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -114,7 +115,8 @@ function publishCB(err:Base.BusinessError) { ...@@ -114,7 +115,8 @@ function publishCB(err:Base.BusinessError) {
// Publish a common event. // Publish a common event.
try { try {
CommonEventManager.publish("event", options, publishCB); CommonEventManager.publish("event", options, publishCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -166,7 +168,8 @@ let userId = 100; ...@@ -166,7 +168,8 @@ let userId = 100;
// Publish a common event. // Publish a common event.
try { try {
CommonEventManager.publishAsUser("event", userId, publishCB); CommonEventManager.publishAsUser("event", userId, publishCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -226,7 +229,8 @@ let userId = 100; ...@@ -226,7 +229,8 @@ let userId = 100;
// Publish a common event. // Publish a common event.
try { try {
CommonEventManager.publishAsUser("event", userId, options, publishCB); CommonEventManager.publishAsUser("event", userId, options, publishCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -269,7 +273,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag ...@@ -269,7 +273,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag
// Create a subscriber. // Create a subscriber.
try { try {
CommonEventManager.createSubscriber(subscribeInfo, createCB); CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -366,7 +371,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag ...@@ -366,7 +371,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag
// Subscribe to a common event. // Subscribe to a common event.
try { try {
CommonEventManager.subscribe(subscriber, SubscribeCB); CommonEventManager.subscribe(subscriber, SubscribeCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} }
} else { } else {
...@@ -377,7 +383,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag ...@@ -377,7 +383,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag
// Create a subscriber. // Create a subscriber.
try { try {
CommonEventManager.createSubscriber(subscribeInfo, createCB); CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -433,7 +440,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag ...@@ -433,7 +440,8 @@ function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManag
// Subscribe to a common event. // Subscribe to a common event.
try { try {
CommonEventManager.subscribe(subscriber, subscribeCB); CommonEventManager.subscribe(subscriber, subscribeCB);
} catch(err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} }
} }
...@@ -449,14 +457,16 @@ function unsubscribeCB(err:Base.BusinessError) { ...@@ -449,14 +457,16 @@ function unsubscribeCB(err:Base.BusinessError) {
// Create a subscriber. // Create a subscriber.
try { try {
CommonEventManager.createSubscriber(subscribeInfo, createCB); CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
} }
// Unsubscribe from the common event. // Unsubscribe from the common event.
try { try {
CommonEventManager.unsubscribe(subscriber, unsubscribeCB); CommonEventManager.unsubscribe(subscriber, unsubscribeCB);
} catch (err) { } catch (error) {
let err:Base.BusinessError = error as Base.BusinessError;
console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
} }
``` ```
...@@ -583,7 +593,7 @@ CommonEventManager.setStaticSubscriberState(true, (err:Base.BusinessError) => { ...@@ -583,7 +593,7 @@ CommonEventManager.setStaticSubscriberState(true, (err:Base.BusinessError) => {
console.info(`Set static subscriber state callback failed, err is null.`); console.info(`Set static subscriber state callback failed, err is null.`);
return; return;
} }
if (err.code) { if (err.code !== undefined && err.code != null) {
console.info(`Set static subscriber state callback failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Set static subscriber state callback failed, errCode: ${err.code}, errMes: ${err.message}`);
return; return;
} }
......
en/application-dev/reference/apis/js-apis-file-fileuri.md
浏览文件 @ 23949e52
...@@ -40,6 +40,70 @@ export default class EntryAbility extends UIAbility { ...@@ -40,6 +40,70 @@ export default class EntryAbility extends UIAbility {
For details about how to obtain the FA model context, see [Context](js-apis-inner-app-context.md#context). For details about how to obtain the FA model context, see [Context](js-apis-inner-app-context.md#context).
## FileUri<sup>10+</sup>
### Attributes
**System capability**: SystemCapability.FileManagement.AppFileService
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
| path<sup>10+</sup> | string | Yes| No| Path of the file corresponding to the URI.|
| name<sup>10+</sup> | string | Yes| No| Name of the file.|
### constructor<sup>10+</sup>
constructor(uriOrPath: string)
A constructor used to create a **FileUri** instance.
**System capability**: SystemCapability.FileManagement.AppFileService
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| uriOrPath | string | Yes| URI or path. The following types of URIs are available:<br>- Application sandbox URI: **file://\<bundleName>/\<sandboxPath>**<br>- URI of the user's document: **file://docs/storage/Users/currentUser/\<publicPath>**<br>- URI of the user's media asset: **file://media/\<mediaType>/IMG_DATATIME_ID/\<displayName>**|
**Error codes**
For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
| ID | Error Message |
| ---------------------------- | ---------- |
| 13900005 | I/O error |
| 13900042 | Unknown error |
**Example**
```js
let path = pathDir + '/test';
let uri = fileuri.getUriFromPath(filePath); // file://<packageName>/data/storage/el2/base/haps/entry/files/test
let fileUriObject = new fileuri.FileUri(uri);
console.info("The name of FileUri is " + fileUriObject.name);
```
### toString<sup>10+</sup>
toString(): string
**System capability**: SystemCapability.FileManagement.AppFileService
Obtains the URI of the string type.
**Return value**
| Type| Description|
| -------- | -------- |
| string | URI of the string type obtained.|
**Example**
```js
let path = pathDir + '/test';
let fileUriObject = new fileuri.FileUri(path);
console.info("The uri of FileUri is " + fileUriObject.toString());
```
## fileUri.getUriFromPath ## fileUri.getUriFromPath
getUriFromPath(path: string): string getUriFromPath(path: string): string
......
en/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md
浏览文件 @ 23949e52
...@@ -21,7 +21,7 @@ let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = { ...@@ -21,7 +21,7 @@ let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
console.info("createSubscriber"); console.info("createSubscriber");
...@@ -52,7 +52,7 @@ Obtains the code of this common event. This API uses an asynchronous callback to ...@@ -52,7 +52,7 @@ Obtains the code of this common event. This API uses an asynchronous callback to
```ts ```ts
// Callback for result code obtaining of an ordered common event. // Callback for result code obtaining of an ordered common event.
function getCodeCB(err:Base.BusinessError, code:number) { function getCodeCB(err:Base.BusinessError, code:number) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("getCode " + JSON.stringify(code)); console.info("getCode " + JSON.stringify(code));
...@@ -105,7 +105,7 @@ Sets the code for this common event. This API uses an asynchronous callback to r ...@@ -105,7 +105,7 @@ Sets the code for this common event. This API uses an asynchronous callback to r
```ts ```ts
// Callback for result code setting of an ordered common event. // Callback for result code setting of an ordered common event.
function setCodeCB(err:Base.BusinessError) { function setCodeCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("setCode"); console.info("setCode");
...@@ -163,7 +163,7 @@ Obtains the data of this common event. This API uses an asynchronous callback to ...@@ -163,7 +163,7 @@ Obtains the data of this common event. This API uses an asynchronous callback to
```ts ```ts
// Callback for result data obtaining of an ordered common event. // Callback for result data obtaining of an ordered common event.
function getDataCB(err:Base.BusinessError, data:string) { function getDataCB(err:Base.BusinessError, data:string) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`getData failed, code is ${err.code}, message is ${err.message}`); console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("getData " + JSON.stringify(data)); console.info("getData " + JSON.stringify(data));
...@@ -216,7 +216,7 @@ Sets the data for this common event. This API uses an asynchronous callback to r ...@@ -216,7 +216,7 @@ Sets the data for this common event. This API uses an asynchronous callback to r
```ts ```ts
// Callback for result data setting of an ordered common event // Callback for result data setting of an ordered common event
function setDataCB(err:Base.BusinessError) { function setDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("setData"); console.info("setData");
...@@ -276,7 +276,7 @@ Sets the code and data for this common event. This API uses an asynchronous call ...@@ -276,7 +276,7 @@ Sets the code and data for this common event. This API uses an asynchronous call
```ts ```ts
// Callback for code and data setting of an ordered common event. // Callback for code and data setting of an ordered common event.
function setCodeDataCB(err:Base.BusinessError) { function setCodeDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("setCodeDataCallback"); console.info("setCodeDataCallback");
...@@ -335,7 +335,7 @@ Checks whether this common event is an ordered one. This API uses an asynchronou ...@@ -335,7 +335,7 @@ Checks whether this common event is an ordered one. This API uses an asynchronou
```ts ```ts
// Callback for checking whether the current common event is an ordered one. // Callback for checking whether the current common event is an ordered one.
function isOrderedCB(err:Base.BusinessError, isOrdered:boolean) { function isOrderedCB(err:Base.BusinessError, isOrdered:boolean) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("isOrdered " + JSON.stringify(isOrdered)); console.info("isOrdered " + JSON.stringify(isOrdered));
...@@ -387,7 +387,7 @@ Checks whether this common event is a sticky one. This API uses an asynchronous ...@@ -387,7 +387,7 @@ Checks whether this common event is a sticky one. This API uses an asynchronous
```ts ```ts
// Callback for checking whether the current common event is a sticky one. // Callback for checking whether the current common event is a sticky one.
function isStickyCB(err:Base.BusinessError, isSticky:boolean) { function isStickyCB(err:Base.BusinessError, isSticky:boolean) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("isSticky " + JSON.stringify(isSticky)); console.info("isSticky " + JSON.stringify(isSticky));
...@@ -439,7 +439,7 @@ Aborts this common event. After the abort, the common event is not sent to the n ...@@ -439,7 +439,7 @@ Aborts this common event. After the abort, the common event is not sent to the n
```ts ```ts
// Callback for common event aborting. // Callback for common event aborting.
function abortCB(err:Base.BusinessError) { function abortCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("abortCommonEvent"); console.info("abortCommonEvent");
...@@ -491,7 +491,7 @@ Clears the aborted state of this common event. This API takes effect only for or ...@@ -491,7 +491,7 @@ Clears the aborted state of this common event. This API takes effect only for or
```ts ```ts
// Callback for clearing the aborted state of the current common event. // Callback for clearing the aborted state of the current common event.
function clearAbortCB(err:Base.BusinessError) { function clearAbortCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("clearAbortCommonEvent"); console.info("clearAbortCommonEvent");
...@@ -543,7 +543,7 @@ Checks whether this common event is in the aborted state. This API takes effect ...@@ -543,7 +543,7 @@ Checks whether this common event is in the aborted state. This API takes effect
```ts ```ts
// Callback for checking whether the current common event is in the aborted state. // Callback for checking whether the current common event is in the aborted state.
function getAbortCB(err:Base.BusinessError, abortEvent:boolean) { function getAbortCB(err:Base.BusinessError, abortEvent:boolean) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("abortCommonEvent " + abortEvent) console.info("abortCommonEvent " + abortEvent)
...@@ -595,7 +595,7 @@ Obtains the subscriber information. This API uses an asynchronous callback to re ...@@ -595,7 +595,7 @@ Obtains the subscriber information. This API uses an asynchronous callback to re
```ts ```ts
// Callback for subscriber information obtaining. // Callback for subscriber information obtaining.
function getCB(err:Base.BusinessError, subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) { function getCB(err:Base.BusinessError, subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
...@@ -647,7 +647,7 @@ Finishes this common event. This API takes effect only for ordered common events ...@@ -647,7 +647,7 @@ Finishes this common event. This API takes effect only for ordered common events
```ts ```ts
// Callback for ordered common event finishing. // Callback for ordered common event finishing.
function finishCB(err:Base.BusinessError) { function finishCB(err:Base.BusinessError) {
if (err.code) { if (err.code !== undefined && err.code != null) {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
console.info("FinishCommonEvent"); console.info("FinishCommonEvent");
......
en/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @ 23949e52
...@@ -36,10 +36,17 @@ Enables listening for combination key events. This API uses an asynchronous call ...@@ -36,10 +36,17 @@ Enables listening for combination key events. This API uses an asynchronous call
```js ```js
let leftAltKey = 2045; let leftAltKey = 2045;
let tabKey = 2049; let tabKey = 2049;
try { let keyOptions: inputConsumer.KeyOptions = {
inputConsumer.on("key", {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0}, keyOptions => { preKeys: [ leftAltKey ],
finalKey: tabKey,
isFinalKeyDown: true,
finalKeyDownDuration: 0
};
let callback = (keyOptions: inputConsumer.KeyOptions) => {
console.log(`keyOptions: ${JSON.stringify(keyOptions)}`); console.log(`keyOptions: ${JSON.stringify(keyOptions)}`);
}); }
try {
inputConsumer.on("key", keyOptions, callback);
} catch (error) { } catch (error) {
console.log(`Subscribe failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Subscribe failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
} }
...@@ -68,10 +75,10 @@ Disables listening for combination key events. ...@@ -68,10 +75,10 @@ Disables listening for combination key events.
let leftAltKey = 2045; let leftAltKey = 2045;
let tabKey = 2049; let tabKey = 2049;
// Disable listening for a single callback function. // Disable listening for a single callback function.
let callback = function (keyOptions) { let callback = (keyOptions: inputConsumer.KeyOptions) => {
console.log(`keyOptions: ${JSON.stringify(keyOptions)}`); console.log(`keyOptions: ${JSON.stringify(keyOptions)}`);
} }
let keyOption = {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0}; let keyOption: inputConsumer.KeyOptions = {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0};
try { try {
inputConsumer.on("key", keyOption, callback); inputConsumer.on("key", keyOption, callback);
inputConsumer.off("key", keyOption, callback); inputConsumer.off("key", keyOption, callback);
...@@ -84,10 +91,10 @@ try { ...@@ -84,10 +91,10 @@ try {
let leftAltKey = 2045; let leftAltKey = 2045;
let tabKey = 2049; let tabKey = 2049;
// Disable listening for all callback functions. // Disable listening for all callback functions.
let callback = function (keyOptions) { let callback = (keyOptions: inputConsumer.KeyOptions) => {
console.log(`keyOptions: ${JSON.stringify(keyOptions)}`); console.log(`keyOptions: ${JSON.stringify(keyOptions)}`);
} }
let keyOption = {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0}; let keyOption: inputConsumer.KeyOptions = {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0};
try { try {
inputConsumer.on("key", keyOption, callback); inputConsumer.on("key", keyOption, callback);
inputConsumer.off("key", keyOption); inputConsumer.off("key", keyOption);
......
en/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @ 23949e52
...@@ -64,7 +64,7 @@ Obtains the IDs of all input devices. This API uses a promise to return the resu ...@@ -64,7 +64,7 @@ Obtains the IDs of all input devices. This API uses a promise to return the resu
```js ```js
try { try {
inputDevice.getDeviceList().then((ids) => { inputDevice.getDeviceList().then((ids: Array<number>) => {
console.log(`Device id list: ${JSON.stringify(ids)}`); console.log(`Device id list: ${JSON.stringify(ids)}`);
}); });
} catch (error) { } catch (error) {
...@@ -157,9 +157,9 @@ Enables listening for device hot swap events. ...@@ -157,9 +157,9 @@ Enables listening for device hot swap events.
```js ```js
let isPhysicalKeyboardExist = true; let isPhysicalKeyboardExist = true;
try { try {
inputDevice.on("change", (data) => { inputDevice.on("change", (data: inputDevice.DeviceListener) => {
console.log(`Device event info: ${JSON.stringify(data)}`); console.log(`Device event info: ${JSON.stringify(data)}`);
inputDevice.getKeyboardType(data.deviceId, (err, type) => { inputDevice.getKeyboardType(data.deviceId, (err: Error, type: inputDevice.KeyboardType) => {
console.log("The keyboard type is: " + type); console.log("The keyboard type is: " + type);
if (type == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') { if (type == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') {
// The physical keyboard is connected. // The physical keyboard is connected.
...@@ -238,7 +238,7 @@ This API is deprecated since API version 9. You are advised to use [inputDevice. ...@@ -238,7 +238,7 @@ This API is deprecated since API version 9. You are advised to use [inputDevice.
**Example** **Example**
```js ```js
inputDevice.getDeviceIds((error, ids) => { inputDevice.getDeviceIds((error: Error, ids: Array<number>) => {
if (error) { if (error) {
console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -266,7 +266,7 @@ This API is deprecated since API version 9. You are advised to use [inputDevice. ...@@ -266,7 +266,7 @@ This API is deprecated since API version 9. You are advised to use [inputDevice.
**Example** **Example**
```js ```js
inputDevice.getDeviceIds().then((ids) => { inputDevice.getDeviceIds().then((ids: Array<number>) => {
console.log(`Device id list: ${JSON.stringify(ids)}`); console.log(`Device id list: ${JSON.stringify(ids)}`);
}); });
``` ```
...@@ -353,7 +353,7 @@ Obtains the key codes supported by the input device. This API uses an asynchrono ...@@ -353,7 +353,7 @@ Obtains the key codes supported by the input device. This API uses an asynchrono
```js ```js
// Check whether the input device whose ID is 1 supports key codes 17, 22, and 2055. // Check whether the input device whose ID is 1 supports key codes 17, 22, and 2055.
try { try {
inputDevice.supportKeys(1, [17, 22, 2055], (error, supportResult) => { inputDevice.supportKeys(1, [17, 22, 2055], (error: Error, supportResult: Array<boolean>) => {
console.log(`Query result: ${JSON.stringify(supportResult)}`); console.log(`Query result: ${JSON.stringify(supportResult)}`);
}); });
} catch (error) { } catch (error) {
...@@ -452,7 +452,7 @@ Obtains the keyboard type of an input device. This API uses an asynchronous call ...@@ -452,7 +452,7 @@ Obtains the keyboard type of an input device. This API uses an asynchronous call
```js ```js
// Query the keyboard type of the input device whose ID is 1. // Query the keyboard type of the input device whose ID is 1.
try { try {
inputDevice.getKeyboardType(1).then((type) => { inputDevice.getKeyboardType(1).then((type: number) => {
console.log(`Keyboard type: ${JSON.stringify(type)}`); console.log(`Keyboard type: ${JSON.stringify(type)}`);
}); });
} catch (error) { } catch (error) {
...@@ -547,7 +547,7 @@ Obtains the keyboard repeat delay. This API uses an asynchronous callback to ret ...@@ -547,7 +547,7 @@ Obtains the keyboard repeat delay. This API uses an asynchronous callback to ret
```js ```js
try { try {
inputDevice.getKeyboardRepeatDelay((error, delay) => { inputDevice.getKeyboardRepeatDelay((error: Error, delay: number) => {
if (error) { if (error) {
console.log(`Get keyboard repeat delay failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Get keyboard repeat delay failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
......
en/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ 23949e52
...@@ -37,7 +37,7 @@ Enables listening for global touch events. ...@@ -37,7 +37,7 @@ Enables listening for global touch events.
```js ```js
try { try {
inputMonitor.on("touch", (touchEvent) => { inputMonitor.on("touch", (touchEvent: TouchEvent) => {
console.log(`Monitor on success ${JSON.stringify(touchEvent)}`); console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
return false; return false;
}); });
...@@ -99,7 +99,7 @@ Disables listening for global touch events. ...@@ -99,7 +99,7 @@ Disables listening for global touch events.
```js ```js
// Disable listening for a single callback function. // Disable listening for a single callback function.
function callback(touchEvent) { let callback = (touchEvent: touchEvent) => {
console.log(`Monitor on success ${JSON.stringify(touchEvent)}`); console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
return false; return false;
}; };
...@@ -114,7 +114,7 @@ try { ...@@ -114,7 +114,7 @@ try {
```js ```js
// Cancel listening for all callback functions. // Cancel listening for all callback functions.
function callback(touchEvent) { let callback = (touchEvent: touchEvent) => {
console.log(`Monitor on success ${JSON.stringify(touchEvent)}`); console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
return false; return false;
}; };
...@@ -148,7 +148,7 @@ Stops listening for global mouse events. ...@@ -148,7 +148,7 @@ Stops listening for global mouse events.
```js ```js
// Disable listening for a single callback. // Disable listening for a single callback.
function callback(mouseEvent) { let callback = (mouseEvent: MouseEvent) => {
console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`); console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
return false; return false;
}; };
...@@ -163,7 +163,7 @@ try { ...@@ -163,7 +163,7 @@ try {
```js ```js
// Disable listening for all callback functions. // Disable listening for all callback functions.
function callback(mouseEvent) { let callback = (mouseEvent: MouseEvent) => {
console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`); console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
return false; return false;
}; };
......
en/application-dev/reference/apis/js-apis-nfcTag.md
浏览文件 @ 23949e52
...@@ -525,7 +525,7 @@ import tag from '@ohos.nfc.tag'; ...@@ -525,7 +525,7 @@ import tag from '@ohos.nfc.tag';
let elementName = null; let elementName = null;
let discTech = [tag.NFC_A, tag.NFC_B]; // replace with the tech(s) that is needed by foreground ability let discTech = [tag.NFC_A, tag.NFC_B]; // replace with the tech(s) that is needed by foreground ability
function foregroundCb(err, taginfo) { function foregroundCb(err, tagInfo) {
if (!err) { if (!err) {
console.log("foreground callback: tag found tagInfo = ", JSON.stringify(tagInfo)); console.log("foreground callback: tag found tagInfo = ", JSON.stringify(tagInfo));
} else { } else {
......
en/application-dev/reference/apis/js-apis-nfctech.md
浏览文件 @ 23949e52
...@@ -1863,7 +1863,7 @@ The following describes the unique APIs of **MifareUltralightTag**. ...@@ -1863,7 +1863,7 @@ The following describes the unique APIs of **MifareUltralightTag**.
readMultiplePages(pageIndex: number): Promise\<number[]> readMultiplePages(pageIndex: number): Promise\<number[]>
Reads four pages (4 bytes per page) from this tag. This API uses a promise to return the result. Reads four pages of data (4 bytes per page) from this tag. This API uses a promise to return the result.
**Required permissions**: ohos.permission.NFC_TAG **Required permissions**: ohos.permission.NFC_TAG
...@@ -1921,7 +1921,7 @@ try { ...@@ -1921,7 +1921,7 @@ try {
readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void
Reads four pages (4 bytes per page) from this tag. This API uses an asynchronous callback to return the result. Reads four pages of data (4 bytes per page) from this tag. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.NFC_TAG **Required permissions**: ohos.permission.NFC_TAG
...@@ -2188,6 +2188,13 @@ Formats this tag as an NDEF tag, and writes an NDEF message to it. This API uses ...@@ -2188,6 +2188,13 @@ Formats this tag as an NDEF tag, and writes an NDEF message to it. This API uses
| ------------------ | --------------------------| | ------------------ | --------------------------|
| callback: AsyncCallback\<void> | Callback invoked to return the result.| | callback: AsyncCallback\<void> | Callback invoked to return the result.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
**Example** **Example**
...@@ -2297,6 +2304,13 @@ Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and the ...@@ -2297,6 +2304,13 @@ Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and the
| ------------------ | --------------------------| | ------------------ | --------------------------|
| callback: AsyncCallback\<void> | Callback invoked to return the result.| | callback: AsyncCallback\<void> | Callback invoked to return the result.|
**Error codes**
For details about the error codes, see [NFC Error Codes](../errorcodes/errorcode-nfc.md).
| ID| Error Message|
| ------- | -------|
| 3100201 | Tag running state is abnormal in service. |
**Example** **Example**
......
en/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @ 23949e52
...@@ -31,7 +31,7 @@ Sets the visible status of the mouse pointer. This API uses an asynchronous call ...@@ -31,7 +31,7 @@ Sets the visible status of the mouse pointer. This API uses an asynchronous call
```js ```js
try { try {
pointer.setPointerVisible(true, (error) => { pointer.setPointerVisible(true, (error: Error) => {
if (error) { if (error) {
console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Set pointer visible failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -123,7 +123,7 @@ Checks the visible status of the mouse pointer. This API uses a promise to retur ...@@ -123,7 +123,7 @@ Checks the visible status of the mouse pointer. This API uses a promise to retur
```js ```js
try { try {
pointer.isPointerVisible().then((visible) => { pointer.isPointerVisible().then((visible: boolean) => {
console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`); console.log(`Get pointer visible success, visible: ${JSON.stringify(visible)}`);
}); });
} catch (error) { } catch (error) {
...@@ -152,7 +152,7 @@ Sets the mouse movement speed. This API uses an asynchronous callback to return ...@@ -152,7 +152,7 @@ Sets the mouse movement speed. This API uses an asynchronous callback to return
```js ```js
try { try {
pointer.setPointerSpeed(5, (error) => { pointer.setPointerSpeed(5, (error: Error) => {
if (error) { if (error) {
console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -218,7 +218,7 @@ Obtains the mouse movement speed. This API uses an asynchronous callback to retu ...@@ -218,7 +218,7 @@ Obtains the mouse movement speed. This API uses an asynchronous callback to retu
```js ```js
try { try {
pointer.getPointerSpeed((error, speed) => { pointer.getPointerSpeed((error: Error, speed：number) => {
if (error) { if (error) {
console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -250,7 +250,7 @@ Obtains the mouse movement speed. This API uses a promise to return the result. ...@@ -250,7 +250,7 @@ Obtains the mouse movement speed. This API uses a promise to return the result.
```js ```js
try { try {
pointer.getPointerSpeed().then(speed => { pointer.getPointerSpeed().then(speed: number => {
console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`); console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
}); });
} catch (error) { } catch (error) {
...@@ -279,7 +279,7 @@ Sets the status of the mouse hover scroll switch. This API uses an asynchronous ...@@ -279,7 +279,7 @@ Sets the status of the mouse hover scroll switch. This API uses an asynchronous
```js ```js
try { try {
pointer.setHoverScrollState(true, (error) => { pointer.setHoverScrollState(true, (error: Error) => {
if (error) { if (error) {
console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -345,7 +345,7 @@ Obtains the status of the mouse hover scroll switch. This API uses an asynchrono ...@@ -345,7 +345,7 @@ Obtains the status of the mouse hover scroll switch. This API uses an asynchrono
```js ```js
try { try {
pointer.getHoverScrollState((error, state) => { pointer.getHoverScrollState((error: Error, state: boolean) => {
console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`); console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -373,7 +373,7 @@ Obtains the status of the mouse hover scroll switch. This API uses a promise to ...@@ -373,7 +373,7 @@ Obtains the status of the mouse hover scroll switch. This API uses a promise to
```js ```js
try { try {
pointer.getHoverScrollState().then((state) => { pointer.getHoverScrollState().then((state: Boolean) => {
console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`); console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -402,7 +402,7 @@ Sets the primary button of the mouse. This API uses an asynchronous callback to ...@@ -402,7 +402,7 @@ Sets the primary button of the mouse. This API uses an asynchronous callback to
```js ```js
try { try {
pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error) => { pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error: Error) => {
if (error) { if (error) {
console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -656,9 +656,9 @@ Obtains the mouse pointer style. This API uses an asynchronous callback to retur ...@@ -656,9 +656,9 @@ Obtains the mouse pointer style. This API uses an asynchronous callback to retur
**Example** **Example**
```js ```js
import window from '@ohos.window'; import { BusinessError } from '@ohos.base';
let context = getContext(this);
window.getLastWindow(this.context, (error, win) => { window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
if (error.code) { if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error)); console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return; return;
...@@ -669,7 +669,7 @@ window.getLastWindow(this.context, (error, win) => { ...@@ -669,7 +669,7 @@ window.getLastWindow(this.context, (error, win) => {
return; return;
} }
try { try {
pointer.getPointerStyle(windowId, (error, style) => { pointer.getPointerStyle(windowId, (error: Error, style: pointer.PointerStyle) => {
console.log(`Get pointer style success, style: ${JSON.stringify(style)}`); console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
}); });
} catch (error) { } catch (error) {
...@@ -701,9 +701,9 @@ Obtains the mouse pointer style. This API uses a promise to return the result. ...@@ -701,9 +701,9 @@ Obtains the mouse pointer style. This API uses a promise to return the result.
**Example** **Example**
```js ```js
import window from '@ohos.window'; import { BusinessError } from '@ohos.base';
let context = getContext(this);
window.getLastWindow(this.context, (error, win) => { window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
if (error.code) { if (error.code) {
console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error)); console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
return; return;
...@@ -714,7 +714,7 @@ window.getLastWindow(this.context, (error, win) => { ...@@ -714,7 +714,7 @@ window.getLastWindow(this.context, (error, win) => {
return; return;
} }
try { try {
pointer.getPointerStyle(windowId).then((style) => { pointer.getPointerStyle(windowId).then((style: pointer.PointerStyle) => {
console.log(`Get pointer style success, style: ${JSON.stringify(style)}`); console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
}); });
} catch (error) { } catch (error) {
...@@ -875,7 +875,7 @@ Sets the scroll switch of the touchpad. This API uses an asynchronous callback t ...@@ -875,7 +875,7 @@ Sets the scroll switch of the touchpad. This API uses an asynchronous callback t
```js ```js
try { try {
pointer.setTouchpadScrollSwitch(true, (error) => { pointer.setTouchpadScrollSwitch(true, (error: Error) => {
if (error) { if (error) {
console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -941,7 +941,7 @@ Obtains the scroll switch status of the touchpad. This API uses an asynchronous ...@@ -941,7 +941,7 @@ Obtains the scroll switch status of the touchpad. This API uses an asynchronous
```js ```js
try { try {
pointer.getTouchpadScrollSwitch ((error, state) => { pointer.getTouchpadScrollSwitch ((error: Error, state: Boolean) => {
console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -969,7 +969,7 @@ Obtains the scroll switch status of the touchpad. This API uses a promise to ret ...@@ -969,7 +969,7 @@ Obtains the scroll switch status of the touchpad. This API uses a promise to ret
```js ```js
try { try {
pointer.getTouchpadScrollSwitch().then((state) => { pointer.getTouchpadScrollSwitch().then((state: Boolean) => {
console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1064,7 +1064,7 @@ Obtains the scroll direction of the touchpad. This API uses an asynchronous call ...@@ -1064,7 +1064,7 @@ Obtains the scroll direction of the touchpad. This API uses an asynchronous call
```js ```js
try { try {
pointer.getTouchpadScrollSwitch ((error, state) => { pointer.getTouchpadScrollSwitch ((error: Error, state: Boolean) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1092,7 +1092,7 @@ Obtains the scroll direction of the touchpad. This API uses a promise to return ...@@ -1092,7 +1092,7 @@ Obtains the scroll direction of the touchpad. This API uses a promise to return
```js ```js
try { try {
pointer.getTouchpadScrollDirection().then((state) => { pointer.getTouchpadScrollDirection().then((state: Boolean) => {
console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1121,7 +1121,7 @@ Sets the tap switch of the touchpad. This API uses an asynchronous callback to r ...@@ -1121,7 +1121,7 @@ Sets the tap switch of the touchpad. This API uses an asynchronous callback to r
```js ```js
try { try {
pointer.setTouchpadTapSwitch(true, (error) => { pointer.setTouchpadTapSwitch(true, (error: Error) => {
if (error) { if (error) {
console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -1215,7 +1215,7 @@ Obtains the tap switch status of the touchpad. This API uses a promise to return ...@@ -1215,7 +1215,7 @@ Obtains the tap switch status of the touchpad. This API uses a promise to return
```js ```js
try { try {
pointer.getTouchpadTapSwitch().then((state) => { pointer.getTouchpadTapSwitch().then((state: Boolean) => {
console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1310,7 +1310,7 @@ Obtains the cursor moving speed of the touchpad. This API uses an asynchronous c ...@@ -1310,7 +1310,7 @@ Obtains the cursor moving speed of the touchpad. This API uses an asynchronous c
```js ```js
try { try {
pointer.getTouchpadPointerSpeed((error, speed) => { pointer.getTouchpadPointerSpeed((error: Error, speed: number) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`); console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1338,7 +1338,7 @@ Obtains the cursor moving speed of the touchpad. This API uses a promise to retu ...@@ -1338,7 +1338,7 @@ Obtains the cursor moving speed of the touchpad. This API uses a promise to retu
```js ```js
try { try {
pointer.getTouchpadPointerSpeed().then((speed) => { pointer.getTouchpadPointerSpeed().then((speed: number) => {
console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`); console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1367,7 +1367,7 @@ Sets the pinch switch of the touchpad. This API uses an asynchronous callback to ...@@ -1367,7 +1367,7 @@ Sets the pinch switch of the touchpad. This API uses an asynchronous callback to
```js ```js
try { try {
pointer.setTouchpadTapSwitch(true, (error) => { pointer.setTouchpadTapSwitch(true, (error: Error) => {
if (error) { if (error) {
console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -1490,7 +1490,7 @@ Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronou ...@@ -1490,7 +1490,7 @@ Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronou
```js ```js
try { try {
pointer.setTouchpadSwipeSwitch(true, (error) => { pointer.setTouchpadSwipeSwitch(true, (error: Error) => {
if (error) { if (error) {
console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
...@@ -1584,7 +1584,7 @@ Obtains the multi-finger swipe switch status of the touchpad. This API uses a pr ...@@ -1584,7 +1584,7 @@ Obtains the multi-finger swipe switch status of the touchpad. This API uses a pr
```js ```js
try { try {
pointer.getTouchpadSwipeSwitch().then((state) => { pointer.getTouchpadSwipeSwitch().then((state: boolean) => {
console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`); console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1691,7 +1691,7 @@ Obtains the shortcut menu type of the touchpad. This API uses an asynchronous ca ...@@ -1691,7 +1691,7 @@ Obtains the shortcut menu type of the touchpad. This API uses an asynchronous ca
```js ```js
try { try {
pointer.getTouchpadRightClickType((error, type) => { pointer.getTouchpadRightClickType((error: Error, type: pointer.RightClickType) => {
console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`); console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1869,7 +1869,7 @@ Obtains the pointer size. This API uses a promise to return the result. ...@@ -1869,7 +1869,7 @@ Obtains the pointer size. This API uses a promise to return the result.
```js ```js
try { try {
pointer.getPointerSize().then((size) => { pointer.getPointerSize().then((size: number) => {
console.log(`getPointerSize success, size: ${JSON.stringify(size)}`); console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
}); });
} catch (error) { } catch (error) {
...@@ -1925,7 +1925,7 @@ Sets the pointer color. This API uses an asynchronous callback to return the res ...@@ -1925,7 +1925,7 @@ Sets the pointer color. This API uses an asynchronous callback to return the res
```js ```js
try { try {
pointer.setPointerColor(0xF6C800, (error) => { pointer.setPointerColor(0xF6C800, (error: Error) => {
if (error) { if (error) {
console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
return; return;
......
zh-cn/application-dev/application-models/Readme-CN.md
浏览文件 @ 23949e52
...@@ -62,7 +62,7 @@ ...@@ -62,7 +62,7 @@
- 应用组件跨设备交互（流转） - 应用组件跨设备交互（流转）
- [流转概述](inter-device-interaction-hop-overview.md) - [流转概述](inter-device-interaction-hop-overview.md)
- [跨端迁移](hop-cross-device-migration.md) - [跨端迁移](hop-cross-device-migration.md)
- [多端协同（仅对系统应用开放）](hop-multi-device-collaboration.md) - [多端协同](hop-multi-device-collaboration.md)
- [订阅系统环境变量的变化](subscribe-system-environment-variable-changes.md) - [订阅系统环境变量的变化](subscribe-system-environment-variable-changes.md)
- 了解进程模型 - 了解进程模型
- [进程模型概述](process-model-stage.md) - [进程模型概述](process-model-stage.md)
......
zh-cn/application-dev/application-models/arkts-ui-widget-event-call.md
浏览文件 @ 23949e52
...@@ -53,27 +53,48 @@ ...@@ -53,27 +53,48 @@
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import Base from '@ohos.base'
import rpc from '@ohos.rpc';
import Want from '@ohos.app.ability.Want';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
function FunACall(data) {
// 获取call事件中传递的所有参数
console.info('FunACall param:' + JSON.stringify(data.readString()));
return null;
}
function FunBCall(data) { class MyParcelable implements rpc.Parcelable {
console.info('FunBCall param:' + JSON.stringify(data.readString())); num: number;
return null; str: string;
constructor(num: number, str: string) {
this.num = num;
this.str = str;
}
marshalling(messageSequence: rpc.MessageSequence): boolean {
messageSequence.writeInt(this.num);
messageSequence.writeString(this.str);
return true;
}
unmarshalling(messageSequence: rpc.MessageSequence): boolean {
this.num = messageSequence.readInt();
this.str = messageSequence.readString();
return true;
}
} }
export default class CameraAbility extends UIAbility { export default class CameraAbility extends UIAbility {
// 如果UIAbility第一次启动，在收到call事件后会触发onCreate生命周期回调 // 如果UIAbility第一次启动，在收到call事件后会触发onCreate生命周期回调
onCreate(want, launchParam) { onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
try { try {
// 监听call事件所需的方法 // 监听call事件所需的方法
this.callee.on('funA', FunACall); this.callee.on('funA', (data: rpc.MessageSequence) => {
this.callee.on('funB', FunBCall); // 获取call事件中传递的所有参数
console.info('FunACall param:' + JSON.stringify(data.readString()));
return new MyParcelable(1, 'aaa');
});
this.callee.on('funB', (data: rpc.MessageSequence) => {
// 获取call事件中传递的所有参数
console.info('FunACall param:' + JSON.stringify(data.readString()));
return new MyParcelable(2, 'bbb');
});
} catch (err) { } catch (err) {
console.error(`Failed to register callee on. Cause: ${JSON.stringify(err)}`); console.error(`Failed to register callee on. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
} }
} }
...@@ -85,7 +106,7 @@ ...@@ -85,7 +106,7 @@
this.callee.off('funA'); this.callee.off('funA');
this.callee.off('funB'); this.callee.off('funB');
} catch (err) { } catch (err) {
console.error(`Failed to register callee off. Cause: ${JSON.stringify(err)}`); console.error(`Failed to register callee off. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
} }
} }
}; };
......
zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md
浏览文件 @ 23949e52
...@@ -52,10 +52,10 @@ ...@@ -52,10 +52,10 @@
let formData = new Map<Object, string>(); let formData = new Map<Object, string>();
formData.set('title', 'Title Update.'); // 和卡片布局中对应 formData.set('title', 'Title Update.'); // 和卡片布局中对应
formData.set('detail', 'Description update success.'); // 和卡片布局中对应 formData.set('detail', 'Description update success.'); // 和卡片布局中对应
let formInfo = formBindingData.createFormBindingData(formData) let formInfo: formBindingData.FormBindingData = formBindingData.createFormBindingData(formData);
formProvider.updateForm(formId, formInfo).then((data) => { formProvider.updateForm(formId, formInfo).then(() => {
console.info('FormAbility updateForm success.' + JSON.stringify(data)); console.info('FormAbility updateForm success.');
}) });
} }
... ...
......
zh-cn/application-dev/application-models/arkts-ui-widget-event-router.md
浏览文件 @ 23949e52
...@@ -54,26 +54,29 @@ ...@@ -54,26 +54,29 @@
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window'; import window from '@ohos.window';
import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
let selectPage = ""; let selectPage: string = "";
let currentWindowStage = null; let currentWindowStage: window.WindowStage | null = null;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// 如果UIAbility第一次启动，在收到Router事件后会触发onCreate生命周期回调 // 如果UIAbility第一次启动，在收到Router事件后会触发onCreate生命周期回调
onCreate(want, launchParam) { onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
// 获取router事件中传递的targetPage参数 // 获取router事件中传递的targetPage参数
console.info("onCreate want:" + JSON.stringify(want)); console.info("onCreate want:" + JSON.stringify(want));
if (want.parameters.params !== undefined) { if (want.parameters?.params !== undefined) {
let params = JSON.parse(want.parameters.params); let params: Record<string, string> = JSON.parse(JSON.stringify(want.parameters?.params));
console.info("onCreate router targetPage:" + params.targetPage); console.info("onCreate router targetPage:" + params.targetPage);
selectPage = params.targetPage; selectPage = params.targetPage;
} }
} }
// 如果UIAbility已在后台运行，在收到Router事件后会触发onNewWant生命周期回调 // 如果UIAbility已在后台运行，在收到Router事件后会触发onNewWant生命周期回调
onNewWant(want, launchParam) { onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam) {
console.info("onNewWant want:" + JSON.stringify(want)); console.info("onNewWant want:" + JSON.stringify(want));
if (want.parameters.params !== undefined) { if (want.parameters?.params !== undefined) {
let params = JSON.parse(want.parameters.params); let params: Record<string, string> = JSON.parse(JSON.stringify(want.parameters?.params));
console.info("onNewWant router targetPage:" + params.targetPage); console.info("onNewWant router targetPage:" + params.targetPage);
selectPage = params.targetPage; selectPage = params.targetPage;
} }
...@@ -83,7 +86,7 @@ ...@@ -83,7 +86,7 @@
} }
onWindowStageCreate(windowStage: window.WindowStage) { onWindowStageCreate(windowStage: window.WindowStage) {
let targetPage; let targetPage: string;
// 根据传递的targetPage不同，选择拉起不同的页面 // 根据传递的targetPage不同，选择拉起不同的页面
switch (selectPage) { switch (selectPage) {
case 'funA': case 'funA':
...@@ -98,7 +101,7 @@ ...@@ -98,7 +101,7 @@
if (currentWindowStage === null) { if (currentWindowStage === null) {
currentWindowStage = windowStage; currentWindowStage = windowStage;
} }
windowStage.loadContent(targetPage, (err, data) => { windowStage.loadContent(targetPage, (err: Base.BusinessError) => {
if (err && err.code) { if (err && err.code) {
console.info('Failed to load the content. Cause: %{public}s', JSON.stringify(err)); console.info('Failed to load the content. Cause: %{public}s', JSON.stringify(err));
return; return;
......
zh-cn/application-dev/application-models/arkts-ui-widget-event-uiability.md
浏览文件 @ 23949e52
...@@ -44,30 +44,33 @@ ...@@ -44,30 +44,33 @@
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
import formInfo from '@ohos.app.form.formInfo'; import formInfo from '@ohos.app.form.formInfo';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base'
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// 如果UIAbility第一次启动，在收到Router事件后会触发onCreate生命周期回调 // 如果UIAbility第一次启动，在收到Router事件后会触发onCreate生命周期回调
onCreate(want, launchParam) { onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
this.handleFormRouterEvent(want); this.handleFormRouterEvent(want);
} }
// 如果UIAbility已在后台运行，在收到Router事件后会触发onNewWant生命周期回调 // 如果UIAbility已在后台运行，在收到Router事件后会触发onNewWant生命周期回调
onNewWant(want, launchParam) { onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam) {
this.handleFormRouterEvent(want); this.handleFormRouterEvent(want);
} }
handleFormRouterEvent(want) { handleFormRouterEvent(want: Want) {
console.info('Want:' + JSON.stringify(want)); console.info('Want:' + JSON.stringify(want));
if (want.parameters[formInfo.FormParam.IDENTITY_KEY] !== undefined) { if (want.parameters && want.parameters[formInfo.FormParam.IDENTITY_KEY] !== undefined) {
let curFormId = want.parameters[formInfo.FormParam.IDENTITY_KEY]; let curFormId = JSON.stringify(want.parameters[formInfo.FormParam.IDENTITY_KEY]);
let message = JSON.parse(want.parameters.params).detail; let message: string = JSON.parse(JSON.stringify(want.parameters.params)).detail;
console.info(`UpdateForm formId: ${curFormId}, message: ${message}`); console.info(`UpdateForm formId: ${curFormId}, message: ${message}`);
let formData = { let formData: Record<string, string> = {
"detail": message + ': UIAbility.', // 和卡片布局中对应 "detail": message + ': UIAbility.', // 和卡片布局中对应
}; };
let formMsg = formBindingData.createFormBindingData(formData) let formMsg = formBindingData.createFormBindingData(formData)
formProvider.updateForm(curFormId, formMsg).then((data) => { formProvider.updateForm(curFormId, formMsg).then((data) => {
console.info('updateForm success.' + JSON.stringify(data)); console.info('updateForm success.' + JSON.stringify(data));
}).catch((error) => { }).catch((error: Base.BusinessError) => {
console.error('updateForm failed:' + JSON.stringify(error)); console.error('updateForm failed:' + JSON.stringify(error));
}) })
} }
...@@ -83,17 +86,20 @@ ...@@ -83,17 +86,20 @@
```ts ```ts
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import Want from '@ohos.app.ability.Want';
export default class EntryFormAbility extends FormExtensionAbility { export default class EntryFormAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want: Want) {
let formId = want.parameters["ohos.extra.param.key.form_identity"]; let dataObj1: Record<string, string> | undefined;
let dataObj1 = { if (want.parameters && want.parameters["ohos.extra.param.key.form_identity"] != undefined) {
let formId: string = JSON.parse(JSON.stringify(want.parameters["ohos.extra.param.key.form_identity"]));
dataObj1 = {
"formId": formId "formId": formId
}; };
}
let obj1 = formBindingData.createFormBindingData(dataObj1); let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1; return obj1;
} }
... ...
}; };
``` ```
...@@ -138,40 +144,63 @@ ...@@ -138,40 +144,63 @@
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base'
import rpc from '@ohos.rpc';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
const MSG_SEND_METHOD: string = 'funA'; const MSG_SEND_METHOD: string = 'funA';
class MyParcelable implements rpc.Parcelable {
num: number;
str: string;
constructor(num: number, str: string) {
this.num = num;
this.str = str;
}
marshalling(messageSequence: rpc.MessageSequence): boolean {
messageSequence.writeInt(this.num);
messageSequence.writeString(this.str);
return true;
}
unmarshalling(messageSequence: rpc.MessageSequence): boolean {
this.num = messageSequence.readInt();
this.str = messageSequence.readString();
return true;
}
}
// 在收到call事件后会触发callee监听的方法 // 在收到call事件后会触发callee监听的方法
function FunACall(data) { let FunACall = (data: rpc.MessageSequence) => {
// 获取call事件中传递的所有参数 // 获取call事件中传递的所有参数
let params = JSON.parse(data.readString()) let params: Record<string, string> = JSON.parse(data.readString())
if (params.formId !== undefined) { if (params.formId !== undefined) {
let curFormId = params.formId; let curFormId: string = params.formId;
let message = params.detail; let message: string = params.detail;
console.info(`UpdateForm formId: ${curFormId}, message: ${message}`); console.info(`UpdateForm formId: ${curFormId}, message: ${message}`);
let formData = { let formData: Record<string, string> = {
"detail": message "detail": message
}; };
let formMsg = formBindingData.createFormBindingData(formData) let formMsg: formBindingData.FormBindingData = formBindingData.createFormBindingData(formData);
formProvider.updateForm(curFormId, formMsg).then((data) => { formProvider.updateForm(curFormId, formMsg).then((data) => {
console.info('updateForm success.' + JSON.stringify(data)); console.info('updateForm success.' + JSON.stringify(data));
}).catch((error) => { }).catch((error: Base.BusinessError) => {
console.error('updateForm failed:' + JSON.stringify(error)); console.error('updateForm failed:' + JSON.stringify(error));
}) })
} }
return null; return new MyParcelable(1, 'aaa');
} }
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// 如果UIAbility第一次启动，call事件后会触发onCreate生命周期回调 // 如果UIAbility第一次启动，call事件后会触发onCreate生命周期回调
onCreate(want, launchParam) { onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
console.info('Want:' + JSON.stringify(want)); console.info('Want:' + JSON.stringify(want));
try { try {
// 监听call事件所需的方法 // 监听call事件所需的方法
this.callee.on(MSG_SEND_METHOD, FunACall); this.callee.on(MSG_SEND_METHOD, FunACall);
} catch (error) { } catch (error) {
console.info(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`) console.info(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error as Base.BusinessError)}`)
} }
} }
...
} }
``` ```
\ No newline at end of file
zh-cn/application-dev/application-models/arkts-ui-widget-image-update.md
浏览文件 @ 23949e52
...@@ -14,27 +14,30 @@ ...@@ -14,27 +14,30 @@
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import request from '@ohos.request'; import request from '@ohos.request';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base';
import fileFs from '@ohos.file.fs';
export default class EntryFormAbility extends FormExtensionAbility { export default class EntryFormAbility extends FormExtensionAbility {
... ...
// 在添加卡片时，打开一个本地图片并将图片内容传递给卡片页面显示 // 在添加卡片时，打开一个本地图片并将图片内容传递给卡片页面显示
onAddForm(want) { onAddForm(want: Want) {
// 假设在当前卡片应用的tmp目录下有一个本地图片：head.PNG // 假设在当前卡片应用的tmp目录下有一个本地图片：head.PNG
let tempDir = this.context.getApplicationContext().tempDir; let tempDir = this.context.getApplicationContext().tempDir;
// 打开本地图片并获取其打开后的fd // 打开本地图片并获取其打开后的fd
let file; let file: fileFs.File;
let formData = new Map<string, Object>();
formData.set('text', 'Image: Bear');
formData.set('imgName', 'imgBear');
formData.set('loaded', true);
try { try {
file = fs.openSync(tempDir + '/' + 'head.PNG'); file = fs.openSync(tempDir + '/' + 'head.PNG');
} catch (e) { let imgBear: Record<string, number> = {
console.error(`openSync failed: ${JSON.stringify(e)}`);
}
let formData = {
'text': 'Image: Bear',
'imgName': 'imgBear',
'formImages': {
'imgBear': file.fd 'imgBear': file.fd
}, }
'loaded': true formData.set('formImages', imgBear);
} catch (e) {
console.error(`openSync failed: ${JSON.stringify(e as Base.BusinessError)}`);
} }
// 将fd封装在formData中并返回至卡片页面 // 将fd封装在formData中并返回至卡片页面
return formBindingData.createFormBindingData(formData); return formBindingData.createFormBindingData(formData);
...@@ -52,10 +55,12 @@ ...@@ -52,10 +55,12 @@
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import request from '@ohos.request'; import request from '@ohos.request';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
import Base from '@ohos.base';
import fileFs from '@ohos.file.fs';
export default class EntryFormAbility extends FormExtensionAbility { export default class EntryFormAbility extends FormExtensionAbility {
// 在卡片页面触发message事件时，下载一个网络图片，并将网络图片内容传递给卡片页面显示 // 在卡片页面触发message事件时，下载一个网络图片，并将网络图片内容传递给卡片页面显示
onFormEvent(formId, message) { onFormEvent(formId: string, message: string) {
let formInfo = formBindingData.createFormBindingData({ let formInfo = formBindingData.createFormBindingData({
'text': '刷新中...' 'text': '刷新中...'
}) })
...@@ -69,42 +74,40 @@ ...@@ -69,42 +74,40 @@
request.downloadFile(this.context, { request.downloadFile(this.context, {
url: netFile, filePath: tmpFile, enableMetered: true, enableRoaming: true url: netFile, filePath: tmpFile, enableMetered: true, enableRoaming: true
}).then((task) => { }).then((task) => {
task.on('complete', function callback() { task.on('complete', () => {
console.info('ArkTSCard download complete:' + tmpFile); console.info('ArkTSCard download complete:' + tmpFile);
let file; let file: fileFs.File;
let formData = new Map<string, Object>();
try { try {
file = fs.openSync(tmpFile); file = fs.openSync(tmpFile);
formData.set('text', 'Image: Bear' + fileName);
formData.set('imgName', 'imgBear' + fileName);
formData.set('loaded', true);
let imgBear: Record<string, number> = {
'imgBear': file.fd
};
formData.set('formImages', imgBear);
} catch (e) { } catch (e) {
console.error(`openSync failed: ${JSON.stringify(e)}`); console.error(`openSync failed: ${JSON.stringify(e as Base.BusinessError)}`);
} }
let fileInfo = {}; let formInfo = formBindingData.createFormBindingData(formData);
fileInfo[fileName] = file.fd; formProvider.updateForm(formId, formInfo).then(() => {
let formData = { console.info('FormAbility updateForm success.');
'text': 'Image:' + fileName, }).catch((error: Base.BusinessError) => {
'imgName': fileName,
'formImages': fileInfo,
'loaded': true
};
let formInfo = formBindingData.createFormBindingData(formData)
formProvider.updateForm(formId, formInfo).then((data) => {
console.info('FormAbility updateForm success.' + JSON.stringify(data));
}).catch((error) => {
console.error('FormAbility updateForm failed: ' + JSON.stringify(error)); console.error('FormAbility updateForm failed: ' + JSON.stringify(error));
});
}) })
}) task.on('fail', (err: number) => {
task.on('fail', function callBack(err) {
console.info('ArkTSCard download task failed. Cause:' + err); console.info('ArkTSCard download task failed. Cause:' + err);
let formInfo = formBindingData.createFormBindingData({ let formInfo = formBindingData.createFormBindingData({
'text': '刷新失败' 'text': '刷新失败'
}) })
formProvider.updateForm(formId, formInfo) formProvider.updateForm(formId, formInfo)
}); });
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); console.error('Failed to request the download. Cause: ' + JSON.stringify(err));
}); });
} }
...
}; };
``` ```
......
zh-cn/application-dev/application-models/arkts-ui-widget-lifecycle.md
浏览文件 @ 23949e52
...@@ -20,14 +20,16 @@ ...@@ -20,14 +20,16 @@
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
import { Configuration } from '@ohos.app.ability.Configuration';
import Want from '@ohos.app.ability.Want';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';
export default class EntryFormAbility extends FormExtensionAbility { export default class EntryFormAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want: Want) {
console.info('[EntryFormAbility] onAddForm'); console.info('[EntryFormAbility] onAddForm');
// 在入参want中可以取出卡片的唯一标识：formId
let formId: string = want.parameters[formInfo.FormParam.IDENTITY_KEY];
// 使用方创建卡片时触发，提供方需要返回卡片数据绑定类 // 使用方创建卡片时触发，提供方需要返回卡片数据绑定类
let obj = { let obj: Record<string, string> = {
'title': 'titleOnAddForm', 'title': 'titleOnAddForm',
'detail': 'detailOnAddForm' 'detail': 'detailOnAddForm'
}; };
...@@ -35,54 +37,50 @@ ...@@ -35,54 +37,50 @@
return formData; return formData;
} }
onCastToNormalForm(formId) { onCastToNormalForm(formId: string) {
// Called when the form provider is notified that a temporary form is successfully // Called when the form provider is notified that a temporary form is successfully
// converted to a normal form. // converted to a normal form.
// 使用方将临时卡片转换为常态卡片触发，提供方需要做相应的处理 // 使用方将临时卡片转换为常态卡片触发，提供方需要做相应的处理
console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`); console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`);
} }
onUpdateForm(formId) { onUpdateForm(formId: string) {
// 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新 // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新
console.info('[EntryFormAbility] onUpdateForm'); console.info('[EntryFormAbility] onUpdateForm');
let obj = { let obj: Record<string, string> = {
'title': 'titleOnUpdateForm', 'title': 'titleOnUpdateForm',
'detail': 'detailOnUpdateForm' 'detail': 'detailOnUpdateForm'
}; };
let formData = formBindingData.createFormBindingData(obj); let formData = formBindingData.createFormBindingData(obj);
formProvider.updateForm(formId, formData).catch((err) => { formProvider.updateForm(formId, formData).catch((err: Base.BusinessError) => {
if (err) {
// 异常分支打印
console.error(`[EntryFormAbility] Failed to updateForm. Code: ${err.code}, message: ${err.message}`); console.error(`[EntryFormAbility] Failed to updateForm. Code: ${err.code}, message: ${err.message}`);
return;
}
}); });
} }
onChangeFormVisibility(newStatus) { onChangeFormVisibility(newStatus: Record<string, number>) {
// Called when the form provider receives form events from the system. // Called when the form provider receives form events from the system.
// 需要配置formVisibleNotify为true，且为系统应用才会回调 // 需要配置formVisibleNotify为true，且为系统应用才会回调
console.info('[EntryFormAbility] onChangeFormVisibility'); console.info('[EntryFormAbility] onChangeFormVisibility');
} }
onFormEvent(formId, message) { onFormEvent(formId: string, message: string) {
// Called when a specified message event defined by the form provider is triggered. // Called when a specified message event defined by the form provider is triggered.
// 若卡片支持触发事件，则需要重写该方法并实现对事件的触发 // 若卡片支持触发事件，则需要重写该方法并实现对事件的触发
console.info('[EntryFormAbility] onFormEvent'); console.info('[EntryFormAbility] onFormEvent');
} }
onRemoveForm(formId) { onRemoveForm(formId: string) {
// Called to notify the form provider that a specified form has been destroyed. // Called to notify the form provider that a specified form has been destroyed.
// 当对应的卡片删除时触发的回调，入参是被删除的卡片ID // 当对应的卡片删除时触发的回调，入参是被删除的卡片ID
console.info('[EntryFormAbility] onRemoveForm'); console.info('[EntryFormAbility] onRemoveForm');
} }
onConfigurationUpdate(config) { onConfigurationUpdate(config: Configuration) {
// 当系统配置信息置更新时触发的回调 // 当系统配置信息置更新时触发的回调
console.info('[EntryFormAbility] configurationUpdate:' + JSON.stringify(config)); console.info('[EntryFormAbility] configurationUpdate:' + JSON.stringify(config));
} }
onAcquireFormState(want) { onAcquireFormState(want: Want) {
// Called to return a {@link FormState} object. // Called to return a {@link FormState} object.
// 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。 // 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。
return formInfo.FormState.READY; return formInfo.FormState.READY;
......
zh-cn/application-dev/application-models/arkts-ui-widget-update-by-proxy.md
浏览文件 @ 23949e52
...@@ -76,11 +76,13 @@ ...@@ -76,11 +76,13 @@
> key可以是uri也可以是简单字符串，subscriberId默认值为当前formId，实际取值都依赖于数据发布方的定义。 > key可以是uri也可以是简单字符串，subscriberId默认值为当前formId，实际取值都依赖于数据发布方的定义。
```ts ```ts
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import Want from '@ohos.app.ability.Want';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
let dataShareHelper; export default class EntryFormAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want: Want) {
let formData = {}; let formData: Record<string, Object> = {};
let proxies = [ let proxies: formBindingData.ProxyData[] = [
{ {
"key": "detail", "key": "detail",
"subscriberId": "11" "subscriberId": "11"
...@@ -90,6 +92,7 @@ ...@@ -90,6 +92,7 @@
formBinding["proxies"] = proxies; formBinding["proxies"] = proxies;
return formBinding; return formBinding;
} }
}
``` ```
- 在[卡片页面文件](arkts-ui-widget-creation.md)中，通过LocalStorage变量获取订阅到的数据，LocalStorage绑定了一个字符串，以key:value的键值对格式来刷新卡片订阅数据，其中key必须与卡片提供方订阅的key保持一致。示例中，通过'detail'获取订阅的数据，并在Text组件显示。 - 在[卡片页面文件](arkts-ui-widget-creation.md)中，通过LocalStorage变量获取订阅到的数据，LocalStorage绑定了一个字符串，以key:value的键值对格式来刷新卡片订阅数据，其中key必须与卡片提供方订阅的key保持一致。示例中，通过'detail'获取订阅的数据，并在Text组件显示。
...@@ -151,24 +154,28 @@ ...@@ -151,24 +154,28 @@
```ts ```ts
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import dataShare from '@ohos.data.dataShare' import dataShare from '@ohos.data.dataShare';
import Want from '@ohos.app.ability.Want';
let dataShareHelper;
onAddForm(want) { let dataShareHelper: dataShare.DataShareHelper;
let template = { export default class EntryFormAbility extends FormExtensionAbility {
predicates : { onAddForm(want: Want) {
"list" : "select type from TBL00 limit 0,1" let template: dataShare.Template = {
predicates: {
"list": "select type from TBL00 limit 0,1"
}, },
scheduler: "" scheduler: ""
} }
let subscriberId = "111"; let subscriberId: string = "111";
dataShare.createDataShareHelper(this.context, "datashareproxy://com.example.myapplication", {isProxy : true}).then((data) => { dataShare.createDataShareHelper(this.context, "datashareproxy://com.example.myapplication", {
isProxy: true
}).then((data: dataShare.DataShareHelper) => {
dataShareHelper = data; dataShareHelper = data;
dataShareHelper.addTemplate("datashareproxy://com.example.myapplication/test", subscriberId, template); dataShareHelper.addTemplate("datashareproxy://com.example.myapplication/test", subscriberId, template);
}) })
let formData = {}; let formData: Record<string, Object> = {};
let proxies = [ let proxies: formBindingData.ProxyData[] = [
{ {
"key": "datashareproxy://com.example.myapplication/test", "key": "datashareproxy://com.example.myapplication/test",
"subscriberId": subscriberId "subscriberId": subscriberId
...@@ -179,6 +186,7 @@ ...@@ -179,6 +186,7 @@
return formBinding; return formBinding;
} }
}
``` ```
- 在[卡片页面文件](arkts-ui-widget-creation.md)中，通过LocalStorage变量获取订阅到的数据，LocalStorage绑定了一个字符串，以key:value的键值对格式来刷新卡片订阅数据，其中key必须与卡片提供方订阅的key保持一致。示例中，通过'list'获取订阅的数据，并把第一个元素的值显示在Text组件上。 - 在[卡片页面文件](arkts-ui-widget-creation.md)中，通过LocalStorage变量获取订阅到的数据，LocalStorage绑定了一个字符串，以key:value的键值对格式来刷新卡片订阅数据，其中key必须与卡片提供方订阅的key保持一致。示例中，通过'list'获取订阅的数据，并把第一个元素的值显示在Text组件上。
......
zh-cn/application-dev/application-models/arkts-ui-widget-update-by-status.md
浏览文件 @ 23949e52
...@@ -96,56 +96,62 @@ ...@@ -96,56 +96,62 @@
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import dataPreferences from '@ohos.data.preferences'; import dataPreferences from '@ohos.data.preferences';
import Want from '@ohos.app.ability.Want';
import Base from '@ohos.base';
export default class EntryFormAbility extends FormExtensionAbility { export default class EntryFormAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want: Want) {
let formId = want.parameters[formInfo.FormParam.IDENTITY_KEY]; let formId: string = '';
let isTempCard: boolean = want.parameters[formInfo.FormParam.TEMPORARY_KEY]; let isTempCard: boolean;
if (want.parameters) {
formId = JSON.stringify(want.parameters[formInfo.FormParam.IDENTITY_KEY]);
isTempCard = want.parameters[formInfo.FormParam.TEMPORARY_KEY] as boolean;
if (isTempCard === false) { // 如果为常态卡片，直接进行信息持久化 if (isTempCard === false) { // 如果为常态卡片，直接进行信息持久化
console.info('Not temp card, init db for:' + formId); console.info('Not temp card, init db for:' + formId);
let promise = dataPreferences.getPreferences(this.context, 'myStore'); let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
promise.then(async (storeDB) => { promise.then(async (storeDB: dataPreferences.Preferences) => {
console.info("Succeeded to get preferences."); console.info("Succeeded to get preferences.");
await storeDB.put('A' + formId, 'false'); await storeDB.put('A' + formId, 'false');
await storeDB.put('B' + formId, 'false'); await storeDB.put('B' + formId, 'false');
await storeDB.flush(); await storeDB.flush();
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.info(`Failed to get preferences. ${JSON.stringify(err)}`); console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
}) })
} }
let formData = {}; }
let formData: Record<string, Object | string> = {};
return formBindingData.createFormBindingData(formData); return formBindingData.createFormBindingData(formData);
} }
onRemoveForm(formId) { onRemoveForm(formId: string) {
console.info('onRemoveForm, formId:' + formId); console.info('onRemoveForm, formId:' + formId);
let promise = dataPreferences.getPreferences(this.context, 'myStore'); let promise = dataPreferences.getPreferences(this.context, 'myStore');
promise.then(async (storeDB) => { promise.then(async (storeDB) => {
console.info("Succeeded to get preferences."); console.info("Succeeded to get preferences.");
await storeDB.delete('A' + formId); await storeDB.delete('A' + formId);
await storeDB.delete('B' + formId); await storeDB.delete('B' + formId);
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.info(`Failed to get preferences. ${JSON.stringify(err)}`); console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
}) })
} }
// 如果在添加时为临时卡片，则建议转为常态卡片时进行信息持久化 // 如果在添加时为临时卡片，则建议转为常态卡片时进行信息持久化
onCastToNormalForm(formId) { onCastToNormalForm(formId: string) {
console.info('onCastToNormalForm, formId:' + formId); console.info('onCastToNormalForm, formId:' + formId);
let promise = dataPreferences.getPreferences(this.context, 'myStore'); let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
promise.then(async (storeDB) => { promise.then(async (storeDB: dataPreferences.Preferences) => {
console.info("Succeeded to get preferences."); console.info("Succeeded to get preferences.");
await storeDB.put('A' + formId, 'false'); await storeDB.put('A' + formId, 'false');
await storeDB.put('B' + formId, 'false'); await storeDB.put('B' + formId, 'false');
await storeDB.flush(); await storeDB.flush();
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.info(`Failed to get preferences. ${JSON.stringify(err)}`); console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
}) })
} }
onUpdateForm(formId) { onUpdateForm(formId: string) {
let promise = dataPreferences.getPreferences(this.context, 'myStore'); let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
promise.then(async (storeDB) => { promise.then(async (storeDB: dataPreferences.Preferences) => {
console.info("Succeeded to get preferences."); console.info("Succeeded to get preferences.");
let stateA = await storeDB.get('A' + formId, 'false'); let stateA = await storeDB.get('A' + formId, 'false');
let stateB = await storeDB.get('B' + formId, 'false'); let stateB = await storeDB.get('B' + formId, 'false');
...@@ -160,18 +166,18 @@ ...@@ -160,18 +166,18 @@
await formProvider.updateForm(formId, formInfo); await formProvider.updateForm(formId, formInfo);
} }
console.info(`Update form success stateA:${stateA} stateB:${stateB}.`); console.info(`Update form success stateA:${stateA} stateB:${stateB}.`);
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.info(`Failed to get preferences. ${JSON.stringify(err)}`); console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
}) })
} }
onFormEvent(formId, message) { onFormEvent(formId: string, message: string) {
// 存放卡片状态 // 存放卡片状态
console.info('onFormEvent formId:' + formId + 'msg:' + message); console.info('onFormEvent formId:' + formId + 'msg:' + message);
let promise = dataPreferences.getPreferences(this.context, 'myStore'); let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
promise.then(async (storeDB) => { promise.then(async (storeDB: dataPreferences.Preferences) => {
console.info("Succeeded to get preferences."); console.info("Succeeded to get preferences.");
let msg = JSON.parse(message); let msg: Record<string, string> = JSON.parse(message);
if (msg.selectA != undefined) { if (msg.selectA != undefined) {
console.info('onFormEvent selectA info:' + msg.selectA); console.info('onFormEvent selectA info:' + msg.selectA);
await storeDB.put('A' + formId, msg.selectA); await storeDB.put('A' + formId, msg.selectA);
...@@ -181,7 +187,7 @@ ...@@ -181,7 +187,7 @@
await storeDB.put('B' + formId, msg.selectB); await storeDB.put('B' + formId, msg.selectB);
} }
await storeDB.flush(); await storeDB.flush();
}).catch((err) => { }).catch((err: Base.BusinessError) => {
console.info(`Failed to get preferences. ${JSON.stringify(err)}`); console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
}) })
} }
......
zh-cn/application-dev/application-models/arkts-ui-widget-update-by-time.md
浏览文件 @ 23949e52
...@@ -69,11 +69,12 @@ ...@@ -69,11 +69,12 @@
```ts ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
import Base from '@ohos.base';
let formId = '123456789'; // 实际业务场景需要使用正确的formId let formId: string = '123456789'; // 实际业务场景需要使用正确的formId
try { try {
// 设置过5分钟后更新卡片内容 // 设置过5分钟后更新卡片内容
formProvider.setFormNextRefreshTime(formId, 5, (err, data) => { formProvider.setFormNextRefreshTime(formId, 5, (err: Base.BusinessError) => {
if (err) { if (err) {
console.error(`Failed to setFormNextRefreshTime. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to setFormNextRefreshTime. Code: ${err.code}, message: ${err.message}`);
return; return;
...@@ -82,7 +83,7 @@ ...@@ -82,7 +83,7 @@
} }
}); });
} catch (err) { } catch (err) {
console.error(`Failed to setFormNextRefreshTime. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to setFormNextRefreshTime. Code: ${(err as Base.BusinessError).code}, message: ${(err as Base.BusinessError).message}`);
} }
``` ```
......
zh-cn/application-dev/application-models/common-event-publish.md
浏览文件 @ 23949e52
...@@ -27,19 +27,20 @@ ...@@ -27,19 +27,20 @@
```ts ```ts
import commonEventManager from '@ohos.commonEventManager'; import commonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
2. 传入需要发布的事件名称和回调函数，发布事件。 2. 传入需要发布的事件名称和回调函数，发布事件。
```ts ```ts
// 发布公共事件 // 发布公共事件
commonEventManager.publish("usual.event.SCREEN_OFF", (err) => { commonEventManager.publish("usual.event.SCREEN_OFF", (err: Base.BusinessError) => {
if (err) { if (err) {
console.error(`[CommonEvent] PublishCallBack err=${JSON.stringify(err)}`); console.error(`[CommonEvent] PublishCallBack err=${JSON.stringify(err)}`);
} else { } else {
console.info(`[CommonEvent] Publish success`); console.info(`[CommonEvent] Publish success`);
} }
}) });
``` ```
...@@ -51,13 +52,14 @@ ...@@ -51,13 +52,14 @@
```ts ```ts
import commonEventManager from '@ohos.commonEventManager'; import commonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
2. 传入需要发布的事件名称和回调函数，发布事件。 2. 传入需要发布的事件名称和回调函数，发布事件。
```ts ```ts
// 公共事件相关信息 // 公共事件相关信息
let options = { let options: commonEventManager.CommonEventPublishData = {
code: 1, // 公共事件的初始代码 code: 1, // 公共事件的初始代码
data: "initial data", // 公共事件的初始数据 data: "initial data", // 公共事件的初始数据
} }
...@@ -67,11 +69,11 @@ ...@@ -67,11 +69,11 @@
```ts ```ts
// 发布公共事件 // 发布公共事件
commonEventManager.publish("usual.event.SCREEN_OFF", options, (err) => { commonEventManager.publish("usual.event.SCREEN_OFF", options, (err: Base.BusinessError) => {
if (err) { if (err) {
console.error('[CommonEvent] PublishCallBack err=' + JSON.stringify(err)); console.error('[CommonEvent] PublishCallBack err=' + JSON.stringify(err));
} else { } else {
console.info('[CommonEvent] Publish success') console.info('[CommonEvent] Publish success')
} }
}) });
``` ```
zh-cn/application-dev/application-models/common-event-remove-sticky.md
浏览文件 @ 23949e52
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
```ts ```ts
import commonEventManager from '@ohos.commonEventManager'; import commonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
3. 调用[`removeStickyCommonEvent()`](../reference/apis/js-apis-commonEventManager.md#commoneventmanagerremovestickycommonevent10)方法移除对应的粘性公共事件。 3. 调用[`removeStickyCommonEvent()`](../reference/apis/js-apis-commonEventManager.md#commoneventmanagerremovestickycommonevent10)方法移除对应的粘性公共事件。
...@@ -31,7 +32,7 @@ ...@@ -31,7 +32,7 @@
> 移除的粘性公共事件，必须是本应用之前已发布的粘性公共事件，发布粘性公共事件参考[公共事件发布](common-event-publish.md)章节。 > 移除的粘性公共事件，必须是本应用之前已发布的粘性公共事件，发布粘性公共事件参考[公共事件发布](common-event-publish.md)章节。
```ts ```ts
commonEventManager.removeStickyCommonEvent("sticky_event", (err) => { // sticky_event粘性公共事件名 commonEventManager.removeStickyCommonEvent("sticky_event", (err: Base.BusinessError) => { // sticky_event粘性公共事件名
if (err) { if (err) {
console.error(`Failed to remove sticky common event. Code is ${err.code}, message is ${err.message}`); console.error(`Failed to remove sticky common event. Code is ${err.code}, message is ${err.message}`);
return; return;
......
zh-cn/application-dev/application-models/common-event-static-subscription.md
浏览文件 @ 23949e52
...@@ -21,10 +21,11 @@ ...@@ -21,10 +21,11 @@
开发者可以在[`onReceiveEvent()`](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent)回调中实现业务逻辑。 开发者可以在[`onReceiveEvent()`](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent)回调中实现业务逻辑。
```ts ```ts
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility' import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility';
import commonEventManager from '@ohos.commonEventManager';
export default class StaticSubscriber extends StaticSubscriberExtensionAbility { export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
onReceiveEvent(event) { onReceiveEvent(event: commonEventManager.CommonEventData) {
console.info('onReceiveEvent, event: ' + event.event); console.info('onReceiveEvent, event: ' + event.event);
} }
} }
......
zh-cn/design/ux-design/figures/fling.png 0 → 100644
浏览文件 @ 23949e52
此差异已折叠。
zh-cn/design/ux-design/figures/longpress.jpg 0 → 100644
浏览文件 @ 23949e52
此差异已折叠。
zh-cn/design/ux-design/figures/scroll.jpg 0 → 100644
浏览文件 @ 23949e52
此差异已折叠。
zh-cn/design/ux-design/figures/zoom.png 0 → 100644
浏览文件 @ 23949e52
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或