diff --git a/en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md b/en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md index 930d1e248c3173bced8df7568bca4215b6a2495b..2487b5c862922af39bc6721e99bb598ab5e10f03 100644 --- a/en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md +++ b/en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md @@ -48,21 +48,18 @@ On the widget page, the **postCardAction** API can be used to trigger a message import formProvider from '@ohos.app.form.formProvider'; export default class EntryFormAbility extends FormExtensionAbility { - onFormEvent(formId, message) { + onFormEvent(formId: string, message: string) { // Called when a specified message event defined by the form provider is triggered. console.info(`FormAbility onEvent, formId = ${formId}, message: ${JSON.stringify(message)}`); - let formData = { - 'title':'Title Update.', // It matches the widget layout. - 'detail':'Description update success.', // It matches the widget layout. - }; + let formData = new Map(); + formData.set('title', 'Title Update.'); // It matches the widget layout. + formData.set('detail', 'Description update success.'); // It matches the widget layout. 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)); }) } - + ... } ``` diff --git a/en/application-dev/quick-start/typescript-to-arkts-migration-guide.md b/en/application-dev/quick-start/typescript-to-arkts-migration-guide.md index eb3a47adb6545ddb001689b8374b206703a0b9b3..29865c79c490f4ad1678034e001b71e1011f1ab3 100644 --- a/en/application-dev/quick-start/typescript-to-arkts-migration-guide.md +++ b/en/application-dev/quick-start/typescript-to-arkts-migration-guide.md @@ -779,7 +779,9 @@ interface Employee extends Identity, Contact {} **Severity: error** -ArkTS does not support the returning `this` type. Use explicit type instead. +ArkTS does not support type notation using the `this` keyword (for example, +specifying a method's return type `this` is not allowed). Use explicit type +instead. **TypeScript** @@ -959,7 +961,9 @@ type N = number **Severity: error** ArkTS does not support indexed access for class fields. Use dot notation -instead. +instead. An exception are all typed arrays from the standard library +(for example, `Int32Array`), which support access to their elements through +`container[index]` syntax. **TypeScript** @@ -975,6 +979,9 @@ let x = p["x"] class Point {x: number = 0; y: number = 0} let p: Point = {x: 1, y: 2} let x = p.x + +let arr = new Int32Array(1) +console.log(arr[0]) ``` ## Recipe: Structural identity is not supported @@ -1541,33 +1548,6 @@ let a2: C[] = [{n: 1, s: "1"}, {n: 2, s : "2"}] // ditto * Recipe: Object literal must correspond to some explicitly declared class or interface * Recipe: Object literals cannot be used as type declarations -## Recipe: Lambdas require explicit type annotation for parameters - -**Rule `arkts-explicit-param-types-in-lambdas`** - -**Severity: error** - -Currently, ArkTS requires the types of lambda parameters -to be explicitly specified. - -**TypeScript** - -```typescript -// Compile-time error only with noImplicitAny: -let f = (s /* type any is assumed */) => { - console.log(s) -} -``` - -**ArkTS** - -```typescript -// Explicit types for lambda parameters are mandatory: -let f = (s: string) => { - console.log(s) -} -``` - ## Recipe: Use arrow functions instead of function expressions **Rule `arkts-no-func-expressions`** @@ -1989,9 +1969,9 @@ let f = "string" + true // "stringtrue" let g = (new Object()) + "string" // "[object Object]string" -let i = true + true // JS: 2, TS: compile-time error -let j = true + 2 // JS: 3, TS: compile-time error -let k = E.E1 + true // JS: 1, TS: compile-time error +let i = true + true // compile-time error +let j = true + 2 // compile-time error +let k = E.E1 + true // compile-time error ``` **ArkTS** @@ -2011,7 +1991,7 @@ let g = (new Object()).toString() + "string" let i = true + true // compile-time error -let j = true + 2 // compile-time error +let j = true + 2 // compile-time error let k = E.E1 + true // compile-time error ``` @@ -2341,7 +2321,8 @@ iterate over data. **Severity: error** ArkTS supports the iteration over arrays and strings by the `for .. of` loop, -but does not support the iteration of objects content. +but does not support the iteration of objects content. All typed arrays from +the standard library (for example, `Int32Array`) are also supported. **TypeScript** @@ -2433,7 +2414,8 @@ console.log("Area: ", Math.PI * r * r) **Severity: error** -ArkTS supports `case` statements that contain only compile-time values. +ArkTS supports `case` statements that contain only compile-time values, +top-level scope `const` values, and `static readonly` class fields. Use `if` statements as an alternative. **TypeScript** @@ -2907,7 +2889,8 @@ function main(): void { The only supported scenario for the spread operator is to spread an array into the rest parameter. Otherwise, manually “unpack” data from arrays and objects, -where necessary. +where necessary. All typed arrays from the standard library (for example, +`Int32Array`) are also supported. **TypeScript** @@ -3880,34 +3863,6 @@ let ce = new CustomError() * Recipe: Prototype assignment is not supported -## Recipe: Runtime import expressions are not supported - -**Rule `arkts-no-runtime-import`** - -**Severity: error** - -ArkTS does not support such “runtime” import expressions as `await import...` -because in the language import is a compile-time, not a runtime feature. -Use regular import syntax instead. - -**TypeScript** - -```typescript -const zipUtil = await import("utils/create-zip-file") -``` - -**ArkTS** - -```typescript -import { zipUtil } from "utils/create-zip-file" -``` - -**See also** - -* Recipe: Wildcards in module names are not supported -* Recipe: Universal module definitions (UMD) are not supported -* Recipe: Import assertions are not supported - ## Recipe: Definite assignment assertions are not supported **Rule `arkts-no-definite-assignment`** @@ -4065,8 +4020,7 @@ M.abc = 200 **Severity: error** Currently ArkTS does not support utility types from TypeScript extensions to the -standard library (`Omit`, `Pick`, etc.). Exceptions are: `Partial`, -`Record`. +standard library, except following: `Partial`, `Record`. For the type *Record*, the type of an indexing expression *rec[index]* is of the type *V | undefined*. @@ -4349,7 +4303,6 @@ import { something } from "module" * Recipe: Wildcards in module names are not supported * Recipe: Universal module definitions (UMD) are not supported -* Recipe: Runtime import expressions are not supported ## Recipe: Usage of standard library is restricted @@ -4364,9 +4317,7 @@ the following APIs is prohibited: Properties and functions of the global object: `eval`, `Infinity`, `NaN`, `isFinite`, `isNaN`, `parseFloat`, `parseInt`, -`encodeURI`, `encodeURIComponent`, `Encode`, -`decodeURI`, `decodeURIComponent`, `Decode`, -`escape`, `unescape`, `ParseHexOctet` +`Encode`, `Decode`, `ParseHexOctet` `Object`: `__proto__`, `__defineGetter__`, `__defineSetter__`, `__lookupGetter__`, `__lookupSetter__`, `assign`, `create`, @@ -4561,3 +4512,54 @@ class BugReport { } ``` +## Recipe: Classes cannot be used as objects + +**Rule `arkts-no-classes-as-obj`** + +**Severity: error** + +ArkTS does not support using classes as objects (assigning them to variables, +etc.) because in ArkTS, a `class` declaration introduces a new type, +not a value. + +**TypeScript** + +```typescript +class C { + s: string = "" + n: number = 0 +} + +let c = C +``` + +## Recipe: `import` statements after other statements are not allowed + +**Rule `arkts-no-misplaced-imports`** + +**Severity: error** + +In ArkTS, all `import` statements should go before all other statements +in the program. + +**TypeScript** + +```typescript +class C { + s: string = "" + n: number = 0 +} + +import foo from "module1" +``` + +**ArkTS** + +```typescript +import foo from "module1" + +class C { + s: string = "" + n: number = 0 +} +``` diff --git a/en/application-dev/reference/apis/js-apis-app-form-formBindingData.md b/en/application-dev/reference/apis/js-apis-app-form-formBindingData.md index 39a7d2b1ec4699882f2155420b5071b0e8ad73a2..c81cc9a93c5bef28c993ee23c68b298b2ac4b548 100644 --- a/en/application-dev/reference/apis/js-apis-app-form-formBindingData.md +++ b/en/application-dev/reference/apis/js-apis-app-form-formBindingData.md @@ -66,11 +66,14 @@ import fs from '@ohos.file.fs'; try { let fd = fs.openSync('/path/to/form.png'); - let obj = { - 'temperature': '21°', - 'formImages': { 'image': fd } - }; - formBindingData.createFormBindingData(obj); + + let createFormBindingDataParam = new Map(); + let formImagesParam = new Map(); + formImagesParam.set('image', fd); + createFormBindingDataParam.set("name", '21°'); + createFormBindingDataParam.set('formImages', formImagesParam); + + formBindingData.createFormBindingData(createFormBindingDataParam); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message}`); } diff --git a/en/application-dev/reference/apis/js-apis-notificationManager.md b/en/application-dev/reference/apis/js-apis-notificationManager.md index b993f99fcba29fa6bfef5bd78b8b268340844c86..206dd80d0c86c4c811538569f99f5d4b3cdc8c7b 100644 --- a/en/application-dev/reference/apis/js-apis-notificationManager.md +++ b/en/application-dev/reference/apis/js-apis-notificationManager.md @@ -10,6 +10,7 @@ The **notificationManager** module provides notification management capabilities ```ts import notificationManager from '@ohos.notificationManager'; +import Base from '@ohos.base'; ``` ## notificationManager.publish @@ -45,7 +46,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // publish callback -function publishCallback(err) { +function publishCallback(err: Base.BusinessError) { if (err) { console.error(`publish failed, code is ${err.code}, message is ${err.message}`); } else { @@ -155,7 +156,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // publish callback -function publishCallback(err) { +function publishCallback(err: Base.BusinessError) { if (err) { console.error(`publish failed, code is ${err.code}, message is ${err.message}`); } else { @@ -163,7 +164,7 @@ function publishCallback(err) { } } // User ID -let userId = 1; +let userId: number = 1; // NotificationRequest object let notificationRequest: notificationManager.NotificationRequest = { id: 1, @@ -228,7 +229,7 @@ let notificationRequest: notificationManager.NotificationRequest = { } }; -let userId = 1; +let userId: number = 1; notificationManager.publish(notificationRequest, userId).then(() => { console.info("publish success"); @@ -267,7 +268,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // cancel callback -function cancelCallback(err) { +function cancelCallback(err: Base.BusinessError) { if (err) { console.error(`cancel failed, code is ${err.code}, message is ${err.message}`); } else { @@ -341,7 +342,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // cancel callback -function cancelCallback(err) { +function cancelCallback(err: Base.BusinessError) { if (err) { console.error(`cancel failed, code is ${err.code}, message is ${err.message}`); } else { @@ -379,7 +380,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // cancel callback -function cancelAllCallback(err) { +function cancelAllCallback(err: Base.BusinessError) { if (err) { console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`); } else { @@ -449,7 +450,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // addSlot callback -function addSlotCallBack(err) { +function addSlotCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -457,7 +458,7 @@ function addSlotCallBack(err) { } } // NotificationSlot object -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.addSlot(notificationSlot, addSlotCallBack); @@ -496,7 +497,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // NotificationSlot object -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.addSlot(notificationSlot).then(() => { @@ -534,7 +535,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // addSlot callback -function addSlotCallBack(err) { +function addSlotCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -611,7 +612,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // addSlots callback -function addSlotsCallBack(err) { +function addSlotsCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`); } else { @@ -619,11 +620,11 @@ function addSlotsCallBack(err) { } } // NotificationSlot object -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; // NotificationSlotArray object -let notificationSlotArray = new Array(); +let notificationSlotArray: notificationManager.NotificationSlot[] = new Array(); notificationSlotArray[0] = notificationSlot; notificationManager.addSlots(notificationSlotArray, addSlotsCallBack); @@ -662,11 +663,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // NotificationSlot object -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; // NotificationSlotArray object -let notificationSlotArray = new Array(); +let notificationSlotArray: notificationManager.NotificationSlot[] = new Array(); notificationSlotArray[0] = notificationSlot; notificationManager.addSlots(notificationSlotArray).then(() => { @@ -703,14 +704,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // getSlot callback -function getSlotCallback(err,data) { +function getSlotCallback(err: Base.BusinessError, data: notificationManager.NotificationSlot) { if (err) { console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlot success"); + console.info(`getSlot success, data is ${JSON.stringify(data)}`); } } -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; notificationManager.getSlot(slotType, getSlotCallback); ``` @@ -747,9 +748,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; -notificationManager.getSlot(slotType).then((data) => { - console.info("getSlot success, data: " + JSON.stringify(data)); +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; + +notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => { + console.info("getSlot success, data: " + JSON.stringify(data)); }); ``` @@ -781,12 +783,12 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // getSlots callback -function getSlotsCallback(err,data) { - if (err) { - console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("getSlots success"); - } +function getSlotsCallback(err: Base.BusinessError, data: Array) { + if (err) { + console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info(`getSlots success, data is ${JSON.stringify(data)}`); + } } notificationManager.getSlots(getSlotsCallback); ``` @@ -818,7 +820,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.getSlots().then((data) => { +notificationManager.getSlots().then((data: Array) => { console.info("getSlots success, data: " + JSON.stringify(data)); }); ``` @@ -852,15 +854,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // removeSlot callback -function removeSlotCallback(err) { - if (err) { - console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("removeSlot success"); - } +function removeSlotCallback(err: Base.BusinessError) { + if (err) { + console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("removeSlot success"); + } } let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; -notificationManager.removeSlot(slotType,removeSlotCallback); +notificationManager.removeSlot(slotType, removeSlotCallback); ``` ## notificationManager.removeSlot @@ -890,7 +892,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; notificationManager.removeSlot(slotType).then(() => { console.info("removeSlot success"); }); @@ -923,7 +925,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function removeAllCallBack(err) { +function removeAllCallBack(err: Base.BusinessError) { if (err) { console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`); } else { @@ -993,17 +995,17 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function setNotificationEnablenCallback(err) { +function setNotificationEnableCallback(err: Base.BusinessError) { if (err) { - console.error(`setNotificationEnablenCallback failed, code is ${err.code}, message is ${err.message}`); + console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("setNotificationEnablenCallback success"); + console.info("setNotificationEnableCallback success"); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback); +notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback); ``` ## notificationManager.setNotificationEnable @@ -1039,7 +1041,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.setNotificationEnable(bundle, false).then(() => { @@ -1080,16 +1082,18 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } -let bundle = { + +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; + notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback); ``` @@ -1131,10 +1135,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.isNotificationEnabled(bundle).then((data) => { +notificationManager.isNotificationEnabled(bundle).then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1170,11 +1174,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } @@ -1212,7 +1216,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.isNotificationEnabled().then((data) => { +notificationManager.isNotificationEnabled().then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1250,15 +1254,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } -let userId = 1; +let userId: number = 1; notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback); ``` @@ -1301,9 +1305,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 1; +let userId: number = 1; -notificationManager.isNotificationEnabled(userId).then((data) => { +notificationManager.isNotificationEnabled(userId).then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1342,14 +1346,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function displayBadgeCallback(err) { +function displayBadgeCallback(err: Base.BusinessError) { if (err) { console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`); } else { console.info("displayBadge success"); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.displayBadge(bundle, false, displayBadgeCallback); @@ -1388,7 +1392,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.displayBadge(bundle, false).then(() => { @@ -1413,7 +1417,7 @@ Checks whether the notification badge is enabled for a specified application. Th | Name | Type | Mandatory| Description | | -------- | --------------------- | ---- | ------------------------ | | bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | Yes | Bundle of the application. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| callback | AsyncCallback\ | Yes | Callback used to return the result.| **Error codes** @@ -1429,14 +1433,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function isBadgeDisplayedCallback(err, data) { +function isBadgeDisplayedCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isBadgeDisplayed success"); + console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); @@ -1480,10 +1484,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { - bundle: "bundleName1", +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; -notificationManager.isBadgeDisplayed(bundle).then((data) => { + +notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => { console.info("isBadgeDisplayed success, data: " + JSON.stringify(data)); }); ``` @@ -1514,7 +1519,8 @@ Sets the notification badge number. This API uses a promise to return the result **Example** ```ts -let badgeNumber = 10 +let badgeNumber: number = 10; + notificationManager.setBadgeNumber(badgeNumber).then(() => { console.info("displayBadge success"); }); @@ -1549,7 +1555,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function setBadgeNumberCallback(err) { +function setBadgeNumberCallback(err: Base.BusinessError) { if (err) { console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`); } else { @@ -1557,7 +1563,7 @@ function setBadgeNumberCallback(err) { } } -let badgeNumber = 10 +let badgeNumber: number = 10; notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback); ``` @@ -1595,17 +1601,17 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function setSlotByBundleCallback(err) { +function setSlotByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { console.info("setSlotByBundle success"); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); @@ -1644,12 +1650,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let notificationSlot = { + +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; + notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => { console.info("setSlotByBundle success"); }); @@ -1688,14 +1696,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getSlotsByBundleCallback(err, data) { +function getSlotsByBundleCallback(err: Base.BusinessError, data: Array) { if (err) { console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlotsByBundle success"); + console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback); @@ -1739,10 +1747,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.getSlotsByBundle(bundle).then((data) => { + +notificationManager.getSlotsByBundle(bundle).then((data: Array) => { console.info("getSlotsByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1780,16 +1789,18 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getSlotNumByBundleCallback(err, data) { +function getSlotNumByBundleCallback(err: Base.BusinessError, data: number) { if (err) { console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlotNumByBundle success"); + console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`); } } -let bundle = { - bundle: "bundleName1", + +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; + notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); ``` @@ -1831,10 +1842,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundle = { - bundle: "bundleName1", +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; -notificationManager.getSlotNumByBundle(bundle).then((data) => { + +notificationManager.getSlotNumByBundle(bundle).then((data: number) => { console.info("getSlotNumByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1869,11 +1881,11 @@ Obtains all active notifications. This API uses an asynchronous callback to retu **Example** ```ts -function getAllActiveNotificationsCallback(err, data) { +function getAllActiveNotificationsCallback(err: Base.BusinessError, data: Array) { if (err) { console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getAllActiveNotifications success"); + console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`); } } @@ -1911,7 +1923,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.getAllActiveNotifications().then((data) => { +notificationManager.getAllActiveNotifications().then((data: Array) => { console.info("getAllActiveNotifications success, data: " + JSON.stringify(data)); }); ``` @@ -1943,11 +1955,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getActiveNotificationCountCallback(err, data) { +function getActiveNotificationCountCallback(err: Base.BusinessError, data: number) { if (err) { console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getActiveNotificationCount success"); + console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`); } } @@ -1981,7 +1993,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.getActiveNotificationCount().then((data) => { +notificationManager.getActiveNotificationCount().then((data: number) => { console.info("getActiveNotificationCount success, data: " + JSON.stringify(data)); }); ``` @@ -2013,7 +2025,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getActiveNotificationsCallback(err, data) { +function getActiveNotificationsCallback(err: Base.BusinessError, data: Array) { if (err) { console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2051,7 +2063,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.getActiveNotifications().then((data) => { +notificationManager.getActiveNotifications().then((data: Array) => { console.info("removeGroupByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -2084,7 +2096,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function cancelGroupCallback(err) { +function cancelGroupCallback(err: Base.BusinessError) { if (err) { console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2092,7 +2104,7 @@ function cancelGroupCallback(err) { } } -let groupName = "GroupName"; +let groupName: string = "GroupName"; notificationManager.cancelGroup(groupName, cancelGroupCallback); ``` @@ -2124,7 +2136,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let groupName = "GroupName"; +let groupName: string = "GroupName"; notificationManager.cancelGroup(groupName).then(() => { console.info("cancelGroup success"); }); @@ -2164,7 +2176,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function removeGroupByBundleCallback(err) { +function removeGroupByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2172,8 +2184,8 @@ function removeGroupByBundleCallback(err) { } } -let bundleOption = {bundle: "Bundle"}; -let groupName = "GroupName"; +let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" }; +let groupName: string = "GroupName"; notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback); ``` @@ -2211,8 +2223,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let bundleOption = {bundle: "Bundle"}; -let groupName = "GroupName"; +let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" }; +let groupName: string = "GroupName"; + notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => { console.info("removeGroupByBundle success"); }); @@ -2251,7 +2264,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function setDoNotDisturbDateCallback(err) { +function setDoNotDisturbDateCallback(err: Base.BusinessError) { if (err) { console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2259,7 +2272,7 @@ function setDoNotDisturbDateCallback(err) { } } -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) @@ -2300,7 +2313,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) @@ -2346,7 +2359,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function setDoNotDisturbDateCallback(err) { +function setDoNotDisturbDateCallback(err: Base.BusinessError) { if (err) { console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2354,13 +2367,13 @@ function setDoNotDisturbDateCallback(err) { } } -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) }; -let userId = 1; +let userId: number = 1; notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback); ``` @@ -2399,13 +2412,13 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) }; -let userId = 1; +let userId: number = 1; notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => { console.info("setDoNotDisturbDate success"); @@ -2445,11 +2458,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getDoNotDisturbDateCallback(err,data) { +function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) { if (err) { console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDoNotDisturbDate success"); + console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`); } } @@ -2488,8 +2501,8 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.getDoNotDisturbDate().then((data) => { - console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); +notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => { + console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2528,15 +2541,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -function getDoNotDisturbDateCallback(err,data) { +function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) { if (err) { console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDoNotDisturbDate success"); + console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`); } } -let userId = 1; +let userId: number = 1; notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback); ``` @@ -2580,9 +2593,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 1; +let userId: number = 1; -notificationManager.getDoNotDisturbDate(userId).then((data) => { +notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => { console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2617,7 +2630,7 @@ Checks whether DND mode is supported. This API uses an asynchronous callback to **Example** ```ts -function isSupportDoNotDisturbModeCallback(err,data) { +function isSupportDoNotDisturbModeCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2659,7 +2672,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -notificationManager.isSupportDoNotDisturbMode().then((data) => { +notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => { console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data)); }); ``` @@ -2692,8 +2705,8 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -let templateName = 'process'; -function isSupportTemplateCallback(err, data) { +let templateName: string = 'process'; +function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2737,9 +2750,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -let templateName = 'process'; +let templateName: string = 'process'; -notificationManager.isSupportTemplate(templateName).then((data) => { +notificationManager.isSupportTemplate(templateName).then((data: boolean) => { console.info("isSupportTemplate success, data: " + JSON.stringify(data)); }); ``` @@ -2771,7 +2784,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function requestEnableNotificationCallback(err) { +function requestEnableNotificationCallback(err: Base.BusinessError) { if (err) { console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2808,7 +2821,76 @@ notificationManager.requestEnableNotification().then(() => { }); ``` +## notificationManager.requestEnableNotification10+ + +requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback\): void + +Requests notification to be enabled for this application in a modal. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Notification.Notification + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------ | ---- |--------------------| +| context | UIAbilityContext | Yes | Ability context bound to the notification dialog box.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Error codes** + +For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md). + +| ID| Error Message | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | +| 1600002 | Marshalling or unmarshalling error. | +| 1600003 | Failed to connect service. | + +**Example** + +```javascript +function requestEnableNotificationCallback(err) { + if (err) { + console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("requestEnableNotification success"); + } +}; + +notificationManager.requestEnableNotification(globalThis.uicontext, requestEnableNotificationCallback); +``` + +## notificationManager.requestEnableNotification10+ + +requestEnableNotification(context: UIAbilityContext): Promise\ + +Requests notification to be enabled for this application in a modal. This API uses a promise to return the result. + +**System capability**: SystemCapability.Notification.Notification + +**Parameters** +| Name | Type | Mandatory| Description | +| -------- | ------------------------ | ---- |--------------------| +| context | UIAbilityContext | Yes | Ability context bound to the notification dialog box.| + +**Error codes** + +For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md). + +| ID| Error Message | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | +| 1600002 | Marshalling or unmarshalling error. | +| 1600003 | Failed to connect service. | + +**Example** + +```javascript +notificationManager.requestEnableNotification(globalThis.uicontext).then(() => { + console.info("requestEnableNotification success"); +}); +``` ## notificationManager.setDistributedEnable @@ -2843,7 +2925,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function setDistributedEnableCallback(err) { +function setDistributedEnableCallback(err: Base.BusinessError) { if (err) { console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2851,7 +2933,7 @@ function setDistributedEnableCallback(err) { } }; -let enable = true; +let enable: boolean = true; notificationManager.setDistributedEnable(enable, setDistributedEnableCallback); ``` @@ -2888,11 +2970,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -let enable = true; +let enable: boolean = true; notificationManager.setDistributedEnable(enable).then(() => { - console.info("setDistributedEnable success"); - }); + console.info("setDistributedEnable success"); +}); ``` @@ -2924,7 +3006,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function isDistributedEnabledCallback(err, data) { +function isDistributedEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2966,7 +3048,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```javascript notificationManager.isDistributedEnabled() - .then((data) => { + .then((data: boolean) => { console.info("isDistributedEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -3007,7 +3089,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function setDistributedEnableByBundleCallback(err) { +function setDistributedEnableByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3015,11 +3097,11 @@ function setDistributedEnableByBundleCallback(err) { } }; -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let enable = true +let enable: boolean = true; notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback); ``` @@ -3060,11 +3142,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let enable = true +let enable: boolean = true; notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => { console.info("setDistributedEnableByBundle success"); @@ -3105,7 +3187,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function isDistributedEnabledByBundleCallback(err, data) { +function isDistributedEnabledByBundleCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3113,7 +3195,7 @@ function isDistributedEnabledByBundleCallback(err, data) { } }; -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; @@ -3159,11 +3241,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.isDistributedEnabledByBundle(bundle).then((data) => { +notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => { console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -3200,11 +3282,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -function getDeviceRemindTypeCallback(err, data) { +function getDeviceRemindTypeCallback(err: Base.BusinessError, data: notificationManager.DeviceRemindType) { if (err) { console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDeviceRemindType success"); + console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`); } }; @@ -3242,7 +3324,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```javascript -notificationManager.getDeviceRemindType().then((data) => { +notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => { console.info("getDeviceRemindType success, data: " + JSON.stringify(data)); }); ``` @@ -3288,7 +3370,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // publishAsBundle callback -function callback(err) { +function callback(err: Base.BusinessError) { if (err) { console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3296,11 +3378,11 @@ function callback(err) { } } // Bundle name of the application whose notification function is taken over by the reminder agent -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // User ID -let userId = 100; +let userId: number = 100; // NotificationRequest object -let request = { +let request: notificationManager.NotificationRequest = { id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -3355,11 +3437,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // Bundle name of the application whose notification function is taken over by the reminder agent -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // User ID -let userId = 100; +let userId: number = 100; // NotificationRequest object -let request = { +let request: notificationManager.NotificationRequest = { id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -3415,7 +3497,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // cancelAsBundle -function cancelAsBundleCallback(err) { +function cancelAsBundleCallback(err: Base.BusinessError) { if (err) { console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3423,9 +3505,9 @@ function cancelAsBundleCallback(err) { } } // Bundle name of the application whose notification function is taken over by the reminder agent -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // User ID -let userId = 100; +let userId: number = 100; notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback); ``` @@ -3468,9 +3550,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // Bundle name of the application whose notification function is taken over by the reminder agent -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // User ID -let userId = 100; +let userId: number = 100; notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => { console.info("cancelAsBundle success"); @@ -3513,7 +3595,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // setNotificationEnableSlot -function setNotificationEnableSlotCallback(err) { +function setNotificationEnableSlotCallback(err: Base.BusinessError) { if (err) { console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3606,11 +3688,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // isNotificationSlotEnabled -function getEnableSlotCallback(err, data) { +function getEnableSlotCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationSlotEnabled success"); + console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`); } }; @@ -3661,7 +3743,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ ```ts // isNotificationSlotEnabled notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", }, - notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => { + notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => { console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -3701,10 +3783,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 100; -let enable = true; +let userId: number = 100; +let enable: boolean = true; -function callback(err) { +function callback(err: Base.BusinessError) { if (err) { console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3755,13 +3837,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 100; -let enable = true; +let userId: number = 100; +let enable: boolean = true; notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => { console.info('setSyncNotificationEnabledWithoutApp success'); -}).catch((err) => { - console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`); }); ``` @@ -3799,9 +3879,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 100; +let userId: number = 100; -function getSyncNotificationEnabledWithoutAppCallback(err, data) { +function getSyncNotificationEnabledWithoutAppCallback(err: Base.BusinessError, data: boolean) { if (err) { console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err); } else { @@ -3851,11 +3931,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/ **Example** ```ts -let userId = 100; -notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => { - console.info('getSyncNotificationEnabledWithoutApp, data:' + data); -}).catch((err) => { - console.info('getSyncNotificationEnabledWithoutApp, err:' + err); +let userId: number = 100; + +notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => { + console.info('getSyncNotificationEnabledWithoutApp, data:' + data); }); ``` @@ -3897,9 +3976,11 @@ try{ function OnCheckNotification(info : notificationManager.NotificationCheckInfo) { console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`); if(info.notificationId == 1){ - return { code: 1, message: "testMsg1"} + let result: notificationManager.NotificationCheckResult = { code: 1, message: "testMsg1"}; + return result; } else { - return { code: 0, message: "testMsg0"} + let result: notificationManager.NotificationCheckResult = { code: 0, message: "testMsg0"}; + return result; } } ``` diff --git a/en/application-dev/reference/apis/js-apis-system-notification.md b/en/application-dev/reference/apis/js-apis-system-notification.md index 0f014e6822dc9b257a7b0eaa6e802b6f7f758110..1f9f095b0516d0c2460e25c09b6000878af24434 100644 --- a/en/application-dev/reference/apis/js-apis-system-notification.md +++ b/en/application-dev/reference/apis/js-apis-system-notification.md @@ -50,18 +50,24 @@ Displays a notification. | options | ShowNotificationOptions | No| Notification title.| **Example** -```javascript -export default { - show() { - notification.show({ - contentTitle: 'title info', - contentText: 'text', - clickAction: { - bundleName: 'com.example.testapp', - abilityName: 'notificationDemo', - uri: '/path/to/notification' - } - }); - } +```ts +class NotificationClass { + show: Function +} + +let notificationObj: NotificationClass = { + show() { + notification.show({ + contentTitle: 'title info', + contentText: 'text', + clickAction: { + bundleName: 'com.example.testapp', + abilityName: 'notificationDemo', + uri: '/path/to/notification' + } + }); + } } + +export default notificationObj ``` diff --git a/zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md b/zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md index bea7df3809ced93e4da2ee081a92bd2e4f9ced8a..9f82d3bad12319224a1bc3a9aafbff57b97eb2f8 100644 --- a/zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md +++ b/zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md @@ -46,21 +46,18 @@ import formProvider from '@ohos.app.form.formProvider'; export default class EntryFormAbility extends FormExtensionAbility { - onFormEvent(formId, message) { + onFormEvent(formId: string, message: string) { // Called when a specified message event defined by the form provider is triggered. console.info(`FormAbility onEvent, formId = ${formId}, message: ${JSON.stringify(message)}`); - let formData = { - 'title': 'Title Update.', // 和卡片布局中对应 - 'detail': 'Description update success.', // 和卡片布局中对应 - }; + let formData = new Map(); + formData.set('title', 'Title Update.'); // 和卡片布局中对应 + formData.set('detail', 'Description update success.'); // 和卡片布局中对应 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)); }) } - + ... } ``` diff --git a/zh-cn/application-dev/application-models/hop-cross-device-migration.md b/zh-cn/application-dev/application-models/hop-cross-device-migration.md index fcc35ec4d4f36088ae25911afac9a23f89760862..dabca884bdec8de6584efd27acf9629f1f0c658a 100644 --- a/zh-cn/application-dev/application-models/hop-cross-device-migration.md +++ b/zh-cn/application-dev/application-models/hop-cross-device-migration.md @@ -1,21 +1,15 @@ # 跨端迁移 - ## 功能描述 跨端迁移的主要工作是实现将应用当前任务(包括页面控件状态变量等)迁移到目标设备,能在目标设备上接续。主要功能包括: - 支持用户自定义数据存储及恢复。 - - 支持页面路由信息和页面控件状态数据的存储及恢复。 - - 支持应用兼容性检测。 - -- 支持应用根据实际使用场景动态设置迁移状态(默认迁移状态为ACTIVE激活状态)。如编辑类应用在编辑文本的页面下才需要迁移,其他页面不需要迁移,则可以通过[setMissionContinueState](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextsetmissioncontinuestate10)进行控制。 - +- 支持应用根据实际使用场景动态设置迁移状态(默认迁移状态为 **ACTIVE** 激活状态)。如编辑类应用在编辑文本的页面下才需要迁移,其他页面不需要迁移,则可以通过[setMissionContinueState](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextsetmissioncontinuestate10)进行控制。 - 支持应用动态选择是否进行页面栈恢复(默认进行页面栈信息恢复)。如应用希望自定义迁移到其他设备后显示的页面,则可以通过[SUPPORT_CONTINUE_PAGE_STACK_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)进行控制。 - -- 支持应用动态选择流转成功后是否退出迁移发起端应用(默认流转成功后退出迁移发起端应用)。则可以通过[SUPPORT_CONTINUE_SOURCE_EXIT_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)进行控制。 +- 支持应用动态选择迁移成功后是否退出迁移发起端应用(默认迁移成功后退出迁移发起端应用)。则可以通过[SUPPORT_CONTINUE_SOURCE_EXIT_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)进行控制。 ## 跨端迁移流程 @@ -28,14 +22,9 @@ ## 约束限制 -- 由于“跨端迁移任务管理”能力尚未具备,开发者当前只能开发具备跨端迁移能力的应用,但不能发起迁移。 - +- 应用迁移的发起依赖系统应用控制,系统应用开发者可以参考[验证指导中的demo示例](#验证指导)实现相关的控制能力。 - 跨端迁移要求在同UIAbility之间进行,也就是需要相同的bundleName、abilityName和签名。 - - -## 最佳实践 - -为了获得最佳体验,使用wantParam传输的数据建议在100KB以下。 +- 为了获得最佳体验,使用wantParam传输的数据建议在100KB以下。 ## 接口说明 @@ -46,31 +35,35 @@ | **接口名** | **描述** | | -------- | -------- | -| onContinue(wantParam : {[key: string]: Object}): OnContinueResult | 迁移发起端在该回调中保存迁移所需要的数据,同时返回是否同意迁移:
- AGREE:表示同意。
- REJECT:表示拒绝:如应用在onContinue中异常可以直接REJECT。
- MISMATCH:表示版本不匹配:迁移发起端应用可以在onContinue中获取到迁移接收端应用的版本号,进行协商后,如果版本不匹配导致无法迁移,可以返回该错误。 | -| onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void; | 应用迁移接收端为冷启动或多实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见[应用组件启动模式](uiability-launch-type.md) | -| onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void; | 迁移接收端为单实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见[应用组件启动模式](uiability-launch-type.md) | +| onContinue(wantParam : {[key: string]: Object}): OnContinueResult | 迁移发起端在该回调中保存迁移所需要的数据,同时返回是否同意迁移:
- AGREE:表示同意。
- REJECT:表示拒绝:如应用在onContinue中异常会导致钱以后数据恢复时显示异常,则可以建议REJECT。
- MISMATCH:表示版本不匹配:迁移发起端应用可以在onContinue中获取到迁移目标端应用的版本号,进行协商后,如果版本不匹配导致无法迁移,可以返回该错误。 | +| onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void; | 应用迁移目标端为冷启动或多实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见[应用组件启动模式](uiability-launch-type.md) | +| onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void; | 迁移目标端为单实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见[应用组件启动模式](uiability-launch-type.md) | ## 开发步骤 -1. 需要申请`ohos.permission.DISTRIBUTED_DATASYNC`权限,配置方式请参见[配置文件权限声明](../security/accesstoken-guidelines.md#配置文件权限声明)。 +1.需要申请`ohos.permission.DISTRIBUTED_DATASYNC`权限 -2. 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见[向用户申请授权](../security/accesstoken-guidelines.md#向用户申请授权)。 +配置方式请参见[配置文件权限声明](../security/accesstoken-guidelines.md#配置文件权限声明)。 -3. 在配置文件中配置跨端迁移相关标签字段。 +2.同时需要在应用首次启动时弹窗向用户申请授权 - 配置应用支持迁移 - 在module.json5中配置continuable标签:true表示支持迁移,false表示不支持,默认为false。配置为false的UIAbility将被系统识别为无法迁移。 +使用方式请参见[向用户申请授权](../security/accesstoken-guidelines.md#向用户申请授权)。 + +3.在配置文件中配置跨端迁移相关标签字段。 + +配置应用支持迁移 +在module.json5中配置continuable标签:true表示支持迁移,false表示不支持,默认为false。配置为false的UIAbility将被系统识别为无法迁移。 ```json { "module": { - ... + // ... "abilities": [ { - ... + // ... "continuable": true, } ] @@ -80,131 +73,325 @@ 根据需要配置应用启动模式类型,配置详情请参照[UIAbility组件启动模式](uiability-launch-type.md)。 -4. 在发起端UIAbility中实现[onContinue()](../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue)接口。 - 当应用触发迁移时,[onContinue()](../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue)接口在发起端被调用,开发者可以在该接口中保存迁移数据,实现应用兼容性检测,决定是否支持此次迁移。 - - 保存迁移数据:开发者可以将要迁移的数据通过键值对的方式保存在wantParam中。 +4.在发起端UIAbility中实现[onContinue](../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue)接口。 + +当应用触发迁移时,[onContinue](../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue)接口在发起端被调用,开发者可以在该接口中保存迁移数据,实现应用兼容性检测,决定是否支持此次迁移。 + +- 保存迁移数据:开发者可以将要迁移的数据通过键值对的方式保存在wantParam中。 + +- 应用兼容性检测:开发者可以通过从wantParam中获取目标应用的版本号与本应用版本号做兼容性校验。开发者可以在触发迁移时从`onContinue`接口中`wantParam.version`获取到迁移目标端应用的版本号与迁移发起端应用版本号做兼容校验。 + +- 迁移决策:开发者可以通过onContinue接口的返回值决定是否支持此次迁移,返回值信息见[接口说明](#接口说明)。 + + 示例如下: + + ```ts + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + + export default class EntryAbility extends UIAbility { + onContinue(wantParam: Record) { + console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`) // 准备迁移数据 + let continueInput = '迁移的数据'; + if (continueInput) { + // 将要迁移的数据保存在wantParam的自定义字段(如:data)中; + wantParam["data"] = continueInput; + } + console.info(`onContinue input = ${wantParam["data"]}`); + return AbilityConstant.OnContinueResult.AGREE; + } + } + ``` + +5.在Stage模型中,应用在不同启动模式下将调用不同的接口,以恢复数据、加载界面。 + +不同情况下的函数调用如下图所示: + +![hop-cross-device-migration](figures/hop-cross-device-migration1.png) + +在目标端设备UIAbility中实现onCreate与onNewWant接口,恢复迁移数据。 + +- onCreate实现示例 + - 目标端设备上,在onCreate中根据launchReason判断该次启动是否为迁移LaunchReason.CONTINUATION。 + - 开发者可以从want中获取保存的迁移数据。 + - 完成数据恢复后,开发者需要调用restoreWindowStage来触发页面恢复:包括页面栈信息。 + + ```ts + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + import Want from '@ohos.app.ability.Want'; + + export default class EntryAbility extends UIAbility { + storage : LocalStorage = new LocalStorage(); + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { + console.info(`EntryAbility onCreate ${AbilityConstant.LaunchReason.CONTINUATION}`) + if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) { + // 将上述的保存的数据取出恢复 + let continueInput = ''; + if (want.parameters != undefined) { + continueInput = JSON.stringify(want.parameters.data); + console.info(`continue input ${continueInput}`) + } + // 将数据显示当前页面 + this.context.restoreWindowStage(this.storage); + } + } + } + ``` +- 如果是单实例应用,需要额外实现onNewWant接口,实现方式与onCreate的实现相同。 + - 在onNewWant中判断迁移场景,恢复数据,并触发页面恢复 + + ```ts + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + import Want from '@ohos.app.ability.Want'; + + export default class EntryAbility extends UIAbility { + storage : LocalStorage = new LocalStorage(); + onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void { + console.info(`EntryAbility onNewWant ${AbilityConstant.LaunchReason.CONTINUATION}`) + if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) { + // get user data from want params + let continueInput = ''; + if (want.parameters != undefined) { + continueInput = JSON.stringify(want.parameters.data); + console.info(`continue input ${continueInput}`); + } + this.context.restoreWindowStage(this.storage); + } + } + } + ``` + + + +## 迁移功能可选配置 + +### 1.动态配置迁移能力 + +从API 10 起,提供了支持动态配置迁移能力的功能。即应用可以根据实际使用场景,在需要迁移功能时,设置开启应用迁移能力;在业务不需要迁移时,则可以关闭迁移能力。开发者可以通过调用[setMissionContinueState](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextsetmissioncontinuestate10)接口对迁移能力进行设置。默认状态下,可迁移应用的迁移能力为**ACTIVE**状态,即迁移能力开启,可以迁移。 + +| 接口状态值 | 含义 | +| :------------------------------------- | ---------------------- | +| AbilityConstant.ContinueState.ACTIVE | 应用当前可迁移能力开启 | +| AbilityConstant.ContinueState.INACTIVE | 应用当前可迁移能力关闭 | + +**设置迁移能力的时机** + +迁移能力的改变可以根据实际业务需求和代码实现,发生在应用生命周期的绝大多数时机。本文介绍常用的几种配置方式。 + +在ability的onCreate函数中调用接口,可以在应用创建时设置应用的迁移状态。 + +```ts +// EntryAbility.ets +import UIAbility from '@ohos.app.ability.UIAbility'; +import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +import Want from '@ohos.app.ability.Want'; +export default class EntryAbility extends UIAbility { + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { + // ... + this.context.setMissionContinueState(AbilityConstant.ContinueState.INACTIVE, (result) => { + console.info(`setMissionContinueState: ${JSON.stringify(result)}`); + }); + // ... + } +} +``` + +在页面的onPageShow函数中调用接口,可以设置单个页面出现时应用的迁移状态。 + +```ts +// PageName.ets +import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +import common from '@ohos.app.ability.common' +@Entry +@Component +struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + } + // ... + onPageShow(){ + // 进入该页面时,将应用设置为可迁移状态 + this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => { + console.info('setMissionContinueState ACTIVE result: ', JSON.stringify(result)); + }); + } +} +``` + +在某个组件的触发事件中设置应用迁移能力。如下例中,使用 **Button** 组件的 **onClick** 事件,触发迁移能力的改变。 + +```ts +// PageName.ets +import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +import common from '@ohos.app.ability.common' +@Entry +@Component +struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button() { + //... + }.onClick(()=>{ + //点击该按钮时,将应用设置为可迁移状态 + this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => { + console.info('setMissionContinueState ACTIVE result: ', JSON.stringify(result)); + }); + }) + } +} +``` + +**保证迁移连续性** + +由于迁移加载时,目标端拉起的应用可能执行过自己的迁移状态设置命令(如:冷启动时目标端在onCreate中设置了 **INACTIVE** ;热启动时对端已打开了不可迁移的页面,迁移状态为 **INACTIVE** 等情况)。为了保证迁移过后的应用依然具有可以迁移回发起端的能力,应在 onCreate和onNewWant的迁移调用判断中,将迁移状态设置为 **ACTIVE** 。 + +```ts +// EntryAbility.ets +import UIAbility from '@ohos.app.ability.UIAbility'; +import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +import Want from '@ohos.app.ability.Want'; +export default class EntryAbility extends UIAbility { + // ... + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { + // ... + // 调用原因为迁移时,设置状态为可迁移,应对冷启动情况 + this.context.setMissionContinueState(AbilityConstant.ContinueState.INACTIVE, (result) => { + console.info(`setMissionContinueState: ${JSON.stringify(result)}`); + }); + } + onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void { + // ... + // 调用原因为迁移时,设置状态为可迁移,应对热启动情况 + if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) { + this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => { + console.info('setMissionContinueState ACTIVE result: ', JSON.stringify(result)); + }); + } + } + // ... +} +``` + + + +### 2.按需迁移页面栈 + +支持应用动态选择是否进行页面栈恢复(默认进行页面栈信息恢复)。如果应用不想使用系统默认恢复的页面栈,则可以设置不进行页面栈迁移,而需要在`onWindowStageRestore`设置迁移后进入的页面,参数定义见[SUPPORT_CONTINUE_PAGE_STACK_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)。 + +应用在发起端的页面栈中存在Index和Second路由,而在目标端恢复时不需要按照发起端页面栈进行恢复,需要恢复到指定页面。 + +- 示例:应用迁移不需要自动迁移页面栈信息 + + ```ts + // EntryAbility.ets + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + import wantConstant from '@ohos.app.ability.wantConstant'; + import window from '@ohos.window'; + export default class EntryAbility extends UIAbility { + // ... + onContinue(wantParam: Record) { + console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`); + wantParam[wantConstant.Params.SUPPORT_CONTINUE_PAGE_STACK_KEY] = false; + return AbilityConstant.OnContinueResult.AGREE; + } + // ... + onWindowStageRestore(windowStage: window.WindowStage) { + // 若不需要自动迁移页面栈信息,则需要在此处设置应用迁移后进入的页面 + windowStage.loadContent('pages/Index', (err, data) => { + if (err.code) { + console.info('Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? ''); + return; + } + console.info('Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? ''); + }); + } + } + ``` - - 应用兼容性检测:开发者可以通过从wantParam中获取目标应用的版本号与本应用版本号做兼容性校验。开发者可以在触发迁移时从`onContinue`接口中`wantParam.version`获取到迁移接收端应用的版本号与迁移发起端应用版本号做兼容校验。 +### 3.按需退出 - - 迁移决策:开发者可以通过onContinue接口的返回值决定是否支持此次迁移,返回值信息见[接口说明](#接口说明)。 +支持应用动态选择迁移成功后是否退出迁移发起端应用(默认迁移成功后退出迁移发起端应用)。如果应用不想让系统自动退出迁移发起端应用,则可以设置不退出,参数定义见[SUPPORT_CONTINUE_SOURCE_EXIT_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)。 - 示例如下: +- 示例:应用迁移设置不需要迁移成功后退出迁移发起端应用 - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + ```ts + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + import wantConstant from '@ohos.app.ability.wantConstant'; + export default class EntryAbility extends UIAbility { + // ... + onContinue(wantParam: Record) { + console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`); + wantParam[wantConstant.Params.SUPPORT_CONTINUE_SOURCE_EXIT_KEY] = false; + return AbilityConstant.OnContinueResult.AGREE; + } + // ... + } + ``` - onContinue(wantParam : {[key: string]: any}) { - console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`) - let workInput = AppStorage.Get('ContinueWork'); - // set user input data into want params - wantParam["work"] = workInput // set user input data into want params - console.info(`onContinue input = ${wantParam["input"]}`); - return AbilityConstant.OnContinueResult.AGREE - } - ``` +## 验证指导 -5. 在目标端设备UIAbility中实现onCreate()与onNewWant()接口,恢复迁移数据。 - - onCreate实现示例 - - 目标端设备上,在onCreate中根据launchReason判断该次启动是否为迁移LaunchReason.CONTINUATION。 - - 开发者可以从want中获取保存的迁移数据。 - - 完成数据恢复后,开发者需要调用restoreWindowStage来触发页面恢复:包括页面栈信息。 - - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import AbilityConstant from '@ohos.app.ability.AbilityConstant'; - import distributedObject from '@ohos.data.distributedDataObject'; - - export default class EntryAbility extends UIAbility { - storage : LocalStorage; - onCreate(want, launchParam) { - console.info(`EntryAbility onCreate ${AbilityConstant.LaunchReason.CONTINUATION}`) - if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) { - // get user data from want params - let workInput = want.parameters.work - console.info(`work input ${workInput}`) - AppStorage.SetOrCreate('ContinueWork', workInput) - this.storage = new LocalStorage(); - this.context.restoreWindowStage(this.storage); - } - } - } - ``` - - 如果是单实例应用,需要额外实现onNewWant()接口,实现方式与onCreate()的实现相同。 - - 在onNewWant()中判断迁移场景,恢复数据,并触发页面恢复 - - ```ts - export default class EntryAbility extends UIAbility { - storage : LocalStorage; - onNewWant(want, launchParam) { - console.info(`EntryAbility onNewWant ${AbilityConstant.LaunchReason.CONTINUATION}`) - if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) { - // get user data from want params - let workInput = want.parameters.work - console.info(`work input ${workInput}`) - AppStorage.SetOrCreate('ContinueWork', workInput) - this.storage = new LocalStorage(); - this.context.restoreWindowStage(this.storage); - } - } - } +为方便开发者验证已开发的可迁移应用,当前OpenHarmony提供了一个全局任务中心demo作为迁移的入口。下面介绍通过安装全局任务中心来验证迁移的方式。 -6. **可选配置:** 在应用支持迁移特性时,默认开启应用迁移状态开关,根据应用当前任务获取焦点/失去焦点通知周边的可信设备当前任务可流转/取消流转。若应用需要在特定场景下才通知周边设备可流转,则需要在应用打开时设置迁移状态为INACTIVE,在后续的业务流程中需要迁移时再设置迁移状态为ACTIVE。接口见[setMissionContinueState](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextsetmissioncontinuestate10)。 +### 1. 编译安装全局任务中心 - - 示例:应用启动不需要流转 +#### **配置环境** - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +public-SDK不支持开发者使用所有的系统API,例如:全局任务中心使用的[**@ohos.distributedDeviceManager**](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-distributedDeviceManager.md)不包括在public_SDK中。因此为了正确编译安装全局任务中心,开发者需要替换full-SDK,具体操作可参见[替换指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/faqs/full-sdk-switch-guide.md)。 - onCreate(want, launchParam) { - this.context.setMissionContinueState(AbilityConstant.ContinueState.INACTIVE, (result) => { - console.info(`setMissionContinueState: ${JSON.stringify(result)}`); - }); - } - ``` - - 示例:应用在后续的业务流程中需要流转了 +**说明**:本文中的截图仅为参考,具体的显示界面请以实际使用的DevEco Studio和SDK的版本为准。 - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import AbilityConstant from '@ohos.app.ability.AbilityConstant'; +#### **下载MissionCenter_Demo[示例代码](https://gitee.com/openharmony/ability_dmsfwk/tree/master/services/dtbschedmgr/test/missionCenterDemo/dmsDemo/entry/src/main)** - this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => { - console.info(`setMissionContinueState: ${JSON.stringify(result)}`); - }); - ``` +#### **编译工程文件** -7. **可选配置:** 支持应用动态选择是否进行页面栈恢复(默认进行页面栈信息恢复)。如果应用不想使用系统默认恢复的页面栈,则可以设置不进行页面栈迁移,而需要在`onWindowStageRestore`设置流转后进入的页面,参数定义见[SUPPORT_CONTINUE_PAGE_STACK_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)。 +**新建OpenHarmony 空的工程,找到对应的文件夹替换下载文件** - - 示例:应用迁移不需要自动流转页面栈信息 +![hop-cross-device-migration](figures/hop-cross-device-migration2.png) - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import wantConstant from '@ohos.app.ability.wantConstant.d.ts'; +**自动签名,编译安装。** - onContinue(wantParam : {[key: string]: any}) { - console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`) - wantParam[wantConstant.Params.SUPPORT_CONTINUE_PAGE_STACK_KEY] = false; - return AbilityConstant.OnContinueResult.AGREE; - } +​ DevEco的自动签名模板默认签名权限为normal级。而本应用设计到ohos.permission.MANAGE_MISSIONS权限为system_core级别。自动生成的签名无法获得足够的权限,所以需要将权限升级为system_core级别,然后签名。 - onWindowStageRestore(windowStage) { - // 若不需要自动流转页面栈信息,则需要在此处设置应用流转后进入的页面 - windowStage.setUIContent(this.contex, "pages/index", null); - } - ``` +**系统权限设置**(以api10目录为例): 将Sdk目录下的openharmony\api版本(如:10)\toolchains\lib\UnsgnedReleasedProfileTemplate.json文件中的"apl":"normal_core"改为"apl":"system_core"。 -8. **可选配置:** 支持应用动态选择迁移成功后是否退出迁移发起端应用(默认流转成功后退出迁移发起端应用)。如果应用不想让系统自动退出迁移发起端应用,则可以设置不退出,参数定义见参数定义见[SUPPORT_CONTINUE_SOURCE_EXIT_KEY](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantparams)。 +①点击file->Project Structrue - - 示例:应用迁移设置不需要迁移成功后退出迁移发起端应用 +![hop-cross-device-migration](figures/hop-cross-device-migration3.png) - ```ts - import UIAbility from '@ohos.app.ability.UIAbility'; - import wantConstant from '@ohos.app.ability.wantConstant.d.ts'; +②点击Signing Configs 点击OK - onContinue(wantParam : {[key: string]: any}) { - console.info(`onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice}`) - wantParam[wantConstant.Params.SUPPORT_CONTINUE_SOURCE_EXIT_KEY] = false; - return AbilityConstant.OnContinueResult.AGREE; - } - ``` \ No newline at end of file +![hop-cross-device-migration](figures/hop-cross-device-migration4.png) + +③连接开发板运行生成demo。 + +### 2.设备组网 + +①打开A,B两设备的计算器 + +②点击右上角箭头选择B设备 + +③在B设备选择信任设备,弹出PIN码 + +④在A设备输入PIN码 + +⑤已组网成功,验证方法:在A设备输入数字,B设备同步出现则证明组网成功 + +### 3.发起迁移 + +1.在B设备打开多设备协同权限的应用,A设备打开全局任务中心demo,A设备出现A设备名称(即:本机:OpenHarmony 3.2)和B设备名称(OpenHarmony 3.2)。 + +![hop-cross-device-migration](figures/hop-cross-device-migration5.png) + +2.点击B设备名称,然后出现B设备的应用。 + +![hop-cross-device-migration](figures/hop-cross-device-migration6.png) + +3.最后将应用拖拽到A设备名称处,A设备应用被拉起,B设备应用退出。 + +![hop-cross-device-migration](figures/hop-cross-device-migration7.png) diff --git a/zh-cn/application-dev/application-models/hop-multi-device-collaboration.md b/zh-cn/application-dev/application-models/hop-multi-device-collaboration.md index cf099d3fcbd12db99b15ec9c2786ace76863d651..b5a06df253b58f163ab373214b5b3b77b4a0cae6 100644 --- a/zh-cn/application-dev/application-models/hop-multi-device-collaboration.md +++ b/zh-cn/application-dev/application-models/hop-multi-device-collaboration.md @@ -1,4 +1,4 @@ -# 多端协同(仅对系统应用开放) +# 多端协同 ## 功能描述 @@ -56,29 +56,32 @@ 3. 获取目标设备的设备ID。 ```ts - import deviceManager from '@ohos.distributedHardware.deviceManager'; - - let dmClass; + import deviceManager from '@ohos.distributedDeviceManager'; + + let dmClass: deviceManager.DeviceManager; function initDmClass() { - // 其中createDeviceManager接口为系统API - deviceManager.createDeviceManager('ohos.samples.demo', (err, dm) => { - if (err) { - ... - return - } - dmClass = dm - }) + // 其中createDeviceManager接口为系统API + try{ + dmClass = deviceManager.createDeviceManager('ohos.samples.demo'); + } catch(err) { + console.error("createDeviceManager err: " + JSON.stringify(err)); + } } function getRemoteDeviceId() { if (typeof dmClass === 'object' && dmClass !== null) { - let list = dmClass.getTrustedDeviceListSync() + let list = dmClass.getAvailableDeviceListSync(); if (typeof (list) === 'undefined' || typeof (list.length) === 'undefined') { - console.info('EntryAbility onButtonClick getRemoteDeviceId err: list is null') + console.info('getRemoteDeviceId err: list is null'); + return; + } + if (list.length === 0) { + console.info("getRemoteDeviceId err: list is empty"); return; } - return list[0].deviceId + return list[0].networkId; } else { - console.info('EntryAbility onButtonClick getRemoteDeviceId err: dmClass is null') + console.info('getRemoteDeviceId err: dmClass is null'); + return; } } ``` @@ -86,24 +89,29 @@ 4. 设置目标组件参数,调用[`startAbility()`](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)接口,启动UIAbility或ServiceExtensionAbility。 ```ts - let want = { - deviceId: getRemoteDeviceId(), + import { BusinessError } from '@ohos.base'; + import Want from '@ohos.app.ability.Want'; + let want: Want = { + deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', - abilityName: 'FuncAbility', - moduleName: 'module1', // moduleName非必选 + abilityName: 'EntryAbility', + moduleName: 'entry', // moduleName非必选 } // context为发起端UIAbility的AbilityContext this.context.startAbility(want).then(() => { - ... - }).catch((err) => { - ... + // ... + }).catch((err: BusinessError) => { + // ... + console.error("startAbility err: " + JSON.stringify(err)); }) ``` -5. 当设备A发起端应用不需要设备B上的ServiceExtensionAbility时,可调用stopServiceExtensionAbility(../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstopserviceextensionability)接口退出。(该接口不支持UIAbility的退出,UIAbility由用户手动通过任务管理退出) +5. 当设备A发起端应用不需要设备B上的ServiceExtensionAbility时,可调用[stopServiceExtensionAbility](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstopserviceextensionability)接口退出。(该接口不支持UIAbility的退出,UIAbility由用户手动通过任务管理退出) ```ts - let want = { + import Want from '@ohos.app.ability.Want'; + import { BusinessError } from '@ohos.base'; + let want: Want = { deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -112,7 +120,7 @@ // 退出由startAbility接口启动的ServiceExtensionAbility this.context.stopServiceExtensionAbility(want).then(() => { console.info("stop service extension ability success") - }).catch((err) => { + }).catch((err: BusinessError) => { console.info("stop service extension ability err is " + JSON.stringify(err)) }) ``` @@ -142,55 +150,107 @@ 3. 在发起端设置目标组件参数,调用startAbilityForResult()接口启动目标端UIAbility,异步回调中的data用于接收目标端UIAbility停止自身后返回给调用方UIAbility的信息。getRemoteDeviceId方法参照[通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据](#通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据)。 ```ts - let want = { - deviceId: getRemoteDeviceId(), - bundleName: 'com.example.myapplication', - abilityName: 'FuncAbility', - moduleName: 'module1', // moduleName非必选 + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; + import common from '@ohos.app.ability.common'; + import { BusinessError } from '@ohos.base'; + import Want from '@ohos.app.ability.Want'; + @Entry + @Component + struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button('StartAbilityForResult') + .onClick(()=>{ + let want: Want = { + deviceId: getRemoteDeviceId(), + bundleName: 'com.example.myapplication', + abilityName: 'FuncAbility', + moduleName: 'module1', // moduleName非必选 + } + // context为发起端UIAbility的AbilityContext + this.context.startAbilityForResult(want).then((data) => { + // ... + }).catch((error: BusinessError) => { + console.info("startAbilityForResult err: " + JSON.stringify(error)); + }) + } + ) + } } - // context为发起端UIAbility的AbilityContext - this.context.startAbilityForResult(want).then((data) => { - ... - }).catch((err) => { - ... - }) ``` 4. 在目标端UIAbility任务完成后,调用terminateSelfWithResult()方法,将数据返回给发起端的UIAbility。 ```ts - const RESULT_CODE: number = 1001; - let abilityResult = { - resultCode: RESULT_CODE, - want: { - bundleName: 'com.example.myapplication', - abilityName: 'FuncAbility', - moduleName: 'module1', - }, + import { BusinessError } from '@ohos.base'; + import common from '@ohos.app.ability.common'; + @Entry + @Component + struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button('terminateSelfWithResult') + .onClick(()=>{ + const RESULT_CODE: number = 1001; + // context为目标端UIAbility的AbilityContext + this.context.terminateSelfWithResult( + { + resultCode: RESULT_CODE, + want: { + bundleName: 'com.example.myapplication', + abilityName: 'FuncAbility', + moduleName: 'module1', + }, + }, + (err: BusinessError) => { + // ... + console.info("terminateSelfWithResult err: " + JSON.stringify(err)); + }); + } + // ... + ) + } } - // context为目标端UIAbility的AbilityContext - this.context.terminateSelfWithResult(abilityResult, (err) => { - ... - }); ``` 5. 发起端UIAbility接收到目标端UIAbility返回的信息,对其进行处理。 ```ts - const RESULT_CODE: number = 1001; - - ... - - // context为调用方UIAbility的UIAbilityContext - this.context.startAbilityForResult(want).then((data) => { - if (data?.resultCode === RESULT_CODE) { - // 解析目标端UIAbility返回的信息 - let info = data.want?.parameters?.info - ... - } - }).catch((err) => { - ... - }) + import common from '@ohos.app.ability.common'; + import { BusinessError } from '@ohos.base'; + import Want from '@ohos.app.ability.Want'; + @Entry + @Component + struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button('StartAbilityForResult') + .onClick(()=>{ + let want: Want = { + deviceId: getRemoteDeviceId(), + bundleName: 'com.example.myapplication', + abilityName: 'FuncAbility', + moduleName: 'module1', // moduleName非必选 + } + const RESULT_CODE: number = 1001; + // ... + // context为调用方UIAbility的UIAbilityContext + this.context.startAbilityForResult(want).then((data) => { + if (data?.resultCode === RESULT_CODE) { + // 解析目标端UIAbility返回的信息 + let info = data.want?.parameters?.info; + // ... + } + }).catch((error: BusinessError) => { + // ... + }) + } + ) + } + } ``` @@ -216,7 +276,7 @@ 2. 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见[向用户申请授权](../security/accesstoken-guidelines.md#向用户申请授权)。 -3. 如果已有后台服务,请直接进入下一步;如果没有,则[实现一个后台服务](serviceextensionability.md#实现一个后台服务仅对系统应用开放)。 +3. 如果已有后台服务,请直接进入下一步;如果没有,则[实现一个后台服务](serviceextensionability.md#实现一个后台服务(仅对系统应用开放))。 4. 连接一个后台服务。 - 实现IAbilityConnection接口。IAbilityConnection提供了以下方法供开发者实现:onConnect()是用来处理连接Service成功的回调,onDisconnect()是用来处理Service异常终止的回调,onFailed()是用来处理连接Service失败的回调。 @@ -227,48 +287,60 @@ ```ts import rpc from '@ohos.rpc'; - - const REQUEST_CODE = 99; - let want = { - "deviceId": getRemoteDeviceId(), - "bundleName": "com.example.myapplication", - "abilityName": "ServiceExtAbility" - }; - let options = { - onConnect(elementName, remote) { - console.info('onConnect callback'); - if (remote === null) { - console.info(`onConnect remote is null`); - return; - } - let option = new rpc.MessageOption(); - let data = new rpc.MessageParcel(); - let reply = new rpc.MessageParcel(); - data.writeInt(1); - data.writeInt(99); // 开发者可发送data到目标端应用进行相应操作 - - // @param code 表示客户端发送的服务请求代码。 - // @param data 表示客户端发送的{@link MessageParcel}对象。 - // @param reply 表示远程服务发送的响应消息对象。 - // @param options 指示操作是同步的还是异步的。 - // - // @return 如果操作成功返回{@code true}; 否则返回 {@code false}。 - remote.sendRequest(REQUEST_CODE, data, reply, option).then((ret) => { - let msg = reply.readInt(); // 在成功连接的情况下,会收到来自目标端返回的信息(100) - console.info(`sendRequest ret:${ret} msg:${msg}`); - }).catch((error) => { - console.info('sendRequest failed'); - }); - }, - onDisconnect(elementName) { - console.info('onDisconnect callback'); - }, - onFailed(code) { - console.info('onFailed callback'); + import Want from '@ohos.app.ability.Want'; + import common from '@ohos.app.ability.common'; + import { BusinessError } from '@ohos.base'; + @Entry + @Component + struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button('connectServiceExtensionAbility') + .onClick(()=>{ + const REQUEST_CODE = 99; + let want: Want = { + "deviceId": getRemoteDeviceId(), + "bundleName": "com.example.myapplication", + "abilityName": "ServiceExtAbility" + }; + // 建立连接后返回的Id需要保存下来,在解绑服务时需要作为参数传入 + let connectionId = this.context.connectServiceExtensionAbility(want, + { + onConnect(elementName, remote) { + console.info('onConnect callback'); + if (remote === null) { + console.info(`onConnect remote is null`); + return; + } + let option = new rpc.MessageOption(); + let data = new rpc.MessageParcel(); + let reply = new rpc.MessageParcel(); + data.writeInt(1); + data.writeInt(99); // 开发者可发送data到目标端应用进行相应操作 + // @param code 表示客户端发送的服务请求代码。 + // @param data 表示客户端发送的{@link MessageParcel}对象。 + // @param reply 表示远程服务发送的响应消息对象。 + // @param options 指示操作是同步的还是异步的。 + // + // @return 如果操作成功返回{@code true}; 否则返回 {@code false}。 + remote.sendRequest(REQUEST_CODE, data, reply, option).then((ret: rpc.SendRequestResult) => { + let msg = reply.readInt(); // 在成功连接的情况下,会收到来自目标端返回的信息(100) + console.info(`sendRequest ret:${ret} msg:${msg}`); + }).catch((error: BusinessError) => { + console.info('sendRequest failed'); + }); + }, + onDisconnect(elementName) { + console.info('onDisconnect callback'); + }, + onFailed(code) { + console.info('onFailed callback'); + } + }); + }) } } - // 建立连接后返回的Id需要保存下来,在解绑服务时需要作为参数传入 - let connectionId = this.context.connectServiceExtensionAbility(want, options); ``` getRemoteDeviceId方法参照[通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据](#通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据)。 @@ -276,12 +348,25 @@ 5. 断开连接。调用disconnectServiceExtensionAbility()断开与后台服务的连接。 ```ts - let connectionId = 1 // 在通过connectServiceExtensionAbility绑定服务时返回的Id - this.context.disconnectServiceExtensionAbility(connectionId).then((data) => { - console.info('disconnectServiceExtensionAbility success'); - }).catch((error) => { - console.error('disconnectServiceExtensionAbility failed'); - }) + import common from '@ohos.app.ability.common'; + import { BusinessError } from '@ohos.base'; + @Entry + @Component + struct PageName { + private context = getContext(this) as common.UIAbilityContext; + build() { + // ... + Button('disconnectServiceExtensionAbility') + .onClick(()=>{ + let connectionId: number = 1 // 在通过connectServiceExtensionAbility绑定服务时返回的Id + this.context.disconnectServiceExtensionAbility(connectionId).then(() => { + console.info('disconnectServiceExtensionAbility success'); + }).catch((error: BusinessError) => { + console.error('disconnectServiceExtensionAbility failed'); + }) + }) + } + } ``` @@ -340,29 +425,30 @@ 2. 导入UIAbility模块。 ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import UIAbility from '@ohos.app.ability.UIAbility'; ``` 3. 定义约定的序列化数据。 调用端及被调用端发送接收的数据格式需协商一致,如下示例约定数据由number和string组成。 ```ts + import rpc from '@ohos.rpc' export default class MyParcelable { num: number = 0; str: string = ""; - constructor(num, string) { + constructor(num: number, string: string) { this.num = num; this.str = string; } - marshalling(messageSequence) { + marshalling(messageSequence: rpc.MessageParcel) { messageSequence.writeInt(this.num); messageSequence.writeString(this.str); return true; } - unmarshalling(messageSequence) { + unmarshalling(messageSequence: rpc.MessageParcel) { this.num = messageSequence.readInt(); this.str = messageSequence.readString(); return true; @@ -373,24 +459,28 @@ 如下示例在Ability的onCreate注册MSG_SEND_METHOD监听,在onDestroy取消监听,收到序列化数据后作相应处理并返回。应用开发者根据实际业务需要做相应处理。 ```ts + import rpc from '@ohos.rpc'; + import Want from '@ohos.app.ability.Want'; + import UIAbility from '@ohos.app.ability.UIAbility'; + import AbilityConstant from '@ohos.app.ability.AbilityConstant'; const TAG: string = '[CalleeAbility]'; const MSG_SEND_METHOD: string = 'CallSendMsg'; - function sendMsgCallback(data) { + function sendMsgCallback(data: rpc.MessageSequence): MyParcelable { console.info('CalleeSortFunc called'); // 获取Caller发送的序列化数据 - let receivedData = new MyParcelable(0, ''); + let receivedData: MyParcelable = new MyParcelable(0, ''); data.readParcelable(receivedData); console.info(`receiveData[${receivedData.num}, ${receivedData.str}]`); // 作相应处理 // 返回序列化数据result给Caller - return new MyParcelable(receivedData.num + 1, `send ${receivedData.str} succeed`); + return new MyParcelable(Number(receivedData.num) + 1, `send ${receivedData.str} succeed`); } - export default class CalleeAbility extends Ability { - onCreate(want, launchParam) { + export default class CalleeAbility extends UIAbility { + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { try { this.callee.on(MSG_SEND_METHOD, sendMsgCallback); } catch (error) { @@ -412,42 +502,48 @@ 1. 导入UIAbility模块。 ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import UIAbility from '@ohos.app.ability.UIAbility'; ``` 2. 获取Caller通信接口。 Ability的context属性实现了startAbilityByCall方法,用于获取指定通用组件的Caller通信接口。如下示例通过this.context获取Ability实例的context属性,使用startAbilityByCall拉起Callee被调用端并获取Caller通信接口,注册Caller的onRelease和onRemoteStateChange监听。应用开发者根据实际业务需要做相应处理。 ```ts - async onButtonGetRemoteCaller() { - var caller = undefined; - var context = this.context; - - context.startAbilityByCall({ - deviceId: getRemoteDeviceId(), - bundleName: 'com.samples.CallApplication', - abilityName: 'CalleeAbility' - }).then((data) => { - if (data != null) { - caller = data; - console.info('get remote caller success'); - // 注册caller的release监听 - caller.onRelease((msg) => { - console.info(`remote caller onRelease is called ${msg}`); - }) - console.info('remote caller register OnRelease succeed'); - // 注册caller的协同场景下跨设备组件状态变化监听通知 - try { - caller.onRemoteStateChange((str) => { - console.info('Remote state changed ' + str); - }); - } catch (error) { - console.info('Caller.onRemoteStateChange catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}'); + import UIAbility, { Caller } from '@ohos.app.ability.UIAbility'; + import { BusinessError } from '@ohos.base'; + export default class EntryAbility extends UIAbility { + // ... + async onButtonGetRemoteCaller() { + let caller: Caller | undefined; + let context = this.context; + + context.startAbilityByCall({ + deviceId: getRemoteDeviceId(), + bundleName: 'com.samples.CallApplication', + abilityName: 'CalleeAbility' + }).then((data) => { + if (data != null) { + caller = data; + console.info('get remote caller success'); + // 注册caller的release监听 + caller.onRelease((msg) => { + console.info(`remote caller onRelease is called ${msg}`); + }) + console.info('remote caller register OnRelease succeed'); + // 注册caller的协同场景下跨设备组件状态变化监听通知 + try { + caller.onRemoteStateChange((str) => { + console.info('Remote state changed ' + str); + }); + } catch (error) { + console.info('Caller.onRemoteStateChange catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}'); + } } - } - }).catch((error) => { - console.error(`get remote caller failed with ${error}`); - }) + }).catch((error: BusinessError) => { + console.error(`get remote caller failed with ${error}`); + }) + } + // ... } ``` @@ -457,49 +553,72 @@ 1. 向被调用端发送Parcelable数据有两种方式,一种是不带返回值,一种是获取被调用端返回的数据,method以及序列化数据需要与被调用端协商一致。如下示例调用Call接口,向Callee被调用端发送数据。 ```ts + import UIAbility, { Caller } from '@ohos.app.ability.UIAbility'; + import { BusinessError } from '@ohos.base'; const MSG_SEND_METHOD: string = 'CallSendMsg'; - async onButtonCall() { - try { - let msg = new MyParcelable(1, 'origin_Msg'); - await this.caller.call(MSG_SEND_METHOD, msg); - } catch (error) { - console.info(`caller call failed with ${error}`); - } + export default class EntryAbility extends UIAbility { + // ... + caller: Caller | undefined; + async onButtonCall() { + try { + let msg: MyParcelable = new MyParcelable(1, 'origin_Msg'); + if (this.caller) { + await this.caller.call(MSG_SEND_METHOD, msg); + } + } catch (error) { + console.info(`caller call failed with ${error}`); + } + } + // ... } ``` 2. 如下示例调用CallWithResult接口,向Callee被调用端发送待处理的数据originMsg,并将’CallSendMsg’方法处理完毕的数据赋值给backMsg。 - ```ts - const MSG_SEND_METHOD: string = 'CallSendMsg'; - originMsg: string = ''; - backMsg: string = ''; - async onButtonCallWithResult(originMsg, backMsg) { - try { - let msg = new MyParcelable(1, originMsg); - const data = await this.caller.callWithResult(MSG_SEND_METHOD, msg); - console.info('caller callWithResult succeed'); - - let result = new MyParcelable(0, ''); - data.readParcelable(result); - backMsg(result.str); - console.info(`caller result is [${result.num}, ${result.str}]`); - } catch (error) { - console.info(`caller callWithResult failed with ${error}`); - } - } - ``` + ```ts + import UIAbility, { Caller } from '@ohos.app.ability.UIAbility'; + import rpc from '@ohos.rpc'; + const MSG_SEND_METHOD: string = 'CallSendMsg'; + let originMsg: string = ''; + let backMsg: string = ''; + export default class EntryAbility extends UIAbility { + // ... + caller: Caller | undefined; + async onButtonCallWithResult(originMsg: string, backMsg: string) { + try { + let msg: MyParcelable = new MyParcelable(1, originMsg); + if (this.caller) { + const data = await this.caller.callWithResult(MSG_SEND_METHOD, msg); + console.info('caller callWithResult succeed'); + let result: MyParcelable = new MyParcelable(0, ''); + data.readParcelable(result); + backMsg = result.str; + console.info(`caller result is [${result.num}, ${result.str}]`); + } + } catch (error) { + console.info(`caller callWithResult failed with ${error}`); + } + } + // ... + } + ``` 6. 释放Caller通信接口。 Caller不再使用后,应用开发者可以通过release接口释放Caller。 ```ts - releaseCall() { - try { - this.caller.release(); - this.caller = undefined - console.info('caller release succeed'); - } catch (error) { - console.info(`caller release failed with ${error}`); - } + import UIAbility, { Caller } from '@ohos.app.ability.UIAbility'; + export default class EntryAbility extends UIAbility { + caller: Caller | undefined; + releaseCall() { + try { + if (this.caller) { + this.caller.release(); + this.caller = undefined; + } + console.info('caller release succeed'); + } catch (error) { + console.info(`caller release failed with ${error}`); + } + } } ``` diff --git a/zh-cn/application-dev/device/location-guidelines.md b/zh-cn/application-dev/device/location-guidelines.md index 06392107148d98c7a6996bd2da8f170f7da17225..e58848c2219958b50a58d156f52ac6ae85a465b8 100644 --- a/zh-cn/application-dev/device/location-guidelines.md +++ b/zh-cn/application-dev/device/location-guidelines.md @@ -149,7 +149,7 @@ 以导航场景为例,实例化方式如下: ```ts - let requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + let requestInfo:geoLocationManager.LocationRequest = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` **方式二:** @@ -179,14 +179,14 @@ 以定位精度优先策略为例,实例化方式如下: ```ts - let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` 4. 实例化Callback对象,用于向系统提供位置上报的途径。 应用需要自行实现系统定义好的回调接口,并将其实例化。系统在定位成功确定设备的实时位置结果时,会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。 ```ts - let locationChange = (location) => { + let locationChange = (location:geoLocationManager.Location):void => { console.log('locationChanger: data: ' + JSON.stringify(location)); }; ``` @@ -209,10 +209,11 @@ ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let location = geoLocationManager.getLastLocation(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -259,10 +260,11 @@ ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let isAvailable = geoLocationManager.isGeocoderAvailable(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -270,7 +272,7 @@ - 调用getAddressesFromLocation,坐标转化地理位置信息。 ```ts - let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; try { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { @@ -280,7 +282,7 @@ } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -288,7 +290,7 @@ - 调用getAddressesFromLocationName位置描述转化坐标。 ```ts - let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; try { geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { @@ -298,7 +300,7 @@ } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -332,11 +334,12 @@ 1. 使用地理围栏功能,需要有权限ohos.permission.APPROXIMATELY_LOCATION,位置权限申请的方法和步骤见[申请位置权限开发指导](#申请位置权限开发指导)。 -2. 导入[geoLocationManager](../reference/apis/js-apis-geoLocationManager.md)模块和[wantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)模块。 +2. 导入[geoLocationManager](../reference/apis/js-apis-geoLocationManager.md)模块、[wantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)模块和[BusinessError](../reference/apis/js-apis-base.md)模块。 ```ts import geoLocationManager from '@ohos.geoLocationManager'; import wantAgent from '@ohos.app.ability.wantAgent'; + import BusinessError from "@ohos.base"; ``` 3. 创建[WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md)信息。 @@ -344,10 +347,10 @@ 场景一:创建拉起Ability的WantAgentInfo信息。 ```ts - let wantAgentObj = null; // 用于保存创建成功的wantAgent对象,后续使用其完成触发的动作。 + let wantAgentObj:wantAgent.WantAgentInfo|null = null; // 用于保存创建成功的wantAgent对象,后续使用其完成触发的动作。 // 通过WantAgentInfo的operationType设置动作类型 - let wantAgentInfo = { + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { deviceId: '', @@ -368,10 +371,10 @@ 场景二:创建发布[公共事件](../application-models/common-event-overview.md)的WantAgentInfo信息。 ```ts - let wantAgentObj = null; // 用于保存创建成功的WantAgent对象,后续使用其完成触发的动作。 + let wantAgentObj:wantAgent.WantAgentInfo|null = null; // 用于保存创建成功的WantAgent对象,后续使用其完成触发的动作。 // 通过WantAgentInfo的operationType设置动作类型 - let wantAgentInfo = { + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { action: 'event_name', // 设置事件名 @@ -397,11 +400,11 @@ } console.info('getWantAgent success'); wantAgentObj = data; - let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; try { geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } }); ``` diff --git a/zh-cn/application-dev/device/sensor-guidelines.md b/zh-cn/application-dev/device/sensor-guidelines.md index 0e86df0246bef21951abdb179f916910c897f0fa..cf0cde22baf843011a03a379d7557e14e41cd5e1 100644 --- a/zh-cn/application-dev/device/sensor-guidelines.md +++ b/zh-cn/application-dev/device/sensor-guidelines.md @@ -25,13 +25,14 @@ 1. 导入模块。 ```ts - import sensor from "@ohos.sensor"; + import sensor from '@ohos.sensor'; + import { BusinessError } from '@ohos.base'; ``` 2. 查询设备支持的所有传感器的参数。 ```ts - sensor.getSensorList(function (error, data) { + sensor.getSensorList((error: BusinessError, data: Array) => { if (error) { console.info('getSensorList failed'); } else { @@ -54,19 +55,19 @@ - 通过on()接口,实现对传感器的持续监听,传感器上报周期interval设置为100000000纳秒。 ```ts - sensor.on(sensor.SensorId.ACCELEROMETER, function (data) { + sensor.on(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info("Succeeded in obtaining data. x: " + data.x + " y: " + data.y + " z: " + data.z); - }, {'interval': 100000000}); + }, { interval: 100000000 }); ``` ![输入图片说明](figures/002.png) - 通过once()接口,实现对传感器的一次监听。 - ```ts - sensor.once(sensor.SensorId.ACCELEROMETER, function (data) { + ```ts + sensor.once(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info("Succeeded in obtaining data. x: " + data.x + " y: " + data.y + " z: " + data.z); - }); + }); ``` ![输入图片说明](figures/003.png) diff --git a/zh-cn/application-dev/device/vibrator-guidelines.md b/zh-cn/application-dev/device/vibrator-guidelines.md index d04b5036ddaf67718f87098661c0d6ce4e4af524..6eae3be58a093f0e338ed6ccd99ca13d78b244d4 100644 --- a/zh-cn/application-dev/device/vibrator-guidelines.md +++ b/zh-cn/application-dev/device/vibrator-guidelines.md @@ -112,15 +112,17 @@ Json文件共包含2个属性。 ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { - vibrator.startVibration({ // 使用startVibration需要添加ohos.permission.VIBRATE权限 + // 使用startVibration需要添加ohos.permission.VIBRATE权限 + vibrator.startVibration({ type: 'time', duration: 1000, }, { id: 0, usage: 'alarm' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -128,7 +130,8 @@ try { console.info('Succeed in starting vibration.'); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -136,10 +139,11 @@ try { ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 按照VIBRATOR_STOP_MODE_TIME模式停止振动, 使用stopVibration需要添加ohos.permission.VIBRATE权限 - vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) { + vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, (error: BusinessError) => { if (error) { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -147,7 +151,8 @@ try { console.info('Succeeded in stopping vibration.'); }) } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -155,7 +160,8 @@ try { ```ts import vibrator from '@ohos.vibrator'; -// 使用startVibration、stopVibration需要添加ohos.permission.VIBRATE权限 +import { BusinessError } from '@ohos.base'; + try { vibrator.startVibration({ type: 'time', @@ -163,7 +169,7 @@ try { }, { id: 0, usage: 'alarm' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -171,7 +177,7 @@ try { console.info('Succeed in starting vibration'); }); // 停止所有类型的马达振动 - vibrator.stopVibration(function (error) { + vibrator.stopVibration((error: BusinessError) => { if (error) { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -179,7 +185,8 @@ try { console.info('Succeed in stopping vibration'); }) } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -187,10 +194,11 @@ try { ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 查询是否支持'haptic.clock.timer' - vibrator.isSupportEffect('haptic.clock.timer', function (err, state) { + vibrator.isSupportEffect('haptic.clock.timer', (err: BusinessError, state: boolean) => { if (err) { console.error(`Failed to query effect. Code: ${err.code}, message: ${err.message}`); return; @@ -198,13 +206,14 @@ try { console.info('Succeed in querying effect'); if (state) { try { - vibrator.startVibration({ // 使用startVibration需要添加ohos.permission.VIBRATE权限 + // 使用startVibration需要添加ohos.permission.VIBRATE权限 + vibrator.startVibration({ type: 'preset', effectId: 'haptic.clock.timer', count: 1, }, { usage: 'unknown' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); } else { @@ -212,12 +221,14 @@ try { } }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } } }) } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -225,20 +236,22 @@ try { ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; +import resourceManager from '@ohos.resourceManager'; // 获取振动文件资源描述符 -async function getRawfileFd(fileName) { - let rawFd = await globalThis.getContext().resourceManager.getRawFd(fileName); +async function getRawfileFd(fileName: string): Promise { + let rawFd = await getContext().resourceManager.getRawFd(fileName); return rawFd; } // 关闭振动文件资源描述符 -async function closeRawfileFd(fileName) { - await globalThis.getContext().resourceManager.closeRawFd(fileName) +async function closeRawfileFd(fileName: string): Promise { + await getContext().resourceManager.closeRawFd(fileName) } // 播放自定义振动,使用startVibration、stopVibration需要添加ohos.permission.VIBRATE权限 -async function playCustomHaptic(fileName) { +async function playCustomHaptic(fileName: string): Promise { try { let rawFd = await getRawfileFd(fileName); vibrator.startVibration({ @@ -248,10 +261,10 @@ async function playCustomHaptic(fileName) { usage: "alarm" }).then(() => { console.info('Succeed in starting vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); }); - vibrator.stopVibration(function (error) { + vibrator.stopVibration((error: BusinessError) => { if (error) { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -260,7 +273,8 @@ async function playCustomHaptic(fileName) { }) await closeRawfileFd(fileName); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } } ``` diff --git a/zh-cn/application-dev/media/camera-device-input.md b/zh-cn/application-dev/media/camera-device-input.md index a2eefd8eb9953812c5397b9f7e5c5098f22d4177..67f66c0641a32323abc36e7876fdadcc2ce54978 100644 --- a/zh-cn/application-dev/media/camera-device-input.md +++ b/zh-cn/application-dev/media/camera-device-input.md @@ -13,10 +13,10 @@ ``` 2. 通过getCameraManager()方法,获取cameraManager对象。 - + [各类Context的获取方式](../application-models/application-context-stage.md)。 ```ts let cameraManager: camera.CameraManager; - let context: Context = getContext(this); // [各类Context的获取方式](../application-models/application-context-stage.md) + let context: Context = getContext(this); cameraManager = camera.getCameraManager(context); ``` @@ -29,15 +29,15 @@ ```ts let cameraArray: Array = cameraManager.getSupportedCameras(); if (cameraArray != undefined && cameraArray.length <= 0) { - console.error("cameraManager.getSupportedCameras error"); - return; + console.error("cameraManager.getSupportedCameras error"); + return; } for (let index = 0; index < cameraArray.length; index++) { - console.info('cameraId : ' + cameraArray[index].cameraId); // 获取相机ID - console.info('cameraPosition : ' + cameraArray[index].cameraPosition); // 获取相机位置 - console.info('cameraType : ' + cameraArray[index].cameraType); // 获取相机类型 - console.info('connectionType : ' + cameraArray[index].connectionType); // 获取相机连接类型 + console.info('cameraId : ' + cameraArray[index].cameraId); // 获取相机ID + console.info('cameraPosition : ' + cameraArray[index].cameraPosition); // 获取相机位置 + console.info('cameraType : ' + cameraArray[index].cameraType); // 获取相机类型 + console.info('connectionType : ' + cameraArray[index].connectionType); // 获取相机连接类型 } ``` @@ -47,22 +47,23 @@ // 创建相机输入流 let cameraInput: camera.CameraInput; try { - cameraInput = cameraManager.createCameraInput(cameraArray[0]); + cameraInput = cameraManager.createCameraInput(cameraArray[0]); } catch (error) { - console.error('Failed to createCameraInput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createCameraInput errorCode = ' + err.code); } // 监听cameraInput错误信息 let cameraDevice: camera.CameraDevice = cameraArray[0]; cameraInput.on('error', cameraDevice, (error: BusinessError) => { - console.info(`Camera input error code: ${error.code}`); + console.info(`Camera input error code: ${error.code}`); }); // 打开相机 await cameraInput.open(); // 获取相机设备支持的输出流能力 let cameraOutputCapability: camera.CameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraArray[0]); if (!cameraOutputCapability) { - console.error("cameraManager.getSupportedOutputCapability error"); - return; + console.error("cameraManager.getSupportedOutputCapability error"); + return; } console.info("outputCapability: " + JSON.stringify(cameraOutputCapability)); ``` diff --git a/zh-cn/application-dev/media/camera-metadata.md b/zh-cn/application-dev/media/camera-metadata.md index 30515f6286b36dd4de5e45e80a5b23b6f319ca8e..cc7c8aa2c1b3b20935d8c565928c05661ca4efa9 100644 --- a/zh-cn/application-dev/media/camera-metadata.md +++ b/zh-cn/application-dev/media/camera-metadata.md @@ -16,8 +16,8 @@ Metadata主要是通过一个TAG(Key),去找对应的Data,用于传递 try { metadataOutput = cameraManager.createMetadataOutput(metadataObjectTypes); } catch (error) { - // 失败返回错误码error.code并处理 - console.info(error.code); + let err = error as BusinessError; + console.info('Failed to createMetadataOutput, error code: '+ err.code); } ``` @@ -26,8 +26,8 @@ Metadata主要是通过一个TAG(Key),去找对应的Data,用于传递 ```ts metadataOutput.start().then(() => { console.info('Callback returned with metadataOutput started.'); - }).catch((err) => { - console.info('Failed to metadataOutput start '+ err.code); + }).catch((err: BusinessError) => { + console.info('Failed to metadataOutput start, error code: '+ err.code); }); ``` @@ -36,7 +36,7 @@ Metadata主要是通过一个TAG(Key),去找对应的Data,用于传递 ```ts metadataOutput.stop().then(() => { console.info('Callback returned with metadataOutput stopped.'); - }).catch((err) => { + }).catch((err: BusinessError) => { console.info('Failed to metadataOutput stop '+ err.code); }); ``` diff --git a/zh-cn/application-dev/media/camera-mode.md b/zh-cn/application-dev/media/camera-mode.md index 8da84335ba533014905409e33d61aaff91425b85..7657436bedf3466120c4c529cb81a311843eaacf 100644 --- a/zh-cn/application-dev/media/camera-mode.md +++ b/zh-cn/application-dev/media/camera-mode.md @@ -1,4 +1,4 @@ -# 人像模式拍照 +# 人像模式拍照实现方案 ## 开发流程 @@ -9,7 +9,7 @@ ![portraitgraphing Development Process](figures/portrait-capture-development-process.png) ## 完整示例 - +[各类Context的获取方式](../application-models/application-context-stage.md) ```ts import camera from '@ohos.multimedia.camera'; import image from '@ohos.multimedia.image'; @@ -17,17 +17,17 @@ import media from '@ohos.multimedia.media'; // 创建CameraManager对象 -let context: Context = getContext(this); // [各类Context的获取方式](../application-models/application-context-stage.md) +let context: Context = getContext(this); let cameraManager: camera.CameraManager = camera.getCameraManager(context); if (!cameraManager) { - console.error("camera.getCameraManager error"); - return; + console.error("camera.getCameraManager error"); + return; } // 创建ModeManager对象 let modeManager: camera.ModeManager = camera.getModeManager(context); if (!cameraManager) { - console.error("camera.getModeManager error"); - return; + console.error("camera.getModeManager error"); + return; } // 监听相机状态变化 cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.CameraStatusInfo) => { @@ -37,34 +37,35 @@ cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.C // 获取相机列表 let cameraArray: Array = cameraManager.getSupportedCameras(); if (cameraArray.length <= 0) { - console.error("cameraManager.getSupportedCameras error"); - return; + console.error("cameraManager.getSupportedCameras error"); + return; } for (let index = 0; index < cameraArray.length; index++) { - console.info('cameraId : ' + cameraArray[index].cameraId); // 获取相机ID - console.info('cameraPosition : ' + cameraArray[index].cameraPosition); // 获取相机位置 - console.info('cameraType : ' + cameraArray[index].cameraType); // 获取相机类型 - console.info('connectionType : ' + cameraArray[index].connectionType); // 获取相机连接类型 + console.info('cameraId : ' + cameraArray[index].cameraId); // 获取相机ID + console.info('cameraPosition : ' + cameraArray[index].cameraPosition); // 获取相机位置 + console.info('cameraType : ' + cameraArray[index].cameraType); // 获取相机类型 + console.info('connectionType : ' + cameraArray[index].connectionType); // 获取相机连接类型 } // 获取模式列表 let cameraModeArray: Array = modeManager.getSupportedModes(cameraArray[0]); if (cameraModeArray.length <= 0) { - console.error("modeManager.getSupportedModes error"); - return; + console.error("modeManager.getSupportedModes error"); + return; } // 创建相机输入流 let cameraInput: camera.CameraInput; try { - cameraInput = cameraManager.createCameraInput(cameraArray[0]); + cameraInput = cameraManager.createCameraInput(cameraArray[0]); } catch (error) { - console.error('Failed to createCameraInput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createCameraInput errorCode = ' + err.code); } // 监听cameraInput错误信息 let cameraDevice: camera.CameraDevice = cameraArray[0]; cameraInput.on('error', cameraDevice, (error: BusinessError) => { - console.info(`Camera input error code: ${error.code}`); + console.info(`Camera input error code: ${error.code}`); }) // 打开相机 @@ -73,82 +74,89 @@ await cameraInput.open(); // 获取当前模式相机设备支持的输出流能力 let cameraOutputCap: camera.CameraOutputCapability = modeManager.getSupportedOutputCapability(cameraArray[0], cameraModeArray[0]); if (!cameraOutputCap) { - console.error("modeManager.getSupportedOutputCapability error") - return; + console.error("modeManager.getSupportedOutputCapability error"); + return; } console.info("outputCapability: " + JSON.stringify(cameraOutputCap)); let previewProfilesArray: Array = cameraOutputCap.previewProfiles; if (!previewProfilesArray) { - console.error("createOutput previewProfilesArray == null || undefined") + console.error("createOutput previewProfilesArray == null || undefined"); } let photoProfilesArray: Array = cameraOutputCap.photoProfiles; if (!photoProfilesArray) { - console.error("createOutput photoProfilesArray == null || undefined") + console.error("createOutput photoProfilesArray == null || undefined"); } // 创建预览输出流,其中参数 surfaceId 参考上文 XComponent 组件,预览流为XComponent组件提供的surface let previewOutput: camera.PreviewOutput; try { - previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId); + previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId); } catch (error) { - console.error("Failed to create the PreviewOutput instance."); + let err = error as BusinessError; + console.error("Failed to create the PreviewOutput instance. error code:" + err.code); } // 监听预览输出错误信息 previewOutput.on('error', (error: BusinessError) => { - console.info(`Preview output error code: ${error.code}`); + console.info(`Preview output error code: ${error.code}`); }) // 创建ImageReceiver对象,并设置照片参数:分辨率大小是根据前面 photoProfilesArray 获取的当前设备所支持的拍照分辨率大小去设置 -let imageReceiver: image.ImageReceiver = await image.createImageReceiver(1920, 1080, 4, 8) +let imageReceiver: image.ImageReceiver = image.createImageReceiver(1920, 1080, 4, 8); // 获取照片显示SurfaceId -let photoSurfaceId: string = await imageReceiver.getReceivingSurfaceId() +let photoSurfaceId: string = await imageReceiver.getReceivingSurfaceId(); // 创建拍照输出流 let photoOutput: camera.PhotoOutput; try { - photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0], photoSurfaceId); + photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0], photoSurfaceId); } catch (error) { - console.error('Failed to createPhotoOutput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createPhotoOutput errorCode = ' + err.code); } //创建portrait会话 let portraitSession: camera.CaptureSession; try { - portraitSession = modeManager.createCaptureSession(cameraModeArray[0]); + portraitSession = modeManager.createCaptureSession(cameraModeArray[0]); } catch (error) { - console.error('Failed to create the CaptureSession instance. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to create the CaptureSession instance. errorCode = ' + err.code); } // 监听portraitSession错误信息 portraitSession.on('error', (error: BusinessError) => { - console.info(`Capture session error code: ${error.code}`); + console.info(`Capture session error code: ${error.code}`); }); // 开始配置会话 try { - portraitSession.beginConfig(); + portraitSession.beginConfig(); } catch (error) { - console.error('Failed to beginConfig. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to beginConfig. errorCode = ' + err.code); } // 向会话中添加相机输入流 try { - portraitSession.addInput(cameraInput); + portraitSession.addInput(cameraInput); } catch (error) { - console.error('Failed to addInput. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addInput. errorCode = ' + err.code); } // 向会话中添加预览输出流 try { - portraitSession.addOutput(previewOutput); + portraitSession.addOutput(previewOutput); } catch (error) { - console.error('Failed to addOutput(previewOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(previewOutput). errorCode = ' + err.code); } // 向会话中添加拍照输出流 try { - portraitSession.addOutput(photoOutput); + portraitSession.addOutput(photoOutput); } catch (error) { - console.error('Failed to addOutput(photoOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(photoOutput). errorCode = ' + err.code); } // 提交会话配置 @@ -156,86 +164,97 @@ await portraitSession.commitConfig(); // 启动会话 await portraitSession.start().then(() => { - console.info('Promise returned to indicate the session start success.'); + console.info('Promise returned to indicate the session start success.'); }) // 获取支持的美颜类型 let beautyTypes: Array; try { - beautyTypes = portraitSession.getSupportedBeautyTypes(); + beautyTypes = portraitSession.getSupportedBeautyTypes(); } catch (error) { - console.error('Failed to get the beauty types. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the beauty types. errorCode = ' + err.code); } // 获取支持的美颜类型对应的美颜强度范围 let beautyRanges: Array; try { - beautyRanges = portraitSession.getSupportedBeautyRanges(beautyTypes[0]); + beautyRanges = portraitSession.getSupportedBeautyRanges(beautyTypes[0]); } catch (error) { - console.error('Failed to get the beauty types ranges. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the beauty types ranges. errorCode = ' + err.code); } // 设置美颜类型及对应的美颜强度 try { - portraitSession.setBeauty(beautyTypes[0], beautyRanges[0]); + portraitSession.setBeauty(beautyTypes[0], beautyRanges[0]); } catch (error) { - console.error('Failed to set the beauty type value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the beauty type value. errorCode = ' + err.code); } // 获取已经设置的美颜类型对应的美颜强度 let beautyLevel: number; try { - beautyLevel = portraitSession.getBeauty(beautyTypes[0]); + beautyLevel = portraitSession.getBeauty(beautyTypes[0]); } catch (error) { - console.error('Failed to get the beauty type value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the beauty type value. errorCode = ' + err.code); } // 获取支持的滤镜类型 let filterTypes: Array; try { - filterTypes = portraitSession.getSupportedFilters(); + filterTypes = portraitSession.getSupportedFilters(); } catch (error) { - console.error('Failed to get the filter types. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the filter types. errorCode = ' + err.code); } // 设置滤镜类型 try { - portraitSession.setFilter(filterTypes[0]); + portraitSession.setFilter(filterTypes[0]); } catch (error) { - console.error('Failed to set the filter type value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the filter type value. errorCode = ' + err.code); } // 获取已经设置的滤镜类型 let filter: number; try { - filter = portraitSession.getFilter(); + filter = portraitSession.getFilter(); } catch (error) { - console.error('Failed to get the filter type value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the filter type value. errorCode = ' + err.code); } // 获取支持的虚化类型 let portraitTypes: Array; try { - portraitTypes = portraitSession.getSupportedPortraitEffects(); + portraitTypes = portraitSession.getSupportedPortraitEffects(); } catch (error) { - console.error('Failed to get the portrait effects types. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the portrait effects types. errorCode = ' + err.code); } // 设置虚化类型 try { - portraitSession.setPortraitEffect(portraitTypes[0]); + portraitSession.setPortraitEffect(portraitTypes[0]); } catch (error) { - console.error('Failed to set the portrait effects value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the portrait effects value. errorCode = ' + err.code); } // 获取已经设置的虚化类型 let effect: camera.PortraitEffect; try { - effect = portraitSession.getPortraitEffect(); + effect = portraitSession.getPortraitEffect(); } catch (error) { - console.error('Failed to get the portrait effects value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the portrait effects value. errorCode = ' + err.code); } +let captureSettings: camera.PhotoCaptureSetting; // 使用当前拍照设置进行拍照 -photoOutput.capture(settings, async (err: BusinessError) => { - if (err) { - console.error('Failed to capture the photo ${err.message}'); - return; - } - console.info('Callback invoked to indicate the photo capture request success.'); +photoOutput.capture(captureSettings, async (err: BusinessError) => { + if (err) { + console.error('Failed to capture the photo ${err.message}'); + return; + } + console.info('Callback invoked to indicate the photo capture request success.'); }); // 停止当前会话 portraitSession.stop(); diff --git a/zh-cn/application-dev/media/camera-performance-improvement.md b/zh-cn/application-dev/media/camera-performance-improvement.md index ccf0fa46bba91b31381c62e2dad8e708cd391d09..7f1bc46078ee1090644f88d16db6a5425f8af220 100644 --- a/zh-cn/application-dev/media/camera-performance-improvement.md +++ b/zh-cn/application-dev/media/camera-performance-improvement.md @@ -31,19 +31,21 @@ ![](figures/deferred-surface-sequence-diagram.png) +[各类Context的获取方式](../application-models/application-context-stage.md) + ```js import camera from '@ohos.multimedia.camera'; -function async preview(context: Context, cameraInfo: camera.Device, previewProfile: camera.Profile, photoProfile: camera.Profile, surfaceId: string): Promise { +async function Preview(context: Context, cameraInfo: camera.CameraDevice, previewProfile: camera.Profile, photoProfile: camera.Profile, surfaceId: string): Promise { const cameraManager: camera.CameraManager = camera.getCameraManager(context); - const cameraInput camera.CameraInput = await cameraManager.createCameraInput(cameraInfo); + const cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameraInfo); const previewOutput: camera.PreviewOutput = await cameraManager.createDeferredPreviewOutput(previewProfile); - const photoOutput: camera.PhotoOutput = await cameraManager.createPhotoOutput(photoProfile); - const session: camera.CaptureSession = await mCameraManager.createCaptureSession(); - await session.beginConfig(); - await session.addInput(cameraInput); - await session.addOutput(previewOutput); - await session.addOutput(photoOutput); + const photoOutput: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, surfaceId); + const session: camera.CaptureSession = cameraManager.createCaptureSession(); + session.beginConfig(); + session.addInput(cameraInput); + session.addOutput(previewOutput); + session.addOutput(photoOutput); await session.commitConfig(); await session.start(); await previewOutput.addDeferredSurface(surfaceId); @@ -79,30 +81,31 @@ function async preview(context: Context, cameraInfo: camera.Device, previewProfi ![](figures/quick-thumbnail-sequence-diagram.png) +[各类Context的获取方式](../application-models/application-context-stage.md) ```js import camera from '@ohos.multimedia.camera'; -let context: Context = getContext(this); // [各类Context的获取方式](../application-models/application-context-stage.md) +let context: Context = getContext(this); let cameraManager: camera.CameraManager = camera.getCameraManager(context); let cameras: Array = cameraManager.getSupportedCameras(); // 创建CaptureSession实例 -let captureSession: camera.CaptureSession = await cameraManager.createCaptureSession(); +let captureSession: camera.CaptureSession = cameraManager.createCaptureSession(); // 开始配置会话 -await captureSession.beginConfig(); +captureSession.beginConfig(); // 把CameraInput加入到会话 -let cameraInput: camera.CameraInput = await cameraManager.createCameraInput(cameras[0]); -await cameraInput.open(); -await captureSession.addInput(cameraInput); +let cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameras[0]); +cameraInput.open(); +captureSession.addInput(cameraInput); // 把PhotoOutPut加入到会话 -let photoOutPut: camera.PhotoOutput = await cameraManager.createPhotoOutput(photoProfile, surfaceId); -await captureSession.addOutput(photoOutPut); +let photoOutPut: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, surfaceId); +captureSession.addOutput(photoOutPut); let isSupported: boolean = photoOutPut.isQuickThumbnailSupported(); if (isSupported) { // 使能快速缩略图 photoOutPut.enableQuickThumbnail(true); photoOutPut.on('quickThumbnail', (err: BusinessError, pixelmap: image.PixelMap) => { if (err || pixelmap === undefined) { - console.error('photoOutPut on thumbnail failed'); - return; + console.error('photoOutPut on thumbnail failed'); + return; } // 显示或保存pixelmap showOrSavePicture(pixelmap); @@ -135,16 +138,19 @@ if (isSupported) { ![](figures/prelaunch-sequence-diagram.png) +[各类Context的获取方式](../application-models/application-context-stage.md) + - **桌面应用** ```js import camera from '@ohos.multimedia.camera'; - - let cameraManager: camera.CameraManager = camera.getCameraManager(globalThis.abilityContext); + let context: Context = getContext(this); + let cameraManager: camera.CameraManager = camera.getCameraManager(context); try { cameraManager.prelaunch(); } catch (error) { - console.error(`catch error: Code: ${error.code}, message: ${error.message}`); + let err = error as BusinessError; + console.error(`catch error: Code: ${err.code}, message: ${err.message}`); } ``` @@ -156,14 +162,15 @@ if (isSupported) { ```js import camera from '@ohos.multimedia.camera'; - - cameraManager: camera.CameraManager = camera.getCameraManager(globalThis.abilityContext); + let context: Context = getContext(this); + let cameraManager: camera.CameraManager = camera.getCameraManager(context); let cameras: Array = cameraManager.getSupportedCameras(); if(cameraManager.isPrelaunchSupported(cameras[0])) { try { cameraManager.setPrelaunchConfig({cameraDevice: cameras[0]}); } catch (error) { - console.error(`catch error: Code: ${error.code}, message: ${error.message}`); + let err = error as BusinessError; + console.error(`catch error: Code: ${err.code}, message: ${err.message}`); } } ``` diff --git a/zh-cn/application-dev/media/camera-preview.md b/zh-cn/application-dev/media/camera-preview.md index 26a1b07371e88117e5d00337e9265f5095122765..ccb84119acd25ee43ea56160ea1fc970d69a74d7 100644 --- a/zh-cn/application-dev/media/camera-preview.md +++ b/zh-cn/application-dev/media/camera-preview.md @@ -7,11 +7,9 @@ 详细的API说明请参考[Camera API参考](../reference/apis/js-apis-camera.md)。 1. 创建Surface。 - + XComponent组件为预览流提供的Surface,而XComponent的能力由UI提供,相关介绍可参考[XComponent组件参考](../reference/arkui-ts/ts-basic-components-xcomponent.md)。 - **注**:预览流与录像输出流的分辨率的宽高比要保持一致,如示例代码中宽高比为1920:1080 = 16:9,则需要预览流中的分辨率的宽高比也为16:9,如分辨率选择640:360,或960:540,或1920:1080,以此类推 - ```ts // 创建XComponentController mXComponentController: XComponentController = new XComponentController; @@ -26,7 +24,6 @@ }) .onLoad(() => { // 设置Surface宽高(1920*1080),预览尺寸设置参考前面 previewProfilesArray 获取的当前设备所支持的预览分辨率大小去设置 - // 预览流与录像输出流的分辨率的宽高比要保持一致 this.mXComponentController.setXComponentSurfaceSize({surfaceWidth:1920,surfaceHeight:1080}); // 获取Surface ID globalThis.surfaceId = this.mXComponentController.getXComponentSurfaceId(); @@ -36,22 +33,22 @@ } } ``` - + 2. 通过CameraOutputCapability类中的previewProfiles()方法获取当前设备支持的预览能力,返回previewProfilesArray数组 。通过createPreviewOutput()方法创建预览输出流,其中,createPreviewOutput()方法中的两个参数分别是previewProfilesArray数组中的第一项和步骤一中获取的surfaceId。 - + ```ts let previewProfilesArray: Array = cameraOutputCapability.previewProfiles; let previewOutput: camera.PreviewOutput; try { previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId); - } - catch (error) { - console.error("Failed to create the PreviewOutput instance." + error); + } catch (error) { + let err = error as BusinessError; + console.error("Failed to create the PreviewOutput instance. error code: " + err.code); } ``` 3. 使能。通过start()方法输出预览流,接口调用失败会返回相应错误码,错误码类型参见[CameraErrorCode](../reference/apis/js-apis-camera.md#cameraerrorcode)。 - + ```ts previewOutput.start().then(() => { console.info('Callback returned with previewOutput started.'); @@ -66,7 +63,7 @@ 在相机应用开发过程中,可以随时监听预览输出流状态,包括预览流启动、预览流结束、预览流输出错误。 - 通过注册固定的frameStart回调函数获取监听预览启动结果,previewOutput创建成功时即可监听,预览第一次曝光时触发,有该事件返回结果则认为预览流已启动。 - + ```ts previewOutput.on('frameStart', () => { console.info('Preview frame started'); @@ -74,7 +71,7 @@ ``` - 通过注册固定的frameEnd回调函数获取监听预览结束结果,previewOutput创建成功时即可监听,预览完成最后一帧时触发,有该事件返回结果则认为预览流已结束。 - + ```ts previewOutput.on('frameEnd', () => { console.info('Preview frame ended'); @@ -82,7 +79,7 @@ ``` - 通过注册固定的error回调函数获取监听预览输出错误结果,callback返回预览输出接口使用错误时对应的错误码,错误码类型参见[CameraErrorCode](../reference/apis/js-apis-camera.md#cameraerrorcode)。 - + ```ts previewOutput.on('error', (previewOutputError: BusinessError) => { console.info(`Preview output error code: ${previewOutputError.code}`); diff --git a/zh-cn/application-dev/media/camera-recording-case.md b/zh-cn/application-dev/media/camera-recording-case.md index ae37b4db5df4f2f69272eb217b497ee410e2469c..5b9d965fc2ab99a7d00f868806c5863203e5c44e 100644 --- a/zh-cn/application-dev/media/camera-recording-case.md +++ b/zh-cn/application-dev/media/camera-recording-case.md @@ -8,18 +8,18 @@ ## 完整示例 - +[各类Context的获取方式](../application-models/application-context-stage.md) ```ts import camera from '@ohos.multimedia.camera'; import media from '@ohos.multimedia.media'; // 创建CameraManager对象 -let context: Context = getContext(this); // [各类Context的获取方式](../application-models/application-context-stage.md) +let context: Context = getContext(this); let cameraManager: camera.CameraManager = camera.getCameraManager(context); if (!cameraManager) { console.error("camera.getCameraManager error"); return; -} +} // 监听相机状态变化 cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.CameraStatusInfo) => { @@ -27,6 +27,12 @@ cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.C console.log(`status: ${cameraStatusInfo.status}`); }); +// 获取相机列表 +let cameraArray: Array = cameraManager.getSupportedCameras(); +if (cameraArray.length <= 0) { + console.error("cameraManager.getSupportedCameras error") + return; +} // 获取相机设备支持的输出流能力 let cameraOutputCap: camera.CameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraArray[0]); if (!cameraOutputCap) { @@ -38,17 +44,17 @@ console.log("outputCapability: " + JSON.stringify(cameraOutputCap)); let previewProfilesArray: Array = cameraOutputCap.previewProfiles; if (!previewProfilesArray) { console.error("createOutput previewProfilesArray == null || undefined"); -} +} let photoProfilesArray: Array = cameraOutputCap.photoProfiles; if (!photoProfilesArray) { console.error("createOutput photoProfilesArray == null || undefined"); -} +} let videoProfilesArray: Array = cameraOutputCap.videoProfiles; if (!videoProfilesArray) { console.error("createOutput videoProfilesArray == null || undefined"); -} +} let metadataObjectTypesArray: Array = cameraOutputCap.supportedMetadataObjectTypes; if (!metadataObjectTypesArray) { @@ -68,7 +74,7 @@ let AVRecorderProfile = { videoFrameHeight : 480, videoFrameRate : 30 }; -let AVRecorderConfig = { +let aVRecorderConfig = { audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC, videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV, profile : AVRecorderProfile, @@ -87,7 +93,7 @@ media.createAVRecorder((error: BusinessError, recorder: media.AVRecorder) => { } }); -avRecorder.prepare(AVRecorderConfig: media.AVRecorderConfig, (err: BusinessError) => { +avRecorder.prepare(aVRecorderConfig, (err: BusinessError) => { if (err == null) { console.log('prepare success'); } else { @@ -138,13 +144,6 @@ try { console.error('Failed to beginConfig. errorCode = ' + error.code); } -// 获取相机列表 -let cameraArray: Array = cameraManager.getSupportedCameras(); -if (cameraArray.length <= 0) { - console.error("cameraManager.getSupportedCameras error") - return; -} - // 创建相机输入流 let cameraInput: camera.CameraInput; try { diff --git a/zh-cn/application-dev/media/camera-recording.md b/zh-cn/application-dev/media/camera-recording.md index ecce6b50e34a4a1cf6396ffdbd424068a3b76e1c..5847ea529c8f59b3b8c1294c187c0a0fd0c6beed 100644 --- a/zh-cn/application-dev/media/camera-recording.md +++ b/zh-cn/application-dev/media/camera-recording.md @@ -7,7 +7,7 @@ 详细的API说明请参考[Camera API参考](../reference/apis/js-apis-camera.md)。 1. 导入media模块。创建拍照输出流的SurfaceId以及拍照输出的数据,都需要用到系统提供的[media接口](../reference/apis/js-apis-media.md)能力,导入media接口的方法如下。 - + ```ts import media from '@ohos.multimedia.media'; ``` @@ -15,7 +15,7 @@ 2. 创建Surface。 系统提供的media接口可以创建一个录像AVRecorder实例,通过该实例的getInputSurface方法获取SurfaceId,与录像输出流做关联,处理录像输出流输出的数据。 - + ```ts let avRecorder: media.AVRecorder; media.createAVRecorder((error: BusinessError, recorder: media.AVRecorder) => { @@ -26,8 +26,9 @@ console.info(`createAVRecorder fail, error:${error}`); } }); - // AVRecorderConfig可参考下一章节 - avRecorder.prepare(AVRecorderConfig: media.AVRecorderConfig, (err: BusinessError) => { + // aVRecorderConfig可参考下一章节 + let aVRecorderConfig: media.AVRecorderConfig; + avRecorder.prepare(aVRecorderConfig, (err: BusinessError) => { if (err == null) { console.log('prepare success'); } else { @@ -35,28 +36,26 @@ } }); - let videoSurfaceId: string = null; + let videoSurfaceId: string = null; avRecorder.getInputSurface().then((surfaceId: string) => { console.info('getInputSurface success'); - videoSurfaceId = surfaceId; - }).catch((err) => { - console.info('getInputSurface failed and catch error is ' + err.message); + videoSurfaceId = surfaceId; + }).catch((err: BusinessError) => { + console.info('getInputSurface failed and catch error is ' + err.message); }); ``` 3. 创建录像输出流。 - + 通过CameraOutputCapability类中的videoProfiles,可获取当前设备支持的录像输出流。然后,定义创建录像的参数,通过createVideoOutput方法创建录像输出流。 - - **注**:预览流与录像输出流的分辨率的宽高比要保持一致,如示例代码中宽高比为640:480 = 4:3,则需要预览流中的分辨率的宽高比也为4:3,如分辨率选择640:480,或960:720,或1440:1080,以此类推 - + ```ts let videoProfilesArray: Array = cameraOutputCapability.videoProfiles; if (!videoProfilesArray) { console.error("createOutput videoProfilesArray == null || undefined"); } - // 创建视频录制的参数,预览流与录像输出流的分辨率的宽(videoFrameWidth)高(videoFrameHeight)比要保持一致 + // 创建视频录制的参数 let videoConfig = { videoSourceType: media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV, profile: { @@ -87,10 +86,11 @@ try { videoOutput = cameraManager.createVideoOutput(videoProfilesArray[0], videoSurfaceId); } catch (error) { - console.error('Failed to create the videoOutput instance. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to create the videoOutput instance. errorCode = ' + err.code); } ``` - + 4. 开始录像。 先通过videoOutput的start方法启动录像输出流,再通过avRecorder的start方法开始录像。 @@ -110,9 +110,9 @@ ``` 5. 停止录像。 - + 先通过avRecorder的stop方法停止录像,再通过videoOutput的stop方法停止录像输出流。 - + ```ts videoRecorder.stop().then(() => { console.info('stop success'); @@ -133,7 +133,7 @@ 在相机应用开发过程中,可以随时监听录像输出流状态,包括录像开始、录像结束、录像流输出的错误。 - 通过注册固定的frameStart回调函数获取监听录像开始结果,videoOutput创建成功时即可监听,录像第一次曝光时触发,有该事件返回结果则认为录像开始。 - + ```ts videoOutput.on('frameStart', () => { console.info('Video frame started'); @@ -141,7 +141,7 @@ ``` - 通过注册固定的frameEnd回调函数获取监听录像结束结果,videoOutput创建成功时即可监听,录像完成最后一帧时触发,有该事件返回结果则认为录像流已结束。 - + ```ts videoOutput.on('frameEnd', () => { console.info('Video frame ended'); @@ -149,7 +149,7 @@ ``` - 通过注册固定的error回调函数获取监听录像输出错误结果,callback返回预览输出接口使用错误时对应的错误码,错误码类型参见[CameraErrorCode](../reference/apis/js-apis-camera.md#cameraerrorcode)。 - + ```ts videoOutput.on('error', (error: BusinessError) => { console.info(`Video output error code: ${error.code}`); diff --git a/zh-cn/application-dev/media/camera-session-management.md b/zh-cn/application-dev/media/camera-session-management.md index 1bddd3c805b880a9dc7ad56194b2c8739d955ab2..1d40506b33a4035ea9344f5fd51478815097cf05 100644 --- a/zh-cn/application-dev/media/camera-session-management.md +++ b/zh-cn/application-dev/media/camera-session-management.md @@ -22,7 +22,8 @@ try { captureSession = cameraManager.createCaptureSession(); } catch (error) { - console.error('Failed to create the CaptureSession instance. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to create the CaptureSession instance. errorCode = ' + err.code); } ``` @@ -32,7 +33,8 @@ try { captureSession.beginConfig(); } catch (error) { - console.error('Failed to beginConfig. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to beginConfig. errorCode = ' + err.code); } ``` @@ -44,17 +46,20 @@ try { captureSession.addInput(cameraInput); } catch (error) { - console.error('Failed to addInput. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addInput. errorCode = ' + err.code); } try { captureSession.addOutput(previewOutput); } catch (error) { - console.error('Failed to addOutput(previewOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(previewOutput). errorCode = ' + err.code); } try { captureSession.addOutput(photoOutput); } catch (error) { - console.error('Failed to addOutput(photoOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(photoOutput). errorCode = ' + err.code); } await captureSession.commitConfig(); await captureSession.start().then(() => { @@ -69,18 +74,21 @@ try { captureSession.beginConfig(); } catch (error) { - console.error('Failed to beginConfig. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to beginConfig. errorCode = ' + err.code); } // 从会话中移除拍照输出流 try { captureSession.removeOutput(photoOutput); } catch (error) { - console.error('Failed to removeOutput(photoOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to removeOutput(photoOutput). errorCode = ' + err.code); } // 向会话中添加视频输出流 try { captureSession.addOutput(videoOutput); } catch (error) { - console.error('Failed to addOutput(videoOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(videoOutput). errorCode = ' + err.code); } ``` diff --git a/zh-cn/application-dev/media/camera-shooting-case.md b/zh-cn/application-dev/media/camera-shooting-case.md index 103921ac5fcd68f56c64d41f7b06046445dfa975..1f1b9081923a9e1b79532dd278a38f152206ace7 100644 --- a/zh-cn/application-dev/media/camera-shooting-case.md +++ b/zh-cn/application-dev/media/camera-shooting-case.md @@ -7,14 +7,14 @@ ![Photographing Development Process](figures/photographing-development-process.png) ## 完整示例 - +[各类Context的获取方式](../application-models/application-context-stage.md) ```ts import camera from '@ohos.multimedia.camera'; import image from '@ohos.multimedia.image'; import media from '@ohos.multimedia.media'; // 创建CameraManager对象 -let context: Context = getContext(this); // [各类Context的获取方式](../application-models/application-context-stage.md) +let context: Context = getContext(this); let cameraManager: camera.CameraManager = camera.getCameraManager(context); if (!cameraManager) { console.error("camera.getCameraManager error"); @@ -45,7 +45,8 @@ let cameraInput: camera.CameraInput; try { cameraInput = cameraManager.createCameraInput(cameraArray[0]); } catch (error) { - console.error('Failed to createCameraInput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createCameraInput errorCode = ' + err.code); } // 监听cameraInput错误信息 @@ -80,7 +81,8 @@ let previewOutput: camera.PreviewOutput; try { previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId); } catch (error) { - console.error("Failed to create the PreviewOutput instance."); + let err = error as BusinessError; + console.error(`Failed to create the PreviewOutput instance. error code: ${err.code}`); } // 监听预览输出错误信息 @@ -89,7 +91,7 @@ previewOutput.on('error', (error: BusinessError) => { }); // 创建ImageReceiver对象,并设置照片参数:分辨率大小是根据前面 photoProfilesArray 获取的当前设备所支持的拍照分辨率大小去设置 -let imageReceiver: image.ImageReceiver = await image.createImageReceiver(1920, 1080, 4, 8); +let imageReceiver: image.ImageReceiver = image.createImageReceiver(1920, 1080, 4, 8); // 获取照片显示SurfaceId let photoSurfaceId: string = await imageReceiver.getReceivingSurfaceId(); // 创建拍照输出流 @@ -97,14 +99,16 @@ let photoOutput: camera.PhotoOutput; try { photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0], photoSurfaceId); } catch (error) { - console.error('Failed to createPhotoOutput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createPhotoOutput errorCode = ' + err.code); } //创建会话 let captureSession: camera.CaptureSession; try { captureSession = cameraManager.createCaptureSession(); } catch (error) { - console.error('Failed to create the CaptureSession instance. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to create the CaptureSession instance. errorCode = ' + err.code); } // 监听session错误信息 @@ -116,28 +120,32 @@ captureSession.on('error', (error: BusinessError) => { try { captureSession.beginConfig(); } catch (error) { - console.error('Failed to beginConfig. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to beginConfig. errorCode = ' + err.code); } // 向会话中添加相机输入流 try { captureSession.addInput(cameraInput); } catch (error) { - console.error('Failed to addInput. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addInput. errorCode = ' + err.code); } // 向会话中添加预览输出流 try { captureSession.addOutput(previewOutput); } catch (error) { - console.error('Failed to addOutput(previewOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(previewOutput). errorCode = ' + err.code); } // 向会话中添加拍照输出流 try { captureSession.addOutput(photoOutput); } catch (error) { - console.error('Failed to addOutput(photoOutput). errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to addOutput(photoOutput). errorCode = ' + err.code); } // 提交会话配置 @@ -152,7 +160,8 @@ let flashStatus: boolean; try { flashStatus = captureSession.hasFlash(); } catch (error) { - console.error('Failed to hasFlash. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to hasFlash. errorCode = ' + err.code); } console.info('Promise returned with the flash light support status:' + flashStatus); @@ -163,14 +172,16 @@ if (flashStatus) { let status: boolean = captureSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO); flashModeStatus = status; } catch (error) { - console.error('Failed to check whether the flash mode is supported. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to check whether the flash mode is supported. errorCode = ' + err.code); } if(flashModeStatus) { // 设置自动闪光灯模式 try { captureSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO); } catch (error) { - console.error('Failed to set the flash mode. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the flash mode. errorCode = ' + err.code); } } } @@ -181,7 +192,8 @@ try { let status: boolean = captureSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO); focusModeStatus = status; } catch (error) { - console.error('Failed to check whether the focus mode is supported. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to check whether the focus mode is supported. errorCode = ' + err.code); } if (focusModeStatus) { @@ -189,23 +201,26 @@ if (focusModeStatus) { try { captureSession.setFocusMode(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO); } catch (error) { - console.error('Failed to set the focus mode. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the focus mode. errorCode = ' + err.code); } } // 获取相机支持的可变焦距比范围 -let zoomRatioRange; +let zoomRatioRange: Array; try { - zoomRatioRange: Array = captureSession.getZoomRatioRange(); + zoomRatioRange = captureSession.getZoomRatioRange(); } catch (error) { - console.error('Failed to get the zoom ratio range. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the zoom ratio range. errorCode = ' + err.code); } // 设置可变焦距比 try { captureSession.setZoomRatio(zoomRatioRange[0]); } catch (error) { - console.error('Failed to set the zoom ratio value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the zoom ratio value. errorCode = ' + err.code); } let settings: camera.PhotoCaptureSetting = { quality: camera.QualityLevel.QUALITY_LEVEL_HIGH, // 设置图片质量高 diff --git a/zh-cn/application-dev/media/camera-shooting.md b/zh-cn/application-dev/media/camera-shooting.md index c63a4389db81f4a7e5f077dd59e41146ffaab799..210264a6f3c8f91af540a86d5394eabfd0b9e908 100644 --- a/zh-cn/application-dev/media/camera-shooting.md +++ b/zh-cn/application-dev/media/camera-shooting.md @@ -17,12 +17,12 @@ 通过image的createImageReceiver方法创建ImageReceiver实例,再通过实例的getReceivingSurfaceId方法获取SurfaceId,与拍照输出流相关联,获取拍照输出流的数据。 ```ts - function getImageReceiverSurfaceId() { + async function getImageReceiverSurfaceId() { let receiver: image.ImageReceiver = image.createImageReceiver(640, 480, 4, 8); console.info('before ImageReceiver check'); if (receiver !== undefined) { console.info('ImageReceiver is ok'); - let photoSurfaceId: string = receiver.getReceivingSurfaceId(); + let photoSurfaceId: string = await receiver.getReceivingSurfaceId(); console.info('ImageReceived id: ' + JSON.stringify(photoSurfaceId)); } else { console.info('ImageReceiver is not ok'); @@ -43,7 +43,8 @@ try { photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0], photoSurfaceId); } catch (error) { - console.error('Failed to createPhotoOutput errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to createPhotoOutput errorCode = ' + err.code); } ``` @@ -57,7 +58,8 @@ try { flashStatus = captureSession.hasFlash(); } catch (error) { - console.error('Failed to hasFlash. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to hasFlash. errorCode = ' + err.code); } console.info('Promise returned with the flash light support status:' + flashStatus); if (flashStatus) { @@ -67,14 +69,16 @@ let status: boolean = captureSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO); flashModeStatus = status; } catch (error) { - console.error('Failed to check whether the flash mode is supported. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to check whether the flash mode is supported. errorCode = ' + err.code); } if(flashModeStatus) { // 设置自动闪光灯模式 try { captureSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO); } catch (error) { - console.error('Failed to set the flash mode. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the flash mode. errorCode = ' + err.code); } } } @@ -84,14 +88,16 @@ let status: boolean = captureSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO); focusModeStatus = status; } catch (error) { - console.error('Failed to check whether the focus mode is supported. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to check whether the focus mode is supported. errorCode = ' + err.code); } if (focusModeStatus) { // 设置连续自动变焦模式 try { captureSession.setFocusMode(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO); - } catch (error) { - console.error('Failed to set the focus mode. errorCode = ' + error.code); + } catch (error) { + let err = error as BusinessError; + console.error('Failed to set the focus mode. errorCode = ' + err.code); } } // 获取相机支持的可变焦距比范围 @@ -99,13 +105,15 @@ try { zoomRatioRange = captureSession.getZoomRatioRange(); } catch (error) { - console.error('Failed to get the zoom ratio range. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to get the zoom ratio range. errorCode = ' + err.code); } // 设置可变焦距比 try { captureSession.setZoomRatio(zoomRatioRange[0]); } catch (error) { - console.error('Failed to set the zoom ratio value. errorCode = ' + error.code); + let err = error as BusinessError; + console.error('Failed to set the zoom ratio value. errorCode = ' + err.code); } ``` diff --git a/zh-cn/application-dev/quick-start/start-overview.md b/zh-cn/application-dev/quick-start/start-overview.md index 94fdb74b5f722c6f40a5d6dccb58b4ee8016e19c..e8181d9a38a1fa75e4992954ae59907658a317b3 100644 --- a/zh-cn/application-dev/quick-start/start-overview.md +++ b/zh-cn/application-dev/quick-start/start-overview.md @@ -35,7 +35,7 @@ OpenHarmony提供了一套UI开发框架,即方舟开发框架(ArkUI框架 FA模型和Stage模型的整体架构和设计思想等更多区别,请见[应用模型解读](../application-models/application-model-description.md)。 -快速入门提供了一个含有两个页面的开发实例,并使用了不同的开发语言或不同的应用模型进行开发,以便开发者理解以上基本概念及应用开发流程。 +快速入门提供了一个含有两个页面的开发实例,并基于Stage模型构建第一个ArkTS应用,以便开发者理解以上基本概念及应用开发流程。 ## 工具准备 diff --git a/zh-cn/application-dev/quick-start/typescript-to-arkts-migration-guide.md b/zh-cn/application-dev/quick-start/typescript-to-arkts-migration-guide.md index 936d48a0e7aab7592af9b28a32c8acbaebd5f009..9b3f5c465425e460dbc17728550509929aa1ba5e 100644 --- a/zh-cn/application-dev/quick-start/typescript-to-arkts-migration-guide.md +++ b/zh-cn/application-dev/quick-start/typescript-to-arkts-migration-guide.md @@ -837,6 +837,7 @@ type N = number **级别:错误** ArkTS不支持通过索引访问对象的字段。改用点操作符。 +ArkTS支持通过索引访问`TypedArray`(例如`Int32Array`)中的元素。 **TypeScript** @@ -852,6 +853,9 @@ let x = p["x"] class Point {x: number = 0; y: number = 0} let p: Point = {x: 1, y: 2} let x = p.x + +let arr = new Int32Array(1) +console.log(arr[0]) ``` ### 不支持structural identity @@ -1305,7 +1309,7 @@ class Point { y: number = 0 // 在字面量初始化之前,使用constructor()创建一个有效对象。 - // 由于Point没有其它构造函数,编译器将自动添加一个默认构造函数。 + // 由于没有为Point定义构造函数,编译器将自动添加一个默认构造函数。 } function id_x_y(o: Point): Point { @@ -1392,32 +1396,6 @@ let a2: C[] = [{n: 1, s: "1"}, {n: 2, s : "2"}] // a2的类型为“C[]” * 对象字面量必须对应某些显式声明的类或接口 * 对象字面量不能用于类型声明 -### 显式标注Lambda函数的参数类型 - -**规则:**`arkts-explicit-param-types-in-lambdas` - -**级别:错误** - -当前ArkTS要求显式标注lambda函数的参数的类型。 - -**TypeScript** - -```typescript -// 只有在开启noImplicitAny选项时会产生编译时错误 -let f = (s /* type any is assumed */) => { - console.log(s) -} -``` - -**ArkTS** - -```typescript -// 显式标注Lambda函数的参数类型 -let f = (s: string) => { - console.log(s) -} -``` - ### 使用箭头函数而非函数表达式 **规则:**`arkts-no-func-expressions` @@ -1814,9 +1792,9 @@ let f = "string" + true // "stringtrue" let g = (new Object()) + "string" // "[object Object]string" -let i = true + true // JS: 2, TS: 编译时错误 -let j = true + 2 // JS: 3, TS: 编译时错误 -let k = E.E1 + true // JS: 1, TS: 编译时错误 +let i = true + true // 编译时错误 +let j = true + 2 // 编译时错误 +let k = E.E1 + true // 编译时错误 ``` **ArkTS** @@ -1835,7 +1813,7 @@ let f = "string" + true // "stringtrue" let g = (new Object()).toString() + "string" let i = true + true // 编译时错误 -let j = true + 2 // 编译时错误 +let j = true + 2 // 编译时错误 let k = E.E1 + true // 编译时错误 ``` @@ -2142,7 +2120,7 @@ ArkTS不支持`Symbol`API、`Symbol.iterator`和最终可迭代的接口。请 **级别:错误** -ArkTS支持通过`for .. of`迭代数组和字符串,但不支持迭代对象。 +ArkTS支持通过`for .. of`迭代数组、字符串和`TypedArray`(例如`Int32Array`),但不支持迭代对象。 **TypeScript** @@ -2232,7 +2210,7 @@ console.log("Area: ", Math.PI * r * r) **级别:错误** -在ArkTS中,`case`语句仅支持编译期值。若值无法在编译期确定,请使用`if`语句。 +在ArkTS中,`case`语句仅支持编译期值,支持`const`常量和`class`的`static readonly`属性。若值无法在编译期确定,请使用`if`语句。 **TypeScript** @@ -2689,7 +2667,7 @@ function main(): void { **级别:错误** -展开运算符唯一支持的场景是函数剩余参数为数组类型。 +展开运算符唯一支持的场景是函数剩余参数为数组类型,包括`TypedArray`(例如`Int32Array`)。 **TypeScript** @@ -3273,7 +3251,7 @@ import "path/to/module" **ArkTS** ```typescript -import * from "path/to/module" +import * as ns from "path/to/module" ``` ### 不支持`import default as ...` @@ -3326,7 +3304,7 @@ import * as m from "mod" **级别:错误** -ArkTS支持大多数场景下的重导出,比如命名导出和重命名导出,重导出import的。不支持`export * as ...`。 +ArkTS支持大多数场景下的重导出,例如命名重导出和重命名重导出。不支持`export * as ...`。 **TypeScript** @@ -3512,7 +3490,7 @@ declare namespace N { function foo(x: number): number } -import * from "module" +import * as m from "module" console.log("N.foo called: ", N.foo(42)) ``` @@ -3622,32 +3600,6 @@ let ce = new CustomError() * 不支持在原型上赋值 -### 不支持动态导入 - -**规则:**`arkts-no-runtime-import` - -**级别:错误** - -由于在ArkTS中,导入是编译时而非运行时特性,因此,ArkTS不支持动态导入,如`await import...`。改用静态`import`语法。 - -**TypeScript** - -```typescript -const zipUtil = await import("utils/create-zip-file") -``` - -**ArkTS** - -```typescript -import { zipUtil } from "utils/create-zip-file" -``` - -**相关约束** - -* 不支持在模块名中使用通配符 -* 不支持通用模块定义(UMD) -* 不支持导入断言 - ### 不支持确定赋值断言 **规则:**`arkts-no-definite-assignment` @@ -3796,7 +3748,7 @@ M.abc = 200 **级别:错误** -当前ArkTS不支持从TypeScript扩展到标准库的utility类型(例如`Omit`、`Pick`等)。支持`Partial`和`Record`。 +ArkTS仅支持`Partial`和`Record`,不支持TypeScript中其他的`Utility Types`。 对于*Record*类型,表达式*rec[index]*的类型是*V | undefined*。 对于`Record`类型,键-值中的值的类型必须是可选类型或者包含`undefined`的联合类型。 @@ -4079,9 +4031,7 @@ ArkTS不允许使用TypeScript或JavaScript标准库中的某些接口。大部 全局对象的属性和方法:`eval`、 `Infinity`、`NaN`、`isFinite`、`isNaN`、`parseFloat`、`parseInt`、 -`encodeURI`、`encodeURIComponent`、`Encode`、 -`decodeURI`、`decodeURIComponent`、`Decode`、 -`escape`、`unescape`、`ParseHexOctet` +`Encode`、`Decode`、`ParseHexOctet` `Object`:`__proto__`、`__defineGetter__`、`__defineSetter__`、 `__lookupGetter__`、`__lookupSetter__`、`assign`、`create`、 @@ -4267,3 +4217,52 @@ function classDecorator(x: number, y: number): void { class BugReport { } ``` + +### `class`不能被用作对象 + +**规则:**`arkts-no-classes-as-obj` + +**级别:错误** + +在ArkTS中,`class`声明的是一个新的类型,不是一个值。因此,不支持将`class`用作对象(例如将`class`赋值给一个对象)。 + +**TypeScript** + +```typescript +class C { + s: string = "" + n: number = 0 +} + +let c = C +``` + +### 不支持在`import`语句前使用其他语句 + +**规则:**`arkts-no-misplaced-imports` + +**级别:错误** + +在ArkTS中,除动态`import`语句外,所有`import`语句需要放在所有其他语句之前。 + +**TypeScript** + +```typescript +class C { + s: string = "" + n: number = 0 +} + +import foo from "module1" +``` + +**ArkTS** + +```typescript +import foo from "module1" + +class C { + s: string = "" + n: number = 0 +} +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md index 77de24d3196af0cdfb6e0a2b1b07636c701d8c71..eba5df820854b05f6552629b7cb64f10f38888d6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md @@ -66,12 +66,17 @@ import fs from '@ohos.file.fs'; try { let fd = fs.openSync('/path/to/form.png'); - let obj = { - 'temperature': '21°', - 'formImages': { 'image': fd } - }; - formBindingData.createFormBindingData(obj); + + let createFormBindingDataParam = new Map(); + let formImagesParam = new Map(); + formImagesParam.set('image', fd); + createFormBindingDataParam.set("name", '21°'); + createFormBindingDataParam.set('formImages', formImagesParam); + + formBindingData.createFormBindingData(createFormBindingDataParam); } catch (error) { - console.error(`catch error, code: ${error.code}, message: ${error.message}`); + let code = (error as Base.BusinessError).code; + let message = (error as Base.BusinessError).message; + console.error(`catch error, code: ${code}, message: ${message}`); } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md index 711c657da7443ecbe73f9a4c32d4ef072ce91ced..446d85a6dcd666ea58022ef5008831a0cd4fa589 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md @@ -46,18 +46,19 @@ onAddForm(want: Want): formBindingData.FormBindingData ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import formBindingData from '@ohos.app.form.formBindingData'; +import Want from '@ohos.app.ability.Want'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onAddForm(want) { + onAddForm(want: Want) { console.log(`FormExtensionAbility onAddForm, want: ${want.abilityName}`); - let dataObj1 = { - temperature: '11c', - 'time': '11:00' - }; + let dataObj1 = new Map(); + dataObj1.set('temperature', '11c'); + dataObj1.set('time', '11:00'); + let obj1 = formBindingData.createFormBindingData(dataObj1); return obj1; } -}; +} ``` ## onCastToNormalForm @@ -80,7 +81,7 @@ onCastToNormalForm(formId: string): void import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onCastToNormalForm(formId) { + onCastToNormalForm(formId: string) { console.log(`FormExtensionAbility onCastToNormalForm, formId: ${formId}`); } }; @@ -108,16 +109,18 @@ import formBindingData from '@ohos.app.form.formBindingData'; import formProvider from '@ohos.app.form.formProvider'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onUpdateForm(formId) { + onUpdateForm(formId: string) { console.log(`FormExtensionAbility onUpdateForm, formId: ${formId}`); + class createFormBindingDataParam { + temperature: string + time: string + } let obj2 = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' - }); + } as createFormBindingDataParam); formProvider.updateForm(formId, obj2).then((data) => { console.log(`FormExtensionAbility context updateForm, data: ${data}`); - }).catch((error) => { - console.error(`Operation updateForm failed. Cause: ${error}`); }); } }; @@ -144,13 +147,24 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import formBindingData from '@ohos.app.form.formBindingData'; import formProvider from '@ohos.app.form.formProvider'; +// 由于arkTs中无Object.keys,且无法使用for..in... +// 若报arkTs问题,请将此方法单独抽离至一个ts文件中并暴露,在需要用到的ets文件中引入使用 +function getObjKeys(obj: Object): string[] { + let keys = Object.keys(obj); + return keys; +} + export default class MyFormExtensionAbility extends FormExtensionAbility { onChangeFormVisibility(newStatus) { console.log(`FormExtensionAbility onChangeFormVisibility, newStatus: ${newStatus}`); + class createFormBindingDataParam { + temperature: string + time: string + } let obj2 = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' - }); + } as createFormBindingDataParam); for (let key in newStatus) { console.log(`FormExtensionAbility onChangeFormVisibility, key: ${key}, value= ${newStatus[key]}`); @@ -185,7 +199,7 @@ onFormEvent(formId: string, message: string): void import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { + onFormEvent(formId: string, message: string) { console.log(`FormExtensionAbility onFormEvent, formId: ${formId}, message: ${message}`); } }; @@ -211,7 +225,7 @@ onRemoveForm(formId: string): void import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onRemoveForm(formId) { + onRemoveForm(formId: string) { console.log(`FormExtensionAbility onRemoveForm, formId: ${formId}`); } }; @@ -235,9 +249,10 @@ onConfigurationUpdate(newConfig: Configuration): void; ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import { Configuration } from '@ohos.app.ability.Configuration'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onConfigurationUpdate(config) { + onConfigurationUpdate(config: Configuration) { console.log(`onConfigurationUpdate, config: ${JSON.stringify(config)}`); } }; @@ -262,9 +277,10 @@ onAcquireFormState?(want: Want): formInfo.FormState; ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import formInfo from '@ohos.app.form.formInfo'; +import Want from '@ohos.app.ability.Want'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onAcquireFormState(want) { + onAcquireFormState(want: Want) { console.log(`FormExtensionAbility onAcquireFormState, want: ${want}`); return formInfo.FormState.UNKNOWN; } @@ -299,11 +315,11 @@ onShareForm?(formId: string): { [key: string]: Object } import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onShareForm(formId) { + onShareForm(formId: string) { console.log(`FormExtensionAbility onShareForm, formId: ${formId}`); let wantParams = { 'temperature': '20', - 'time': '2022-8-8 09:59', + 'time': '2022-8-8 09:59',s }; return wantParams; } @@ -338,7 +354,7 @@ onAcquireFormData?(formId: string): { [key: string]: Object } import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onAcquireFormData(formId) { + onAcquireFormData(formId: string) { console.log('FormExtensionAbility onAcquireFormData, formId: ${formId}'); let wantParams = { 'temperature': '20', diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md index c2983efcd2fe9963b150a5bcd53ab9bae5ffc760..107e2bbf0c8b6b388ea3bcf8e3133d5d97dffe72 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md @@ -11,6 +11,7 @@ formHost模块提供了卡片使用方相关接口的能力,包括对使用方 ```ts import formHost from '@ohos.app.form.formHost'; +import Base from '@ohos.base'; ``` ## deleteForm @@ -51,8 +52,8 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; - formHost.deleteForm(formId, (error) => { + let formId: string = '12400633174999288'; + formHost.deleteForm(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { @@ -108,11 +109,11 @@ deleteForm(formId: string): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; + let formId: string = '12400633174999288'; formHost.deleteForm(formId).then(() => { console.log('formHost deleteForm success'); - }).catch((error) => { - console.error(`error, code: ${error.code}, message: ${error.message}`); + }).catch((error: Base.BusinessError) => { + console.error('formHost deleteForm, error: ${JSON.stringify(error)}'); }); } catch(error) { console.error(`catch error, code: ${error.code}, message: ${error.message}`); @@ -157,8 +158,8 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; - formHost.releaseForm(formId, (error) => { + let formId: string = '12400633174999288'; + formHost.releaseForm(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -207,8 +208,8 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; - formHost.releaseForm(formId, true, (error) => { + let formId: string = '12400633174999288'; + formHost.releaseForm(formId, true, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -262,10 +263,10 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; + let formId: string = '12400633174999288'; formHost.releaseForm(formId, true).then(() => { console.log('formHost releaseForm success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -311,8 +312,8 @@ requestForm(formId: string, callback: AsyncCallback<void>): void import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; - formHost.requestForm(formId, (error) => { + let formId: string = '12400633174999288'; + formHost.requestForm(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -365,10 +366,10 @@ requestForm(formId: string): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; + let formId: string = '12400633174999288'; formHost.requestForm(formId).then(() => { console.log('formHost requestForm success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -415,8 +416,8 @@ castToNormalForm(formId: string, callback: AsyncCallback<void>): void import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; - formHost.castToNormalForm(formId, (error) => { + let formId: string = '12400633174999288'; + formHost.castToNormalForm(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -469,10 +470,10 @@ castToNormalForm(formId: string): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = '12400633174999288'; + let formId: string = '12400633174999288'; formHost.castToNormalForm(formId).then(() => { console.log('formHost castTempForm success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -516,8 +517,8 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; - formHost.notifyVisibleForms(formId, (error) => { + let formId: string[] = ['12400633174999288']; + formHost.notifyVisibleForms(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -568,10 +569,10 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; + let formId: string[] = ['12400633174999288']; formHost.notifyVisibleForms(formId).then(() => { console.log('formHost notifyVisibleForms success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -615,8 +616,8 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; - formHost.notifyInvisibleForms(formId, (error) => { + let formId: string[] = ['12400633174999288']; + formHost.notifyInvisibleForms(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -667,10 +668,10 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; + let formId: string[] = ['12400633174999288']; formHost.notifyInvisibleForms(formId).then(() => { console.log('formHost notifyInvisibleForms success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -715,8 +716,8 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; - formHost.enableFormsUpdate(formId, (error) => { + let formId: string[] = ['12400633174999288']; + formHost.enableFormsUpdate(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -768,10 +769,10 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; + let formId: string[] = ['12400633174999288']; formHost.enableFormsUpdate(formId).then(() => { console.log('formHost enableFormsUpdate success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -817,8 +818,8 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; - formHost.disableFormsUpdate(formId, (error) => { + let formId: string[] = ['12400633174999288']; + formHost.disableFormsUpdate(formId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -871,10 +872,10 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> import formHost from '@ohos.app.form.formHost'; try { - let formId = ['12400633174999288']; + let formId: string[] = ['12400633174999288']; formHost.disableFormsUpdate(formId).then(() => { console.log('formHost disableFormsUpdate success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -911,7 +912,7 @@ isSystemReady(callback: AsyncCallback<void>): void import formHost from '@ohos.app.form.formHost'; try { - formHost.isSystemReady((error, data) => { + formHost.isSystemReady((error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -951,7 +952,7 @@ import formHost from '@ohos.app.form.formHost'; try { formHost.isSystemReady().then(() => { console.log('formHost isSystemReady success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -992,13 +993,14 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): ```ts import formHost from '@ohos.app.form.formHost'; +import formInfo from '@ohos.app.form.formInfo'; try { - formHost.getAllFormsInfo((error, data) => { + formHost.getAllFormsInfo((error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { - console.log('formHost getAllFormsInfo, data: ${JSON.stringify(data)}'); + console.log(`formHost getAllFormsInfo, data: ${JSON.stringify(data)}`); } }); } catch(error) { @@ -1038,11 +1040,12 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> ```ts import formHost from '@ohos.app.form.formHost'; +import formInfo from '@ohos.app.form.formInfo'; try { - formHost.getAllFormsInfo().then((data) => { - console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}'); - }).catch((error) => { + formHost.getAllFormsInfo().then((data: formInfo.FormInfo[]) => { + console.log(`formHost getAllFormsInfo data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1085,13 +1088,14 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo ```ts import formHost from '@ohos.app.form.formHost'; +import formInfo from '@ohos.app.form.formInfo'; try { - formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => { + formHost.getFormsInfo('com.example.ohos.formjsdemo', (error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { - console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}'); + console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`); } }); } catch(error) { @@ -1135,9 +1139,10 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< ```ts import formHost from '@ohos.app.form.formHost'; +import formInfo from '@ohos.app.form.formInfo'; try { - formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => { + formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { @@ -1190,11 +1195,12 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI ```ts import formHost from '@ohos.app.form.formHost'; +import formInfo from '@ohos.app.form.formInfo'; try { - formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => { - console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}'); - }).catch((error) => { + formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data: formInfo.FormInfo[]) => { + console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1238,12 +1244,12 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb import formHost from '@ohos.app.form.formHost'; try { - let formIds = new Array('12400633174999288', '12400633174999289'); - formHost.deleteInvalidForms(formIds, (error, data) => { + let formIds: string[] = new Array('12400633174999288', '12400633174999289'); + formHost.deleteInvalidForms(formIds, (error: Base.BusinessError, data: number) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { - console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}'); + console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`); } }); } catch(error) { @@ -1292,10 +1298,10 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> import formHost from '@ohos.app.form.formHost'; try { - let formIds = new Array('12400633174999288', '12400633174999289'); - formHost.deleteInvalidForms(formIds).then((data) => { - console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}'); - }).catch((error) => { + let formIds: string[] = new Array('12400633174999288', '12400633174999289'); + formHost.deleteInvalidForms(formIds).then((data: number) => { + console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1338,8 +1344,10 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g ```ts import formHost from '@ohos.app.form.formHost'; +import Want from '@ohos.app.ability.Want'; +import formInfo from '@ohos.app.form.formInfo'; -let want = { +let want: Want = { 'deviceId': '', 'bundleName': 'ohos.samples.FormApplication', 'abilityName': 'FormAbility', @@ -1350,11 +1358,11 @@ let want = { } }; try { - formHost.acquireFormState(want, (error, data) => { + formHost.acquireFormState(want, (error:Base.BusinessError, data: formInfo.FormStateInfo) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { - console.log('formHost acquireFormState, data: ${JSON.stringify(data)}'); + console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`); } }); } catch(error) { @@ -1402,8 +1410,10 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> ```ts import formHost from '@ohos.app.form.formHost'; +import Want from '@ohos.app.ability.Want'; +import formInfo from '@ohos.app.form.formInfo'; -let want = { +let want: Want = { 'deviceId': '', 'bundleName': 'ohos.samples.FormApplication', 'abilityName': 'FormAbility', @@ -1414,9 +1424,9 @@ let want = { } }; try { - formHost.acquireFormState(want).then((data) => { - console.log('formHost acquireFormState, data: ${JSON.stringify(data)}'); - }).catch((error) => { + formHost.acquireFormState(want).then((data: formInfo.FormStateInfo) => { + console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1453,10 +1463,9 @@ on(type: 'formUninstall', callback: Callback<string>): void ```ts import formHost from '@ohos.app.form.formHost'; -let callback = function(formId) { - console.log('formHost on formUninstall, formId: ${formId}'); -} -formHost.on('formUninstall', callback); +formHost.on('formUninstall', (formId: string) => { + console.log(`formHost on formUninstall, formId: ${formId}`); +}); ``` ## off('formUninstall') @@ -1488,10 +1497,9 @@ off(type: 'formUninstall', callback?: Callback<string>): void ```ts import formHost from '@ohos.app.form.formHost'; -let callback = function(formId) { - console.log('formHost on formUninstall, formId: ${formId}'); -} -formHost.off('formUninstall', callback); +formHost.off('formUninstall', (formId: string) => { + console.log(`formHost on formUninstall, formId: ${formId}`); +}); ``` ## notifyFormsVisible @@ -1531,9 +1539,9 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { - formHost.notifyFormsVisible(formIds, true, (error) => { + formHost.notifyFormsVisible(formIds, true, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -1585,11 +1593,11 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise< ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { formHost.notifyFormsVisible(formIds, true).then(() => { console.log('formHost notifyFormsVisible success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1634,9 +1642,9 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { - formHost.notifyFormsEnableUpdate(formIds, true, (error) => { + formHost.notifyFormsEnableUpdate(formIds, true, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -1688,11 +1696,11 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { formHost.notifyFormsEnableUpdate(formIds, true).then(() => { console.log('formHost notifyFormsEnableUpdate success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1736,10 +1744,10 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>) ```ts import formHost from '@ohos.app.form.formHost'; -let formId = '12400633174999288'; -let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; +let formId: string = '12400633174999288'; +let deviceId: string = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; try { - formHost.shareForm(formId, deviceId, (error) => { + formHost.shareForm(formId, deviceId, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -1791,12 +1799,12 @@ shareForm(formId: string, deviceId: string): Promise<void> ```ts import formHost from '@ohos.app.form.formHost'; -let formId = '12400633174999288'; -let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; +let formId: string = '12400633174999288'; +let deviceId: string = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; try { formHost.shareForm(formId, deviceId).then(() => { console.log('formHost shareForm success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1840,9 +1848,9 @@ notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean, callb ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { - formHost.notifyFormsPrivacyProtected(formIds, true, (error) => { + formHost.notifyFormsPrivacyProtected(formIds, true, (error: Base.BusinessError) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } @@ -1891,11 +1899,11 @@ notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean): Pro ```ts import formHost from '@ohos.app.form.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); try { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { console.log('formHost notifyFormsPrivacyProtected success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { @@ -1937,13 +1945,13 @@ acquireFormData(formId: string, callback: AsyncCallback<{[key: string]: Object}> ```ts import formHost from '@ohos.app.form.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; try { formHost.acquireFormData(formId, (error, data) => { if (error) { console.error(`error, code: ${error.code}, message: ${error.message}`); } else { - console.log('formHost acquireFormData, data: ${JSON.stringify(data)}'); + console.log(`formHost acquireFormData, data: ${JSON.stringify(data)}`); } }); } catch(error) { @@ -1989,11 +1997,11 @@ acquireFormData(formId: string): Promise<{[key: string]: Object}>; ```ts import formHost from '@ohos.app.form.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; try { formHost.acquireFormData(formId).then((data) => { console.log('formHost acquireFormData success' + data); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`error, code: ${error.code}, message: ${error.message}`); }); } catch(error) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md index d9fd5467a858833c825e6916ac9e2292b6570079..93beb8f5c2d8dd50fe37a0d13a2f0c9c5d2f70f9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md @@ -9,6 +9,7 @@ FormProvider模块提供了卡片提供方相关接口的能力,开发者在 ```ts import formProvider from '@ohos.app.form.formProvider'; +import Base from '@ohos.base'; ``` ## setFormNextRefreshTime @@ -45,9 +46,9 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l **示例:** ```ts -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; try { - formProvider.setFormNextRefreshTime(formId, 5, (error) => { + formProvider.setFormNextRefreshTime(formId, 5, (error: Base.BusinessError) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; @@ -98,11 +99,11 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void> **示例:** ```ts -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; try { formProvider.setFormNextRefreshTime(formId, 5).then(() => { console.log(`formProvider setFormNextRefreshTime success`); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { @@ -145,10 +146,17 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ```ts import formBindingData from '@ohos.app.form.formBindingData'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; try { - let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); - formProvider.updateForm(formId, obj, (error) => { + class createFormBindingDataParamType { + temperature: string + time: string + } + let obj = formBindingData.createFormBindingData({ + temperature:'22c', + time:'22:00' + } as createFormBindingDataParamType); + formProvider.updateForm(formId, obj, (error: Base.BusinessError) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; @@ -200,12 +208,19 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ```ts import formBindingData from '@ohos.app.form.formBindingData'; -let formId = '12400633174999288'; -let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' }); +let formId: string = '12400633174999288'; +class createFormBindingDataParamType { + temperature: string + time: string + } +let obj = formBindingData.createFormBindingData({ + temperature:'22c', + time:'22:00' + } as createFormBindingDataParamType); try { formProvider.updateForm(formId, obj).then(() => { console.log(`formProvider updateForm success`); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { @@ -247,7 +262,7 @@ try { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; } - console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}'); + console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`); }); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message})`); @@ -294,7 +309,7 @@ try { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; } - console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}'); + console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`); }); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message})`); @@ -342,9 +357,9 @@ const filter: formInfo.FormInfoFilter = { moduleName: 'entry' }; try { - formProvider.getFormsInfo(filter).then((data) => { - console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}'); - }).catch((error) => { + formProvider.getFormsInfo(filter).then((data: formInfo.FormInfo[]) => { + console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { @@ -386,8 +401,9 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ```ts import formBindingData from '@ohos.app.form.formBindingData'; +import Want from '@ohos.app.ability.Want'; -let want = { +let want: Want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -396,8 +412,15 @@ let want = { } }; try { - let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' }); - formProvider.requestPublishForm(want, obj, (error, data) => { + class createFormBindingDataParamType { + temperature: string + time: string + } + let obj = formBindingData.createFormBindingData({ + temperature:'22c', + time:'22:00' + } as createFormBindingDataParamType); + formProvider.requestPublishForm(want, obj, (error: Base.BusinessError, data: string) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; @@ -441,7 +464,9 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void **示例:** ```ts -let want = { +import Want from '@ohos.app.ability.Want'; + +let want: Want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -450,12 +475,12 @@ let want = { } }; try { - formProvider.requestPublishForm(want, (error, data) => { + formProvider.requestPublishForm(want, (error: Base.BusinessError, data: string) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; } - console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}'); + console.log(`formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}`); }); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message})`); @@ -500,7 +525,9 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData **示例:** ```ts -let want = { +import Want from '@ohos.app.ability.Want'; + +let want: Want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -509,9 +536,9 @@ let want = { } }; try { - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}'); - }).catch((error) => { + formProvider.requestPublishForm(want).then((data: string) => { + console.log(`formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { @@ -549,13 +576,15 @@ isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void **示例:** ```ts +import Want from '@ohos.app.ability.Want'; + try { - formProvider.isRequestPublishFormSupported((error, isSupported) => { + formProvider.isRequestPublishFormSupported((error: Base.BusinessError, isSupported: boolean) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); } else { if (isSupported) { - var want = { + let want: Want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -564,12 +593,12 @@ try { } }; try { - formProvider.requestPublishForm(want, (error, data) => { + formProvider.requestPublishForm(want, (error: Base.BusinessError, data: string) => { if (error) { console.error(`callback error, code: ${error.code}, message: ${error.message})`); return; } - console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}'); + console.log(`formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}`); }); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message})`); @@ -611,10 +640,12 @@ isRequestPublishFormSupported(): Promise<boolean> **示例:** ```ts +import Want from '@ohos.app.ability.Want'; + try { - formProvider.isRequestPublishFormSupported().then((isSupported) => { + formProvider.isRequestPublishFormSupported().then((isSupported: boolean) => { if (isSupported) { - var want = { + let want: Want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -623,16 +654,16 @@ try { } }; try { - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}'); - }).catch((error) => { + formProvider.requestPublishForm(want).then((data: string) => { + console.log(`formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { console.error(`catch error, code: ${error.code}, message: ${error.message})`); } } - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error(`promise error, code: ${error.code}, message: ${error.message})`); }); } catch (error) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md index ad0f798a0faa5f2dba8cf5b81641c3c99ebf7059..100b42bec2451f936f64db7bd907abb5c87bb888 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md @@ -1509,7 +1509,7 @@ auth(name: string, owner: string, authType: string, options: {[key: string]: Obj } let options: Record = { - password: 'xxxx', + 'password': 'xxxx', }; try { appAccountManager.auth('LiSi', 'com.example.accountjsdemo', 'getSocialData', options, { @@ -4919,7 +4919,7 @@ onRequestRedirected: (request: Want) => void } auth(name: string, authType: string, - options: { [key: string]: Object }, callback: account_appAccount.AuthCallback) { + options: Record, callback: account_appAccount.AuthCallback) { let result: account_appAccount.AuthResult = { account: { name: 'Lisi', @@ -5020,7 +5020,7 @@ onRequestRedirected: (request: Want) => void ```js class MyAuthenticator extends account_appAccount.Authenticator { addAccountImplicitly(authType: string, callerBundleName: string, - options: { [key: string]: Object }, callback: account_appAccount.AuthenticatorCallback) { + options: Record, callback: account_appAccount.AuthenticatorCallback) { let want: Want = { bundleName: 'com.example.accountjsdemo', abilityName: 'com.example.accountjsdemo.LoginAbility', @@ -5029,7 +5029,7 @@ onRequestRedirected: (request: Want) => void } authenticate(name: string, authType: string, callerBundleName: string, - options: { [key: string]: Object }, callback: account_appAccount.AuthenticatorCallback) { + options: Record, callback: account_appAccount.AuthenticatorCallback) { callback.onResult(account_appAccount.ResultCode.SUCCESS, { name: name, authType: authType, @@ -5196,7 +5196,7 @@ getRemoteObject(): rpc.RemoteObject; class MyAuthenticator extends account_appAccount.Authenticator { addAccountImplicitly(authType: string, callerBundleName: string, - options: { [key: string]: Object }, callback: account_appAccount.AuthenticatorCallback) { + options: Record, callback: account_appAccount.AuthenticatorCallback) { let want: Want = { bundleName: 'com.example.accountjsdemo', abilityName: 'com.example.accountjsdemo.LoginAbility', @@ -5205,7 +5205,7 @@ getRemoteObject(): rpc.RemoteObject; } authenticate(name: string, authType: string, callerBundleName: string, - options: { [key: string]: Object }, callback: account_appAccount.AuthenticatorCallback) { + options: Record, callback: account_appAccount.AuthenticatorCallback) { callback.onResult(account_appAccount.ResultCode.SUCCESS, { name: name, authType: authType, diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md index 29a45814d01f595a1a2f0e4a19065f5f69a33465..40a9952eb8887299476380badd48ee8ff4a39136 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md @@ -53,11 +53,13 @@ import fs from '@ohos.file.fs'; try { let fd = fs.openSync('/path/to/form.png'); - let obj = { - 'temperature': '21°', - 'formImages': { 'image': fd } - }; - formBindingData.createFormBindingData(obj); + let createFormBindingDataParam = new Map(); + let formImagesParam = new Map(); + formImagesParam.set('image', fd); + createFormBindingDataParam.set("name", '21°'); + createFormBindingDataParam.set('formImages', formImagesParam); + + formBindingData.createFormBindingData(createFormBindingDataParam); } catch (error) { console.error('catch error, error: ${JSON.stringify(error)}'); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md index da1915673114f6f644f9902849a2640a7e33f339..dd8f03d8d7edc690cf5ecb68ebcdf8a3db95050a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md @@ -12,6 +12,7 @@ formHost模块提供了卡片使用方相关接口的能力,包括对使用方 ```ts import formHost from '@ohos.application.formHost'; +import Base from '@ohos.base'; ``` ## deleteForm @@ -36,7 +37,7 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.deleteForm(formId, (error, data) => { if (error.code) { console.error('formHost deleteForm, error: ${JSON.stringify(error)}'); @@ -71,10 +72,10 @@ deleteForm(formId: string): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.deleteForm(formId).then(() => { console.log('formHost deleteForm success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost deleteForm, error: ${JSON.stringify(error)}'); }); ``` @@ -101,8 +102,8 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; -formHost.releaseForm(formId, (error, data) => { +let formId: string = '12400633174999288'; +formHost.releaseForm(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost releaseForm, error: ${JSON.stringify(error)}'); } else { @@ -134,8 +135,8 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; -formHost.releaseForm(formId, true, (error, data) => { +let formId: string = '12400633174999288'; +formHost.releaseForm(formId, true, (error: Base.BusinessError) => { if (error.code) { console.error('formHost releaseForm, error: ${JSON.stringify(error)}'); } else { @@ -172,10 +173,10 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.releaseForm(formId, true).then(() => { console.log('formHost releaseForm success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost releaseForm, error: ${JSON.stringify(error)}'); }); ``` @@ -202,8 +203,8 @@ requestForm(formId: string, callback: AsyncCallback<void>): void ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; -formHost.requestForm(formId, (error, data) => { +let formId: string = '12400633174999288'; +formHost.requestForm(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost requestForm, error: ${JSON.stringify(error)}'); } @@ -237,10 +238,10 @@ requestForm(formId: string): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.requestForm(formId).then(() => { console.log('formHost requestForm success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost requestForm, error: ${JSON.stringify(error)}'); }); ``` @@ -267,8 +268,8 @@ castTempForm(formId: string, callback: AsyncCallback<void>): void ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; -formHost.castTempForm(formId, (error, data) => { +let formId: string = '12400633174999288'; +formHost.castTempForm(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost castTempForm, error: ${JSON.stringify(error)}'); } @@ -302,10 +303,10 @@ castTempForm(formId: string): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.castTempForm(formId).then(() => { console.log('formHost castTempForm success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost castTempForm, error: ${JSON.stringify(error)}'); }); ``` @@ -332,8 +333,8 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; -formHost.notifyVisibleForms(formId, (error, data) => { +let formId: string[] = ['12400633174999288']; +formHost.notifyVisibleForms(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}'); } @@ -367,10 +368,10 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; +let formId: string[] = ['12400633174999288']; formHost.notifyVisibleForms(formId).then(() => { console.log('formHost notifyVisibleForms success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}'); }); ``` @@ -397,8 +398,8 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; -formHost.notifyInvisibleForms(formId, (error, data) => { +let formId: string[] = ['12400633174999288']; +formHost.notifyInvisibleForms(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}'); } @@ -432,10 +433,10 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; +let formId: string[] = ['12400633174999288']; formHost.notifyInvisibleForms(formId).then(() => { console.log('formHost notifyInvisibleForms success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}'); }); ``` @@ -462,8 +463,8 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; -formHost.enableFormsUpdate(formId, (error, data) => { +let formId: string[] = ['12400633174999288']; +formHost.enableFormsUpdate(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}'); } @@ -497,10 +498,10 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; +let formId: string[] = ['12400633174999288']; formHost.enableFormsUpdate(formId).then(() => { console.log('formHost enableFormsUpdate success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}'); }); ``` @@ -527,8 +528,8 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; -formHost.disableFormsUpdate(formId, (error, data) => { +let formId: string[] = ['12400633174999288']; +formHost.disableFormsUpdate(formId, (error: Base.BusinessError) => { if (error.code) { console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}'); } @@ -562,10 +563,10 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = ['12400633174999288']; +let formId: string[] = ['12400633174999288']; formHost.disableFormsUpdate(formId).then(() => { console.log('formHost disableFormsUpdate success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}'); }); ``` @@ -589,8 +590,8 @@ isSystemReady(callback: AsyncCallback<void>): void ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; -formHost.isSystemReady((error, data) => { +let formId: string = '12400633174999288'; +formHost.isSystemReady((error: Base.BusinessError) => { if (error.code) { console.error('formHost isSystemReady, error: ${JSON.stringify(error)}'); } @@ -616,10 +617,10 @@ isSystemReady(): Promise<void> ```ts import formHost from '@ohos.application.formHost'; -let formId = '12400633174999288'; +let formId: string = '12400633174999288'; formHost.isSystemReady().then(() => { console.log('formHost isSystemReady success'); -}).catch((error) => { +}).catch((error: Base.BusinessError) => { console.error('formHost isSystemReady, error: ${JSON.stringify(error)}'); }); ``` @@ -644,8 +645,9 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): ```ts import formHost from '@ohos.application.formHost'; +import formInfo from '@ohos.app.form.formInfo'; -formHost.getAllFormsInfo((error, data) => { +formHost.getAllFormsInfo((error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error.code) { console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}'); } else { @@ -674,10 +676,11 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> ```ts import formHost from '@ohos.application.formHost'; + import formInfo from '@ohos.app.form.formInfo'; - formHost.getAllFormsInfo().then((data) => { + formHost.getAllFormsInfo().then((data: formInfo.FormInfo[]) => { console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}'); }); ``` @@ -703,12 +706,13 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo ```ts import formHost from '@ohos.application.formHost'; +import formInfo from '@ohos.app.form.formInfo'; -formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => { +formHost.getFormsInfo('com.example.ohos.formjsdemo', (error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error.code) { - console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}'); + console.error(`formHost getFormsInfo, error: ${JSON.stringify(error)}`); } else { - console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}'); + console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`); } }); ``` @@ -735,8 +739,9 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< ```ts import formHost from '@ohos.application.formHost'; +import formInfo from '@ohos.app.form.formInfo'; -formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => { +formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error: Base.BusinessError, data: formInfo.FormInfo[]) => { if (error.code) { console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}'); } else { @@ -773,10 +778,10 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI ```ts import formHost from '@ohos.application.formHost'; - formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => { - console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}'); - }).catch((error) => { - console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}'); + formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data: formInfo.FormInfo[]) => { + console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`); + }).catch((error: Base.BusinessError) => { + console.error(`formHost getFormsInfo, error: ${JSON.stringify(error)}`); }); ``` @@ -802,12 +807,12 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); -formHost.deleteInvalidForms(formIds, (error, data) => { +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); +formHost.deleteInvalidForms(formIds, (error: Base.BusinessError, data: number) => { if (error.code) { - console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}'); + console.error(`formHost deleteInvalidForms, error: ${JSON.stringify(error)}`); } else { - console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}'); + console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`); } }); ``` @@ -839,11 +844,11 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); -formHost.deleteInvalidForms(formIds).then((data) => { - console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}'); -}).catch((error) => { - console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); +formHost.deleteInvalidForms(formIds).then((data: number) => { + console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`); +}).catch((error: Base.BusinessError) => { + console.error(`formHost deleteInvalidForms, error: ${JSON.stringify(error)}`); }); ``` @@ -868,8 +873,10 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g ```ts import formHost from '@ohos.application.formHost'; +import Want from '@ohos.app.ability.Want'; +import formInfo from '@ohos.app.form.formInfo'; -let want = { +let want: Want = { 'deviceId': '', 'bundleName': 'ohos.samples.FormApplication', 'abilityName': 'FormAbility', @@ -879,11 +886,11 @@ let want = { 'ohos.extra.param.key.form_dimension': 2 } }; -formHost.acquireFormState(want, (error, data) => { +formHost.acquireFormState(want, (error:Base.BusinessError, data: formInfo.FormStateInfo) => { if (error.code) { - console.error('formHost acquireFormState, error: ${JSON.stringify(error)}'); + console.error(`formHost acquireFormState, error: ${JSON.stringify(error)}`); } else { - console.log('formHost acquireFormState, data: ${JSON.stringify(data)}'); + console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`); } }); ``` @@ -914,8 +921,10 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> ```ts import formHost from '@ohos.application.formHost'; +import Want from '@ohos.app.ability.Want'; +import formInfo from '@ohos.app.form.formInfo'; -let want = { +let want: Want = { 'deviceId': '', 'bundleName': 'ohos.samples.FormApplication', 'abilityName': 'FormAbility', @@ -925,10 +934,10 @@ let want = { 'ohos.extra.param.key.form_dimension': 2 } }; -formHost.acquireFormState(want).then((data) => { - console.log('formHost acquireFormState, data: ${JSON.stringify(data)}'); -}).catch((error) => { - console.error('formHost acquireFormState, error: ${JSON.stringify(error)}'); +formHost.acquireFormState(want).then((data: formInfo.FormStateInfo) => { + console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`); +}).catch((error: Base.BusinessError) => { + console.error(`formHost acquireFormState, error: ${JSON.stringify(error)}`); }); ``` @@ -952,10 +961,9 @@ on(type: 'formUninstall', callback: Callback<string>): void ```ts import formHost from '@ohos.application.formHost'; -let callback = function(formId) { - console.log('formHost on formUninstall, formId: ${formId}'); -}; -formHost.on('formUninstall', callback); +formHost.on('formUninstall', (formId: string) => { + console.log(`formHost on formUninstall, formId: ${formId}`); +}); ``` ## off('formUninstall') @@ -978,10 +986,9 @@ off(type: 'formUninstall', callback?: Callback<string>): void ```ts import formHost from '@ohos.application.formHost'; -let callback = function(formId) { - console.log('formHost on formUninstall, formId: ${formId}'); -}; -formHost.off('formUninstall', callback); +formHost.off('formUninstall', (formId: string) => { + console.log(`formHost on formUninstall, formId: ${formId}`); +}); ``` ## notifyFormsVisible @@ -1007,10 +1014,10 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); -formHost.notifyFormsVisible(formIds, true, (error, data) => { +let formIds: string[]= new Array('12400633174999288', '12400633174999289'); +formHost.notifyFormsVisible(formIds, true, (error: Base.BusinessError) => { if (error.code) { - console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}'); + console.error(`formHost notifyFormsVisible, error: ${JSON.stringify(error)}`); } }); ``` @@ -1043,11 +1050,11 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise< ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); formHost.notifyFormsVisible(formIds, true).then(() => { console.log('formHost notifyFormsVisible success'); -}).catch((error) => { - console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}'); +}).catch((error: Base.BusinessError) => { + console.error(`formHost notifyFormsVisible, error: ${JSON.stringify(error)}`); }); ``` @@ -1074,8 +1081,8 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); -formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); +formHost.notifyFormsEnableUpdate(formIds, true, (error: Base.BusinessError) => { if (error.code) { console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}'); } @@ -1110,10 +1117,10 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): ```ts import formHost from '@ohos.application.formHost'; -let formIds = new Array('12400633174999288', '12400633174999289'); +let formIds: string[] = new Array('12400633174999288', '12400633174999289'); formHost.notifyFormsEnableUpdate(formIds, true).then(() => { console.log('formHost notifyFormsEnableUpdate success'); -}).catch((error) => { - console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}'); +}).catch((error: Base.BusinessError) => { + console.error(`formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md index 4fac1599bb626295c0b6e62d4afb1981849d819b..9113fbc4411944becf79f8e25ad9acd814b98dfc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md @@ -10,6 +10,7 @@ FormProvider模块提供了卡片提供方相关接口的能力,开发者在 ```ts import formProvider from '@ohos.application.formProvider'; +import Base from '@ohos.base' ``` ## setFormNextRefreshTime @@ -31,8 +32,8 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l **示例:** ```ts - let formId = '12400633174999288'; - formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { + let formId: string = '12400633174999288'; + formProvider.setFormNextRefreshTime(formId, 5, (error: Base.BusinessError) => { if (error.code) { console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}'); } @@ -63,11 +64,11 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void> **示例:** ```ts - let formId = '12400633174999288'; + let formId: string = '12400633174999288'; formProvider.setFormNextRefreshTime(formId, 5).then(() => { console.log('formProvider setFormNextRefreshTime success'); - }).catch((error) => { - console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}'); + }).catch((error: Base.BusinessError) => { + console.error(`formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}`); }); ``` @@ -93,10 +94,17 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call import formBindingData from '@ohos.app.form.formBindingData'; let formId = '12400633174999288'; - let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); - formProvider.updateForm(formId, obj, (error, data) => { + class createBindingDataType { + temperature: string + time: string + }; + let obj = formBindingData.createFormBindingData({ + temperature:'22c', + time:'22:00' + } as createBindingDataType); + formProvider.updateForm(formId, obj, (error: Base.BusinessError) => { if (error.code) { - console.error('formProvider updateForm, error: ${JSON.stringify(error)}'); + console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`); } }); ``` @@ -127,12 +135,19 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ```ts import formBindingData from '@ohos.application.formBindingData'; - let formId = '12400633174999288'; - let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); + let formId: string = '12400633174999288'; + class createBindingDataType { + temperature: string + time: string + }; + let obj = formBindingData.createFormBindingData({ + temperature:'22c', + time:'22:00' + } as createBindingDataType); formProvider.updateForm(formId, obj).then(() => { console.log('formProvider updateForm success'); - }).catch((error) => { - console.error('formProvider updateForm, error: ${JSON.stringify(error)}'); + }).catch((error: Base.BusinessError) => { + console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md index 1f426e9d7da30c1c97fe93608fc3822f6a9dc125..78bd92084556c17a5c00d4f6d97bf11feef383a2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md @@ -7,6 +7,8 @@ > 本模块首批接口从 API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > > 示例效果请以真机运行为准,当前 IDE 预览器不支持。 +> +> 当前不支持同时配置excuteDrag和[onDragStart](../arkui-ts/ts-universal-events-drag-drop.md#事件)。 ## 导入模块 @@ -180,3 +182,4 @@ struct DragControllerPage { | pointerId | number | 是 | 设置启动拖拽时屏幕上触摸点的Id。 | | data | [unifiedDataChannel.UnifiedData](js-apis-data-unifiedDataChannel.md#unifieddata) | 否 | 设置拖拽过程中携带的数据。 | | extraParams | string | 否 | 设置拖拽事件额外信息,具体功能暂未实现。 | + diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md index ed1e4495a6798ce533d8f1a9966ff3d8ae786a3c..9ab4f8912c9090f474adbd8ee0b8e3f3e65a7720 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md @@ -17,7 +17,7 @@ import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawa ## DrawableDescriptor.constructor constructor() -创建DrawableDescriptor或LayeredDrawableDescriptor对象。对象构造需要使用全球化接口[getDrawableDescriptor](js-apis-resource-manager.md##getdrawabledescriptor)或[getDrawableDescriptorByName](js-apis-resource-manager.md##getdrawabledescriptorbyname)。 +创建DrawableDescriptor或LayeredDrawableDescriptor对象。对象构造需要使用全球化接口[getDrawableDescriptor](js-apis-resource-manager.md#getdrawabledescriptor)或[getDrawableDescriptorByName](js-apis-resource-manager.md#getdrawabledescriptorbyname)。 **系统接口:** 此接口为系统接口。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md index 990dd73240ea6b0d7e0fc7883239f4fce44b8940..19fb23bfaf0a54ebca90529dd273bfae25774d00 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md @@ -250,16 +250,18 @@ getBundleInfoForSelf(bundleFlags: [number](#bundleflag)): Promise\<[BundleInfo]( ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; try { bundleManager.getBundleInfoForSelf(bundleFlags).then((data) => { hilog.info(0x0000, 'testTag', 'getBundleInfoForSelf successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', message); } ``` @@ -282,6 +284,7 @@ getBundleInfoForSelf(bundleFlags: [number](#bundleflag), callback: AsyncCallback ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; @@ -294,7 +297,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', message); } ``` @@ -336,6 +340,7 @@ getBundleInfo(bundleName: string, bundleFlags: number, userId: number, callback: ```ts // 额外获取AbilityInfo import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_HAP_MODULE | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_ABILITY; @@ -350,13 +355,15 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', message); } ``` ```ts // 额外获取ApplicationInfo中的metadata import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_METADATA; @@ -371,7 +378,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', message); } ``` @@ -411,6 +419,7 @@ getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\< ```ts // 额外获取extensionAbility import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_HAP_MODULE | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY; @@ -424,7 +433,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfo failed: %{public}s', message); } ``` @@ -471,6 +481,7 @@ getBundleInfo(bundleName: string, bundleFlags: [number](#bundleflag), userId?: n ```ts // 额外获取ApplicationInfo和SignatureInfo import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO; @@ -479,16 +490,18 @@ let userId = 100; try { bundleManager.getBundleInfo(bundleName, bundleFlags, userId).then((data) => { hilog.info(0x0000, 'testTag', 'getBundleInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', message); } ``` ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; @@ -496,11 +509,12 @@ let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; try { bundleManager.getBundleInfo(bundleName, bundleFlags).then((data) => { hilog.info(0x0000, 'testTag', 'getBundleInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfo failed. Cause: %{public}s', message); } ``` @@ -542,6 +556,7 @@ getApplicationInfo(bundleName: string, appFlags: [number](#applicationflag), use ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; @@ -556,7 +571,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getApplicationInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getApplicationInfo failed: %{public}s', message); } ``` @@ -595,6 +611,7 @@ getApplicationInfo(bundleName: string, appFlags: [number](#applicationflag), cal ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_WITH_PERMISSION; @@ -608,7 +625,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getApplicationInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getApplicationInfo failed: %{public}s', message); } ``` @@ -654,6 +672,7 @@ getApplicationInfo(bundleName: string, appFlags: [number](#applicationflag), use ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_WITH_PERMISSION; @@ -662,11 +681,12 @@ let userId = 100; try { bundleManager.getApplicationInfo(bundleName, appFlags, userId).then((data) => { hilog.info(0x0000, 'testTag', 'getApplicationInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getApplicationInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getApplicationInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getApplicationInfo failed. Cause: %{public}s', message); } ``` @@ -702,6 +722,7 @@ getAllBundleInfo(bundleFlags: [number](#bundleflag), userId: number, callback: A ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION; let userId = 100; @@ -715,7 +736,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllBundleInfo failed: %{public}s', message); } ``` @@ -742,6 +764,7 @@ getAllBundleInfo(bundleFlags: [number](#bundleflag), callback: AsyncCallback { hilog.info(0x0000, 'testTag', 'getAllBundleInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getAllBundleInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllBundleInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllBundleInfo failed. Cause: %{public}s', message); } ``` @@ -841,6 +867,7 @@ getAllApplicationInfo(appFlags: [number](#applicationflag), userId: number, call ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; let userId = 100; @@ -854,7 +881,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed: %{public}s', message); } ``` @@ -881,6 +909,7 @@ getAllApplicationInfo(appFlags: [number](#applicationflag), callback: AsyncCallb ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; @@ -893,7 +922,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed: %{public}s', message); } ``` @@ -934,17 +964,19 @@ getAllApplicationInfo(appFlags: [number](#applicationflag), userId?: number): Pr ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let appFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; try { bundleManager.getAllApplicationInfo(appFlags).then((data) => { hilog.info(0x0000, 'testTag', 'getAllApplicationInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllApplicationInfo failed. Cause: %{public}s', message); } ``` @@ -986,6 +1018,7 @@ queryAbilityInfo(want: Want, abilityFlags: [number](#abilityflag), userId: numbe ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -1003,7 +1036,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed: %{public}s', message); } ``` @@ -1042,6 +1076,7 @@ queryAbilityInfo(want: Want, abilityFlags: [number](#abilityflag), callback: Asy ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let want = { @@ -1058,7 +1093,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed: %{public}s', message); } ``` @@ -1104,6 +1140,7 @@ queryAbilityInfo(want: Want, abilityFlags: [number](#abilityflag), userId?: numb ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -1115,16 +1152,18 @@ let want = { try { bundleManager.queryAbilityInfo(want, abilityFlags, userId).then((data) => { hilog.info(0x0000, 'testTag', 'queryAbilityInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let want = { @@ -1135,11 +1174,12 @@ let want = { try { bundleManager.queryAbilityInfo(want, abilityFlags).then((data) => { hilog.info(0x0000, 'testTag', 'queryAbilityInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }) } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -1180,6 +1220,7 @@ queryExtensionAbilityInfo(want: Want, extensionAbilityType: [ExtensionAbilityTyp ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let extensionAbilityType = bundleManager.ExtensionAbilityType.FORM; let extensionFlags = bundleManager.ExtensionAbilityFlag.GET_EXTENSION_ABILITY_INFO_DEFAULT; @@ -1198,7 +1239,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed: %{public}s', message); } ``` @@ -1237,6 +1279,7 @@ queryExtensionAbilityInfo(want: Want, extensionAbilityType: [ExtensionAbilityTyp ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let extensionAbilityType = bundleManager.ExtensionAbilityType.FORM; let extensionFlags = bundleManager.ExtensionAbilityFlag.GET_EXTENSION_ABILITY_INFO_DEFAULT; @@ -1254,7 +1297,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed: %{public}s', message); } ``` @@ -1300,6 +1344,7 @@ queryExtensionAbilityInfo(want: Want, extensionAbilityType: [ExtensionAbilityTyp ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let extensionAbilityType = bundleManager.ExtensionAbilityType.FORM; @@ -1317,12 +1362,14 @@ try { hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', message); } ``` ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let extensionAbilityType = bundleManager.ExtensionAbilityType.FORM; let extensionFlags = bundleManager.ExtensionAbilityFlag.GET_EXTENSION_ABILITY_INFO_DEFAULT; @@ -1334,11 +1381,12 @@ let want = { try { bundleManager.queryExtensionAbilityInfo(want, extensionAbilityType, extensionFlags).then((data) => { hilog.info(0x0000, 'testTag', 'queryExtensionAbilityInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', err.message); }) } catch (err) { - hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryExtensionAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -1373,6 +1421,7 @@ getBundleNameByUid(uid: number, callback: AsyncCallback\): void; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let uid = 20010005; try { @@ -1384,7 +1433,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleNameByUid failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleNameByUid failed: %{public}s', message); } ``` @@ -1424,6 +1474,7 @@ getBundleNameByUid(uid: number): Promise\; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let uid = 20010005; try { @@ -1433,7 +1484,8 @@ try { hilog.error(0x0000, 'testTag', 'getBundleNameByUid failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleNameByUid failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleNameByUid failed. Cause: %{public}s', message); } ``` @@ -1469,6 +1521,7 @@ getBundleArchiveInfo(hapFilePath: string, bundleFlags: [number](#bundleflag), ca ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let hapFilePath = "/data/xxx/test.hap"; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; @@ -1482,7 +1535,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleArchiveInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleArchiveInfo failed. Cause: %{public}s', message); } ``` @@ -1523,6 +1577,7 @@ getBundleArchiveInfo(hapFilePath: string, bundleFlags: [number](#bundleflag)): ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let hapFilePath = "/data/xxx/test.hap"; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; @@ -1530,11 +1585,12 @@ let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT; try { bundleManager.getBundleArchiveInfo(hapFilePath, bundleFlags).then((data) => { hilog.info(0x0000, 'testTag', 'getBundleArchiveInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getBundleArchiveInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleArchiveInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleArchiveInfo failed. Cause: %{public}s', message); } ``` @@ -1570,6 +1626,7 @@ cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback\): void; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; @@ -1582,7 +1639,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'cleanBundleCacheFiles failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'cleanBundleCacheFiles failed: %{public}s', message); } ``` @@ -1623,17 +1681,19 @@ cleanBundleCacheFiles(bundleName: string): Promise\; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; try { bundleManager.cleanBundleCacheFiles(bundleName).then(() => { hilog.info(0x0000, 'testTag', 'cleanBundleCacheFiles successfully.'); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'cleanBundleCacheFiles failed: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'cleanBundleCacheFiles failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'cleanBundleCacheFiles failed: %{public}s', message); } ``` @@ -1669,6 +1729,7 @@ setApplicationEnabled(bundleName: string, isEnabled: boolean, callback: AsyncCal ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; @@ -1681,7 +1742,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'setApplicationEnabled failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'setApplicationEnabled failed: %{public}s', message); } ``` @@ -1722,6 +1784,7 @@ setApplicationEnabled(bundleName: string, isEnabled: boolean): Promise\; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; @@ -1732,7 +1795,8 @@ try { hilog.error(0x0000, 'testTag', 'setApplicationEnabled failed: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'setApplicationEnabled failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'setApplicationEnabled failed: %{public}s', message); } ``` @@ -1769,6 +1833,7 @@ setAbilityEnabled(info: [AbilityInfo](js-apis-bundleManager-abilityInfo.md), isE ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -1794,7 +1859,8 @@ try { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -1836,6 +1902,7 @@ setAbilityEnabled(info: [AbilityInfo](js-apis-bundleManager-abilityInfo.md), isE ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -1859,7 +1926,8 @@ try { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -1892,6 +1960,7 @@ isApplicationEnabled(bundleName: string, callback: AsyncCallback\): voi ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; @@ -1904,7 +1973,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'isApplicationEnabled failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'isApplicationEnabled failed: %{public}s', message); } ``` @@ -1942,17 +2012,19 @@ isApplicationEnabled(bundleName: string): Promise\; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; try { bundleManager.isApplicationEnabled(bundleName).then((data) => { hilog.info(0x0000, 'testTag', 'isApplicationEnabled successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'isApplicationEnabled failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'isApplicationEnabled failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'isApplicationEnabled failed. Cause: %{public}s', message); } ``` @@ -1986,6 +2058,7 @@ isAbilityEnabled(info: [AbilityInfo](js-apis-bundleManager-abilityInfo.md), call ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -2007,11 +2080,12 @@ try { hilog.info(0x0000, 'testTag', 'isAbilityEnabled successfully: %{public}s', JSON.stringify(data)); } }); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -2050,6 +2124,7 @@ isAbilityEnabled(info: [AbilityInfo](js-apis-bundleManager-abilityInfo.md)): Pro ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let abilityFlags = bundleManager.AbilityFlag.GET_ABILITY_INFO_DEFAULT; let userId = 100; @@ -2073,7 +2148,8 @@ try { hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'queryAbilityInfo failed. Cause: %{public}s', message); } ``` @@ -2111,6 +2187,7 @@ getLaunchWantForBundle(bundleName: string, userId: number, callback: AsyncCallba ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let userId = 100; @@ -2124,7 +2201,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed: %{public}s', message); } ``` @@ -2160,6 +2238,7 @@ getLaunchWantForBundle(bundleName: string, callback: AsyncCallback\): void ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; @@ -2172,7 +2251,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed: %{public}s', message); } ``` @@ -2215,6 +2295,7 @@ getLaunchWantForBundle(bundleName: string, userId?: number): Promise\; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let userId = 100; @@ -2222,11 +2303,12 @@ let userId = 100; try { bundleManager.getLaunchWantForBundle(bundleName, userId).then((data) => { hilog.info(0x0000, 'testTag', 'getLaunchWantForBundle successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getLaunchWantForBundle failed. Cause: %{public}s', message); } ``` @@ -2263,6 +2345,7 @@ getProfileByAbility(moduleName: string, abilityName: string, metadataName: strin ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let moduleName = 'entry'; let abilityName = 'EntryAbility'; @@ -2277,7 +2360,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message); } ``` @@ -2319,6 +2403,7 @@ getProfileByAbility(moduleName: string, abilityName: string, metadataName?: stri ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let moduleName = 'entry'; let abilityName = 'EntryAbility'; @@ -2330,12 +2415,14 @@ try { hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message); } ``` ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let moduleName = 'entry'; let abilityName = 'EntryAbility'; @@ -2343,11 +2430,12 @@ let metadataName = 'com.example.myapplication.metadata'; try { bundleManager.getProfileByAbility(moduleName, abilityName, metadataName).then((data) => { hilog.info(0x0000, 'testTag', 'getProfileByAbility successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message); } ``` @@ -2383,6 +2471,7 @@ getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, m ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let moduleName = 'entry'; let extensionAbilityName = 'com.example.myapplication.extension'; @@ -2397,7 +2486,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed: %{public}s', message); } ``` @@ -2438,6 +2528,7 @@ getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, m ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let moduleName = 'entry'; let extensionAbilityName = 'com.example.myapplication.extension'; @@ -2446,21 +2537,23 @@ let metadataName = 'com.example.myapplication.metadata'; try { bundleManager.getProfileByExtensionAbility(moduleName, extensionAbilityName).then((data) => { hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbility successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', message); } try { bundleManager.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataName).then((data) => { hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbility successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', message); } ``` @@ -2495,6 +2588,7 @@ getPermissionDef(permissionName: string, callback: AsyncCallback\<[PermissionDef ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let permission = "ohos.permission.GET_BUNDLE_INFO"; try { @@ -2506,7 +2600,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getPermissionDef failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getPermissionDef failed: %{public}s', message); } ``` @@ -2546,16 +2641,18 @@ getPermissionDef(permissionName: string): Promise\<[PermissionDef](js-apis-bundl ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let permissionName = "ohos.permission.GET_BUNDLE_INFO"; try { bundleManager.getPermissionDef(permissionName).then((data) => { hilog.info(0x0000, 'testTag', 'getPermissionDef successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getPermissionDef failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getPermissionDef failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getPermissionDef failed. Cause: %{public}s', message); } ``` @@ -2596,6 +2693,7 @@ getAbilityLabel(bundleName: string, moduleName: string, abilityName: string, cal ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let moduleName = 'entry'; @@ -2610,7 +2708,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAbilityLabel failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAbilityLabel failed: %{public}s', message); } ``` @@ -2656,6 +2755,7 @@ getAbilityLabel(bundleName: string, moduleName: string, abilityName: string): Pr ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let moduleName = 'entry'; @@ -2664,11 +2764,12 @@ let abilityName = 'EntryAbility'; try { bundleManager.getAbilityLabel(bundleName, moduleName, abilityName).then((data) => { hilog.info(0x0000, 'testTag', 'getAbilityLabel successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getAbilityLabel failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAbilityLabel failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAbilityLabel failed. Cause: %{public}s', message); } ``` @@ -2713,6 +2814,7 @@ getApplicationInfoSync(bundleName: string, applicationFlags: number, userId: num ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let applicationFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; @@ -2722,7 +2824,8 @@ try { let data = bundleManager.getApplicationInfoSync(bundleName, applicationFlags, userId); hilog.info(0x0000, 'testTag', 'getApplicationInfoSync successfully: %{public}s', JSON.stringify(data)); } catch (err) { - hilog.error(0x0000, 'testTag', 'getApplicationInfoSync failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getApplicationInfoSync failed: %{public}s', message); } ``` @@ -2764,6 +2867,7 @@ getApplicationInfoSync(bundleName: string, applicationFlags: number) : [Applicat ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let applicationFlags = bundleManager.ApplicationFlag.GET_APPLICATION_INFO_DEFAULT; @@ -2772,7 +2876,8 @@ try { let data = bundleManager.getApplicationInfoSync(bundleName, applicationFlags); hilog.info(0x0000, 'testTag', 'getApplicationInfoSync successfully: %{public}s', JSON.stringify(data)); } catch (err) { - hilog.error(0x0000, 'testTag', 'getApplicationInfoSync failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getApplicationInfoSync failed: %{public}s', message); } ``` @@ -2816,6 +2921,7 @@ getBundleInfoSync(bundleName: string, bundleFlags: [number](#bundleflag), userId ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION; @@ -2825,7 +2931,8 @@ try { let data = bundleManager.getBundleInfoSync(bundleName, bundleFlags, userId); hilog.info(0x0000, 'testTag', 'getBundleInfoSync successfully: %{public}s', JSON.stringify(data)); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfoSync failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfoSync failed: %{public}s', message); } ``` @@ -2867,6 +2974,7 @@ getBundleInfoSync(bundleName: string, bundleFlags: [number](#bundleflag)): [Bund ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION; @@ -2874,7 +2982,8 @@ try { let data = bundleManager.getBundleInfoSync(bundleName, bundleFlags); hilog.info(0x0000, 'testTag', 'getBundleInfoSync successfully: %{public}s', JSON.stringify(data)); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfoSync failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfoSync failed: %{public}s', message); } ``` @@ -2911,6 +3020,7 @@ getSharedBundleInfo(bundleName: string, moduleName: string, callback: AsyncCall ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = 'com.example.myapplication'; let moduleName = 'library'; @@ -2924,7 +3034,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getSharedBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getSharedBundleInfo failed: %{public}s', message); } ``` @@ -2966,6 +3077,7 @@ getSharedBundleInfo(bundleName: string, moduleName: string): Promise\ { hilog.info(0x0000, 'testTag', 'getSharedBundleInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getSharedBundleInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getSharedBundleInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getSharedBundleInfo failed. Cause: %{public}s', message); } ``` @@ -3003,6 +3116,7 @@ getAllSharedBundleInfo(callback: AsyncCallback\\>): vo ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; try { @@ -3014,7 +3128,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllSharedBundleInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllSharedBundleInfo failed: %{public}s', message); } ``` @@ -3040,6 +3155,7 @@ getAllSharedBundleInfo(): Promise\\>; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; try { @@ -3049,7 +3165,8 @@ try { hilog.error(0x0000, 'testTag', 'getAllSharedBundleInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAllSharedBundleInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAllSharedBundleInfo failed. Cause: %{public}s', message); } ``` @@ -3084,6 +3201,7 @@ getAppProvisionInfo(bundleName: string, callback: AsyncCallback\<[AppProvisionIn ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; @@ -3096,7 +3214,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed: %{public}s', message); } ``` @@ -3134,6 +3253,7 @@ getAppProvisionInfo(bundleName: string, userId: number, callback: AsyncCallback\ ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; let userId = 100; @@ -3147,7 +3267,8 @@ try { } }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed: %{public}s', message); } ``` @@ -3190,6 +3311,7 @@ getAppProvisionInfo(bundleName: string, userId?: number): Promise\<[AppProvision ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleName = "com.ohos.myapplication"; let userId = 100; @@ -3197,21 +3319,23 @@ let userId = 100; try { bundleManager.getAppProvisionInfo(bundleName).then((data) => { hilog.info(0x0000, 'testTag', 'getAppProvisionInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', message); } try { bundleManager.getAppProvisionInfo(bundleName, userId).then((data) => { hilog.info(0x0000, 'testTag', 'getAppProvisionInfo successfully. Data: %{public}s', JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', err.message); }); } catch (err) { - hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getAppProvisionInfo failed. Cause: %{public}s', message); } ``` @@ -3249,13 +3373,15 @@ getSpecifiedDistributionType(bundleName: string): string; **示例:** ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication"; try { let type = bundleManager.getSpecifiedDistributionType(bundleName); console.info('getSpecifiedDistributionType successfully, type:' + type); } catch (error) { - console.error('getSpecifiedDistributionType failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getSpecifiedDistributionType failed. Cause: ' + message); } ``` @@ -3296,13 +3422,15 @@ getAdditionalInfo(bundleName: string): string; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication"; try { let info = bundleManager.getAdditionalInfo(bundleName); console.info('getAdditionalInfo successfully, additionInfo:' + info); } catch (error) { - console.error('getAdditionalInfo failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getAdditionalInfo failed. Cause: ' + message); } ``` @@ -3330,12 +3458,14 @@ getBundleInfoForSelfSync(bundleFlags: number): BundleInfo; ```ts import bundleManager from '@ohos.bundle.bundleManager'; +import { BusinessError } from '@ohos.base'; import hilog from '@ohos.hilog'; let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION; try { let data = bundleManager.getBundleInfoForSelfSync(bundleFlags); hilog.info(0x0000, 'testTag', 'getBundleInfoForSelfSync successfully: %{public}s', JSON.stringify(data)); } catch (err) { - hilog.error(0x0000, 'testTag', 'getBundleInfoForSelfSync failed: %{public}s', err.message); + let message = (err as BusinessError).message; + hilog.error(0x0000, 'testTag', 'getBundleInfoForSelfSync failed: %{public}s', message); } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index 7cb58125b8042d6a8d188749c7fa6a6a1344c665..81ced42f9133db97a0b9d378f2d884e677ed59b0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -312,6 +312,44 @@ CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber) ``` +## CommonEventManager.createSubscriberSync + +createSubscriberSync(subscribeInfo: CommonEventSubscribeInfo): CommonEventSubscriber + +createSubscriber的同步接口。 + +**系统能力:** SystemCapability.Notification.CommonEvent + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | ----------------------------------------------------- | ---- | -------------- | +| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 | + +**返回值:** +| 类型 | 说明 | +| --------------------------------------------------------- | ---------------- | +| [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 返回订阅者对象。 | + +**示例:** + +```ts +let subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作 + +//订阅者信息 +let subscribeInfo = { + events: ["event"] +}; + +//创建订阅者 +try { + subscriber = CommonEventManager.createSubscriberSync(subscribeInfo); +} catch (err) { + console.error(`createSubscriberSync failed, code is ${err.code}, message is ${err.message}`); +} + +``` + ## CommonEventManager.subscribe subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationManager.md b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationManager.md index b2d36361def6fdb491a82d8a267a0419ef633687..3d01e4d6920cd44b9fd595403349efb90f3fbe16 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationManager.md @@ -43,7 +43,8 @@ register(callback: AsyncCallback\): void; **示例:** ```ts - let token = -1; + import continuationManager from '@ohos.continuation.continuationManager' + let token: number = -1; continuationManager.register((err, data) => { if (err.code != 0) { console.error('register failed, cause: ' + JSON.stringify(err)); @@ -85,17 +86,19 @@ register(options: ContinuationExtraParams, callback: AsyncCallback\): vo **示例:** ```ts - let token = -1; - let continuationExtraParams = { - deviceType: ["00E"] - }; - continuationManager.register(continuationExtraParams, (err, data) => { - if (err.code != 0) { - console.error('register failed, cause: ' + JSON.stringify(err)); - return; - } - console.info('register finished, ' + JSON.stringify(data)); - token = data; + import continuationManager from '@ohos.continuation.continuationManager' + let token: number = -1; + continuationManager.register( + { + deviceType: ["00E"] + }, + (err, data) => { + if (err.code != 0) { + console.error('register failed, cause: ' + JSON.stringify(err)); + return; + } + console.info('register finished, ' + JSON.stringify(data)); + token = data; }); ``` @@ -135,18 +138,16 @@ register(options?: ContinuationExtraParams): Promise\; **示例:** ```ts - let token = -1; - let continuationExtraParams = { - deviceType: ["00E"] - }; - continuationManager.register(continuationExtraParams) - .then((data) => { + import continuationManager from '@ohos.continuation.continuationManager' + import { BusinessError } from '@ohos.base'; + let token: number = -1; + continuationManager.register( + { deviceType: ["00E"] }).then((data) => { console.info('register finished, ' + JSON.stringify(data)); token = data; - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('register failed, cause: ' + JSON.stringify(err)); - }); + }); ``` ## continuationManager.registerContinuation9+ @@ -177,7 +178,8 @@ registerContinuation(callback: AsyncCallback\): void; **示例:** ```ts - let token = -1; + import continuationManager from '@ohos.continuation.continuationManager' + let token: number = -1; try { continuationManager.registerContinuation((err, data) => { if (err.code != 0) { @@ -221,18 +223,20 @@ registerContinuation(options: ContinuationExtraParams, callback: AsyncCallback\< **示例:** ```ts - let token = -1; - let continuationExtraParams = { - deviceType: ["00E"] - }; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = -1; try { - continuationManager.registerContinuation(continuationExtraParams, (err, data) => { - if (err.code != 0) { - console.error('registerContinuation failed, cause: ' + JSON.stringify(err)); - return; - } - console.info('registerContinuation finished, ' + JSON.stringify(data)); - token = data; + continuationManager.registerContinuation( + { + deviceType: ["00E"] + }, + (err, data) => { + if (err.code != 0) { + console.error('registerContinuation failed, cause: ' + JSON.stringify(err)); + return; + } + console.info('registerContinuation finished, ' + JSON.stringify(data)); + token = data; }); } catch (err) { console.error('registerContinuation failed, cause: ' + JSON.stringify(err)); @@ -273,19 +277,19 @@ registerContinuation(options?: ContinuationExtraParams): Promise\; **示例:** ```ts - let token = -1; - let continuationExtraParams = { - deviceType: ["00E"] - }; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = -1; try { - continuationManager.register(continuationExtraParams) - .then((data) => { + continuationManager.register( + { + deviceType: ["00E"] + }).then((data) => { console.info('registerContinuation finished, ' + JSON.stringify(data)); token = data; - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('registerContinuation failed, cause: ' + JSON.stringify(err)); - }); + }); } catch (err) { console.error('registerContinuation failed, cause: ' + JSON.stringify(err)); } @@ -324,6 +328,7 @@ on(type: "deviceConnect", callback: Callback\): void; **示例:** ```ts + import continuationManager from '@ohos.continuation.continuationManager'; continuationManager.on("deviceConnect", (data) => { console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id)); console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type)); @@ -363,6 +368,7 @@ on(type: "deviceDisconnect", callback: Callback\): void; **示例:** ```ts + import continuationManager from '@ohos.continuation.continuationManager'; continuationManager.on("deviceDisconnect", (data) => { console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data)); }); @@ -400,6 +406,7 @@ off(type: "deviceConnect", callback?: Callback\): void; **示例:** ```ts + import continuationManager from '@ohos.continuation.continuationManager'; continuationManager.off("deviceConnect", (data) => { console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id)); console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type)); @@ -439,6 +446,7 @@ off(type: "deviceDisconnect", callback?: Callback\): void; **示例:** ```ts + import continuationManager from '@ohos.continuation.continuationManager'; continuationManager.off("deviceDisconnect", (data) => { console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data)); }); @@ -475,7 +483,8 @@ on(type: "deviceSelected", token: number, callback: Callback\ { console.info('onDeviceSelected len: ' + data.length); @@ -521,7 +530,8 @@ on(type: "deviceUnselected", token: number, callback: Callback\ { console.info('onDeviceUnselected len: ' + data.length); @@ -567,7 +577,8 @@ off(type: "deviceSelected", token: number): void; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; try { continuationManager.off("deviceSelected", token); } catch (err) { @@ -605,7 +616,8 @@ off(type: "deviceUnselected", token: number): void; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; try { continuationManager.off("deviceUnselected", token); } catch (err) { @@ -646,7 +658,8 @@ startDeviceManager(token: number, callback: AsyncCallback\): void; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; continuationManager.startDeviceManager(token, (err, data) => { if (err.code != 0) { console.error('startDeviceManager failed, cause: ' + JSON.stringify(err)); @@ -690,16 +703,19 @@ startDeviceManager(token: number, options: ContinuationExtraParams, callback: As **示例:** ```ts - let token = 1; - let continuationExtraParams = { - deviceType: ["00E"] - }; - continuationManager.startDeviceManager(token, continuationExtraParams, (err, data) => { - if (err.code != 0) { - console.error('startDeviceManager failed, cause: ' + JSON.stringify(err)); - return; - } - console.info('startDeviceManager finished, ' + JSON.stringify(data)); + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; + continuationManager.startDeviceManager( + token, + { + deviceType: ["00E"] + }, + (err, data) => { + if (err.code != 0) { + console.error('startDeviceManager failed, cause: ' + JSON.stringify(err)); + return; + } + console.info('startDeviceManager finished, ' + JSON.stringify(data)); }); ``` @@ -742,17 +758,18 @@ startDeviceManager(token: number, options?: ContinuationExtraParams): Promise\ { + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = -1; + continuationManager.startDeviceManager( + token, + { + deviceType: ["00E"] + }).then((data) => { console.info('startDeviceManager finished, ' + JSON.stringify(data)); - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('startDeviceManager failed, cause: ' + JSON.stringify(err)); - }); + }); ``` ## continuationManager.startContinuationDeviceManager9+ @@ -784,7 +801,8 @@ startContinuationDeviceManager(token: number, callback: AsyncCallback\): v **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = -1; try { continuationManager.startContinuationDeviceManager(token, (err, data) => { if (err.code != 0) { @@ -828,17 +846,20 @@ startContinuationDeviceManager(token: number, options: ContinuationExtraParams, **示例:** ```ts - let token = 1; - let continuationExtraParams = { - deviceType: ["00E"] - }; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = -1; try { - continuationManager.startContinuationDeviceManager(token, continuationExtraParams, (err, data) => { - if (err.code != 0) { - console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err)); - return; - } - console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data)); + continuationManager.startContinuationDeviceManager( + token, + { + deviceType: ["00E"] + }, + (err, data) => { + if (err.code != 0) { + console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err)); + return; + } + console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data)); }); } catch (err) { console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err)); @@ -880,16 +901,17 @@ startContinuationDeviceManager(token: number, options?: ContinuationExtraParams) **示例:** ```ts - let token = 1; - let continuationExtraParams = { - deviceType: ["00E"] - }; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = -1; try { - continuationManager.startContinuationDeviceManager(token, continuationExtraParams) - .then((data) => { + continuationManager.startContinuationDeviceManager( + token, + { + deviceType: ["00E"] + }).then((data) => { console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data)); - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err)); }); } catch (err) { @@ -932,7 +954,8 @@ updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState, **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = -1; let deviceId: string = "test deviceId"; continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED, (err, data) => { if (err.code != 0) { @@ -983,15 +1006,17 @@ updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState) **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = 1; let deviceId: string = "test deviceId"; continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED) .then((data) => { console.info('updateConnectStatus finished, ' + JSON.stringify(data)); }) - .catch((err) => { + .catch((err: BusinessError) => { console.error('updateConnectStatus failed, cause: ' + JSON.stringify(err)); - }); + }); ``` ## continuationManager.updateContinuationState9+ @@ -1025,7 +1050,8 @@ updateContinuationState(token: number, deviceId: string, status: DeviceConnectSt **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; let deviceId: string = "test deviceId"; try { continuationManager.updateContinuationState(token, deviceId, continuationManager.DeviceConnectState.CONNECTED, (err, data) => { @@ -1076,14 +1102,16 @@ updateContinuationState(token: number, deviceId: string, status: DeviceConnectSt **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = 1; let deviceId: string = "test deviceId"; try { continuationManager.updateContinuationState(token, deviceId, continuationManager.DeviceConnectState.CONNECTED) .then((data) => { console.info('updateContinuationState finished, ' + JSON.stringify(data)); }) - .catch((err) => { + .catch((err: BusinessError) => { console.error('updateContinuationState failed, cause: ' + JSON.stringify(err)); }); } catch (err) { @@ -1122,7 +1150,8 @@ unregister(token: number, callback: AsyncCallback\): void; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + let token: number = 1; continuationManager.unregister(token, (err, data) => { if (err.code != 0) { console.error('unregister failed, cause: ' + JSON.stringify(err)); @@ -1167,14 +1196,15 @@ unregister(token: number): Promise\; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = 1; continuationManager.unregister(token) .then((data) => { console.info('unregister finished, ' + JSON.stringify(data)); - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('unregister failed, cause: ' + JSON.stringify(err)); - }); + }); ``` ## continuationManager.unregisterContinuation9+ @@ -1206,7 +1236,9 @@ unregisterContinuation(token: number, callback: AsyncCallback\): void; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = 1; try { continuationManager.unregisterContinuation(token, (err, data) => { if (err.code != 0) { @@ -1254,15 +1286,15 @@ unregisterContinuation(token: number): Promise\; **示例:** ```ts - let token = 1; + import continuationManager from '@ohos.continuation.continuationManager'; + import { BusinessError } from '@ohos.base'; + let token: number = -1; try { - continuationManager.unregisterContinuation(token) - .then((data) => { + continuationManager.unregisterContinuation(token).then((data) => { console.info('unregisterContinuation finished, ' + JSON.stringify(data)); - }) - .catch((err) => { + }).catch((err: BusinessError) => { console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err)); - }); + }); } catch (err) { console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err)); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-curve.md b/zh-cn/application-dev/reference/apis/js-apis-curve.md index fff376653d0a691788e8623a0bd2e880de014476..4083dbbdb96fea6d4670808dfbbab26a9571e2e1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-curve.md +++ b/zh-cn/application-dev/reference/apis/js-apis-curve.md @@ -279,9 +279,9 @@ customCurve(interpolate: (fraction: number) => number): ICurve ```ts import Curves from '@ohos.curves' -let interpolate = function(fraction) { - return Math.sqrt(fraction) - } +let interpolate = (fraction:number):number => { + return Math.sqrt(fraction) +} let curve = Curves.customCurve(interpolate) // 创建一个用户自定义插值曲线 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributedBundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-distributedBundleManager.md index 4bcaceb89bd653ad30a3b634672cf98bd3ca4844..5d9654659cfd3b00842c085f097d90a04e143bc7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributedBundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributedBundleManager.md @@ -59,13 +59,16 @@ getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback\ { + }, (err: BusinessError, data: distributedBundle.RemoteAbilityInfo) => { if (err) { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); } else { @@ -73,7 +76,9 @@ try { } }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -115,19 +120,24 @@ getRemoteAbilityInfo(elementName: ElementName): Promise\; **示例:** ```ts +import distributedBundle from '@ohos.bundle.distributedBundleManager'; +import { BusinessError } from '@ohos.base'; + try { distributedBundle.getRemoteAbilityInfo( { deviceId: '1', bundleName: 'com.example.application', abilityName: 'EntryAbility' - }).then(data => { + }).then((data: distributedBundle.RemoteAbilityInfo) => { console.info('Operation succeed:' + JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -164,6 +174,9 @@ getRemoteAbilityInfo(elementNames: Array\, callback: AsyncCallback\ **示例:** ```ts +import distributedBundle from '@ohos.bundle.distributedBundleManager'; +import { BusinessError } from '@ohos.base'; + try { distributedBundle.getRemoteAbilityInfo( [ @@ -177,7 +190,7 @@ try { bundleName: 'com.example.application2', abilityName: 'EntryAbility' } - ], (err, data) => { + ], (err: BusinessError, data: distributedBundle.RemoteAbilityInfo[]) => { if (err) { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); } else { @@ -185,7 +198,9 @@ try { } }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -227,6 +242,9 @@ getRemoteAbilityInfo(elementNames: Array\): Promise\ { + ]).then((data: distributedBundle.RemoteAbilityInfo[]) => { console.info('Operation succeed:' + JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -284,13 +304,16 @@ getRemoteAbilityInfo(elementName: ElementName, locale: string, callback: AsyncCa **示例:** ```ts +import distributedBundle from '@ohos.bundle.distributedBundleManager'; +import { BusinessError } from '@ohos.base'; + try { distributedBundle.getRemoteAbilityInfo( { deviceId: '1', bundleName: 'com.example.application', abilityName: 'EntryAbility' - }, 'zh-Hans-CN', (err, data) => { + }, 'zh-Hans-CN', (err: BusinessError, data: distributedBundle.RemoteAbilityInfo) => { if (err) { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); } else { @@ -298,7 +321,9 @@ try { } }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -341,19 +366,24 @@ getRemoteAbilityInfo(elementName: ElementName, locale: string): Promise\ { + }, 'zh-Hans-CN').then((data: distributedBundle.RemoteAbilityInfo) => { console.info('Operation succeed:' + JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -391,6 +421,9 @@ getRemoteAbilityInfo(elementNames: Array\, locale: string, callback **示例:** ```ts +import distributedBundle from '@ohos.bundle.distributedBundleManager'; +import { BusinessError } from '@ohos.base'; + try { distributedBundle.getRemoteAbilityInfo( [ @@ -404,7 +437,7 @@ try { bundleName: 'com.example.application2', abilityName: 'EntryAbility' } - ], 'zh-Hans-CN', (err, data) => { + ], 'zh-Hans-CN', (err: BusinessError, data: distributedBundle.RemoteAbilityInfo[]) => { if (err) { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); } else { @@ -412,7 +445,9 @@ try { } }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` @@ -455,6 +490,9 @@ getRemoteAbilityInfo(elementNames: Array\, locale: string): Promise **示例:** ```ts +import distributedBundle from '@ohos.bundle.distributedBundleManager'; +import { BusinessError } from '@ohos.base'; + try { distributedBundle.getRemoteAbilityInfo( [ @@ -468,12 +506,14 @@ try { bundleName: 'com.example.application2', abilityName: 'EntryAbility' } - ], 'zh-Hans-CN').then(data => { + ], 'zh-Hans-CN').then((data: distributedBundle.RemoteAbilityInfo[]) => { console.info('Operation succeed:' + JSON.stringify(data)); - }).catch(err => { + }).catch((err: BusinessError) => { console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); }); } catch (err) { - console.log(`Operation failed: error code is ${err.code} and error message is ${err.message}`); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log(`Operation failed: error code is ${code} and error message is ${message}`); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md b/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md index 9ec3d73d699ae14b1a3b47ae0b01c3d22c799099..b5461d61226d09ae500940a58228b3a60dce8721 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md @@ -35,34 +35,35 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, **示例:** ```ts - function NotifyMissionsChanged(deviceId) { - console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId)); + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; + function NotifyMissionsChanged(deviceId: string): void { + console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId)); } - function NotifySnapshot(deviceId, missionId) { - console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId)); - console.log('NotifySnapshot missionId ' + JSON.stringify(missionId)); + function NotifySnapshot(deviceId: string, missionId: number): void { + console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId)); + console.log('NotifySnapshot missionId ' + JSON.stringify(missionId)); } - function NotifyNetDisconnect(deviceId, state) { - console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId)); - console.log('NotifyNetDisconnect state ' + JSON.stringify(state)); - } - var parameter = { - deviceId: "" - }; - var options = { - notifyMissionsChanged: NotifyMissionsChanged, - notifySnapshot: NotifySnapshot, - notifyNetDisconnect: NotifyNetDisconnect + function NotifyNetDisconnect(deviceId: string, state: number): void { + console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId)); + console.log('NotifyNetDisconnect state ' + JSON.stringify(state)); } try { - distributedMissionManager.registerMissionListener(parameter, options, (error) => { - if (error.code != 0) { - console.error('registerMissionListener failed, cause: ' + JSON.stringify(error)) - } - console.info('registerMissionListener finished') - }) + distributedMissionManager.registerMissionListener( + { deviceId: "" }, + { + notifyMissionsChanged: NotifyMissionsChanged, + notifySnapshot: NotifySnapshot, + notifyNetDisconnect: NotifyNetDisconnect + }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('registerMissionListener failed, cause: ' + JSON.stringify(error)) + } + console.info('registerMissionListener finished') + }); } catch (error) { - console.error('registerMissionListener failed, cause: ' + JSON.stringify(error)) + console.error('registerMissionListener failed, cause: ' + JSON.stringify(error)) } ``` ## distributedMissionManager.registerMissionListener @@ -91,30 +92,29 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): **示例:** ```ts - function NotifyMissionsChanged(deviceId) { - console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId)); + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; + function NotifyMissionsChanged(deviceId: string): void { + console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId)); } - function NotifySnapshot(deviceId, missionId) { - console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId)); - console.log('NotifySnapshot missionId ' + JSON.stringify(missionId)); + function NotifySnapshot(deviceId: string, missionId: number): void { + console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId)); + console.log('NotifySnapshot missionId ' + JSON.stringify(missionId)); } - function NotifyNetDisconnect(deviceId, state) { - console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId)); - console.log('NotifyNetDisconnect state ' + JSON.stringify(state)); - } - var parameter = { - deviceId: "" - }; - var options = { - notifyMissionsChanged: NotifyMissionsChanged, - notifySnapshot: NotifySnapshot, - notifyNetDisconnect: NotifyNetDisconnect + function NotifyNetDisconnect(deviceId: string, state: number): void { + console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId)); + console.log('NotifyNetDisconnect state ' + JSON.stringify(state)); } try { - distributedMissionManager.registerMissionListener(parameter, options) - .then(data => { + distributedMissionManager.registerMissionListener( + { deviceId: "" }, + { + notifyMissionsChanged: NotifyMissionsChanged, + notifySnapshot: NotifySnapshot, + notifyNetDisconnect: NotifyNetDisconnect + }).then((data: void) => { console.info('registerMissionListener finished, ' + JSON.stringify(data)); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('registerMissionListener failed, cause: ' + JSON.stringify(error)); }) } catch (error) { @@ -142,16 +142,17 @@ unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback& **示例:** ```ts - var parameter = { - deviceId: "" - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.unRegisterMissionListener(parameter, (error) => { - if (error.code != 0) { - console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)) - } - console.info('unRegisterMissionListener finished') - }) + distributedMissionManager.unRegisterMissionListener( + { deviceId: "" }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)) + } + console.info('unRegisterMissionListener finished') + }) } catch (error) { console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)) } @@ -182,16 +183,14 @@ unRegisterMissionListener(parameter: MissionDeviceInfo): Promise<void> **示例:** ```ts - var parameter = { - deviceId: "" - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.unRegisterMissionListener(parameter) - .then(data => { - console.info('unRegisterMissionListener finished, ' + JSON.stringify(data)); - }).catch(error => { - console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)); - }) + distributedMissionManager.unRegisterMissionListener({deviceId: ""}).then(() => { + console.info('unRegisterMissionListener finished successfully'); + }).catch((error: BusinessError) => { + console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)); + }) } catch (error) { console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error)) } @@ -217,20 +216,23 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback< **示例:** ```ts - var parameter = { - deviceId: "", - fixConflict: false, - tag: 0 - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.startSyncRemoteMissions(parameter, (error) => { - if (error.code != 0) { - console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) - } - console.info('startSyncRemoteMissions finished') - }) + distributedMissionManager.startSyncRemoteMissions( + { + deviceId: "", + fixConflict: false, + tag: 0 + }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + } + console.info('startSyncRemoteMissions finished')} + ) } catch (error) { - console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) } ``` @@ -259,20 +261,22 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise<void> **示例:** ```ts - var parameter = { - deviceId: "", - fixConflict: false, - tag: 0 - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.startSyncRemoteMissions(parameter) - .then(data => { - console.info('startSyncRemoteMissions finished, ' + JSON.stringify(data)); - }).catch(error => { - console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)); - }) + distributedMissionManager.startSyncRemoteMissions( + { + deviceId: "", + fixConflict: false, + tag: 0 + } + ).then(() => { + console.info('startSyncRemoteMissions finished successfully'); + }).catch((error: BusinessError) => { + console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)); + }) } catch (error) { - console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) } ``` @@ -296,18 +300,21 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback< **示例:** ```ts - var parameter = { - deviceId: "" - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.stopSyncRemoteMissions(parameter, (error) => { - if (error.code != 0) { - console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) - } - console.info('stopSyncRemoteMissions finished') - }) + distributedMissionManager.stopSyncRemoteMissions( + { + deviceId: "" + }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + } + console.info('stopSyncRemoteMissions finished')} + ) } catch (error) { - console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) } ``` @@ -336,18 +343,19 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise<void> **示例:** ```ts - var parameter = { - deviceId: "" - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.stopSyncRemoteMissions(parameter) - .then(data => { - console.info('stopSyncRemoteMissions finished, ' + JSON.stringify(data)); - }).catch(error => { - console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)); - }) + distributedMissionManager.stopSyncRemoteMissions( + { + deviceId: "" + }).then((data: void) => { + console.info('stopSyncRemoteMissions finished successfully'); + }).catch((error: BusinessError) => { + console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)); + }) } catch (error) { - console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) + console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error)) } ``` @@ -385,27 +393,28 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba **示例:** ```ts - var parameter = { - srcDeviceId: "", - dstDeviceId: "", - missionId: 1, - wantParam: {"key": "value"} - }; - function onContinueDone(resultCode) { - console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode)); - }; - var options = { - onContinueDone: onContinueDone + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; + function onContinueDone(resultCode: number): void { + console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode)); }; try { - distributedMissionManager.continueMission(parameter, options, (error) => { - if (error.code != 0) { - console.error('continueMission failed, cause: ' + JSON.stringify(error)) - } - console.info('continueMission finished') - }) + distributedMissionManager.continueMission( + { + srcDeviceId: "", + dstDeviceId: "", + missionId: 1, + wantParam: {"key": "value"} + }, + { onContinueDone: onContinueDone }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('continueMission failed, cause: ' + JSON.stringify(error)) + } + console.info('continueMission finished') + }) } catch (error) { - console.error('continueMission failed, cause: ' + JSON.stringify(error)) + console.error('continueMission failed, cause: ' + JSON.stringify(error)) } ``` @@ -448,27 +457,26 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi **示例:** ```ts - var parameter = { - srcDeviceId: "", - dstDeviceId: "", - missionId: 1, - wantParam: {"key": "value"} - }; - function onContinueDone(resultCode) { - console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode)); - }; - var options = { - onContinueDone: onContinueDone + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; + function onContinueDone(resultCode: number): void { + console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode)); }; try { - distributedMissionManager.continueMission(parameter, options) - .then(data => { - console.info('continueMission finished, ' + JSON.stringify(data)); - }).catch(error => { - console.error('continueMission failed, cause: ' + JSON.stringify(error)); - }) + distributedMissionManager.continueMission( + { + srcDeviceId: "", + dstDeviceId: "", + missionId: 1, + wantParam: {"key": "value"} + }, + { onContinueDone: onContinueDone }).then(() => { + console.info('continueMission finished successfully'); + }).catch((error: BusinessError) => { + console.error('continueMission failed, cause: ' + JSON.stringify(error)); + }) } catch (error) { - console.error('continueMission failed, cause: ' + JSON.stringify(error)) + console.error('continueMission failed, cause: ' + JSON.stringify(error)) } ``` @@ -505,21 +513,24 @@ continueMission(parameter: ContinueMissionInfo, callback: AsyncCallback<void& **示例:** ```ts - var parameter = { - srcDeviceId: "", - dstDeviceId: "", - bundleName: "ohos.test.continueapp", - wantParam: {"key": "value"} - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.continueMission(parameter, (error) => { - if (error.code != 0) { - console.error('continueMission failed, cause: ' + JSON.stringify(error)) - } - console.info('continueMission finished') - }) + distributedMissionManager.continueMission( + { + srcDeviceId: "", + dstDeviceId: "", + bundleName: "ohos.test.continueapp", + wantParam: {"key": "value"} + }, + (error: BusinessError) => { + if (error.code != 0) { + console.error('continueMission failed, cause: ' + JSON.stringify(error)) + } + console.info('continueMission finished') + }) } catch (error) { - console.error('continueMission failed, cause: ' + JSON.stringify(error)) + console.error('continueMission failed, cause: ' + JSON.stringify(error)) } ``` @@ -561,17 +572,19 @@ continueMission(parameter: ContinueMissionInfo): Promise<void> **示例:** ```ts - var parameter = { - srcDeviceId: "", - dstDeviceId: "", - bundleName: "ohos.test.continueapp", - wantParam: {"key": "value"} - }; + import distributedMissionManager from '@ohos.distributedMissionManager' + import { BusinessError } from '@ohos.base'; try { - distributedMissionManager.continueMission(parameter) - .then(data => { - console.info('continueMission finished, ' + JSON.stringify(data)); - }).catch(error => { + distributedMissionManager.continueMission( + { + srcDeviceId: "", + dstDeviceId: "", + bundleName: "ohos.test.continueapp", + wantParam: {"key": "value"} + } + ).then(() => { + console.info('continueMission finished successfully'); + }).catch((error: BusinessError) => { console.error('continueMission failed, cause: ' + JSON.stringify(error)); }) } catch (error) { @@ -599,12 +612,13 @@ on(type: 'continueStateChange', callback: Callback<{ state: ContinueState, i **示例:** ```js + import distributedMissionManager from '@ohos.distributedMissionManager' try { distributedMissionManager.on('continueStateChange', (data) => { console.info("continueStateChange on:" + JSON.stringify(data)); }); - } catch (err) { - console.error("continueStateChange errCode:" + err.code + ",errMessage:" + err.message); + } catch (error) { + console.error("continueStateChange err: " + JSON.stringify(error)); } ``` @@ -628,12 +642,13 @@ off(type: 'continueStateChange', callback?: Callback<{ state: ContinueState, **示例:** ```js + import distributedMissionManager from '@ohos.distributedMissionManager' try { distributedMissionManager.off('continueStateChange', (data) => { - console.info("continueStateChange on:" + JSON.stringify(data)); + console.info("continueStateChange off:" + JSON.stringify(data)); }); } catch (err) { - console.error("continueStateChange errCode:" + err.code + ",errMessage:" + err.message); + console.error("continueStateChange err: " + JSON.stringify(error)); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-accountManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-accountManager.md index c2de9f0163503ba56c098ee511fb2121d98a431d..bee740610ffb97964ebae60284dfec48e1c9c4d4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-accountManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-accountManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import accountManager from '@ohos.enterprise.accountManager'; ``` @@ -47,8 +47,9 @@ disallowAddLocalAccount(admin: Want, disallow: boolean, callback: AsyncCallback& **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -98,15 +99,17 @@ disallowAddLocalAccount(admin: Want, disallow: boolean): Promise<void> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; accountManager.disallowAddLocalAccount(wantTemp, true).then(() => { console.info('Succeeded in disallowing add local account'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to disallow add local account. Code: ${err.code}, message: ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md index 1fb8c5e88895f684445bace3a5e6287433071f73..858be249734e023e1aa362e25cb3832aa2d017c8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import adminManager from '@ohos.enterprise.adminManager'; ``` @@ -49,12 +49,13 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callba **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let enterpriseInfo = { +let enterpriseInfo: adminManager.EnterpriseInfo = { name: 'enterprise name', description: 'enterprise description' } @@ -102,12 +103,13 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let enterpriseInfo = { +let enterpriseInfo: adminManager.EnterpriseInfo = { name: 'enterprise name', description: 'enterprise description' } @@ -160,19 +162,22 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let enterpriseInfo = { +let enterpriseInfo: adminManager.EnterpriseInfo = { name: 'enterprise name', description: 'enterprise description' } -adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100).catch((err) => { - console.error(`Failed to enable admin. Code: ${err.code}, message: ${err.message}`); -}); +adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100).catch( + (err: BusinessError) => { + console.error(`Failed to enable admin. Code: ${err.code}, message: ${err.message}`); + }); ``` ## adminManager.disableAdmin @@ -204,8 +209,9 @@ disableAdmin(admin: Want, callback: AsyncCallback\): void **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -249,8 +255,9 @@ disableAdmin(admin: Want, userId: number, callback: AsyncCallback\): void **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -299,13 +306,15 @@ disableAdmin(admin: Want, userId?: number): Promise\ **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -adminManager.disableAdmin(wantTemp, 100).catch((err) => { +adminManager.disableAdmin(wantTemp, 100).catch((err: BusinessError) => { console.error(`Failed to disable admin. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -339,8 +348,9 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\): void **示例**: -```js -let bundleName = 'com.example.myapplication'; +```ts +import Want from '@ohos.app.ability.Want'; +let bundleName: string = 'com.example.myapplication'; adminManager.disableSuperAdmin(bundleName, (err) => { if (err) { @@ -385,10 +395,12 @@ disableSuperAdmin(bundleName: String): Promise\ **示例**: -```js -let bundleName = 'com.example.myapplication'; +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let bundleName: string = 'com.example.myapplication'; -adminManager.disableSuperAdmin(bundleName).catch((err) => { +adminManager.disableSuperAdmin(bundleName).catch((err: BusinessError) => { console.error(`Failed to disable super admin. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -412,8 +424,9 @@ isAdminEnabled(admin: Want, callback: AsyncCallback\): void **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -447,8 +460,9 @@ isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\): **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -487,15 +501,17 @@ isAdminEnabled(admin: Want, userId?: number): Promise\ **示例**: -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; adminManager.isAdminEnabled(wantTemp, 100).then((result) => { console.info(`Succeeded in querying admin is enabled or not, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query admin is enabled or not. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -519,8 +535,9 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\): void **示例**: -```js -let bundleName = 'com.example.myapplication'; +```ts +import Want from '@ohos.app.ability.Want'; +let bundleName: string = 'com.example.myapplication'; adminManager.isSuperAdmin(bundleName, (err, result) => { if (err) { @@ -555,12 +572,14 @@ isSuperAdmin(bundleName: String): Promise\ **示例**: -```js -let bundleName = 'com.example.myapplication'; +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let bundleName: string = 'com.example.myapplication'; adminManager.isSuperAdmin(bundleName).then((result) => { console.info(`Succeeded in querying admin is super admin or not, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query admin is super admin or not. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -595,12 +614,13 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCa **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let enterpriseInfo = { +let enterpriseInfo: adminManager.EnterpriseInfo = { name: 'enterprise name', description: 'enterprise description' } @@ -649,17 +669,19 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise\; **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let enterpriseInfo = { +let enterpriseInfo: adminManager.EnterpriseInfo = { name: 'enterprise name', description: 'enterprise description' } -adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo).catch((err) => { +adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo).catch((err: BusinessError) => { console.error(`Failed to set enterprise info. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -691,8 +713,9 @@ getEnterpriseInfo(admin: Want, callback: AsyncCallback<EnterpriseInfo>): v **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -738,15 +761,17 @@ getEnterpriseInfo(admin: Want): Promise<EnterpriseInfo> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; adminManager.getEnterpriseInfo(wantTemp).then((result) => { console.info(`Succeeded in getting enterprise info, enterprise name : ${result.name}, enterprise description : ${result.description}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get enterprise info. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -782,12 +807,13 @@ subscribeManagedEvent(admin: Want, managedEvents: Array\, callback **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let events = [0, 1]; +let events: Array = [0, 1]; adminManager.subscribeManagedEvent(wantTemp, events, (err) => { if (err) { @@ -834,15 +860,17 @@ subscribeManagedEvent(admin: Want, managedEvents: Array\): Promise **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let events = [0, 1]; +let events: Array = [0, 1]; adminManager.subscribeManagedEvent(wantTemp, events).then(() => { -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to subscribe managed event. Code: ${err.code}, message: ${err.message}`); }) ``` @@ -878,12 +906,13 @@ unsubscribeManagedEvent(admin: Want, managedEvents: Array\, callba **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let events = [0, 1]; +let events: Array = [0, 1]; adminManager.unsubscribeManagedEvent(wantTemp, events, (err) => { if (err) { @@ -930,15 +959,17 @@ unsubscribeManagedEvent(admin: Want, managedEvents: Array\): Promi **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let events = [0, 1]; +let events: Array = [0, 1]; adminManager.unsubscribeManagedEvent(wantTemp, events).then(() => { -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to unsubscribe managed event. Code: ${err.code}, message: ${err.message}`); }) ``` @@ -975,12 +1006,14 @@ authorizeAdmin(admin: Want, bundleName: string, callback: AsyncCallback<void& **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; let bundleName: string = "com.example.application"; + adminManager.authorizeAdmin(wantTemp, bundleName, (err) => { if (err) { console.error(`Failed to authorize permission to the application. Code: ${err.code}, message: ${err.message}`); @@ -1027,14 +1060,17 @@ authorizeAdmin(admin: Want, bundleName: string): Promise<void> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; let bundleName: string = "com.example.application"; + adminManager.authorizeAdmin(wantTemp, bundleName).then(() => { -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to authorize permission to the application. Code: ${err.code}, message: ${err.message}`); }) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-applicationManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-applicationManager.md index 59ab8f119d06612efd5ad01fbe479267eab920a3..615425b7cc6a3ec6250e6afaf323dc3e90bda81e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-applicationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-applicationManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import applicationManager from '@ohos.enterprise.applicationManager'; ``` @@ -48,12 +48,13 @@ addDisallowedRunningBundles(admin: Want, appIds: Array\, callback: Async **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.addDisallowedRunningBundles(wantTemp, appIds, (err) => { if (err) { @@ -96,12 +97,13 @@ addDisallowedRunningBundles(admin: Want, appIds: Array\, userId: number, **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.addDisallowedRunningBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -149,17 +151,19 @@ addDisallowedRunningBundles(admin: Want, appIds: Array\, userId?: number **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.addDisallowedRunningBundles(wantTemp, appIds, 100).then(() => { - console.info('Succeeded in adding disallowed running bundles'); -}).catch((err) => { - console.error(`Failed to add disallowed running bundles. Code is ${err.code}, message is ${err.message}`); + console.info('Succeeded in adding disallowed running bundles'); +}).catch((err: BusinessError) => { + console.error(`Failed to add disallowed running bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -194,12 +198,13 @@ removeDisallowedRunningBundles(admin: Want, appIds: Array\, callback: As **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, (err) => { if (err) { @@ -242,12 +247,13 @@ removeDisallowedRunningBundles(admin: Want, appIds: Array\, userId: numb **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -295,17 +301,19 @@ removeDisallowedRunningBundles(admin: Want, appIds: Array\, userId?: num **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, 100).then(() => { - console.info('Succeeded in removing disallowed running bundles'); -}).catch((err) => { - console.error(`Failed to remove disallowed running bundles. Code is ${err.code}, message is ${err.message}`); + console.info('Succeeded in removing disallowed running bundles'); +}).catch((err: BusinessError) => { + console.error(`Failed to remove disallowed running bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -339,8 +347,9 @@ getDisallowedRunningBundles(admin: Want, callback: AsyncCallback<Array<str **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -385,8 +394,9 @@ getDisallowedRunningBundles(admin: Want, userId: number, callback: AsyncCallback **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -436,15 +446,17 @@ getDisallowedRunningBundles(admin: Want, userId?: number): Promise<Array<s **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; applicationManager.getDisallowedRunningBundles(wantTemp, 100).then((result) => { console.info(`Succeeded in getting disallowed running bundles, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get disallowed running bundles. Code is ${err.code}, message is ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-browser.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-browser.md index 79cdfdacdbe04a3ae2df65e20779591f947e9a65..8f52e5df79ffe51c2dada26c3d1ec9f137fecb74 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-browser.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-browser.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import browser from '@ohos.enterprise.browser'; ``` @@ -48,8 +48,9 @@ setPolicies(admin: Want, appId: string, policies: string, callback: AsyncCallbac **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -101,8 +102,10 @@ setPolicies(admin: Want, appId: string, policies: string): Promise<void>; **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -110,7 +113,7 @@ let appId: string = 'com.example.myapplication'; let policies: string = '{"InsecurePrivateNetworkRequestsAllowed":{"level":"mandatory","scope":"machine","source":"platform","value":true},"LegacySameSiteCookieBehaviorEnabledForDomainList":{"level":"mandatory","scope":"machine","source":"platform","value":["[*.]"]}}' browser.setPolicies(wantTemp, appId, policies).then(() => { console.info('Succeeded in setting browser policies'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set browser policies. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -143,8 +146,9 @@ getPolicies(admin: Want, appId: string, callback: AsyncCallback<string>): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -191,15 +195,17 @@ getPolicies(admin: Want, appId: string): Promise<string>; **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; let appId: string = 'com.example.myapplication'; browser.getPolicies(wantTemp, appId).then((result) => { console.info(`Succeeded in getting browser policies, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get browser policies. Code is ${err.code}, message is ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-bundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-bundleManager.md index c88ffc6313741182c75e229440a2c93a512e23c7..55d06e0f09d6ba0982d679acb86901ff691d42f0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-bundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-bundleManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import bundleManager from '@ohos.enterprise.bundleManager'; ``` @@ -47,12 +47,13 @@ addAllowedInstallBundles(admin: Want, appIds: Array\, callback: AsyncCal **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addAllowedInstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -95,12 +96,13 @@ addAllowedInstallBundles(admin: Want, appIds: Array\, userId: number, ca **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addAllowedInstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -148,16 +150,18 @@ addAllowedInstallBundles(admin: Want, appIds: Array\, userId?: number): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addAllowedInstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in adding allowed install bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to add allowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -193,12 +197,13 @@ removeAllowedInstallBundles(admin: Want, appIds: Array\, callback: Async **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeAllowedInstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -241,12 +246,13 @@ removeAllowedInstallBundles(admin: Want, appIds: Array\, userId: number, **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -294,16 +300,18 @@ removeAllowedInstallBundles(admin: Want, appIds: Array\, userId?: number **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in removing allowed install bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to remove allowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -338,8 +346,9 @@ getAllowedInstallBundles(admin: Want, callback: AsyncCallback<Array<string **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -384,8 +393,9 @@ getAllowedInstallBundles(admin: Want, userId: number, callback: AsyncCallback< **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -435,15 +445,17 @@ getAllowedInstallBundles(admin: Want, userId?: number): Promise<Array<stri **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; bundleManager.getAllowedInstallBundles(wantTemp, 100).then((result) => { console.info(`Succeeded in getting allowed install bundles, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get allowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -479,12 +491,13 @@ addDisallowedInstallBundles(admin: Want, appIds: Array\, callback: Async **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedInstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -527,12 +540,13 @@ addDisallowedInstallBundles(admin: Want, appIds: Array\, userId: number, **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedInstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -580,16 +594,18 @@ addDisallowedInstallBundles(admin: Want, appIds: Array\, userId?: number **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedInstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in adding disallowed install bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to add disallowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -625,12 +641,13 @@ removeDisallowedInstallBundles(admin: Want, appIds: Array\, callback: As **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -673,12 +690,13 @@ removeDisallowedInstallBundles(admin: Want, appIds: Array\, userId: numb **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -726,16 +744,18 @@ removeDisallowedInstallBundles(admin: Want, appIds: Array\, userId?: num **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in removing disallowed install bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to remove disallowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -770,8 +790,9 @@ getDisallowedInstallBundles(admin: Want, callback: AsyncCallback<Array<str **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -816,10 +837,11 @@ getDisallowedInstallBundles(admin: Want, userId: number, callback: AsyncCallback **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; bundleManager.getDisallowedInstallBundles(wantTemp, 100, (err, result) => { @@ -867,15 +889,17 @@ getDisallowedInstallBundles(admin: Want, userId?: number): Promise<Array<s **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; bundleManager.getDisallowedInstallBundles(wantTemp, 100).then((result) => { console.info(`Succeeded in getting disallowed install bundles, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get disallowed install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -911,12 +935,13 @@ addDisallowedUninstallBundles(admin: Want, appIds: Array\, callback: Asy **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -959,12 +984,13 @@ addDisallowedUninstallBundles(admin: Want, appIds: Array\, userId: numbe **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -1012,16 +1038,18 @@ addDisallowedUninstallBundles(admin: Want, appIds: Array\, userId?: numb **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in adding disallowed uninstall bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to add disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -1057,12 +1085,13 @@ removeDisallowedUninstallBundles(admin: Want, appIds: Array\, callback: **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, (err) => { if (err) { @@ -1105,12 +1134,13 @@ removeDisallowedUninstallBundles(admin: Want, appIds: Array\, userId: nu **示例:** -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { + bundleName: 'com.example.myapplication', + abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, 100, (err) => { if (err) { @@ -1158,16 +1188,18 @@ removeDisallowedUninstallBundles(admin: Want, appIds: Array\, userId?: n **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let appIds = ['com.example.myapplication']; +let appIds: Array = ['com.example.myapplication']; bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, 100).then(() => { console.info('Succeeded in removing disallowed uninstall bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to remove disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -1202,8 +1234,9 @@ getDisallowedUninstallBundles(admin: Want, callback: AsyncCallback<Array<s **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1248,8 +1281,9 @@ getDisallowedUninstallBundles(admin: Want, userId: number, callback: AsyncCallba **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1299,15 +1333,17 @@ getDisallowedUninstallBundles(admin: Want, userId?: number): Promise<Array< **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; bundleManager.getDisallowedUninstallBundles(wantTemp, 100).then((result) => { console.info(`Succeeded in getting disallowed uninstall bundles, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -1343,8 +1379,9 @@ uninstall(admin: Want, bundleName: string, callback: AsyncCallback<void>): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1389,8 +1426,9 @@ uninstall(admin: Want, bundleName: string, userId: number, callback: AsyncCallba **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1435,8 +1473,9 @@ uninstall(admin: Want, bundleName: string, isKeepData: boolean, callback: AsyncC **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1482,8 +1521,9 @@ uninstall(admin: Want, bundleName: string, userId: number, isKeepData: boolean, **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1534,15 +1574,17 @@ uninstall(admin: Want, bundleName: string, userId?: number, isKeepData?: boolean **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; bundleManager.uninstall(wantTemp, 'bundleName', 100, true).then(() => { console.info('Succeeded in uninstalling bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`); }); ``` @@ -1579,12 +1621,13 @@ install(admin: Want, hapFilePaths: Array\, callback: AsyncCallback\ = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap'] bundleManager.install(wantTemp, hapFilePaths, (err) => { if (err) { @@ -1627,13 +1670,14 @@ install(admin: Want, hapFilePaths: Array\, installParam: InstallParam, c **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let hapFilePaths = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap'] -let installParam = { +let hapFilePaths: Array = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap'] +let installParam: bundleManager.InstallParam = { userId: 100, installFlag: 1, }; @@ -1684,16 +1728,18 @@ install(admin: Want, hapFilePaths: Array\, installParam?: InstallParam): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let hapFilePaths = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap'] +let hapFilePaths: Array = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap'] bundleManager.install(wantTemp, hapFilePaths).then(() => { console.info('Succeeded in installing bundles'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to install bundles. Code is ${err.code}, message is ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md index f4a2aafed907d17f7ea383492df82d00cdce7cee..abd638c0322169c97c460b4e8874038783d4217e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md @@ -12,8 +12,8 @@ ## 导入模块 -```js -import dateTimeManager from '@ohos.enterprise.dateTimeManager' +```ts +import dateTimeManager from '@ohos.enterprise.dateTimeManager'; ``` ## dateTimeManager.setDateTime @@ -47,8 +47,9 @@ setDateTime(admin: Want, time: number, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -98,15 +99,17 @@ setDateTime(admin: Want, time: number): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; dateTimeManager.setDateTime(wantTemp, 1526003846000).then(() => { console.info('Succeeded in setting date time'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set date time. Code is ${err.code}, message is ${err.message}`); }) ``` @@ -142,8 +145,9 @@ disallowModifyDateTime(admin: Want, disallow: boolean, callback: AsyncCallback\< **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -193,15 +197,17 @@ disallowModifyDateTime(admin: Want, disallow: boolean): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; dateTimeManager.disallowModifyDateTime(wantTemp, true).then(() => { console.info('Succeeded in disallowing modify date time'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to disallow modify date time. Code is ${err.code}, message is ${err.message}`); }) ``` @@ -236,8 +242,9 @@ isModifyDateTimeDisallowed(admin: Want, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -286,15 +293,17 @@ isModifyDateTimeDisallowed(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; dateTimeManager.isModifyDateTimeDisallowed(wantTemp).then((result) => { console.info(`Succeeded in querying modify date time is disallowed : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query modify date time is disallowed or not. Code is ${err.code}, message is ${err.message}`); }) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceControl.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceControl.md index c0265e6091d3d506c2ee1112aecd56f91d7a5b2c..fb19e3ef7637ed37073005a177da7ec1231194f7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceControl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceControl.md @@ -12,8 +12,8 @@ ## 导入模块 -```js -import deviceControl from '@ohos.enterprise.deviceControl' +```ts +import deviceControl from '@ohos.enterprise.deviceControl'; ``` ## deviceControl.resetFactory @@ -46,8 +46,9 @@ resetFactory(admin: Want, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -96,14 +97,16 @@ resetFactory(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; deviceControl.resetFactory(wantTemp).then(() => { -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to reset factory. Code is ${err.code}, message is ${err.message}`); }) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md index 1bb08297e3049200225ffa4561ad55ebf26130b5..c3252392437204c795fe6032765007eb45411795 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import deviceInfo from '@ohos.enterprise.deviceInfo'; ``` @@ -46,8 +46,9 @@ getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -96,15 +97,17 @@ getDeviceSerial(admin: Want): Promise<string> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; deviceInfo.getDeviceSerial(wantTemp).then((result) => { console.info(`Succeeded in getting device serial, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get device serial. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -139,8 +142,9 @@ getDisplayVersion(admin: Want, callback: AsyncCallback<string>): void; **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -189,15 +193,17 @@ getDisplayVersion(admin: Want): Promise<string> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; deviceInfo.getDisplayVersion(wantTemp).then((result) => { console.info(`Succeeded in getting display version, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get display version. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -232,8 +238,9 @@ getDeviceName(admin: Want, callback: AsyncCallback<string>): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -282,15 +289,17 @@ getDeviceName(admin: Want): Promise<string> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; deviceInfo.getDeviceName(wantTemp).then((result) => { console.info(`Succeeded in getting device name, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get device name. Code: ${err.code}, message: ${err.message}`); }); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md index 9467f9a32ae06c82a26eba8c55ffb958745fba0a..9728638d37d10d67ecb7b86a5965120816a49f10 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import deviceSettings from '@ohos.enterprise.deviceSettings'; ``` @@ -46,8 +46,9 @@ getScreenOffTime(admin: Want, callback: AsyncCallback<number>): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -96,15 +97,17 @@ getScreenOffTime(admin: Want): Promise<number> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; deviceSettings.getScreenOffTime(wantTemp).then((result) => { console.info(`Succeeded in getting screen off time, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get screen off time. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -141,30 +144,31 @@ installUserCertificate(admin: Want, certificate: CertBlob, callback: AsyncCallba **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -var certFileArray: Uint8Array; +let certFileArray: Uint8Array = new Uint8Array(); // The variable context needs to be initialized in MainAbility's onCreate callback function // test.cer needs to be placed in the rawfile directory -await globalThis.context.resourceManager.getRawFileContent("test.cer") - .then(value => { +await getContext().resourceManager.getRawFileContent("test.cer") + .then((value) => { certFileArray = value }) - .catch(error => { + .catch((error: BusinessError) => { console.error(`Failed to get row file content. message: ${error.message}`); return }); -new Promise((resolve, reject) => { - deviceSettings.installUserCertificate(wantTemp, {inData: certFileArray, alias: "cert_alias_xts"}, (err, result) => { - if (err) { - console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); - } else{ - console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`); - } - }); + +deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }, (err, result) => { + if (err) { + console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); + } else { + console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`); + } }); ``` @@ -205,27 +209,31 @@ installUserCertificate(admin: Want, certificate: CertBlob): Promise<string> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -var certFileArray: Uint8Array +let certFileArray: Uint8Array = new Uint8Array(); // The variable context needs to be initialized in MainAbility's onCreate callback function // test.cer needs to be placed in the rawfile directory -await globalThis.context.resourceManager.getRawFileContent("test.cer") - .then(data => { - certFileArray = data - }).catch(error => { - console.log('getRawFileContent error' + error) - return +await getContext().resourceManager.getRawFileContent("test.cer") + .then((value) => { + certFileArray = value }) -deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }) + .catch((error: BusinessError) => { + console.error(`Failed to get row file content. message: ${error.message}`); + return + }); + +await deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }) .then((result) => { console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`); - }).catch(err => { - console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); - }) + }).catch((err: BusinessError) => { + console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); +}) ``` ## CertBlob @@ -273,8 +281,9 @@ uninstallUserCertificate(admin: Want, certUri: string, callback: AsyncCallback&l **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -325,15 +334,17 @@ uninstallUserCertificate(admin: Want, certUri: string): Promise<void> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; let aliasStr = "certName" deviceSettings.uninstallUserCertificate(wantTemp, aliasStr).then(() => { console.info(`Succeeded in uninstalling user certificate`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to uninstall user certificate. Code is ${err.code}, message is ${err.message}`); }); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md index 260b9af76e52cc7ea4937025a6f58fbbf91fb1ae..ec7fc5b4262adc71c61aed26178eb6b73d22c3d3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import networkManager from '@ohos.enterprise.networkManager'; ``` @@ -46,8 +46,9 @@ getAllNetworkInterfaces(admin: Want, callback: AsyncCallback<Array<string& **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -96,15 +97,17 @@ getAllNetworkInterfaces(admin: Want): Promise<Array<string>> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.getAllNetworkInterfaces(wantTemp).then((result) => { console.info(`Succeeded in getting all network interfaces, result : ${JSON.stringify(result)}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get all network interfaces. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -140,8 +143,9 @@ getIpAddress(admin: Want, networkInterface: string, callback: AsyncCallback<s **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -191,15 +195,17 @@ getIpAddress(admin: Want, networkInterface: string): Promise<string> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.getIpAddress(wantTemp, 'eth0').then((result) => { console.info(`Succeeded in getting ip address, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get ip address. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -235,8 +241,9 @@ getMac(admin: Want, networkInterface: string, callback: AsyncCallback<string& **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -286,15 +293,17 @@ getMac(admin: Want, networkInterface: string): Promise\; **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.getMac(wantTemp, 'eth0').then((result) => { console.info(`Succeeded in getting mac, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get mac. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -330,8 +339,9 @@ isNetworkInterfaceDisabled(admin: Want, networkInterface: string, callback: Asyn **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -381,15 +391,17 @@ isNetworkInterfaceDisabled(admin: Want, networkInterface: string): Promise<bo **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.isNetworkInterfaceDisabled(wantTemp, 'eth0').then((result) => { console.info(`Succeeded in querying network interface is disabled or not, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query network interface is disabled or not. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -426,8 +438,9 @@ setNetworkInterfaceDisabled(admin: Want, networkInterface: string, isDisabled: b **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -478,15 +491,17 @@ setNetworkInterfaceDisabled(admin: Want, networkInterface: string, isDisabled: b **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.setNetworkInterfaceDisabled(wantTemp, 'eth0', true).then(() => { console.info(`Succeeded in setting network interface disabled`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set network interface disabled. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -522,14 +537,16 @@ setGlobalProxy(admin: Want, httpProxy: connection.HttpProxy, callback: AsyncCall **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import connection from '@ohos.net.connection'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let exclusionStr = "192.168,baidu.com" -let exclusionArray = exclusionStr.split(','); -let httpProxy = { +let exclusionStr: string = "192.168,baidu.com" +let exclusionArray: Array = exclusionStr.split(','); +let httpProxy: connection.HttpProxy = { host: "192.168.xx.xxx", port: 8080, exclusionList: exclusionArray @@ -581,14 +598,17 @@ setGlobalProxy(admin: Want, httpProxy: connection.HttpProxy): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +import connection from '@ohos.net.connection'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let exclusionStr = "192.168,baidu.com" -let exclusionArray = exclusionStr.split(','); -let httpProxy = { +let exclusionStr: string = "192.168,baidu.com" +let exclusionArray: Array = exclusionStr.split(','); +let httpProxy: connection.HttpProxy = { host: "192.168.xx.xxx", port: 8080, exclusionList: exclusionArray @@ -596,7 +616,7 @@ let httpProxy = { networkManager.setGlobalProxy(wantTemp, httpProxy).then(() => { console.info(`Succeeded in setting network global proxy`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set network global proxy. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -631,8 +651,9 @@ getGlobalProxy(admin: Want, callback: AsyncCallback\): voi **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -681,15 +702,17 @@ getGlobalProxy(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.getGlobalProxy(wantTemp).then(() => { console.info(`Succeeded in getting network global proxy`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to get network global proxy. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -725,12 +748,13 @@ addIptablesFilterRule(admin: Want, filterRule: AddFilterRule, callback: AsyncCal **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let filterRule = { +let filterRule: networkManager.AddFilterRule = { "ruleNo": 1, "srcAddr": "192.168.1.1-192.188.22.66", "destAddr": "10.1.1.1", @@ -788,12 +812,14 @@ addIptablesFilterRule(admin: Want, filterRule: AddFilterRule): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let filterRule = { +let filterRule: networkManager.AddFilterRule = { "ruleNo": 1, "srcAddr": "192.168.1.1-192.188.22.66", "destAddr": "10.1.1.1", @@ -808,7 +834,7 @@ let filterRule = { networkManager.addIptablesFilterRule(wantTemp, filterRule).then(() => { console.info(`Succeeded in setting iptables filter rule`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set iptables filter rule. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -844,12 +870,13 @@ removeIptablesFilterRule(admin: Want, filterRule: RemoveFilterRule, callback: As **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let filterRule = { +let filterRule: networkManager.RemoveFilterRule = { "srcAddr": "192.168.1.1-192.188.22.66", "destAddr": "10.1.1.1", "srcPort": "8080", @@ -905,12 +932,14 @@ removeIptablesFilterRule(admin: Want, filterRule: RemoveFilterRule): Promise\ { console.info(`Succeeded in removing iptables filter rule`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to remove iptables filter rule. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -958,8 +987,9 @@ listIptablesFilterRules(admin: Want, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -1008,15 +1038,17 @@ listIptablesFilterRules(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; networkManager.listIptablesFilterRules(wantTemp).then((result) => { console.info(`Succeeded in getting iptables filter rule, result: ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to remove iptables filter rule. Code: ${err.code}, message: ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-restrictions.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-restrictions.md index 8f8b7c9d8505964af536d32d58b7bc0367f6d7a7..71c722a407c9b28bdb8eb3cf539ccaa9960832ea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-restrictions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-restrictions.md @@ -12,8 +12,8 @@ ## 导入模块 -```js -import restrictions from '@ohos.enterprise.restrictions' +```ts +import restrictions from '@ohos.enterprise.restrictions'; ``` ## restrictions.setPrinterDisabled @@ -47,8 +47,9 @@ setPrinterDisabled(admin: Want, disabled: boolean, callback: AsyncCallback\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; restrictions.setPrinterDisabled(wantTemp, true).then(() => { console.info('Succeeded in setting printer disabled'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set printer disabled. Code is ${err.code}, message is ${err.message}`); }) ``` @@ -141,8 +144,9 @@ isPrinterDisabled(admin: Want, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -191,15 +195,17 @@ isPrinterDisabled(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; restrictions.isPrinterDisabled(wantTemp).then((result) => { console.info(`Succeeded in querying is the printing function disabled : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query is the printing function disabled or not. Code is ${err.code}, message is ${err.message}`); }) ``` @@ -235,8 +241,9 @@ setHdcDisabled(admin: Want, disabled: boolean, callback: AsyncCallback\): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -286,15 +293,17 @@ setHdcDisabled(admin: Want, disabled: boolean): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; restrictions.setHdcDisabled(wantTemp, true).then(() => { console.info('Succeeded in setting hdc disabled'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set hdc disabled. Code is ${err.code}, message is ${err.message}`); }) ``` @@ -329,8 +338,9 @@ isHdcDisabled(admin: Want, callback: AsyncCallback\): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; @@ -379,15 +389,17 @@ isHdcDisabled(admin: Want): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; restrictions.isHdcDisabled(wantTemp).then((result) => { console.info(`Succeeded in querying is hdc disabled : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query is hdc disabled or not. Code is ${err.code}, message is ${err.message}`); }) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md index f2c96d2ba36d3758a5d54e9e51de6f7ecb18369d..34091e7183ef8878f542885a309cfd960e23bf58 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md @@ -12,8 +12,8 @@ ## 导入模块 -```js -import usbManager from '@ohos.enterprise.usbManager' +```ts +import usbManager from '@ohos.enterprise.usbManager'; ``` ## usbManager.setUsbPolicy @@ -47,12 +47,13 @@ setUsbPolicy(admin: Want, usbPolicy: UsbPolicy, callback: AsyncCallback\): **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let policy = usbManager.UsbPolicy.READ_WRITE +let policy: usbManager.UsbPolicy = usbManager.UsbPolicy.READ_WRITE usbManager.setUsbPolicy(wantTemp, policy, (err) => { if (err) { @@ -99,16 +100,18 @@ setUsbPolicy(admin: Want, usbPolicy: UsbPolicy): Promise\ **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'bundleName', abilityName: 'abilityName', }; -let policy = usbManager.UsbPolicy.READ_WRITE +let policy: usbManager.UsbPolicy = usbManager.UsbPolicy.READ_WRITE usbManager.setUsbPolicy(wantTemp, policy).then(() => { console.info('Succeeded in setting usb policy'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set usb policy. Code is ${err.code}, message is ${err.message}`); }) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-wifiManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-wifiManager.md index feb9dc12e5d5e4bd7f706aa0e7f09913917990c9..77f8bc9940c2ac1f3b5340ce2ce55540a3388135 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-wifiManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-wifiManager.md @@ -12,7 +12,7 @@ ## 导入模块 -```js +```ts import wifiManager from '@ohos.enterprise.wifiManager'; ``` @@ -46,8 +46,9 @@ isWifiActive(admin: Want, callback: AsyncCallback<boolean>): void **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -96,15 +97,17 @@ isWifiActive(admin: Want): Promise<boolean> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; wifiManager.isWifiActive(wantTemp).then((result) => { console.info(`Succeeded in query is wifi active or not, result : ${result}`); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to query is wifi active or not. Code: ${err.code}, message: ${err.message}`); }); ``` @@ -140,8 +143,9 @@ setWifiProfile(admin: Want, profile: WifiProfile, callback: AsyncCallback<voi **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; @@ -196,12 +200,14 @@ setWifiProfile(admin: Want, profile: WifiProfile): Promise<void> **示例:** -```js -let wantTemp = { +```ts +import Want from '@ohos.app.ability.Want'; +import { BusinessError } from '@ohos.base'; +let wantTemp: Want = { bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', }; -let profile : wifiManager.WifiProfile = { +let profile: wifiManager.WifiProfile = { 'ssid': 'name', 'preSharedKey': 'passwd', 'securityType': wifiManager.WifiSecurityType.WIFI_SEC_TYPE_PSK @@ -209,7 +215,7 @@ let profile : wifiManager.WifiProfile = { wifiManager.setWifiProfile(wantTemp, profile).then(() => { console.info('Succeeded in setting wifi profile'); -}).catch((err) => { +}).catch((err: BusinessError) => { console.error(`Failed to set wifi profile. Code: ${err.code}, message: ${err.message}`); }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-font.md b/zh-cn/application-dev/reference/apis/js-apis-font.md index d1ae820a17ee9130f34c2a3ba0ccbb74c9b17083..ff5d03fda1579dfa9d2ab5d7408806b0f867a429 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-font.md +++ b/zh-cn/application-dev/reference/apis/js-apis-font.md @@ -104,7 +104,7 @@ import font from '@ohos.font'; @Entry @Component struct FontExample { - fontList: Array; + fontList: Array = new Array(); build() { Column() { Button("getSystemFontList") @@ -164,8 +164,8 @@ import font from '@ohos.font'; @Entry @Component struct FontExample { - fontList: Array; - fontInfo: font.FontInfo; + fontList: Array = new Array(); + fontInfo: font.FontInfo = font.getFontByName(''); build() { Column() { Button("getFontByName") diff --git a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md index c79cffc135cb0c15dd6a41eb6173246f81c3fe6c..538f9c9c2db1e3cc45a2db1e0c982994460b84e3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md @@ -426,14 +426,15 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback<Locat ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0}; - let locationChange = (location) => { + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0}; + let locationChange = (location:geoLocationManager.Location):void => { console.log('locationChanger: data: ' + JSON.stringify(location)); }; try { geoLocationManager.on('locationChange', requestInfo, locationChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -470,15 +471,16 @@ off(type: 'locationChange', callback?: Callback<Location>): void ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0}; - let locationChange = (location) => { - console.log('locationChanger: data: ' + JSON.stringify(location)); + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0}; + let locationChange = (location:geoLocationManager.Location):void => { + console.log('locationChanger: data: ' + JSON.stringify(location)); }; try { geoLocationManager.on('locationChange', requestInfo, locationChange); geoLocationManager.off('locationChange', locationChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -510,13 +512,14 @@ on(type: 'locationEnabledChange', callback: Callback<boolean>): void ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let locationEnabledChange = (state) => { + import BusinessError from "@ohos.base"; + let locationEnabledChange = (state:boolean):void => { console.log('locationEnabledChange: ' + JSON.stringify(state)); } try { geoLocationManager.on('locationEnabledChange', locationEnabledChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -548,14 +551,15 @@ off(type: 'locationEnabledChange', callback?: Callback<boolean>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let locationEnabledChange = (state) => { + import BusinessError from "@ohos.base"; + let locationEnabledChange = (state:boolean):void => { console.log('locationEnabledChange: state: ' + JSON.stringify(state)); } try { geoLocationManager.on('locationEnabledChange', locationEnabledChange); geoLocationManager.off('locationEnabledChange', locationEnabledChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -592,14 +596,15 @@ on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callb ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let cachedLocationsCb = (locations) => { + import BusinessError from "@ohos.base"; + let cachedLocationsCb = (locations:Array):void => { console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); } - let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + let requestInfo:geoLocationManager.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; try { geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -635,15 +640,16 @@ off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location& ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let cachedLocationsCb = (locations) => { + import BusinessError from "@ohos.base"; + let cachedLocationsCb = (locations:Array):void => { console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); } - let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + let requestInfo:geoLocationManager.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; try { geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); geoLocationManager.off('cachedGnssLocationsChange'); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -678,14 +684,15 @@ on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>) ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let gnssStatusCb = (satelliteStatusInfo) => { + import BusinessError from "@ohos.base"; + let gnssStatusCb = (satelliteStatusInfo:geoLocationManager.SatelliteStatusInfo):void => { console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); } try { geoLocationManager.on('satelliteStatusChange', gnssStatusCb); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -721,14 +728,15 @@ off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo> ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let gnssStatusCb = (satelliteStatusInfo) => { + import BusinessError from "@ohos.base"; + let gnssStatusCb = (satelliteStatusInfo:geoLocationManager.SatelliteStatusInfo):void => { console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); } try { geoLocationManager.on('satelliteStatusChange', gnssStatusCb); geoLocationManager.off('satelliteStatusChange', gnssStatusCb); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -764,14 +772,15 @@ on(type: 'nmeaMessage', callback: Callback<string>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let nmeaCb = (str) => { + import BusinessError from "@ohos.base"; + let nmeaCb = (str:string):void => { console.log('nmeaMessage: ' + JSON.stringify(str)); } try { geoLocationManager.on('nmeaMessage', nmeaCb ); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -807,7 +816,8 @@ off(type: 'nmeaMessage', callback?: Callback<string>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let nmeaCb = (str) => { + import BusinessError from "@ohos.base"; + let nmeaCb = (str:string):void => { console.log('nmeaMessage: ' + JSON.stringify(str)); } @@ -815,7 +825,7 @@ off(type: 'nmeaMessage', callback?: Callback<string>): void; geoLocationManager.on('nmeaMessage', nmeaCb); geoLocationManager.off('nmeaMessage', nmeaCb); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -853,8 +863,9 @@ on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): vo ```ts import geoLocationManager from '@ohos.geoLocationManager'; import wantAgent from '@ohos.app.ability.wantAgent'; - - let wantAgentInfo = { + import BusinessError from "@ohos.base"; + + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", @@ -868,11 +879,11 @@ on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): vo }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; try { geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } }); ``` @@ -911,8 +922,9 @@ off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): v ```ts import geoLocationManager from '@ohos.geoLocationManager'; import wantAgent from '@ohos.app.ability.wantAgent'; + import BusinessError from "@ohos.base"; - let wantAgentInfo = { + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", @@ -926,12 +938,12 @@ off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): v }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};; try { geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } }); ``` @@ -966,14 +978,15 @@ on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let callback = (code) => { + import BusinessError from "@ohos.base"; + let callback = (code:geoLocationManager.CountryCode):void => { console.log('countryCodeChange: ' + JSON.stringify(code)); } try { geoLocationManager.on('countryCodeChange', callback); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1006,7 +1019,8 @@ off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let callback = (code) => { + import BusinessError from "@ohos.base"; + let callback = (code:geoLocationManager.CountryCode):void => { console.log('countryCodeChange: ' + JSON.stringify(code)); } @@ -1014,7 +1028,7 @@ off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; geoLocationManager.on('countryCodeChange', callback); geoLocationManager.off('countryCodeChange', callback); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1051,14 +1065,15 @@ on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callb ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let callback = (code) => { + import BusinessError from "@ohos.base"; + let callback = (code:Array):void => { console.log('locatingRequiredDataChange: ' + JSON.stringify(code)); } - let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; + let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; try { geoLocationManager.on('locatingRequiredDataChange', config, callback); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1090,15 +1105,16 @@ off(type: 'locatingRequiredDataChange', callback?: Callback<Array<Locating ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let callback = (code) => { + import BusinessError from "@ohos.base"; + let callback = (code:Array):void => { console.log('locatingRequiredDataChange: ' + JSON.stringify(code)); } - let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; + let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; try { geoLocationManager.on('locatingRequiredDataChange', config, callback); geoLocationManager.off('locatingRequiredDataChange', callback); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1134,8 +1150,9 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0}; - let locationChange = (err, location) => { + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0}; + let locationChange = (err:BusinessError.BusinessError, location:geoLocationManager.Location):void => { if (err) { console.log('locationChanger: err=' + JSON.stringify(err)); } @@ -1147,7 +1164,7 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L try { geoLocationManager.getCurrentLocation(requestInfo, locationChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1181,7 +1198,8 @@ getCurrentLocation(callback: AsyncCallback<Location>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let locationChange = (err, location) => { + import BusinessError from "@ohos.base"; + let locationChange = (err:BusinessError.BusinessError, location:geoLocationManager.Location) => { if (err) { console.log('locationChanger: err=' + JSON.stringify(err)); } @@ -1193,7 +1211,7 @@ getCurrentLocation(callback: AsyncCallback<Location>): void; try { geoLocationManager.getCurrentLocation(locationChange); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1233,16 +1251,17 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0}; + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0}; try { geoLocationManager.getCurrentLocation(requestInfo).then((result) => { console.log('current location: ' + JSON.stringify(result)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getCurrentLocation: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1277,10 +1296,11 @@ getLastLocation(): Location ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let location = geoLocationManager.getLastLocation(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1311,10 +1331,11 @@ isLocationEnabled(): boolean ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let locationEnabled = geoLocationManager.isLocationEnabled(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1349,6 +1370,7 @@ enableLocation(callback: AsyncCallback<void>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.enableLocation((err, data) => { if (err) { @@ -1356,7 +1378,7 @@ enableLocation(callback: AsyncCallback<void>): void; } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1391,15 +1413,16 @@ enableLocation(): Promise<void> ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.enableLocation().then((result) => { console.log('promise, enableLocation succeed'); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, enableLocation: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1427,10 +1450,11 @@ disableLocation(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.disableLocation(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1463,7 +1487,8 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + import BusinessError from "@ohos.base"; + let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; try { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { @@ -1474,7 +1499,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1512,16 +1537,17 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + import BusinessError from "@ohos.base"; + let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; try { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { console.log('getAddressesFromLocation: ' + JSON.stringify(data)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1554,7 +1580,8 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + import BusinessError from "@ohos.base"; + let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; try { geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { @@ -1565,7 +1592,7 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1603,16 +1630,17 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + import BusinessError from "@ohos.base"; + let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; try { geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => { console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1642,10 +1670,11 @@ isGeocoderAvailable(): boolean; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let isAvailable = geoLocationManager.isGeocoderAvailable(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1679,6 +1708,7 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.getCachedGnssLocationsSize((err, size) => { if (err) { @@ -1689,7 +1719,7 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1723,15 +1753,16 @@ getCachedGnssLocationsSize(): Promise<number>; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.getCachedGnssLocationsSize().then((result) => { console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1766,6 +1797,7 @@ flushCachedGnssLocations(callback: AsyncCallback<void>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.flushCachedGnssLocations((err, result) => { if (err) { @@ -1773,7 +1805,7 @@ flushCachedGnssLocations(callback: AsyncCallback<void>): void; } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1808,15 +1840,16 @@ flushCachedGnssLocations(): Promise<void>; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.flushCachedGnssLocations().then((result) => { console.log('promise, flushCachedGnssLocations success'); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1848,7 +1881,8 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'scenario': 0x301, 'command': "command_1"}; + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.LocationCommand = {'scenario': 0x301, 'command': "command_1"}; try { geoLocationManager.sendCommand(requestInfo, (err, result) => { if (err) { @@ -1856,7 +1890,7 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1893,16 +1927,17 @@ sendCommand(command: LocationCommand): Promise<void>; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let requestInfo = {'scenario': 0x301, 'command': "command_1"}; + import BusinessError from "@ohos.base"; + let requestInfo:geoLocationManager.LocationCommand = {'scenario': 0x301, 'command': "command_1"}; try { geoLocationManager.sendCommand(requestInfo).then((result) => { console.log('promise, sendCommand success'); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, sendCommand: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1934,6 +1969,7 @@ getCountryCode(callback: AsyncCallback<CountryCode>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.getCountryCode((err, result) => { if (err) { @@ -1944,7 +1980,7 @@ getCountryCode(callback: AsyncCallback<CountryCode>): void; } }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -1976,16 +2012,17 @@ getCountryCode(): Promise<CountryCode>; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.getCountryCode() .then((result) => { console.log('promise, getCountryCode: result=' + JSON.stringify(result)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getCountryCode: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2013,10 +2050,11 @@ enableLocationMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.enableLocationMock(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2044,10 +2082,11 @@ disableLocationMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.disableLocationMock(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2083,19 +2122,20 @@ setMockedLocations(config: LocationMockConfig): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let locations = [ + import BusinessError from "@ohos.base"; + let locations:Array = [ {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true}, {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true}, {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true}, {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true}, {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true} ]; - let config = {"timeInterval": 5, "locations": locations}; + let config:geoLocationManager.LocationMockConfig = {"timeInterval": 5, "locations": locations}; try { geoLocationManager.enableLocationMock(); geoLocationManager.setMockedLocations(config); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2122,10 +2162,11 @@ enableReverseGeocodingMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.enableReverseGeocodingMock(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2152,10 +2193,11 @@ disableReverseGeocodingMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.disableReverseGeocodingMock(); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2190,18 +2232,19 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): v ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let mockInfos = [ - {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}}, - {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}}, - {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}}, - {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}}, - {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}}, + import BusinessError from "@ohos.base"; + let mockInfos:Array = [ + {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "isFromMock": true}}, ]; try { geoLocationManager.enableReverseGeocodingMock(); geoLocationManager.setReverseGeocodingMockInfo(mockInfos); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2240,10 +2283,11 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { let isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2279,10 +2323,11 @@ setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean) ```ts import geoLocationManager from '@ohos.geoLocationManager'; + import BusinessError from "@ohos.base"; try { geoLocationManager.setLocationPrivacyConfirmStatus(1, true); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` @@ -2323,15 +2368,16 @@ getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise<Array< ```ts import geoLocationManager from '@ohos.geoLocationManager'; - let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; + import BusinessError from "@ohos.base"; + let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; try { geoLocationManager.getLocatingRequiredData(config).then((result) => { console.log('getLocatingRequiredData return: ' + JSON.stringify(result)); }) - .catch((error) => { + .catch((error:number) => { console.log('promise, getLocatingRequiredData: error=' + JSON.stringify(error)); }); } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); + console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md index 1e7eccc4c18451a0c1521c7d0b47c344e586d8fd..9729d1682a75e37a4c557d7204ea66432da41a38 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md @@ -68,8 +68,8 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback<Locat ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; - let locationChange = (location) => { + let requestInfo:geolocation.LocationRequest = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + let locationChange = (location:geolocation.Location):void => { console.log('locationChanger: data: ' + JSON.stringify(location)); }; geolocation.on('locationChange', requestInfo, locationChange); @@ -101,8 +101,8 @@ off(type: 'locationChange', callback?: Callback<Location>): void ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; - let locationChange = (location) => { + let requestInfo:geolocation.LocationRequest = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + let locationChange = (location:geolocation.Location):void => { console.log('locationChanger: data: ' + JSON.stringify(location)); }; geolocation.on('locationChange', requestInfo, locationChange); @@ -135,7 +135,7 @@ on(type: 'locationServiceState', callback: Callback<boolean>): void ```ts import geolocation from '@ohos.geolocation'; - let locationServiceState = (state) => { + let locationServiceState = (state:boolean):void => { console.log('locationServiceState: ' + JSON.stringify(state)); } geolocation.on('locationServiceState', locationServiceState); @@ -167,7 +167,7 @@ off(type: 'locationServiceState', callback?: Callback<boolean>): void; ```ts import geolocation from '@ohos.geolocation'; - let locationServiceState = (state) => { + let locationServiceState = (state:boolean):void => { console.log('locationServiceState: state: ' + JSON.stringify(state)); } geolocation.on('locationServiceState', locationServiceState); @@ -202,10 +202,10 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ```ts import geolocation from '@ohos.geolocation'; - let cachedLocationsCb = (locations) => { + let cachedLocationsCb = (locations:Array):void => { console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); } - let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + let requestInfo:geolocation.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); ``` @@ -236,10 +236,10 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Locati ```ts import geolocation from '@ohos.geolocation'; - let cachedLocationsCb = (locations) => { + let cachedLocationsCb = (locations:Array):void => { console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); } - let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + let requestInfo:geolocation.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); geolocation.off('cachedGnssLocationsReporting'); ``` @@ -271,7 +271,7 @@ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): voi ```ts import geolocation from '@ohos.geolocation'; - let gnssStatusCb = (satelliteStatusInfo) => { + let gnssStatusCb = (satelliteStatusInfo:geolocation.SatelliteStatusInfo):void => { console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo)); } geolocation.on('gnssStatusChange', gnssStatusCb); @@ -303,7 +303,7 @@ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): v ```ts import geolocation from '@ohos.geolocation'; - let gnssStatusCb = (satelliteStatusInfo) => { + let gnssStatusCb = (satelliteStatusInfo:geolocation.SatelliteStatusInfo) => { console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo)); } geolocation.on('gnssStatusChange', gnssStatusCb); @@ -337,7 +337,7 @@ on(type: 'nmeaMessageChange', callback: Callback<string>): void; ```ts import geolocation from '@ohos.geolocation'; - let nmeaCb = (str) => { + let nmeaCb = (str:string):void => { console.log('nmeaMessageChange: ' + JSON.stringify(str)); } geolocation.on('nmeaMessageChange', nmeaCb ); @@ -370,7 +370,7 @@ off(type: 'nmeaMessageChange', callback?: Callback<string>): void; ```ts import geolocation from '@ohos.geolocation'; - let nmeaCb = (str) => { + let nmeaCb = (str:string):void => { console.log('nmeaMessageChange: ' + JSON.stringify(str)); } geolocation.on('nmeaMessageChange', nmeaCb); @@ -406,7 +406,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; import geolocation from '@ohos.geolocation'; import wantAgent from '@ohos.app.ability.wantAgent'; - let wantAgentInfo = { + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", @@ -420,7 +420,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + let requestInfo:geolocation.GeofenceRequest = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); }); ``` @@ -454,7 +454,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; import geolocation from '@ohos.geolocation'; import wantAgent from '@ohos.app.ability.wantAgent'; - let wantAgentInfo = { + let wantAgentInfo:wantAgent.WantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", @@ -468,7 +468,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + let requestInfo:geolocation.GeofenceRequest = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); geolocation.off('fenceStatusChange', requestInfo, wantAgentObj); }); @@ -499,8 +499,9 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; - let locationChange = (err, location) => { + import BusinessError from "@ohos.base" + let requestInfo:geolocation.CurrentLocationRequest = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + let locationChange = (err:BusinessError.BusinessError, location:geolocation.Location) => { if (err) { console.log('locationChanger: err=' + JSON.stringify(err)); } @@ -536,7 +537,8 @@ getCurrentLocation(callback: AsyncCallback<Location>): void ```ts import geolocation from '@ohos.geolocation'; - let locationChange = (err, location) => { + import BusinessError from "@ohos.base" + let locationChange = (err:BusinessError.BusinessError, location:geolocation.Location):void => { if (err) { console.log('locationChanger: err=' + JSON.stringify(err)); } @@ -578,7 +580,7 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + let requestInfo:geolocation.CurrentLocationRequest = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; geolocation.getCurrentLocation(requestInfo).then((result) => { console.log('current location: ' + JSON.stringify(result)); }); @@ -863,7 +865,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ```ts import geolocation from '@ohos.geolocation'; - let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + let reverseGeocodeRequest:geolocation.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); @@ -904,7 +906,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge ```ts import geolocation from '@ohos.geolocation'; - let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + let reverseGeocodeRequest:geolocation.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { console.log('getAddressesFromLocation: ' + JSON.stringify(data)); }); @@ -935,7 +937,7 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< ```ts import geolocation from '@ohos.geolocation'; - let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + let geocodeRequest:geolocation.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); @@ -976,7 +978,7 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd ```ts import geolocation from '@ohos.geolocation'; - let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + let geocodeRequest:geolocation.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => { console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); }); @@ -1138,7 +1140,7 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): v ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'scenario': 0x301, 'command': "command_1"}; + let requestInfo:geolocation.LocationCommand = {'scenario': 0x301, 'command': "command_1"}; geolocation.sendCommand(requestInfo, (err, result) => { if (err) { console.log('sendCommand: err=' + JSON.stringify(err)); @@ -1180,7 +1182,7 @@ sendCommand(command: LocationCommand): Promise<boolean>; ```ts import geolocation from '@ohos.geolocation'; - let requestInfo = {'scenario': 0x301, 'command': "command_1"}; + let requestInfo:geolocation.LocationCommand = {'scenario': 0x301, 'command': "command_1"}; geolocation.sendCommand(requestInfo).then((result) => { console.log('promise, sendCommand: ' + JSON.stringify(result)); }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md index 9ac8782c1d4bdf62bd834a5f9ebfb348accb556e..b8026fa0c3bfb3eba736a08ba878ca06a9aff55d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md @@ -25,13 +25,13 @@ import distributedMissionManager from '@ohos.distributedMissionManager'; **示例:** ```js - import distributedMissionManager from '@ohos.distributedMissionManager'; - - try { - distributedMissionManager.on('continueStateChange', (data) => { - console.info("continueStateChange on:" + JSON.stringify(data)); - }); - } catch (err) { - console.error("continueStateChange errCode:" + err.code + ",errMessage:" + err.message); - } - ``` \ No newline at end of file +import distributedMissionManager from '@ohos.distributedMissionManager'; + +try { + distributedMissionManager.on('continueStateChange', (data) => { + console.info("continueStateChange on:" + JSON.stringify(data)); + }); +} catch (err) { + console.error("continueStateChange err: " + JSON.stringify(err)); +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md index 04d0ea50b84487b8185df8b6a57beaf5adaae4c1..6f31e046aab4208a99096b271348bd610f7a8c04 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md @@ -26,26 +26,25 @@ Mission迁移完成后调用,返回迁移结果。 ```ts import distributedMissionManager from '@ohos.distributedMissionManager'; + import { BusinessError } from '@ohos.base'; - let continueDeviceInfo = { + distributedMissionManager.continueMission( + { srcDeviceId: '123', dstDeviceId: '456', missionId: 123, wantParam: { 'key':'value' } - }; - - let continueCallback = { + }, + { onContinueDone(result) { console.log('onContinueDone, result: ${JSON.stringify(result)}'); } - }; - - distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => { + }, (error: BusinessError) => { if (error && error.code) { console.error('continueMission failed, error.code: ${error.code}, error.message: ${error.message}'); } console.log('continueMission finished'); - }); + }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md index 55f071816dd5699c96533c14a0b1c841cc333c25..7f45e2086a6a68276805d04676de5185d1e8e41c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md @@ -24,22 +24,20 @@ ```ts import distributedMissionManager from '@ohos.distributedMissionManager'; - let continueDeviceInfo = { + distributedMissionManager.continueMission( + { srcDeviceId: '123', dstDeviceId: '456', missionId: 123, wantParam: { 'key':'value' } - }; - - let continueCallback = { - onContinueDone(result) { + }, + { + onContinueDone(result): void { console.log('onContinueDone, result: ${JSON.stringify(result)}'); } - }; - - distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => { + }, (error) => { if (error && error.code) { console.error('continueMission failed, error.code: ${error.code}, error.message: ${error.message}'); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md index 453cbb1039e5d0743f81a3550c67c64df1d5d562..4c6532be27feef311dcb63995375ecf7fe8d91a8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md @@ -28,15 +28,16 @@ import distributedMissionManager from '@ohos.distributedMissionManager'; ```ts import distributedMissionManager from '@ohos.distributedMissionManager'; + import { BusinessError } from '@ohos.base'; - var parameter = { - srcDeviceId: "", - dstDeviceId: "", - bundleName: "ohos.test.continueapp", - wantParam: {"key": "value"} - }; try { - distributedMissionManager.continueMission(parameter, (error) => { + distributedMissionManager.continueMission( + { + srcDeviceId: "", + dstDeviceId: "", + bundleName: "ohos.test.continueapp", + wantParam: {"key": "value"} + }, (error: BusinessError) => { if (error.code != 0) { console.error('continueMission failed, cause: ' + JSON.stringify(error)) } diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md index ed6f806ee0cbbeb465e4f07a9e69cf6ee3f49838..24a6d2c83216335f9c25eabf0cb2a0964861b7ce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md @@ -13,6 +13,7 @@ FormExtensionContext模块提供FormExtensionAbility具有的接口和能力。 ```ts import common from '@ohos.app.ability.common'; +import Base from '@ohos.base'; ``` ## FormExtensionContext.startAbility @@ -49,12 +50,13 @@ startAbility(want: Want, callback: AsyncCallback<void>): void ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import Want from '@ohos.app.ability.Want'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { + onFormEvent(formId: string, message: string) { // 当触发卡片message事件时,执行startAbility - console.log('FormExtensionAbility onFormEvent, formId: ${formId}, message:${message}'); - let want = { + console.log(`FormExtensionAbility onFormEvent, formId: ${formId}, message:${message}`); + let want: Want = { deviceId: '', bundleName: 'com.example.formstartability', abilityName: 'EntryAbility', @@ -62,7 +64,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { 'message': message } }; - this.context.startAbility(want, (error) => { + this.context.startAbility(want, (error: Base.BusinessError) => { if (error) { console.error('FormExtensionContext startAbility, error:${JSON.stringify(error)}'); } else { @@ -112,12 +114,13 @@ startAbility(want: Want): Promise<void> ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import Want from '@ohos.app.ability.Want'; export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { + onFormEvent(formId: string, message: string) { // 当触发卡片message事件时,执行startAbility - console.log('FormExtensionAbility onFormEvent, formId:${formId}, message:${message}'); - let want = { + console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`); + let want: Want = { deviceId: '', bundleName: 'com.example.formstartability', abilityName: 'EntryAbility', @@ -127,7 +130,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { }; this.context.startAbility(want).then(() => { console.info('StartAbility Success'); - }).catch((error) => { + }).catch((error: Base.BusinessError) => { console.error('StartAbility failed'); }); } @@ -164,7 +167,6 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; | 16000001 | The specified ability does not exist. | | 16000002 | Incorrect ability type. | | 16000004 | Can not start invisible component. | -| 16000005 | The specified process does not have the permission. | | 16000006 | Cross-user operations are not allowed. | | 16000008 | The crowdtesting application expires. | | 16000053 | The ability is not on the top of the UI. | @@ -176,41 +178,44 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; **示例:** - ```ts - import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; - - let commRemote = null; - export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { - // 当触发卡片message事件时,执行connectServiceExtensionAbility - console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`); - let want = { - deviceId: '', - bundleName: 'com.example.formstartability', - abilityName: 'EntryAbility', - parameters: { - 'message': message - } - }; - let options = { - onConnect(elementName, remote) { - commRemote = remote; // remote 用于与ServiceExtensionAbility进行通信 - console.log('----------- onConnect -----------'); - }, - onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, - onFailed(code) { console.error('----------- onFailed -----------') } - }; - - let connection = null; - try { - connection = this.context.connectServiceExtensionAbility(want, options); - } catch (paramError) { - // 处理入参错误异常 - console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); +```ts +import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import Want from '@ohos.app.ability.Want'; +import rpc from '@ohos.rpc'; +import common from '@ohos.app.ability.common'; + +let commRemote: rpc.IRemoteObject | null = null; +export default class MyFormExtensionAbility extends FormExtensionAbility { + onFormEvent(formId: string, message: string) { + // 当触发卡片message事件时,执行connectServiceExtensionAbility + console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`); + let want: Want = { + deviceId: '', + bundleName: 'com.example.formstartability', + abilityName: 'EntryAbility', + parameters: { + 'message': message } + }; + let options: common.ConnectOptions = { + onConnect(elementName, remote) { + commRemote = remote; // remote 用于与ServiceExtensionAbility进行通信 + console.log('----------- onConnect -----------'); + }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.error('----------- onFailed -----------') } + }; + + let connection: number | null = null; + try { + connection = this.context.connectServiceExtensionAbility(want, options); + } catch (paramError) { + // 处理入参错误异常 + console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); } - }; - ``` + } +}; +``` ## FormExtensionContext.disconnectServiceExtensionAbility10+ @@ -240,36 +245,38 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback< **示例:** - ```ts - import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +```ts +import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import rpc from '@ohos.rpc'; +import common from '@ohos.app.ability.common'; - // commRemote为onConnect回调内返回的remote对象,此处定义为null无任何实际意义,仅作示例 - let commRemote = null; - export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { - // 实际使用时,connection为connectServiceExtensionAbility中的返回值,此处定义为1无任何实际意义,仅作示例 - let connection = 1; +// commRemote为onConnect回调内返回的remote对象,此处定义为null无任何实际意义,仅作示例 +let commRemote: rpc.IRemoteObject | null = null; +export default class MyFormExtensionAbility extends FormExtensionAbility { + onFormEvent(formId: string, message: string) { + // 实际使用时,connection为connectServiceExtensionAbility中的返回值,此处定义为1无任何实际意义,仅作示例 + let connection: number = 1; - try { - this.context.disconnectServiceExtensionAbility(connection, (error) => { - commRemote = null; - if (error.code) { - // 处理业务逻辑错误 - console.error( - `disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`); - return; - } - // 执行正常业务 - console.log('disconnectServiceExtensionAbility succeed'); - }); - } catch (paramError) { + try { + this.context.disconnectServiceExtensionAbility(connection, (error: Base.BusinessError) => { commRemote = null; - // 处理入参错误异常 - console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); - } + if (error.code) { + // 处理业务逻辑错误 + console.error( + `disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`); + return; + } + // 执行正常业务 + console.log('disconnectServiceExtensionAbility succeed'); + }); + } catch (paramError) { + commRemote = null; + // 处理入参错误异常 + console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); } - }; - ``` + } +}; +``` ## FormExtensionContext.disconnectServiceExtensionAbility10+ @@ -304,34 +311,36 @@ disconnectServiceExtensionAbility(connection: number): Promise<void>; **示例:** - ```ts - import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; - - // commRemote为onConnect回调内返回的remote对象,此处定义为null无任何实际意义,仅作示例 - let commRemote = null; - export default class MyFormExtensionAbility extends FormExtensionAbility { - onFormEvent(formId, message) { - // 实际使用时,connection为connectServiceExtensionAbility中的返回值,此处定义为1无任何实际意义,仅作示例 - let connection = 1; - - try { - this.context.disconnectServiceExtensionAbility(connection) - .then((data) => { - commRemote = null; - // 执行正常业务 - console.log('disconnectServiceExtensionAbility succeed'); - }) - .catch((error) => { - commRemote = null; - // 处理业务逻辑错误 - console.error( - `disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`); - }); - } catch (paramError) { - commRemote = null; - // 处理入参错误异常 - console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); - } +```ts +import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import rpc from '@ohos.rpc'; +import common from '@ohos.app.ability.common'; + +// commRemote为onConnect回调内返回的remote对象,此处定义为null无任何实际意义,仅作示例 +let commRemote: rpc.IRemoteObject | null = null; +export default class MyFormExtensionAbility extends FormExtensionAbility { + onFormEvent(formId: string, message: string) { + // 实际使用时,connection为connectServiceExtensionAbility中的返回值,此处定义为1无任何实际意义,仅作示例 + let connection: number = 1; + + try { + this.context.disconnectServiceExtensionAbility(connection) + .then(() => { + commRemote = null; + // 执行正常业务 + console.log('disconnectServiceExtensionAbility succeed'); + }) + .catch((error: Base.BusinessError) => { + commRemote = null; + // 处理业务逻辑错误 + console.error( + `disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`); + }); + } catch (paramError) { + commRemote = null; + // 处理入参错误异常 + console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`); } - }; - ``` + } +}; +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md index 39523a3d373ad9adfa860cf4f5e4fdc37c6e5454..061b0f71c5e1144a22abfa1293c85b624c974b64 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md @@ -28,7 +28,7 @@ import missionManager from '@ohos.app.ability.missionManager'; **示例:** ```ts - import ElementName from '@ohos.bundle'; + import ElementName from '@ohos.bundle.bundleManager'; import image from '@ohos.multimedia.image'; import missionManager from '@ohos.app.ability.missionManager'; diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md index caa6b850cd30c9ac9b7c331bef6c983ba33f5a23..ba96ba2503901ae5065b4ad5a04540e1bcb8f5db 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md @@ -83,6 +83,27 @@ subscriber.getCode().then((code) => { }); ``` +## getCodeSync + +getCodeSync(): number + +getCode的同步接口 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| number | 公共事件代码。 | + +**示例:** + +```ts +let code = subscriber.getCodeSync(); +console.info("getCodeSync " + JSON.stringify(code)); +``` + ## setCode setCode(code: number, callback: AsyncCallback\): void @@ -142,6 +163,32 @@ subscriber.setCode(1).then(() => { }); ``` +## setCodeSync + +setCodeSync(code: number): void + +setCode的同步接口 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| code | number | 是 | 公共事件的代码。 | + + +**示例:** + +```ts + +try { + subscriber.setCodeSync(1); +} catch (err) { + console.error(`setCodeSync failed, code is ${err.code}, message is ${err.message}`); +} +``` + ## getData getData(callback: AsyncCallback\): void @@ -194,6 +241,27 @@ subscriber.getData().then((data) => { }); ``` +## getDataSync + +getDataSync(): string + +getData的同步接口 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | ------------------ | +| string | 公共事件的数据。 | + +**示例:** + +```ts +let data = subscriber.getDataSync(); +console.info("getDataSync " + JSON.stringify(data)); +``` + ## setData setData(data: string, callback: AsyncCallback\): void @@ -253,6 +321,29 @@ subscriber.setData("publish_data_changed").then(() => { }); ``` +## setDataSync +setDataSync(data: string): void + +setData的同步接口。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| data | string | 是 | 公共事件的数据。 | + +**示例:** + +```ts +try { + subscriber.setDataSync("publish_data_changed"); +} catch (err) { + console.error(`setDataSync failed, code is ${err.code}, message is ${err.message}`); +} +``` + ## setCodeAndData setCodeAndData(code: number, data: string, callback:AsyncCallback\): void @@ -314,6 +405,31 @@ subscriber.setCodeAndData(1, "publish_data_changed").then(() => { }); ``` +## setCodeAndDataSync + +setCodeAndData的同步接口。 + +setCodeAndDataSync(code: number, data: string): void + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | + +**示例:** + +```ts +try { + subscriber.setCodeAndDataSync(1, "publish_data_changed"); +} catch (err) { + console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); +} + +``` ## isOrderedCommonEvent isOrderedCommonEvent(callback: AsyncCallback\): void @@ -370,6 +486,29 @@ subscriber.isOrderedCommonEvent().then((isOrdered) => { }); ``` +## isOrderedCommonEventSync + +isOrderedCommonEventSync(): boolean + +isOrderedCommonEvent的同步接口 + +返回true代表是有序公共事件,false代表不是有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | -------------------------------- | +| boolean | 当前公共事件的是否为有序公共事件。 | + +**示例:** + +```ts +let isOrdered = subscriber.isOrderedCommonEventSync(); +console.info("isOrdered " + JSON.stringify(isOrdered)); +``` + ## isStickyCommonEvent isStickyCommonEvent(callback: AsyncCallback\): void @@ -426,6 +565,29 @@ subscriber.isStickyCommonEvent().then((isSticky) => { }); ``` +## isStickyCommonEventSync + +isStickyCommonEventSync(): boolean + +isStickyCommonEvent的同步接口。 + +返回true代表是粘性公共事件,false代表不是粘性公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | -------------------------------- | +| boolean | 当前公共事件的是否为粘性公共事件。 | + +**示例:** + +```ts +let isSticky = subscriber.isStickyCommonEventSync(); +console.info("isSticky " + JSON.stringify(isSticky)); +``` + ## abortCommonEvent abortCommonEvent(callback: AsyncCallback\): void @@ -478,6 +640,20 @@ subscriber.abortCommonEvent().then(() => { }); ``` +## abortCommonEventSync + +abortCommonEventSync(): void + +abortCommonEvent的同步接口 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**示例:** + +```ts +subscriber.abortCommonEventSync(); +``` + ## clearAbortCommonEvent clearAbortCommonEvent(callback: AsyncCallback\): void @@ -530,6 +706,20 @@ subscriber.clearAbortCommonEvent().then(() => { }); ``` +## clearAbortCommonEventSync + +clearAbortCommonEventSync(): void + +clearAbortCommonEvent的同步接口 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**示例:** + +```ts +subscriber.clearAbortCommonEventSync(); +``` + ## getAbortCommonEvent getAbortCommonEvent(callback: AsyncCallback\): void @@ -582,6 +772,27 @@ subscriber.getAbortCommonEvent().then((abortEvent) => { }); ``` +## getAbortCommonEventSync + +getAbortCommonEventSync(): boolean + +getAbortCommonEvent的同步接口。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | ---------------------------------- | +| boolean | 表示当前有序公共事件是否取消的状态。 | + +**示例:** + +```ts +let abortEvent = subscriber.getAbortCommonEventSync(); +console.info("getAbortCommonEventSync " + JSON.stringify(abortEvent)); +``` + ## getSubscribeInfo getSubscribeInfo(callback: AsyncCallback\): void @@ -634,6 +845,27 @@ subscriber.getSubscribeInfo().then((subscribeInfo) => { }); ``` +## getSubscribeInfoSync + +getSubscribeInfoSync(): CommonEventSubscribeInfo + +getSubscribeInfo的同步接口。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ---------------------- | +| [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 表示订阅者的订阅信息。 | + +**示例:** + +```ts +let subscribeInfo = subscriber.getSubscribeInfoSync(); +console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); +``` + ## finishCommonEvent9+ finishCommonEvent(callback: AsyncCallback\): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-installer.md b/zh-cn/application-dev/reference/apis/js-apis-installer.md index 02c05776e1800413ef36cf062425c015dde2c2be..84f78d7a8b3cf9d5f41eedbce3efa5e513dad5f9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-installer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-installer.md @@ -46,9 +46,10 @@ getBundleInstaller(callback: AsyncCallback\): void; ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; try { - installer.getBundleInstaller((err, data) => { + installer.getBundleInstaller((err: BusinessError, data: installer.BundleInstaller) => { if (err) { console.error('getBundleInstaller failed:' + err.message); } else { @@ -56,7 +57,8 @@ try { } }); } catch (error) { - console.error('getBundleInstaller failed:' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed:' + message); } ``` @@ -79,15 +81,17 @@ getBundleInstaller(): Promise\; ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; try { - installer.getBundleInstaller().then((data) => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { console.info('getBundleInstaller successfully.'); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -148,27 +152,30 @@ install(hapFilePaths: Array<string>, installParam: InstallParam, callback: ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/']; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1, }; try { - installer.getBundleInstaller().then(data => { - data.install(hapFilePaths, installParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.install(hapFilePaths, installParam, (err: BusinessError) => { if (err) { console.error('install failed:' + err.message); } else { console.info('install successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` ## BundleInstaller.install @@ -226,22 +233,25 @@ install(hapFilePaths: Array<string>, callback: AsyncCallback<void>): ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/']; try { - installer.getBundleInstaller().then(data => { - data.install(hapFilePaths, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.install(hapFilePaths, (err: BusinessError) => { if (err) { console.error('install failed:' + err.message); } else { console.info('install successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -308,26 +318,29 @@ install(hapFilePaths: Array\, installParam?: InstallParam) : Promise\ { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { data.install(hapFilePaths, installParam) - .then((data) => { + .then((data: void) => { console.info('install successfully: ' + JSON.stringify(data)); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error('install failed:' + error.message); }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -367,27 +380,30 @@ uninstall(bundleName: string, installParam: InstallParam, callback: AsyncCallbac ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1 }; try { - installer.getBundleInstaller().then(data => { - data.uninstall(bundleName, installParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.uninstall(bundleName, installParam, (err: BusinessError) => { if (err) { console.error('uninstall failed:' + err.message); } else { console.info('uninstall successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -425,22 +441,25 @@ uninstall(bundleName: string, callback: AsyncCallback<void>): void; ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; try { - installer.getBundleInstaller().then(data => { - data.uninstall(bundleName, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.uninstall(bundleName, (err: BusinessError) => { if (err) { console.error('uninstall failed:' + err.message); } else { console.info('uninstall successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` ## BundleInstaller.uninstall @@ -483,26 +502,29 @@ uninstall(bundleName: string, installParam?: InstallParam) : Promise\; **示例:** ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1, }; try { - installer.getBundleInstaller().then(data => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { data.uninstall(bundleName, installParam) - .then((data) => { + .then((data: void) => { console.info('uninstall successfully: ' + JSON.stringify(data)); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error('uninstall failed:' + error.message); }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -539,27 +561,30 @@ recover(bundleName: string, installParam: InstallParam, callback: AsyncCallback& ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1 }; try { - installer.getBundleInstaller().then(data => { - data.recover(bundleName, installParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.recover(bundleName, installParam, (err: BusinessError) => { if (err) { console.error('recover failed:' + err.message); } else { console.info('recover successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -595,22 +620,25 @@ recover(bundleName: string, callback: AsyncCallback<void>): void; ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; try { - installer.getBundleInstaller().then(data => { - data.recover(bundleName, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.recover(bundleName, (err: BusinessError) => { if (err) { console.error('recover failed:' + err.message); } else { console.info('recover successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -651,26 +679,29 @@ recover(bundleName: string, installParam?: InstallParam) : Promise\; **示例:** ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let bundleName = 'com.ohos.demo'; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1, }; try { - installer.getBundleInstaller().then(data => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { data.recover(bundleName, installParam) - .then((data) => { + .then((data: void) => { console.info('recover successfully: ' + JSON.stringify(data)); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error('recover failed:' + error.message); }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -707,24 +738,27 @@ uninstall(uninstallParam: UninstallParam, callback : AsyncCallback\) : voi ```ts import installer from '@ohos.bundle.installer'; -let uninstallParam = { - bundleName : "com.ohos.demo", +import { BusinessError } from '@ohos.base'; + +let uninstallParam: installer.UninstallParam = { + bundleName: "com.ohos.demo", }; try { - installer.getBundleInstaller().then(data => { - data.uninstall(uninstallParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.uninstall(uninstallParam, (err: BusinessError) => { if (err) { console.error('uninstall failed:' + err.message); } else { console.info('uninstall successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -766,24 +800,27 @@ uninstall(uninstallParam: UninstallParam) : Promise\; ```ts import installer from '@ohos.bundle.installer'; -let uninstallParam = { - bundleName : "com.ohos.demo", +import { BusinessError } from '@ohos.base'; + +let uninstallParam: installer.UninstallParam = { + bundleName: "com.ohos.demo", }; try { - installer.getBundleInstaller().then(data => { - data.uninstall(uninstallParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.uninstall(uninstallParam, (err: BusinessError) => { if (err) { console.error('uninstall failed:' + err.message); } else { console.info('uninstall successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -836,27 +873,30 @@ updateBundleForSelf(hapFilePaths: Array\, installParam: InstallParam, c ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/']; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1, }; try { - installer.getBundleInstaller().then(data => { - data.updateBundleForSelf(hapFilePaths, installParam, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.updateBundleForSelf(hapFilePaths, installParam, (err: BusinessError) => { if (err) { console.error('updateBundleForSelf failed:' + err.message); } else { console.info('updateBundleForSelf successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -907,22 +947,25 @@ updateBundleForSelf(hapFilePaths: Array\, callback: AsyncCallback\ { - data.updateBundleForSelf(hapFilePaths, err => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { + data.updateBundleForSelf(hapFilePaths, (err: BusinessError) => { if (err) { console.error('updateBundleForSelf failed:' + err.message); } else { console.info('updateBundleForSelf successfully.'); } }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` @@ -974,26 +1017,29 @@ updateBundleForSelf(hapFilePaths: Array\, installParam?: InstallParam): ```ts import installer from '@ohos.bundle.installer'; +import { BusinessError } from '@ohos.base'; + let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/']; -let installParam = { +let installParam: installer.InstallParam = { userId: 100, isKeepData: false, installFlag: 1, }; try { - installer.getBundleInstaller().then(data => { + installer.getBundleInstaller().then((data: installer.BundleInstaller) => { data.updateBundleForSelf(hapFilePaths, installParam) - .then((data) => { + .then((data: void) => { console.info('updateBundleForSelf successfully: ' + JSON.stringify(data)); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error('updateBundleForSelf failed:' + error.message); }); - }).catch(error => { + }).catch((error: BusinessError) => { console.error('getBundleInstaller failed. Cause: ' + error.message); }); } catch (error) { - console.error('getBundleInstaller failed. Cause: ' + error.message); + let message = (error as BusinessError).message; + console.error('getBundleInstaller failed. Cause: ' + message); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md index c0eee70d41e4a9dd645b472388f8821dc56ca5cb..a91a1393c0524a9b59f8fc1a49efdcfb4492a27a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md @@ -51,9 +51,11 @@ getLauncherAbilityInfo(bundleName: string, userId: number, callback: AsyncCallba ```ts import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; +import { BusinessError } from '@ohos.base'; try { - launcherBundleManager.getLauncherAbilityInfo('com.example.demo', 100, (errData, data) => { + launcherBundleManager.getLauncherAbilityInfo('com.example.demo', 100, + (errData: BusinessError, data: launcherBundleManager.LauncherAbilityInfo[]) => { if (errData !== null) { console.error(`errData is errCode:${errData.code} message:${errData.message}`); } else { @@ -61,7 +63,9 @@ try { } }) } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` @@ -101,17 +105,21 @@ getLauncherAbilityInfo(bundleName: string, userId: number) : Promise { + launcherBundleManager.getLauncherAbilityInfo("com.example.demo", 100) + .then((data: launcherBundleManager.LauncherAbilityInfo[]) => { console.log("data is " + JSON.stringify(data)); - }).catch (errData => { + }).catch ((errData: BusinessError) => { console.error(`errData is errCode:${errData.code} message:${errData.message}`); }) } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` @@ -151,9 +159,11 @@ getAllLauncherAbilityInfo(userId: number, callback: AsyncCallback { + launcherBundleManager.getAllLauncherAbilityInfo(100, + (errData: BusinessError, data: launcherBundleManager.LauncherAbilityInfo[]) => { if (errData !== null) { console.error(`errData is errCode:${errData.code} message:${errData.message}`); } else { @@ -161,7 +171,9 @@ try { } }); } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` ## launcherBundlemanager.getAllLauncherAbilityInfo9+ @@ -200,15 +212,19 @@ getAllLauncherAbilityInfo(userId: number) : Promise { + launcherBundleManager.getAllLauncherAbilityInfo(100) + .then((data: launcherBundleManager.LauncherAbilityInfo[]) => { console.log("data is " + JSON.stringify(data)); - }).catch (errData => { + }).catch ((errData: BusinessError) => { console.error(`errData is errCode:${errData.code} message:${errData.message}`); }); } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` @@ -246,9 +262,11 @@ getShortcutInfo(bundleName :string, callback: AsyncCallback { + launcherBundleManager.getShortcutInfo("com.example.demo", + (errData: BusinessError, data: launcherBundleManager.ShortcutInfo[]) => { if (errData !== null) { console.error(`errData is errCode:${errData.code} message:${errData.message}`); } else { @@ -256,7 +274,9 @@ try { } }); } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` @@ -294,14 +314,18 @@ getShortcutInfo(bundleName : string) : Promise { + launcherBundleManager.getShortcutInfo("com.example.demo") + .then((data: launcherBundleManager.ShortcutInfo[]) => { console.log("data is " + JSON.stringify(data)); - }).catch (errData => { + }).catch ((errData: BusinessError) => { console.error(`errData is errCode:${errData.code} message:${errData.message}`); }); } catch (errData) { - console.error(`errData is errCode:${errData.code} message:${errData.message}`); + let code = (errData as BusinessError).code; + let message = (errData as BusinessError).message; + console.error(`errData is errCode:${code} message:${message}`); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-matrix4.md b/zh-cn/application-dev/reference/apis/js-apis-matrix4.md index 9cd9ee889ea6dd9f31f196fbe6ed37fb73e6320d..c10be54904ed2a2ad8fafbe9ee0e798373a11448 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-matrix4.md +++ b/zh-cn/application-dev/reference/apis/js-apis-matrix4.md @@ -561,9 +561,9 @@ import matrix4 from '@ohos.matrix4' @Entry @Component struct Test { - private originPoint: [number, number] = [50, 50] + private originPoint: number[] = [50, 50] private matrix_1 = matrix4.identity().translate({ x: 150, y: -50 }) - private transformPoint = this.matrix_1.transformPoint(this.originPoint) + private transformPoint = this.matrix_1.transformPoint([this.originPoint[0], this.originPoint[1]]) private matrix_2 = matrix4.identity().translate({ x: this.transformPoint[0], y: this.transformPoint[1] }) build() { diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md index 5277999966fe8f6d57f4bd059f23f7d5f332f54e..d6e81af5da132a9d69fe9c0f9ad563a6635ef153 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md @@ -30,14 +30,14 @@ matchMediaSync(condition: string): MediaQueryListener **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | ---------------------------------------- | -| condition | string | 是 | 媒体事件的匹配条件,具体可参考[媒体查询语法规则](../../ui/arkts-layout-development-media-query.md#语法规则)。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ------------------------------------------------------------ | +| condition | string | 是 | 媒体事件的匹配条件,具体可参考[媒体查询语法规则](../../ui/arkts-layout-development-media-query.md#语法规则)。 | **返回值:** -| 类型 | 说明 | -| ------------------ | ---------------------- | +| 类型 | 说明 | +| ------------------ | -------------------------------------------- | | MediaQueryListener | 媒体事件监听句柄,用于注册和去注册监听回调。 | **示例:** @@ -71,10 +71,10 @@ on(type: 'change', callback: Callback<MediaQueryResult>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ---------------- | -| type | string | 是 | 必须填写字符串'change'。 | -| callback | Callback<MediaQueryResult> | 是 | 向媒体查询注册的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------------------ | +| type | string | 是 | 必须填写字符串'change'。 | +| callback | Callback<MediaQueryResult> | 是 | 向媒体查询注册的回调 | **示例:** @@ -102,7 +102,7 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void import mediaquery from '@ohos.mediaquery' let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 - function onPortrait(mediaQueryResult) { + function onPortrait(mediaQueryResult:mediaquery.MediaQueryResult) { if (mediaQueryResult.matches) { // do something here } else { @@ -141,7 +141,7 @@ struct MediaQueryExample { @State text: string = 'Portrait' listener = mediaquery.matchMediaSync('(orientation: landscape)') - onPortrait(mediaQueryResult) { + onPortrait(mediaQueryResult:mediaquery.MediaQueryResult) { if (mediaQueryResult.matches) { this.color = '#FFD700' this.text = 'Landscape' @@ -152,7 +152,7 @@ struct MediaQueryExample { } aboutToAppear() { - let portraitFunc = this.onPortrait.bind(this) // bind current js instance + let portraitFunc = (mediaQueryResult:mediaquery.MediaQueryResult):void=>this.onPortrait(mediaQueryResult) // bind current js instance this.listener.on('change', portraitFunc) } diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md index ca406ed0ae385ee789d4a43bd27ea0dd990809d3..d9f1af9c03796b89dce1c923c7d6feea53de508b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md @@ -10,6 +10,7 @@ ```ts import notificationManager from '@ohos.notificationManager'; +import Base from '@ohos.base'; ``` ## notificationManager.publish @@ -45,7 +46,7 @@ publish(request: NotificationRequest, callback: AsyncCallback\): void ```ts //publish回调 -function publishCallback(err) { +function publishCallback(err: Base.BusinessError) { if (err) { console.error(`publish failed, code is ${err.code}, message is ${err.message}`); } else { @@ -155,7 +156,7 @@ publish(request: NotificationRequest, userId: number, callback: AsyncCallback\ { console.info("publish success"); @@ -267,7 +268,7 @@ cancel(id: number, label: string, callback: AsyncCallback\): void ```ts // cancel回调 -function cancelCallback(err) { +function cancelCallback(err: Base.BusinessError) { if (err) { console.error(`cancel failed, code is ${err.code}, message is ${err.message}`); } else { @@ -341,7 +342,7 @@ cancel(id: number, callback: AsyncCallback\): void ```ts // cancel回调 -function cancelCallback(err) { +function cancelCallback(err: Base.BusinessError) { if (err) { console.error(`cancel failed, code is ${err.code}, message is ${err.message}`); } else { @@ -379,7 +380,7 @@ cancelAll(callback: AsyncCallback\): void ```ts // cancel回调 -function cancelAllCallback(err) { +function cancelAllCallback(err: Base.BusinessError) { if (err) { console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`); } else { @@ -449,7 +450,7 @@ addSlot(slot: NotificationSlot, callback: AsyncCallback\): void ```ts // addslot回调 -function addSlotCallBack(err) { +function addSlotCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -457,7 +458,7 @@ function addSlotCallBack(err) { } } // 通知slot对象 -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.addSlot(notificationSlot, addSlotCallBack); @@ -496,7 +497,7 @@ addSlot(slot: NotificationSlot): Promise\ ```ts // 通知slot对象 -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.addSlot(notificationSlot).then(() => { @@ -534,7 +535,7 @@ addSlot(type: SlotType, callback: AsyncCallback\): void ```ts // addslot回调 -function addSlotCallBack(err) { +function addSlotCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -611,7 +612,7 @@ addSlots(slots: Array\, callback: AsyncCallback\): voi ```ts // addSlots回调 -function addSlotsCallBack(err) { +function addSlotsCallBack(err: Base.BusinessError) { if (err) { console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`); } else { @@ -619,11 +620,11 @@ function addSlotsCallBack(err) { } } // 通知slot对象 -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; // 通知slot array 对象 -let notificationSlotArray = new Array(); +let notificationSlotArray: notificationManager.NotificationSlot[] = new Array(); notificationSlotArray[0] = notificationSlot; notificationManager.addSlots(notificationSlotArray, addSlotsCallBack); @@ -662,11 +663,11 @@ addSlots(slots: Array\): Promise\ ```ts // 通知slot对象 -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; // 通知slot array 对象 -let notificationSlotArray = new Array(); +let notificationSlotArray: notificationManager.NotificationSlot[] = new Array(); notificationSlotArray[0] = notificationSlot; notificationManager.addSlots(notificationSlotArray).then(() => { @@ -703,14 +704,14 @@ getSlot(slotType: SlotType, callback: AsyncCallback\): void ```ts // getSlot回调 -function getSlotCallback(err,data) { +function getSlotCallback(err: Base.BusinessError, data: notificationManager.NotificationSlot) { if (err) { console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlot success"); + console.info(`getSlot success, data is ${JSON.stringify(data)}`); } } -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; notificationManager.getSlot(slotType, getSlotCallback); ``` @@ -747,9 +748,10 @@ getSlot(slotType: SlotType): Promise\ **示例:** ```ts -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; -notificationManager.getSlot(slotType).then((data) => { - console.info("getSlot success, data: " + JSON.stringify(data)); +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; + +notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => { + console.info("getSlot success, data: " + JSON.stringify(data)); }); ``` @@ -781,12 +783,12 @@ getSlots(callback: AsyncCallback\>): void ```ts // getSlots回调 -function getSlotsCallback(err,data) { - if (err) { - console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("getSlots success"); - } +function getSlotsCallback(err: Base.BusinessError, data: Array) { + if (err) { + console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info(`getSlots success, data is ${JSON.stringify(data)}`); + } } notificationManager.getSlots(getSlotsCallback); ``` @@ -818,7 +820,7 @@ getSlots(): Promise\> **示例:** ```ts -notificationManager.getSlots().then((data) => { +notificationManager.getSlots().then((data: Array) => { console.info("getSlots success, data: " + JSON.stringify(data)); }); ``` @@ -852,15 +854,15 @@ removeSlot(slotType: SlotType, callback: AsyncCallback\): void ```ts // removeSlot回调 -function removeSlotCallback(err) { - if (err) { - console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("removeSlot success"); - } +function removeSlotCallback(err: Base.BusinessError) { + if (err) { + console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("removeSlot success"); + } } let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; -notificationManager.removeSlot(slotType,removeSlotCallback); +notificationManager.removeSlot(slotType, removeSlotCallback); ``` ## notificationManager.removeSlot @@ -890,7 +892,7 @@ removeSlot(slotType: SlotType): Promise\ **示例:** ```ts -let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; +let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION; notificationManager.removeSlot(slotType).then(() => { console.info("removeSlot success"); }); @@ -923,7 +925,7 @@ removeAllSlots(callback: AsyncCallback\): void **示例:** ```ts -function removeAllCallBack(err) { +function removeAllCallBack(err: Base.BusinessError) { if (err) { console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`); } else { @@ -993,17 +995,17 @@ setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCall **示例:** ```ts -function setNotificationEnablenCallback(err) { +function setNotificationEnableCallback(err: Base.BusinessError) { if (err) { - console.error(`setNotificationEnablenCallback failed, code is ${err.code}, message is ${err.message}`); + console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("setNotificationEnablenCallback success"); + console.info("setNotificationEnableCallback success"); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback); +notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback); ``` ## notificationManager.setNotificationEnable @@ -1039,7 +1041,7 @@ setNotificationEnable(bundle: BundleOption, enable: boolean): Promise\ **示例:** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.setNotificationEnable(bundle, false).then(() => { @@ -1080,16 +1082,18 @@ isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\): **示例:** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } -let bundle = { + +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; + notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback); ``` @@ -1131,10 +1135,10 @@ isNotificationEnabled(bundle: BundleOption): Promise\ **示例:** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.isNotificationEnabled(bundle).then((data) => { +notificationManager.isNotificationEnabled(bundle).then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1170,11 +1174,11 @@ isNotificationEnabled(callback: AsyncCallback\): void **示例:** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } @@ -1212,7 +1216,7 @@ isNotificationEnabled(): Promise\ **示例:** ```ts -notificationManager.isNotificationEnabled().then((data) => { +notificationManager.isNotificationEnabled().then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1250,15 +1254,15 @@ isNotificationEnabled(userId: number, callback: AsyncCallback\): void **示例:** ```ts -function isNotificationEnabledCallback(err, data) { +function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationEnabled success"); + console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`); } } -let userId = 1; +let userId: number = 1; notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback); ``` @@ -1301,9 +1305,9 @@ isNotificationEnabled(userId: number): Promise\ **示例:** ```ts -let userId = 1; +let userId: number = 1; -notificationManager.isNotificationEnabled(userId).then((data) => { +notificationManager.isNotificationEnabled(userId).then((data: boolean) => { console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1342,14 +1346,14 @@ displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\ **示例:** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.displayBadge(bundle, false).then(() => { @@ -1413,7 +1417,7 @@ isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ------------------------ | | bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是 | 指定应用的包信息。 | -| callback | AsyncCallback\ | 是 | 获取角标使能状态回调函数。 | +| callback | AsyncCallback\ | 是 | 获取角标使能状态回调函数。 | **错误码:** @@ -1429,14 +1433,14 @@ isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\): void **示例:** ```ts -function isBadgeDisplayedCallback(err, data) { +function isBadgeDisplayedCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isBadgeDisplayed success"); + console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); @@ -1480,10 +1484,11 @@ isBadgeDisplayed(bundle: BundleOption): Promise\ **示例:** ```ts -let bundle = { - bundle: "bundleName1", +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; -notificationManager.isBadgeDisplayed(bundle).then((data) => { + +notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => { console.info("isBadgeDisplayed success, data: " + JSON.stringify(data)); }); ``` @@ -1514,7 +1519,8 @@ setBadgeNumber(badgeNumber: number): Promise\ **示例:** ```ts -let badgeNumber = 10 +let badgeNumber: number = 10; + notificationManager.setBadgeNumber(badgeNumber).then(() => { console.info("displayBadge success"); }); @@ -1549,7 +1555,7 @@ setBadgeNumber(badgeNumber: number, callback: AsyncCallback\): void **示例:** ```ts -function setBadgeNumberCallback(err) { +function setBadgeNumberCallback(err: Base.BusinessError) { if (err) { console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`); } else { @@ -1557,7 +1563,7 @@ function setBadgeNumberCallback(err) { } } -let badgeNumber = 10 +let badgeNumber: number = 10; notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback); ``` @@ -1595,17 +1601,17 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCal **示例:** ```ts -function setSlotByBundleCallback(err) { +function setSlotByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { console.info("setSlotByBundle success"); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let notificationSlot = { +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); @@ -1644,12 +1650,14 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\ **示例:** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let notificationSlot = { + +let notificationSlot: notificationManager.NotificationSlot = { type: notificationManager.SlotType.SOCIAL_COMMUNICATION }; + notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => { console.info("setSlotByBundle success"); }); @@ -1688,14 +1696,14 @@ getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback\) { if (err) { console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlotsByBundle success"); + console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`); } } -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback); @@ -1739,10 +1747,11 @@ getSlotsByBundle(bundle: BundleOption): Promise\> **示例:** ```ts -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.getSlotsByBundle(bundle).then((data) => { + +notificationManager.getSlotsByBundle(bundle).then((data: Array) => { console.info("getSlotsByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1780,16 +1789,18 @@ getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\): voi **示例:** ```ts -function getSlotNumByBundleCallback(err, data) { +function getSlotNumByBundleCallback(err: Base.BusinessError, data: number) { if (err) { console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getSlotNumByBundle success"); + console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`); } } -let bundle = { - bundle: "bundleName1", + +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; + notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); ``` @@ -1831,10 +1842,11 @@ getSlotNumByBundle(bundle: BundleOption): Promise\ **示例:** ```ts -let bundle = { - bundle: "bundleName1", +let bundle: notificationManager.BundleOption = { + bundle: "bundleName1", }; -notificationManager.getSlotNumByBundle(bundle).then((data) => { + +notificationManager.getSlotNumByBundle(bundle).then((data: number) => { console.info("getSlotNumByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1869,11 +1881,11 @@ getAllActiveNotifications(callback: AsyncCallback\>) **示例:** ```ts -function getAllActiveNotificationsCallback(err, data) { +function getAllActiveNotificationsCallback(err: Base.BusinessError, data: Array) { if (err) { console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getAllActiveNotifications success"); + console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`); } } @@ -1911,7 +1923,7 @@ getAllActiveNotifications(): Promise\ { +notificationManager.getAllActiveNotifications().then((data: Array) => { console.info("getAllActiveNotifications success, data: " + JSON.stringify(data)); }); ``` @@ -1943,11 +1955,11 @@ getActiveNotificationCount(callback: AsyncCallback\): void **示例:** ```ts -function getActiveNotificationCountCallback(err, data) { +function getActiveNotificationCountCallback(err: Base.BusinessError, data: number) { if (err) { console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getActiveNotificationCount success"); + console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`); } } @@ -1981,7 +1993,7 @@ getActiveNotificationCount(): Promise\ **示例:** ```ts -notificationManager.getActiveNotificationCount().then((data) => { +notificationManager.getActiveNotificationCount().then((data: number) => { console.info("getActiveNotificationCount success, data: " + JSON.stringify(data)); }); ``` @@ -2013,7 +2025,7 @@ getActiveNotifications(callback: AsyncCallback\>): v **示例:** ```ts -function getActiveNotificationsCallback(err, data) { +function getActiveNotificationsCallback(err: Base.BusinessError, data: Array) { if (err) { console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2051,7 +2063,7 @@ getActiveNotifications(): Promise\ { +notificationManager.getActiveNotifications().then((data: Array) => { console.info("removeGroupByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -2084,7 +2096,7 @@ cancelGroup(groupName: string, callback: AsyncCallback\): void **示例:** ```ts -function cancelGroupCallback(err) { +function cancelGroupCallback(err: Base.BusinessError) { if (err) { console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2092,7 +2104,7 @@ function cancelGroupCallback(err) { } } -let groupName = "GroupName"; +let groupName: string = "GroupName"; notificationManager.cancelGroup(groupName, cancelGroupCallback); ``` @@ -2124,7 +2136,7 @@ cancelGroup(groupName: string): Promise\ **示例:** ```ts -let groupName = "GroupName"; +let groupName: string = "GroupName"; notificationManager.cancelGroup(groupName).then(() => { console.info("cancelGroup success"); }); @@ -2164,7 +2176,7 @@ removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCall **示例:** ```ts -function removeGroupByBundleCallback(err) { +function removeGroupByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2172,8 +2184,8 @@ function removeGroupByBundleCallback(err) { } } -let bundleOption = {bundle: "Bundle"}; -let groupName = "GroupName"; +let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" }; +let groupName: string = "GroupName"; notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback); ``` @@ -2211,8 +2223,9 @@ removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\ **示例:** ```ts -let bundleOption = {bundle: "Bundle"}; -let groupName = "GroupName"; +let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" }; +let groupName: string = "GroupName"; + notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => { console.info("removeGroupByBundle success"); }); @@ -2251,7 +2264,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\): vo **示例:** ```ts -function setDoNotDisturbDateCallback(err) { +function setDoNotDisturbDateCallback(err: Base.BusinessError) { if (err) { console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2259,7 +2272,7 @@ function setDoNotDisturbDateCallback(err) { } } -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) @@ -2300,7 +2313,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate): Promise\ **示例:** ```ts -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) @@ -2346,7 +2359,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallb **示例:** ```ts -function setDoNotDisturbDateCallback(err) { +function setDoNotDisturbDateCallback(err: Base.BusinessError) { if (err) { console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2354,13 +2367,13 @@ function setDoNotDisturbDateCallback(err) { } } -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) }; -let userId = 1; +let userId: number = 1; notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback); ``` @@ -2399,13 +2412,13 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\ **示例:** ```ts -let doNotDisturbDate = { +let doNotDisturbDate: notificationManager.DoNotDisturbDate = { type: notificationManager.DoNotDisturbType.TYPE_ONCE, begin: new Date(), end: new Date(2021, 11, 15, 18, 0) }; -let userId = 1; +let userId: number = 1; notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => { console.info("setDoNotDisturbDate success"); @@ -2445,11 +2458,11 @@ getDoNotDisturbDate(callback: AsyncCallback\): void **示例:** ```ts -function getDoNotDisturbDateCallback(err,data) { +function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) { if (err) { console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDoNotDisturbDate success"); + console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`); } } @@ -2488,8 +2501,8 @@ getDoNotDisturbDate(): Promise\ **示例:** ```ts -notificationManager.getDoNotDisturbDate().then((data) => { - console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); +notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => { + console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2528,15 +2541,15 @@ getDoNotDisturbDate(userId: number, callback: AsyncCallback\) **示例:** ```ts -function getDoNotDisturbDateCallback(err,data) { +function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) { if (err) { console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDoNotDisturbDate success"); + console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`); } } -let userId = 1; +let userId: number = 1; notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback); ``` @@ -2580,9 +2593,9 @@ getDoNotDisturbDate(userId: number): Promise\ **示例:** ```ts -let userId = 1; +let userId: number = 1; -notificationManager.getDoNotDisturbDate(userId).then((data) => { +notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => { console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2617,7 +2630,7 @@ notificationManager.getDoNotDisturbDate(userId).then((data) => { **示例:** ```ts -function isSupportDoNotDisturbModeCallback(err,data) { +function isSupportDoNotDisturbModeCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2659,7 +2672,7 @@ isSupportDoNotDisturbMode(): Promise\ **示例:** ```ts -notificationManager.isSupportDoNotDisturbMode().then((data) => { +notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => { console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data)); }); ``` @@ -2692,8 +2705,8 @@ isSupportTemplate(templateName: string, callback: AsyncCallback\): voi **示例:** ```javascript -let templateName = 'process'; -function isSupportTemplateCallback(err, data) { +let templateName: string = 'process'; +function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2737,9 +2750,9 @@ isSupportTemplate(templateName: string): Promise\ **示例:** ```javascript -let templateName = 'process'; +let templateName: string = 'process'; -notificationManager.isSupportTemplate(templateName).then((data) => { +notificationManager.isSupportTemplate(templateName).then((data: boolean) => { console.info("isSupportTemplate success, data: " + JSON.stringify(data)); }); ``` @@ -2771,7 +2784,7 @@ requestEnableNotification(callback: AsyncCallback\): void **示例:** ```javascript -function requestEnableNotificationCallback(err) { +function requestEnableNotificationCallback(err: Base.BusinessError) { if (err) { console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2808,7 +2821,76 @@ notificationManager.requestEnableNotification().then(() => { }); ``` +## notificationManager.requestEnableNotification10+ + +requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback\): void + +应用请求通知使能模态弹窗(Callback形式)。 + +**系统能力**:SystemCapability.Notification.Notification + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- |--------------------| +| context | UIAbilityContext | 是 | 通知弹窗绑定Ability的上下文。 | +| callback | AsyncCallback\ | 是 | 应用请求通知使能的回调函数。 | + +**错误码:** + +错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | +| 1600002 | Marshalling or unmarshalling error. | +| 1600003 | Failed to connect service. | + +**示例:** + +```javascript +function requestEnableNotificationCallback(err) { + if (err) { + console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("requestEnableNotification success"); + } +}; + +notificationManager.requestEnableNotification(globalThis.uicontext, requestEnableNotificationCallback); +``` + +## notificationManager.requestEnableNotification10+ + +requestEnableNotification(context: UIAbilityContext): Promise\ + +应用请求通知使能模态弹窗(Promise形式)。 + +**系统能力**:SystemCapability.Notification.Notification + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- |--------------------| +| context | UIAbilityContext | 是 | 通知弹窗绑定Ability的上下文。 | + +**错误码:** +错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | +| 1600002 | Marshalling or unmarshalling error. | +| 1600003 | Failed to connect service. | + +**示例:** + +```javascript +notificationManager.requestEnableNotification(globalThis.uicontext).then(() => { + console.info("requestEnableNotification success"); +}); +``` ## notificationManager.setDistributedEnable @@ -2843,7 +2925,7 @@ setDistributedEnable(enable: boolean, callback: AsyncCallback\): void **示例:** ```javascript -function setDistributedEnableCallback(err) { +function setDistributedEnableCallback(err: Base.BusinessError) { if (err) { console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2851,7 +2933,7 @@ function setDistributedEnableCallback(err) { } }; -let enable = true; +let enable: boolean = true; notificationManager.setDistributedEnable(enable, setDistributedEnableCallback); ``` @@ -2888,11 +2970,11 @@ setDistributedEnable(enable: boolean): Promise\ **示例:** ```javascript -let enable = true; +let enable: boolean = true; notificationManager.setDistributedEnable(enable).then(() => { - console.info("setDistributedEnable success"); - }); + console.info("setDistributedEnable success"); +}); ``` @@ -2924,7 +3006,7 @@ isDistributedEnabled(callback: AsyncCallback\): void **示例:** ```javascript -function isDistributedEnabledCallback(err, data) { +function isDistributedEnabledCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`); } else { @@ -2966,7 +3048,7 @@ isDistributedEnabled(): Promise\ ```javascript notificationManager.isDistributedEnabled() - .then((data) => { + .then((data: boolean) => { console.info("isDistributedEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -3007,7 +3089,7 @@ setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: As **示例:** ```javascript -function setDistributedEnableByBundleCallback(err) { +function setDistributedEnableByBundleCallback(err: Base.BusinessError) { if (err) { console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3015,11 +3097,11 @@ function setDistributedEnableByBundleCallback(err) { } }; -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -let enable = true +let enable: boolean = true; notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback); ``` @@ -3060,11 +3142,11 @@ setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise\ { console.info("setDistributedEnableByBundle success"); @@ -3105,7 +3187,7 @@ isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\ **示例:** ```javascript -let bundle = { +let bundle: notificationManager.BundleOption = { bundle: "bundleName1", }; -notificationManager.isDistributedEnabledByBundle(bundle).then((data) => { +notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => { console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -3200,11 +3282,11 @@ getDeviceRemindType(callback: AsyncCallback\): void **示例:** ```javascript -function getDeviceRemindTypeCallback(err, data) { +function getDeviceRemindTypeCallback(err: Base.BusinessError, data: notificationManager.DeviceRemindType) { if (err) { console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("getDeviceRemindType success"); + console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`); } }; @@ -3242,7 +3324,7 @@ getDeviceRemindType(): Promise\ **示例:** ```javascript -notificationManager.getDeviceRemindType().then((data) => { +notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => { console.info("getDeviceRemindType success, data: " + JSON.stringify(data)); }); ``` @@ -3288,7 +3370,7 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user ```ts //publishAsBundle回调 -function callback(err) { +function callback(err: Base.BusinessError) { if (err) { console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3296,11 +3378,11 @@ function callback(err) { } } // 被代理应用的包名 -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // 用户ID -let userId = 100; +let userId: number = 100; // NotificationRequest对象 -let request = { +let request: notificationManager.NotificationRequest = { id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -3355,11 +3437,11 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user ```ts // 被代理应用的包名 -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // 用户ID -let userId = 100; +let userId: number = 100; // NotificationRequest对象 -let request = { +let request: notificationManager.NotificationRequest = { id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -3415,7 +3497,7 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number, callbac ```ts // cancelAsBundle -function cancelAsBundleCallback(err) { +function cancelAsBundleCallback(err: Base.BusinessError) { if (err) { console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3423,9 +3505,9 @@ function cancelAsBundleCallback(err) { } } // 被代理应用的包名 -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // 用户ID -let userId = 100; +let userId: number = 100; notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback); ``` @@ -3468,9 +3550,9 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number): Promis ```ts // 被代理应用的包名 -let representativeBundle = "com.example.demo"; +let representativeBundle: string = "com.example.demo"; // 用户ID -let userId = 100; +let userId: number = 100; notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => { console.info("cancelAsBundle success"); @@ -3513,7 +3595,7 @@ setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, ```ts // setNotificationEnableSlot -function setNotificationEnableSlotCallback(err) { +function setNotificationEnableSlotCallback(err: Base.BusinessError) { if (err) { console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3606,11 +3688,11 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncC ```ts // isNotificationSlotEnabled -function getEnableSlotCallback(err, data) { +function getEnableSlotCallback(err: Base.BusinessError, data: boolean) { if (err) { console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`); } else { - console.info("isNotificationSlotEnabled success"); + console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`); } }; @@ -3661,7 +3743,7 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\ { + notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => { console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -3701,10 +3783,10 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: **示例:** ```ts -let userId = 100; -let enable = true; +let userId: number = 100; +let enable: boolean = true; -function callback(err) { +function callback(err: Base.BusinessError) { if (err) { console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`); } else { @@ -3755,13 +3837,11 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise\< **示例:** ```ts -let userId = 100; -let enable = true; +let userId: number = 100; +let enable: boolean = true; notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => { console.info('setSyncNotificationEnabledWithoutApp success'); -}).catch((err) => { - console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`); }); ``` @@ -3799,9 +3879,9 @@ getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\ **示例:** ```ts -let userId = 100; -notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => { - console.info('getSyncNotificationEnabledWithoutApp, data:' + data); -}).catch((err) => { - console.info('getSyncNotificationEnabledWithoutApp, err:' + err); +let userId: number = 100; + +notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => { + console.info('getSyncNotificationEnabledWithoutApp, data:' + data); }); ``` @@ -3897,9 +3976,11 @@ try{ function OnCheckNotification(info : notificationManager.NotificationCheckInfo) { console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`); if(info.notificationId == 1){ - return { code: 1, message: "testMsg1"} + let result: notificationManager.NotificationCheckResult = { code: 1, message: "testMsg1"}; + return result; } else { - return { code: 0, message: "testMsg0"} + let result: notificationManager.NotificationCheckResult = { code: 0, message: "testMsg0"}; + return result; } } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md index c99064305ebd3121b71dc979402b1c0c4ff5ada0..adde3dcde0de3f2240a9c0e4ea01b1c469e3581f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md @@ -5635,7 +5635,7 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; let credentialInfo: account_osAccount.CredentialInfo = { credType: account_osAccount.AuthType.PIN, credSubType: account_osAccount.AuthSubType.PIN_SIX, - token: null + token: new Uint8Array([]), }; let userIDM = new account_osAccount.UserIdentityManager(); userIDM.openSession((err: BusinessError, challenge: Uint8Array) => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-overlay.md b/zh-cn/application-dev/reference/apis/js-apis-overlay.md index 30d31c0e22a1856fcedff4ce04165ee7083f923d..95ab7d99622d93b82206986fb63817a4509f14d6 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-overlay.md +++ b/zh-cn/application-dev/reference/apis/js-apis-overlay.md @@ -45,6 +45,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean): Promise\; **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let moduleName = "feature"; let isEnabled = false; @@ -52,11 +54,13 @@ try { overlay.setOverlayEnabled(moduleName, isEnabled) .then(() => { console.info('setOverlayEnabled success'); - }).catch((err) => { + }).catch((err: BusinessError) => { console.info('setOverlayEnabled failed due to err code: ' + err.code + ' ' + 'message:' + err.message); }); } catch (err) { - console.info('setOverlayEnabled failed due to err code: ' + err.code + ' ' + 'message:' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.info('setOverlayEnabled failed due to err code: ' + code + ' ' + 'message:' + message); } ``` @@ -88,6 +92,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean, callback: AsyncCallback **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let moduleName = "feature"; let isEnabled = false; @@ -100,7 +106,9 @@ try { console.info('setOverlayEnabled success'); }); } catch (err) { - console.info('setOverlayEnabled failed due to err code: ' + err.code + ' ' + 'message:' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.info('setOverlayEnabled failed due to err code: ' + code + ' ' + 'message:' + message); } ``` @@ -144,6 +152,8 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication_xxxxx"; let moduleName = "feature"; let isEnabled = false; @@ -152,11 +162,13 @@ try { overlay.setOverlayEnabledByBundleName(bundleName, moduleName, isEnabled) .then((data) => { console.info('setOverlayEnabledByBundleName successfully'); - }).catch((err) => { + }).catch((err: BusinessError) => { console.info('setOverlayEnabledByBundleName failed due to err code: ' + err.code + ' ' + 'message:' + err.message); }); } catch (err) { - console.info('setOverlayEnabledByBundleName failed due to err code: ' + err.code + ' ' + 'message:' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.info('setOverlayEnabledByBundleName failed due to err code: ' + code + ' ' + 'message:' + message); } ``` @@ -195,6 +207,8 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication_xxxxx"; let moduleName = "feature"; let isEnabled = false; @@ -208,7 +222,9 @@ try { console.info('setOverlayEnabledByBundleName successfully'); }); } catch (err) { - console.info('setOverlayEnabledByBundleName failed due to err code: ' + err.code + ' ' + 'message:' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.info('setOverlayEnabledByBundleName failed due to err code: ' + code + ' ' + 'message:' + message); } ``` @@ -245,6 +261,8 @@ getOverlayModuleInfo(moduleName: string): Promise\; **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let moduleName = "feature"; (async() => { @@ -252,7 +270,9 @@ let moduleName = "feature"; let overlayModuleInfo = await overlay.getOverlayModuleInfo(moduleName); console.log('overlayModuleInfo is ' + JSON.stringify(overlayModuleInfo)); } catch(err) { - console.log('getOverlayModuleInfo failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getOverlayModuleInfo failed due to err code : ' + code + ' ' + 'message :' + message); } })(); ``` @@ -285,6 +305,8 @@ getOverlayModuleInfo(moduleName: string, callback: AsyncCallback\ { @@ -295,7 +317,9 @@ try { console.log('overlayModuleInfo is ' + JSON.stringify(data)); }); } catch (err) { - console.log('getOverlayModuleInfo failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getOverlayModuleInfo failed due to err code : ' + code + ' ' + 'message :' + message); } ``` @@ -331,6 +355,8 @@ getTargetOverlayModuleInfos(targetModuleName: string): Promise\ { @@ -338,7 +364,9 @@ let targetModuleName = "feature"; let overlayModuleInfos = await overlay.getTargetOverlayModuleInfos(targetModuleName); console.log('overlayModuleInfos are ' + JSON.stringify(overlayModuleInfos)); } catch(err) { - console.log('getTargetOverlayModuleInfos failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getTargetOverlayModuleInfos failed due to err code : ' + code + ' ' + 'message :' + message); } })(); ``` @@ -370,6 +398,8 @@ getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback\ { @@ -380,7 +410,9 @@ try { console.log('overlayModuleInfo is ' + JSON.stringify(data)); }); } catch (err) { - console.log('getTargetOverlayModuleInfos failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getTargetOverlayModuleInfos failed due to err code : ' + code + ' ' + 'message :' + message); } ``` @@ -423,6 +455,8 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promi **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication_xxxxx"; let moduleName = "feature"; @@ -431,7 +465,9 @@ let moduleName = "feature"; let overlayModuleInfos = await overlay.getOverlayModuleInfoByBundleName(bundleName, moduleName); console.log('overlayModuleInfos are ' + JSON.stringify(overlayModuleInfos)); } catch(err) { - console.log('getTargetOverlayModuleInfos failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getTargetOverlayModuleInfos failed due to err code : ' + code + ' ' + 'message :' + message); } })(); ``` @@ -470,6 +506,8 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callbac **示例:** ```ts +import overlay from '@ohos.bundle.overlay'; +import { BusinessError } from '@ohos.base'; let bundleName = "com.example.myapplication_xxxxx"; let moduleName = "feature"; @@ -482,7 +520,9 @@ try { console.log('overlayModuleInfo is ' + JSON.stringify(data)); }); } catch (err) { - console.log('getOverlayModuleInfoByBundleName failed due to err code : ' + err.code + ' ' + 'message :' + err.message); + let code = (err as BusinessError).code; + let message = (err as BusinessError).message; + console.log('getOverlayModuleInfoByBundleName failed due to err code : ' + code + ' ' + 'message :' + message); } ``` @@ -517,6 +557,8 @@ getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback\ { - try { + phAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => { if (err == undefined) { console.info(`getPhotoIndex successfully and index is : ${index}`); } else { console.info(`getPhotoIndex failed;`); } - } catch (error) { - console.info(`getPhotoIndex failed; error: ${error}`); - } + }); + } catch (error) { + console.info(`getPhotoIndex failed; error: ${error}`); } } ``` @@ -1390,33 +1389,34 @@ getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promis import dataSharePredicates from '@ohos.data.dataSharePredicates'; async function example() { - console.info('getPhotoIndexDemo'); - let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); - let fetchOp = { - fetchColumns: [], - predicates: predicatesForGetAsset - }; - //Obtain the uri of the album - let albumFetchResult = await helper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp); - let album = await albumFetchResult.getFirstObject(); - - let predicates = new dataSharePredicates.DataSharePredicates(); - predicates.orderByAsc("add_modified"); - let fetchOptions = { - fetchColumns: [], - predicates: predicates - }; - let photoFetchResult = await album.getAssets(fetchOptions); - let expectIndex = 1; - //Obtain the uri of the second file - let photoAsset = await photoFetchResult.getObjectByPosition(expectIndex); - - photoAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions) - .then((index) => { - console.info(`getPhotoIndex successfully and index is : ${index}`); - }).catch((err) => { + try { + console.info('getPhotoIndexDemo'); + let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); + let fetchOp = { + fetchColumns: [], + predicates: predicatesForGetAsset + }; + // Obtain the uri of the album + let albumFetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp); + let album = await albumFetchResult.getFirstObject(); + let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.orderByAsc(photoAccessHelper.PhotoKeys.DATE_MODIFIED); + let fetchOptions = { + fetchColumns: [photoAccessHelper.PhotoKeys.DATE_MODIFIED], + predicates: predicates + }; + let photoFetchResult = await album.getAssets(fetchOptions); + let expectIndex = 1; + // Obtain the uri of the second file + let photoAsset = await photoFetchResult.getObjectByPosition(expectIndex); + phAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions).then((index) => { + console.info(`getPhotoIndex successfully and index is : ${index}`); + }).catch((err) => { console.info(`getPhotoIndex failed; error: ${err}`); - }) + }); + } catch (error) { + console.info(`getPhotoIndex failed; error: ${error}`); + } } ``` @@ -2394,7 +2394,7 @@ getExif(): Promise<string> 返回jpg格式图片Exif标签组成的json格式的字符串,该方法使用Promise方式返回结果。 -**注意**:此接口返回的是exif标签组成的json格式的字符串,完整exif信息由all_exif与photoKeys.USER_COMMENT组成,fetchColumns需要传入这两个字段。 +**注意**:此接口返回的是exif标签组成的json格式的字符串,完整exif信息由all_exif与PhotoKeys.USER_COMMENT组成,fetchColumns需要传入这两个字段。 **系统接口**:此接口为系统接口。 @@ -2459,15 +2459,18 @@ async function example() { try { console.info('getExifDemo'); let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.isNotNull('all_exif') let fetchOptions = { - fetchColumns: [ 'all_exif', photoKeys.USER_COMMENT], + fetchColumns: ['all_exif', photoAccessHelper.PhotoKeys.USER_COMMENT], predicates: predicates }; let fetchResult = await phAccessHelper.getAssets(fetchOptions); let fileAsset = await fetchResult.getFirstObject(); + console.info('getExifDemo fileAsset displayName: ' + JSON.stringify(fileAsset.displayName)); let exifMessage = await fileAsset.getExif(); let userCommentKey = 'UserComment'; let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]); + console.info('getExifDemo userComment: ' + JSON.stringify(userComment)); fetchResult.close(); } catch (err) { console.error('getExifDemoCallback failed with error: ' + err); @@ -2481,7 +2484,7 @@ getExif(callback: AsyncCallback<string>): void 返回jpg格式图片Exif标签组成的json格式的字符串,该方法使用Promise方式返回结果。 -**注意**:此接口返回的是exif标签组成的json格式的字符串,完整exif信息由all_exif与photoKeys.USER_COMMENT组成,fetchColumns需要传入这两个字段。 +**注意**:此接口返回的是exif标签组成的json格式的字符串,完整exif信息由all_exif与PhotoKeys.USER_COMMENT组成,fetchColumns需要传入这两个字段。 **系统接口**:此接口为系统接口。 @@ -2546,16 +2549,19 @@ async function example() { try { console.info('getExifDemo'); let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.isNotNull('all_exif') let fetchOptions = { - fetchColumns: [ 'all_exif', photoKeys.USER_COMMENT], + fetchColumns: ['all_exif', photoAccessHelper.PhotoKeys.USER_COMMENT], predicates: predicates }; let fetchResult = await phAccessHelper.getAssets(fetchOptions); let fileAsset = await fetchResult.getFirstObject(); + console.info('getExifDemo fileAsset displayName: ' + JSON.stringify(fileAsset.displayName)); let userCommentKey = 'UserComment'; fileAsset.getExif((err, exifMessage) => { if (exifMessage != undefined) { let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]); + console.info('getExifDemo userComment: ' + JSON.stringify(userComment)); } else { console.error('getExif failed, message = ', err); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-sensor.md index 6b638e95a4424251ec6cee9552c936bcce64d9ae..a66b1e1acc004d0023722aac1eca96821869da33 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -43,13 +43,17 @@ on(type: SensorId.COLOR, callback: Callback\,options?: Options): **示例:** ```ts -try { - sensor.on(sensor.SensorId.COLOR, function (data) { - console.info('Succeeded in getting the intensity of light: ' + data.lightIntensity); - console.info('Succeeded in getting the color temporature: ' + data.colorTemperature); +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +try{ + sensor.on(sensor.SensorId.COLOR, (data: sensor.ColorResponse) => { + console.log('Succeeded in getting the intensity of light: ' + data.lightIntensity); + console.log('Succeeded in getting the color temperature: ' + data.colorTemperature); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -82,12 +86,16 @@ on(type: SensorId.SAR, callback: Callback\,options?: Options): void **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.SAR, function (data) { + sensor.on(sensor.SensorId.SAR, (data: sensor.SarResponse) => { console.info('Succeeded in getting specific absorption rate : ' + data.absorptionRatio); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -120,14 +128,18 @@ on(type: SensorId.ACCELEROMETER, callback: Callback<AccelerometerResponse> **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.ACCELEROMETER, function (data) { + sensor.on(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -160,8 +172,11 @@ on(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<Acceleromete **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, function (data) { + sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -170,7 +185,8 @@ try { console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -201,12 +217,16 @@ on(type: SensorId.AMBIENT_LIGHT, callback: Callback<LightResponse>, option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.AMBIENT_LIGHT, function (data) { + sensor.on(sensor.SensorId.AMBIENT_LIGHT, (data: sensor.LightResponse) => { console.info('Succeeded in getting the ambient light intensity: ' + data.intensity); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -237,12 +257,16 @@ on(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatureR **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, function (data) { + sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => { console.info('Succeeded in invoking on. Temperature: ' + data.temperature); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -273,12 +297,16 @@ on(type: SensorId.BAROMETER, callback: Callback<BarometerResponse>, option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.BAROMETER, function (data) { + sensor.on(sensor.SensorId.BAROMETER, (data: sensor.BarometerResponse) => { console.info('Succeeded in invoking on. Atmospheric pressure: ' + data.pressure); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -309,14 +337,18 @@ on(type: SensorId.GRAVITY, callback: Callback<GravityResponse>,options?: O **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.GRAVITY, function (data) { + sensor.on(sensor.SensorId.GRAVITY, (data: sensor.GravityResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -349,14 +381,18 @@ on(type: SensorId.GYROSCOPE, callback: Callback<GyroscopeResponse>,options **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.GYROSCOPE, function (data) { + sensor.on(sensor.SensorId.GYROSCOPE, (data: sensor.GyroscopeResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -390,8 +426,11 @@ on(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback<GyroscopeUncalib **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, function (data) { + sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -400,8 +439,10 @@ try { console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } + ``` ### HALL9+ @@ -431,13 +472,18 @@ on(type: SensorId.HALL, callback: Callback<HallResponse>, options?: Option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.HALL, function (data) { + sensor.on(sensor.SensorId.HALL, (data: sensor.HallResponse) => { console.info('Succeeded in invoking on. Hall status: ' + data.status); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } + ``` ### HEART_RATE9+ @@ -469,12 +515,16 @@ on(type: SensorId.HEART_RATE, callback: Callback<HeartRateResponse>,option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.HEART_RATE, function (data) { + sensor.on(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => { console.info('Succeeded in invoking on. Heart rate: ' + data.heartRate); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -505,12 +555,16 @@ on(type: SensorId.HUMIDITY, callback: Callback<HumidityResponse>,options?: **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.HUMIDITY, function (data) { + sensor.on(sensor.SensorId.HUMIDITY, (data: sensor.HumidityResponse) => { console.info('Succeeded in invoking on. Humidity: ' + data.humidity); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -544,14 +598,18 @@ on(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback<LinearAcceleromete **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, function (data) { + sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, (data: sensor.LinearAccelerometerResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -582,14 +640,18 @@ on(type: SensorId.MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse> **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.MAGNETIC_FIELD, function (data) { + sensor.on(sensor.SensorId.MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -620,8 +682,11 @@ on(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback<MagneticFie **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, function (data) { + sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -630,7 +695,8 @@ try { console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -661,14 +727,18 @@ on(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>,opt **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.ORIENTATION, function (data) { + sensor.on(sensor.SensorId.ORIENTATION, (data: sensor.OrientationResponse) => { console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha); console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta); console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -701,12 +771,16 @@ on(type: SensorId.PEDOMETER, callback: Callback<PedometerResponse>, option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.PEDOMETER, function (data) { + sensor.on(sensor.SensorId.PEDOMETER, (data: sensor.PedometerResponse) => { console.info('Succeeded in invoking on. Step count: ' + data.steps); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -740,12 +814,16 @@ on(type: SensorId.PEDOMETER_DETECTION, callback: Callback<PedometerDetectionR **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.PEDOMETER_DETECTION, function (data) { + sensor.on(sensor.SensorId.PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => { console.info('Succeeded in invoking on. Pedometer scalar: ' + data.scalar); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -776,12 +854,16 @@ on(type: SensorId.PROXIMITY, callback: Callback<ProximityResponse>, option **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.PROXIMITY, function (data) { + sensor.on(sensor.SensorId.PROXIMITY, (data: sensor.ProximityResponse) => { console.info('Succeeded in invoking on. Distance: ' + data.distance); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -813,15 +895,19 @@ on(type: SensorId.ROTATION_VECTOR, callback: Callback<RotationVectorResponse& **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.ROTATION_VECTOR, function (data) { + sensor.on(sensor.SensorId.ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); console.info('Succeeded in invoking on. Scalar quantity: ' + data.w); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -853,12 +939,16 @@ on(type: SensorId.SIGNIFICANT_MOTION, callback: Callback<SignificantMotionRes **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, function (data) { + sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => { console.info('Succeeded in invoking on. Scalar data: ' + data.scalar); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -890,12 +980,16 @@ on(type: SensorId.WEAR_DETECTION, callback: Callback<WearDetectionResponse> **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.on(sensor.SensorId.WEAR_DETECTION, function (data) { + sensor.on(sensor.SensorId.WEAR_DETECTION, (data: sensor.WearDetectionResponse) => { console.info('Succeeded in invoking on. Wear status: ' + data.value); }, { interval: 100000000 }); } catch (error) { - console.error(`Failed to invoke on. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`); } ``` @@ -929,20 +1023,24 @@ once(type: SensorId.ACCELEROMETER, callback: Callback<AccelerometerResponse&g **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.ACCELEROMETER, function (data) { + sensor.once(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` ### ACCELEROMETER_UNCALIBRATED9+ -once(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<AccelerometerUncalibratedResponse>): void +once(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<AccelerometerUncalibratedResponse>): voidMAGNETIC_FIELD 获取一次未校准加速度传感器数据。 @@ -968,8 +1066,11 @@ once(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<Accelerome **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, function (data) { + sensor.once(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -978,7 +1079,8 @@ try { console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1008,12 +1110,16 @@ once(type: SensorId.AMBIENT_LIGHT, callback: Callback<LightResponse>): voi **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.AMBIENT_LIGHT, function (data) { + sensor.once(sensor.SensorId.AMBIENT_LIGHT, (data: sensor.LightResponse) => { console.info('Succeeded in invoking once. the ambient light intensity: ' + data.intensity); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1043,12 +1149,16 @@ once(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatur **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.AMBIENT_TEMPERATURE, function (data) { + sensor.once(sensor.SensorId.AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => { console.info('Succeeded in invoking once. Temperature: ' + data.temperature); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1078,12 +1188,16 @@ once(type: SensorId.BAROMETER, callback: Callback<BarometerResponse>): voi **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.BAROMETER, function (data) { + sensor.once(sensor.SensorId.BAROMETER, (data: sensor.BarometerResponse) => { console.info('Succeeded in invoking once. Atmospheric pressure: ' + data.pressure); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1113,14 +1227,18 @@ once(type: SensorId.GRAVITY, callback: Callback<GravityResponse>): void **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.GRAVITY, function (data) { + sensor.once(sensor.SensorId.GRAVITY, (data: sensor.GravityResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1153,15 +1271,17 @@ once(type: SensorId.GYROSCOPE, callback: Callback<GyroscopeResponse>): voi ```ts import sensor from '@ohos.sensor'; +import BusinessError from "@ohos.base" try { - sensor.once(sensor.SensorId.GYROSCOPE, function (data) { + sensor.once(sensor.SensorId.GYROSCOPE, (data: sensor.GyroscopeResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1193,8 +1313,11 @@ once(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback<GyroscopeUncal **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.GYROSCOPE_UNCALIBRATED, function (data) { + sensor.once(sensor.SensorId.GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -1203,7 +1326,8 @@ try { console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1233,12 +1357,16 @@ once(type: SensorId.HALL, callback: Callback<HallResponse>): void **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.HALL, function (data) { + sensor.once(sensor.SensorId.HALL, (data: sensor.HallResponse) => { console.info('Succeeded in invoking once. Status: ' + data.status); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1270,12 +1398,16 @@ once(type: SensorId.HEART_RATE, callback: Callback<HeartRateResponse>): vo **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.HEART_RATE, function (data) { + sensor.once(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => { console.info('Succeeded in invoking once. Heart rate: ' + data.heartRate); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1305,12 +1437,16 @@ once(type: SensorId.HUMIDITY, callback: Callback<HumidityResponse>): void **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.HUMIDITY, function (data) { - console.info('Succeeded in invoking once. Humidity: ' + data.humidity); + sensor.once(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => { + console.info('Succeeded in invoking once. Heart rate: ' + data.heartRate); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1342,14 +1478,18 @@ once(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback<LinearAccelerome **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.LINEAR_ACCELEROMETER, function (data) { + sensor.once(sensor.SensorId.LINEAR_ACCELEROMETER, (data: sensor.LinearAccelerometerResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1379,14 +1519,18 @@ once(type: SensorId.MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse& **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.MAGNETIC_FIELD, function (data) { + sensor.once(sensor.SensorId.MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1416,8 +1560,11 @@ once(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback<MagneticF **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, function (data) { + sensor.once(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -1426,7 +1573,8 @@ try { console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1447,7 +1595,7 @@ once(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>): **错误码**: -以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)。 +以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)。AMBIENT_LIGHT | 错误码ID | 错误信息 | | -------- | ------------------ | @@ -1456,14 +1604,18 @@ once(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>): **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.ORIENTATION, function (data) { + sensor.once(sensor.SensorId.ORIENTATION, (data: sensor.OrientationResponse) => { console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta); console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma); console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1495,12 +1647,16 @@ once(type: SensorId.PEDOMETER, callback: Callback<PedometerResponse>): voi **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.PEDOMETER, function (data) { + sensor.once(sensor.SensorId.PEDOMETER, (data: sensor.PedometerResponse) => { console.info('Succeeded in invoking once. Step count: ' + data.steps); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1532,12 +1688,16 @@ once(type: SensorId.PEDOMETER_DETECTION, callback: Callback<PedometerDetectio **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.PEDOMETER_DETECTION, function (data) { + sensor.once(sensor.SensorId.PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => { console.info('Succeeded in invoking once. Scalar data: ' + data.scalar); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1567,12 +1727,16 @@ once(type: SensorId.PROXIMITY, callback: Callback<ProximityResponse>): voi **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.PROXIMITY, function (data) { + sensor.once(sensor.SensorId.PROXIMITY, (data: sensor.ProximityResponse) => { console.info('Succeeded in invoking once. Distance: ' + data.distance); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1602,15 +1766,19 @@ once(type: SensorId.ROTATION_VECTOR, callback: Callback<RotationVectorRespons **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.ROTATION_VECTOR, function (data) { + sensor.once(sensor.SensorId.ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); console.info('Succeeded in invoking once. Scalar quantity: ' + data.w); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1640,12 +1808,16 @@ once(type: SensorId.SIGNIFICANT_MOTION, callback: Callback<SignificantMotionR **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.SIGNIFICANT_MOTION, function (data) { + sensor.once(sensor.SensorId.SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => { console.info('Succeeded in invoking once. Scalar data: ' + data.scalar); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1675,12 +1847,16 @@ once(type: SensorId.WEAR_DETECTION, callback: Callback<WearDetectionResponse& **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.once(sensor.SensorId.WEAR_DETECTION, function (data) { + sensor.once(sensor.SensorId.WEAR_DETECTION, (data: sensor.WearDetectionResponse) => { console.info('Succeeded in invoking once. Wear status: ' + data.value); }); } catch (error) { - console.error(`Failed to invoke once. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1706,11 +1882,14 @@ off(type: SensorId.COLOR, callback?: Callback\): void **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1722,7 +1901,8 @@ try { // 取消注册SensorId.COLOR的所有回调 sensor.off(sensor.SensorId.COLOR); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1746,11 +1926,14 @@ off(type: SensorId.SAR, callback?: Callback\): void **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1762,7 +1945,8 @@ try { // 取消注册SensorId.SAR的所有回调 sensor.off(sensor.SensorId.SAR); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1786,11 +1970,14 @@ off(type: SensorId.ACCELEROMETER, callback?: Callback<AccelerometerResponse&g **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1802,7 +1989,8 @@ try { // 取消SensorId.ACCELEROMETER类型的所有回调 sensor.off(sensor.SensorId.ACCELEROMETER); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1826,11 +2014,14 @@ off(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback?: Callback<Accelerome **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1842,7 +2033,8 @@ try { // 取消注册SensorId.ACCELEROMETER_UNCALIBRATED类型的所有回调 sensor.off(sensor.SensorId.ACCELEROMETER_UNCALIBRATED); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1864,11 +2056,14 @@ off(type: SensorId.AMBIENT_LIGHT, callback?: Callback<LightResponse>): voi **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1880,7 +2075,8 @@ try { // 取消注册SensorId.AMBIENT_LIGHT sensor.off(sensor.SensorId.AMBIENT_LIGHT); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1902,11 +2098,14 @@ off(type: SensorId.AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatur **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1918,7 +2117,8 @@ try { // 取消注册SensorId.AMBIENT_TEMPERATURE的所有回调 sensor.off(sensor.SensorId.AMBIENT_TEMPERATURE); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1940,11 +2140,14 @@ off(type: SensorId.BAROMETER, callback?: Callback<BarometerResponse>): voi **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1956,7 +2159,8 @@ try { // 取消注册SensorId.BAROMETER的所有回调 sensor.off(sensor.SensorId.BAROMETER); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -1978,11 +2182,14 @@ off(type: SensorId.GRAVITY, callback?: Callback<GravityResponse>): void **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -1994,8 +2201,10 @@ try { // 取消注册SensorId.GRAVITY的所有回调 sensor.off(sensor.SensorId.GRAVITY); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } + ``` ### GYROSCOPE9+ @@ -2018,11 +2227,14 @@ off(type: SensorId.GYROSCOPE, callback?: Callback<GyroscopeResponse>): voi **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2034,7 +2246,8 @@ try { // 取消注册SensorId.GYROSCOPE的所有回调 sensor.off(sensor.SensorId.GYROSCOPE); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2058,11 +2271,14 @@ off(type: SensorId.GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncal **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2074,7 +2290,8 @@ try { // 取消注册SensorId.GYROSCOPE_UNCALIBRATED的所有回调 sensor.off(sensor.SensorId.GYROSCOPE_UNCALIBRATED); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2096,11 +2313,14 @@ off(type: SensorId.HALL, callback?: Callback<HallResponse>): void **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2112,7 +2332,8 @@ try { // 取消注册SensorId.HALL的所有回调 sensor.off(sensor.SensorId.HALL); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2136,11 +2357,14 @@ off(type: SensorId.HEART_RATE, callback?: Callback<HeartRateResponse>): vo **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2152,7 +2376,8 @@ try { // 取消注册SensorId.HEART_RATE的所有回调 sensor.off(sensor.SensorId.HEART_RATE); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2174,11 +2399,14 @@ off(type: SensorId.HUMIDITY, callback?: Callback<HumidityResponse>): void **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2190,7 +2418,8 @@ try { // 取消注册SensorId.HUMIDITY的所有回调 sensor.off(sensor.SensorId.HUMIDITY); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2214,11 +2443,14 @@ off(type: SensorId.LINEAR_ACCELEROMETER, callback?: Callback<LinearAccelerome **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2230,7 +2462,8 @@ try { // 取消注册SensorId.LINEAR_ACCELEROMETER的所有回调 sensor.off(sensor.SensorId.LINEAR_ACCELEROMETER); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2252,11 +2485,14 @@ off(type: SensorId.MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse& **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2268,7 +2504,8 @@ try { // 取消注册SensorId.MAGNETIC_FIELD的所有回调 sensor.off(sensor.SensorId.MAGNETIC_FIELD); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2290,11 +2527,14 @@ off(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticF **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2306,7 +2546,8 @@ try { // 取消注册SensorId.MAGNETIC_FIELD_UNCALIBRATED的所有回调 sensor.off(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2328,11 +2569,14 @@ off(type: SensorId.ORIENTATION, callback?: Callback<OrientationResponse>): **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2344,7 +2588,8 @@ try { // 取消注册SensorId.ORIENTATION的所有回调 sensor.off(sensor.SensorId.ORIENTATION); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2368,11 +2613,14 @@ off(type: SensorId.PEDOMETER, callback?: Callback<PedometerResponse>): voi **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2381,10 +2629,11 @@ try { sensor.on(sensor.SensorId.PEDOMETER, callback2); // 仅取消callback1的注册 sensor.off(sensor.SensorId.PEDOMETER, callback1); - // 取消注册SensorId.PEDOMETER的所有回调 + // 取消注册SensorId.ORIENTATION的所有回调 sensor.off(sensor.SensorId.PEDOMETER); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2408,11 +2657,14 @@ off(type: SensorId.PEDOMETER_DETECTION, callback?: Callback<PedometerDetectio **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2424,7 +2676,8 @@ try { // 取消注册SensorId.PEDOMETER_DETECTION的所有回调 sensor.off(sensor.SensorId.PEDOMETER_DETECTION); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2446,11 +2699,14 @@ off(type: SensorId.PROXIMITY, callback?: Callback<ProximityResponse>): voi **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2462,7 +2718,8 @@ try { // 取消注册SensorId.PROXIMITY的所有回调 sensor.off(sensor.SensorId.PROXIMITY); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2484,11 +2741,14 @@ off(type: SensorId.ROTATION_VECTOR, callback?: Callback<RotationVectorRespons **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2500,7 +2760,8 @@ try { // 取消注册SensorId.ROTATION_VECTOR的所有回调 sensor.off(sensor.SensorId.ROTATION_VECTOR); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2522,11 +2783,14 @@ off(type: SensorId.SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionR **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2538,7 +2802,8 @@ try { // 取消注册SensorId.SIGNIFICANT_MOTION的所有回调 sensor.off(sensor.SensorId.SIGNIFICANT_MOTION); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2560,11 +2825,14 @@ off(type: SensorId.WEAR_DETECTION, callback?: Callback<WearDetectionResponse& **示例:** ```ts -function callback1(data) { +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + +function callback1(data: object) { console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data)); } -function callback2(data) { +function callback2(data: object) { console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data)); } @@ -2576,7 +2844,8 @@ try { // 取消注册SensorId.WEAR_DETECTION的所有回调 sensor.off(sensor.SensorId.WEAR_DETECTION); } catch (error) { - console.error(`Failed to invoke off. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2607,8 +2876,12 @@ getGeomagneticInfo(locationOptions: LocationOptions, timeMillis: number, callbac **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { - sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, function (err, data) { + sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, + (err: BusinessError.BusinessError, data: sensor.GeomagneticResponse) => { if (err) { console.error(`Failed to get geomagneticInfo. Code: ${err.code}, message: ${err.message}`); return; @@ -2622,7 +2895,8 @@ try { console.info("Succeeded in getting geomagneticInfo totalIntensity" + data.totalIntensity); }); } catch (error) { - console.error(`Failed to get geomagneticInfo. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get geomagneticInfo. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2658,9 +2932,12 @@ getGeomagneticInfo(locationOptions: LocationOptions, timeMillis: number): Promis **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { const promise = sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000); - promise.then((data) => { + promise.then((data: sensor.GeomagneticResponse) => { console.info("Succeeded in getting geomagneticInfo x" + data.x); console.info("Succeeded in getting geomagneticInfo y" + data.y); console.info("Succeeded in getting geomagneticInfo z" + data.z); @@ -2668,11 +2945,12 @@ try { console.info("Succeeded in getting geomagneticInfo deflectionAngle" + data.deflectionAngle); console.info("Succeeded in getting geomagneticInfo levelIntensity" + data.levelIntensity); console.info("Succeeded in getting geomagneticInfo totalIntensity" + data.totalIntensity); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get geomagneticInfo. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get geomagneticInfo. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get geomagneticInfo. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2703,10 +2981,13 @@ getDeviceAltitude(seaPressure: number, currentPressure: number, callback: AsyncC **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let seaPressure = 1013.2; let currentPressure = 1500.0; - sensor.getDeviceAltitude(seaPressure, currentPressure, function (err, data) { + sensor.getDeviceAltitude(seaPressure, currentPressure, (err: BusinessError.BusinessError, data: number) => { if (err) { console.error(`Failed to get altitude. Code: ${err.code}, message: ${err.message}`); return; @@ -2714,7 +2995,8 @@ try { console.info('Succeeded in getting altitude: ' + data); }); } catch (error) { - console.error(`Failed to get altitude. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get altitude. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2750,17 +3032,21 @@ getDeviceAltitude(seaPressure: number, currentPressure: number): Promise<numb **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let seaPressure = 1013.2; let currentPressure = 1500.0; const promise = sensor.getDeviceAltitude(seaPressure, currentPressure); - promise.then((data) => { + promise.then((data: number) => { console.info('Succeeded in getting sensor_getDeviceAltitude_Promise', data); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get altitude. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get altitude. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get altitude. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2790,6 +3076,9 @@ getInclination(inclinationMatrix: Array<number>, callback: AsyncCallback&l **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { // inclinationMatrix可以为3*3,或者4*4 let inclinationMatrix = [ @@ -2797,7 +3086,7 @@ try { 0, 1, 0, 0, 0, 1 ] - sensor.getInclination(inclinationMatrix, function (err, data) { + sensor.getInclination(inclinationMatrix, (err: BusinessError.BusinessError, data: number) => { if (err) { console.error(`Failed to get inclination. Code: ${err.code}, message: ${err.message}`); return; @@ -2805,7 +3094,8 @@ try { console.info('Succeeded in getting inclination: ' + data); }) } catch (error) { - console.error(`Failed to get inclination. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get inclination. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2840,6 +3130,9 @@ try { **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { // inclinationMatrix可以为3*3,或者4*4 let inclinationMatrix = [ @@ -2848,13 +3141,14 @@ try { 0, 0, 1 ] const promise = sensor.getInclination(inclinationMatrix); - promise.then((data) => { + promise.then((data: number) => { console.info('Succeeded in getting inclination: ' + data); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get inclination. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get inclination. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get inclination. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2886,6 +3180,9 @@ try { **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { // 旋转矩阵可以为3*3,或者4*4 let currentRotationMatrix = [ @@ -2898,7 +3195,7 @@ try { 0, 0.87, -0.50, 0, 0.50, 0.87 ]; - sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix, function (err, data) { + sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix, (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to get angle variation. Code: ${err.code}, message: ${err.message}`); return; @@ -2911,7 +3208,8 @@ try { console.info("Y : " + data[2]); }) } catch (error) { - console.error(`Failed to get angle variation. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get angle variation. Code: ${e.code}, message: ${e.message}`); } ``` @@ -2947,6 +3245,9 @@ getAngleVariation(currentRotationMatrix: Array<number>, preRotationMatrix: **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { // 旋转矩阵可以为3*3,或者4*4 let currentRotationMatrix = [ @@ -2960,18 +3261,19 @@ try { 0, 0.50, 0.87 ]; const promise = sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix); - promise.then((data) => { + promise.then((data: Array) => { if (data.length < 3) { console.error("Failed to get angle variation, length" + data.length); } console.info("Z: " + data[0]); console.info("X: " + data[1]); console.info("Y : " + data[2]); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get angle variation. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get angle variation. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get angle variation. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3001,19 +3303,23 @@ getRotationMatrix(rotationVector: Array<number>, callback: AsyncCallback&l **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877]; - sensor.getRotationMatrix(rotationVector, function (err, data) { + sensor.getRotationMatrix(rotationVector, (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } }) } catch (error) { - console.error(`Failed to get rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3048,18 +3354,22 @@ getRotationMatrix(rotationVector: Array<number>): Promise<Array<numb **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877]; const promise = sensor.getRotationMatrix(rotationVector); - promise.then((data) => { - for (var i = 0; i < data.length; i++) { + promise.then((data: Array) => { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3091,23 +3401,27 @@ transformRotationMatrix(inRotationVector: Array<number>, coordinates: Coor **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationMatrix = [ 1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87 ]; - sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 }, function (err, data) { + sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 }, (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to transform rotationMatrix. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + '] = ' + data[i]); } }) } catch (error) { - console.error(`Failed to transform rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to transform rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3143,6 +3457,9 @@ transformRotationMatrix(inRotationVector: Array<number>, coordinates: Coor **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationMatrix = [ 1, 0, 0, @@ -3150,15 +3467,16 @@ try { 0, 0.50, 0.87 ]; const promise = sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 }); - promise.then((data) => { - for (var i = 0; i < data.length; i++) { + promise.then((data: Array) => { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to transform rotationMatrix. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to transform rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to transform rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3188,19 +3506,23 @@ getQuaternion(rotationVector: Array<number>, callback: AsyncCallback<Ar **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877]; - sensor.getQuaternion(rotationVector, function (err, data) { + sensor.getQuaternion(rotationVector, (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to get quaternion. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } }) } catch (error) { - console.error(`Failed to get quaternion. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get quaternion. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3235,18 +3557,22 @@ getQuaternion(rotationVector: Array<number>): Promise<Array<number&g **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877]; const promise = sensor.getQuaternion(rotationVector); - promise.then((data) => { - for (var i = 0; i < data.length; i++) { + promise.then((data: Array) => { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get quaternion. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get quaternion. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get quaternion. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3276,13 +3602,16 @@ getOrientation(rotationMatrix: Array<number>, callback: AsyncCallback<A **示例:** ```ts +import sensor from "@ohos.sensor" +import BusinessError from "@ohos.base" + try { let preRotationMatrix = [ 1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87 ]; - sensor.getOrientation(preRotationMatrix, function (err, data) { + sensor.getOrientation(preRotationMatrix, (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to get orientation. Code: ${err.code}, message: ${err.message}`); return; @@ -3295,7 +3624,8 @@ try { console.info("Succeeded in getting data. Y: " + data[2]); }) } catch (error) { - console.error(`Failed to get orientation. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get orientation. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3330,6 +3660,9 @@ getOrientation(rotationMatrix: Array<number>): Promise<Array<number& **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { let preRotationMatrix = [ 1, 0, 0, @@ -3337,15 +3670,16 @@ try { 0, 0.50, 0.87 ]; const promise = sensor.getOrientation(preRotationMatrix); - promise.then((data) => { - for (var i = 0; i < data.length; i++) { + promise.then((data: Array) => { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + data[i]); } - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to getOrientatin. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to getOrientatin Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to getOrientatin Code: ${e.code}, message: ${e.message}`); } ``` @@ -3376,10 +3710,13 @@ getRotationMatrix(gravity: Array<number>, geomagnetic: Array<number> **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { let gravity = [-0.27775216, 0.5351276, 9.788099]; let geomagnetic = [210.87253, -78.6096, -111.44444]; - sensor.getRotationMatrix(gravity, geomagnetic, function (err, data) { + sensor.getRotationMatrix(gravity, geomagnetic, (err: BusinessError.BusinessError, data: sensor.RotationMatrixResponse) => { if (err) { console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`); return; @@ -3387,7 +3724,8 @@ try { console.info('Succeeded in getting rotationMatrix' + JSON.stringify(data)); }) } catch (error) { - console.error(`Failed to get rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3423,17 +3761,21 @@ getRotationMatrix(gravity: Array<number>, geomagnetic: Array<number> **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { let gravity = [-0.27775216, 0.5351276, 9.788099]; let geomagnetic = [210.87253, -78.6096, -111.44444]; const promise = sensor.getRotationMatrix(gravity, geomagnetic); - promise.then((data) => { + promise.then((data: sensor.RotationMatrixResponse) => { console.info('Succeeded in getting rotationMatrix' + JSON.stringify(data)); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get rotationMatrix. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3462,18 +3804,22 @@ getSensorList(callback: AsyncCallback<Array<Sensor>>): void **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { - sensor.getSensorList((err, data) => { + sensor.getSensorList((err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to get sensorList. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + JSON.stringify(data[i])); } }); } catch (error) { - console.error(`Failed to get sensorList. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get sensorList. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3502,16 +3848,20 @@ try { **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { - sensor.getSensorList().then((data) => { - for (var i = 0; i < data.length; i++) { + sensor.getSensorList().then((data: Array) => { + for (let i = 0; i < data.length; i++) { console.info('Succeeded in getting data[' + i + ']: ' + JSON.stringify(data[i])); } - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get sensorList. Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get sensorList. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get sensorList. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3541,8 +3891,11 @@ getSingleSensor(type: SensorId, callback: AsyncCallback<Sensor>): void **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { - sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER, (err, data) => { + sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER, (err: BusinessError.BusinessError, data: sensor.Sensor) => { if (err) { console.error(`Failed to get singleSensor. Code: ${err.code}, message: ${err.message}`); return; @@ -3550,7 +3903,8 @@ try { console.info('Succeeded in getting sensor: ' + JSON.stringify(data)); }); } catch (error) { - console.error(`Failed to get singleSensor. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get singleSensor. Code: ${e.code}, message: ${e.message}`); } ``` @@ -3585,14 +3939,18 @@ try { **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + try { - sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER).then((data) => { + sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER).then((data: sensor.Sensor) => { console.info('Succeeded in getting sensor: ' + JSON.stringify(data)); - }, (err) => { + }, (err: BusinessError.BusinessError) => { console.error(`Failed to get singleSensor . Code: ${err.code}, message: ${err.message}`); }); } catch (error) { - console.error(`Failed to get singleSensor . Code: ${error.code}, message: ${error.message}`); + let e: BusinessError.BusinessError = error as BusinessError.BusinessError; + console.error(`Failed to get singleSensor . Code: ${e.code}, message: ${e.message}`); } ``` @@ -3677,16 +4035,16 @@ try { | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | -------- | ---------------------- | ---------------------- | ---------------------- | -| sensorName | string | 是 | 是 | 传感器名称。 | -| vendorName | string | 是 | 是 | 传感器供应商。 | -| firmwareVersion | string | 是 | 是 | 传感器固件版本。 | -| hardwareVersion | string | 是 | 是 | 传感器硬件版本。 | -| sensorId | number | 是 | 是 | 传感器类型id。 | -| maxRange | number | 是 | 是 | 传感器测量范围的最大值。 | -| minSamplePeriod | number | 是 | 是 | 允许的最小采样周期。 | -| maxSamplePeriod | number | 是 | 是 | 允许的最大采样周期。 | -| precision | number | 是 | 是 | 传感器精度。 | -| power | number | 是 | 是 | 传感器功率。 | +| sensorName | string | 是 | 否 | 传感器名称。 | +| vendorName | string | 是 | 否 | 传感器供应商。 | +| firmwareVersion | string | 是 | 否 | 传感器固件版本。 | +| hardwareVersion | string | 是 | 否 | 传感器硬件版本。 | +| sensorId | number | 是 | 否 | 传感器类型id。 | +| maxRange | number | 是 | 否 | 传感器测量范围的最大值。 | +| minSamplePeriod | number | 是 | 否 | 允许的最小采样周期。 | +| maxSamplePeriod | number | 是 | 否 | 允许的最大采样周期。 | +| precision | number | 是 | 否 | 传感器精度。 | +| power | number | 是 | 否 | 传感器功率的估计值,单位:mA。 | ## ColorResponse10+ @@ -4084,7 +4442,9 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4136,7 +4496,9 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4146,6 +4508,7 @@ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function }, { interval: 100000000 } ); + ``` ### GRAVITY(deprecated) @@ -4169,7 +4532,9 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, (data: sensor.GravityResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4201,7 +4566,9 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, (data: sensor.GyroscopeResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4233,7 +4600,9 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4266,7 +4635,9 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => { console.info('Succeeded in invoking on. Scalar data: ' + data.scalar); }, { interval: 100000000 } @@ -4296,7 +4667,9 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => { console.info('Succeeded in invoking on. Scalar data: ' + data.scalar); }, { interval: 100000000 } @@ -4326,7 +4699,9 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, (data: sensor.PedometerResponse) => { console.info('Succeeded in invoking on. Steps: ' + data.steps); }, { interval: 100000000 } @@ -4354,7 +4729,9 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambi **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => { console.info('Succeeded in invoking on. Temperature: ' + data.temperature); }, { interval: 100000000 } @@ -4382,7 +4759,9 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4412,7 +4791,9 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4445,7 +4826,9 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, (data: sensor.ProximityResponse) => { console.info('Succeeded in invoking on. Distance: ' + data.distance); }, { interval: 100000000 } @@ -4473,7 +4856,9 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, (data: sensor.HumidityResponse) => { console.info('Succeeded in invoking on. Humidity: ' + data.humidity); }, { interval: 100000000 } @@ -4501,7 +4886,9 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, (data: sensor.BarometerResponse) => { console.info('Succeeded in invoking on. Atmospheric pressure: ' + data.pressure); }, { interval: 100000000 } @@ -4529,7 +4916,9 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL, (data: sensor.HallResponse) => { console.info('Succeeded in invoking on. Status: ' + data.status); }, { interval: 100000000 } @@ -4557,7 +4946,9 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, (data: sensor.LightResponse) => { console.info('Succeeded in invoking on. Illumination: ' + data.intensity); }, { interval: 100000000 } @@ -4585,7 +4976,9 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, (data: sensor.OrientationResponse) => { console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta); console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma); console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha); @@ -4635,7 +5028,9 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => { console.info('Succeeded in invoking on. X-coordinate component: ' + data.x); console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z); @@ -4666,7 +5061,9 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet **示例:** ```ts -sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, (data: sensor.WearDetectionResponse) => { console.info('Succeeded in invoking on. Wear status: ' + data.value); }, { interval: 100000000 } @@ -4697,7 +5094,9 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (data: sensor.AccelerometerResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4745,7 +5144,9 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4775,7 +5176,9 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespo **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, (data: sensor.GravityResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4804,7 +5207,9 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeR **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, (data: sensor.GyroscopeResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4832,7 +5237,9 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4862,7 +5269,9 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<Si **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => { console.info('Succeeded in invoking once. Scalar data: ' + data.scalar); }); ``` @@ -4889,7 +5298,9 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<P **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => { console.info('Succeeded in invoking once. Scalar data: ' + data.scalar); }); ``` @@ -4914,9 +5325,11 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerR | callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 | **示例:** - + ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, (data: sensor.PedometerResponse) => { console.info('Succeeded in invoking once. Steps: ' + data.steps); }); ``` @@ -4941,7 +5354,9 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<A **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => { console.info('Succeeded in invoking once. Temperature: ' + data.temperature); }); ``` @@ -4966,7 +5381,9 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magne **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -4993,7 +5410,9 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -5023,7 +5442,9 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityR **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, (data: sensor.ProximityResponse) => { console.info('Succeeded in invoking once. Distance: ' + data.distance); } ); @@ -5049,7 +5470,9 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRes **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, (data: sensor.HumidityResponse) => { console.info('Succeeded in invoking once. Humidity: ' + data.humidity); }); ``` @@ -5074,7 +5497,9 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerR **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, (data: sensor.BarometerResponse) => { console.info('Succeeded in invoking once. Atmospheric pressure: ' + data.pressure); }); ``` @@ -5099,7 +5524,9 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse> **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, (data: sensor.HallResponse) => { console.info('Succeeded in invoking once. Status: ' + data.status); }); ``` @@ -5124,7 +5551,9 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightR **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, (data: sensor.LightResponse) => { console.info('Succeeded in invoking once. invoking once. Illumination: ' + data.intensity); }); ``` @@ -5149,7 +5578,9 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientat **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, (data: sensor.OrientationResponse) => { console.info('Succeeded in invoking the device rotateing at an angle around the X axis: ' + data.beta); console.info('Succeeded in invoking the device rotateing at an angle around the Y axis: ' + data.gamma); console.info('Succeeded in invoking the device rotateing at an angle around the Z axis: ' + data.alpha); @@ -5176,7 +5607,9 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => { console.info('Succeeded in invoking once. X-coordinate component: ' + data.x); console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z); @@ -5222,7 +5655,9 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearD **示例:** ```ts -sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function (data) { +import sensor from '@ohos.sensor'; + +sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, (data: sensor.WearDetectionResponse) => { console.info("Succeeded in invoking once. Wear status: " + data.value); }); ``` @@ -5251,7 +5686,9 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<Accele **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.AccelerometerResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5282,7 +5719,9 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callb **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.AccelerometerUncalibratedResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5314,7 +5753,9 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightR **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.LightResponse) { console.info('Succeeded in invoking off. Illumination: ' + data.intensity); } @@ -5341,7 +5782,9 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback< **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.AmbientTemperatureResponse) { console.info('Succeeded in invoking off. Temperature: ' + data.temperature); } @@ -5368,7 +5811,9 @@ off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerR **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.BarometerResponse) { console.info('Succeeded in invoking off. Atmospheric pressure: ' + data.pressure); } @@ -5395,7 +5840,9 @@ off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityRespo **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.GravityResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5426,7 +5873,9 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeR **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.GyroscopeResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5457,7 +5906,9 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback& **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.GyroscopeUncalibratedResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5486,7 +5937,9 @@ off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse> **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.HallResponse) { console.info('Succeeded in invoking off. Status: ' + data.status); } @@ -5532,7 +5985,9 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityRes **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.HumidityResponse) { console.info('Succeeded in invoking off. Humidity: ' + data.humidity); } @@ -5578,7 +6033,9 @@ off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback< **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.MagneticFieldResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5607,7 +6064,9 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback); **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.MagneticFieldUncalibratedResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5639,7 +6098,9 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callbac **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.OrientationResponse) { console.info('Succeeded in invoking off. The device rotates at an angle around the X axis: ' + data.beta); console.info('Succeeded in invoking off. The device rotates at an angle around the Y axis: ' + data.gamma); console.info('Succeeded in invoking off. The device rotates at an angle around the Z axis: ' + data.alpha); @@ -5670,7 +6131,9 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerR **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.PedometerResponse) { console.info('Succeeded in invoking off. Steps: ' + data.steps); } @@ -5699,7 +6162,9 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback< **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.PedometerDetectionResponse) { console.info('Succeeded in invoking off. Scalar data: ' + data.scalar); } @@ -5726,7 +6191,9 @@ off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityR **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.ProximityResponse) { console.info('Succeeded in invoking off. Distance: ' + data.distance); } @@ -5753,7 +6220,9 @@ off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<Rota **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.RotationVectorResponse) { console.info('Succeeded in invoking off. X-coordinate component: ' + data.x); console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y); console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z); @@ -5783,7 +6252,9 @@ off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<S **示例:** ```ts -function callback(data) { +import sensor from '@ohos.sensor'; + +function callback(data: sensor.SignificantMotionResponse) { console.info('Succeeded in invoking off. Scalar data: ' + data.scalar); } @@ -5810,7 +6281,9 @@ off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearD **示例:** ```ts -function accCallback(data) { +import sensor from '@ohos.sensor'; + +function accCallback(data: sensor.WearDetectionResponse) { console.info('Succeeded in invoking off. Wear status: ' + data.value); } @@ -5838,13 +6311,17 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co **示例:** ```ts -sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], { x: 2, y: 3 }, function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], { x: 2, y: 3 }, + (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`); return; } console.info("Succeeded in starting Operation. Data obtained: " + data); - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("Succeeded in getting transformCoordinateSystem data[ " + i + "] = " + data[i]); } }) @@ -5875,13 +6352,16 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], { x: 2, y: 3 }); -promise.then((data) => { +promise.then((data: Array) => { console.info("Succeeded in starting Operation"); - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("Succeeded in getting transformCoordinateSystem data[ " + i + "] = " + data[i]); } -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.error(`Failed to operate.`); }) ``` @@ -5907,7 +6387,11 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba **示例:** ```ts -sensor.getGeomagneticField({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.getGeomagneticField({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, + (err: BusinessError.BusinessError, data: sensor.GeomagneticResponse) => { if (err) { console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`); return; @@ -5942,12 +6426,15 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.getGeomagneticField({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000); -promise.then((data) => { +promise.then((data: sensor.GeomagneticResponse) => { console.info('Succeeded in getting sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' + data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle + ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity); -}).catch((reason) => { +}).catch((reason: BusinessError.BusinessError) => { console.error(`Failed to operate.`); }) ``` @@ -5973,7 +6460,10 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac **示例:** ```ts -sensor.getAltitude(0, 200, function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.getAltitude(0, 200, (err: BusinessError.BusinessError, data: number) => { if (err) { console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`); return; @@ -6008,10 +6498,13 @@ getAltitude(seaPressure: number, currentPressure: number): Promise<number> **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.getAltitude(0, 200); -promise.then((data) => { +promise.then((data: number) => { console.info('Succeeded in getting sensor_getAltitude_Promise success', data); -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.error(`Failed to operate.`); }) ``` @@ -6037,7 +6530,10 @@ getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallbac **示例:** ```ts -sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], (err: BusinessError.BusinessError, data: number) => { if (err) { console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`); return; @@ -6071,10 +6567,13 @@ getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number> **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]); -promise.then((data) => { +promise.then((data: number) => { console.info('Succeeded in get GeomagneticDip_promise', data); -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.error(`Failed to operate.`); }) ``` @@ -6100,12 +6599,16 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar **示例:** ```ts -sensor.getAngleModify([1, 0, 0, 0, 1, 0, 0, 0, 1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.getAngleModify([1, 0, 0, 0, 1, 0, 0, 0, 1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], + (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } }) @@ -6137,14 +6640,18 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.getAngleModify([1, 0, 0, 0, 1, 0, 0, 0, 1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87]); -promise.then((data) => { +promise.then((data: Array) => { console.info('Succeeded in getting AngleModify_promise.'); - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("Succeeded in getting data[" + i + "]: " + data[i]); } -}).catch((reason) => { - console.info("Succeeded in getting promise::catch", reason); +}).catch((reason: BusinessError.BusinessError) => { + let e: BusinessError.BusinessError = reason as BusinessError.BusinessError; + console.info("Succeeded in getting promise::catch", e); }) ``` @@ -6168,12 +6675,16 @@ createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallbac **示例:** ```ts -sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], + (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("Succeeded in getting data[" + i + "]: " + data[i]); } }) @@ -6204,16 +6715,19 @@ createRotationMatrix(rotationVector: Array<number>): Promise<Array<n **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]); -promise.then((data) => { +promise.then((data: Array) => { console.info('Succeeded in getting createRotationMatrix_promise'); - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } -}).catch((reason) => { +}).catch((reason: BusinessError.BusinessError) => { console.info("Succeeded in getting promise::catch", reason); }) -``` + ``` ## sensor.createQuaternion(deprecated) @@ -6235,12 +6749,16 @@ createQuaternion(rotationVector: Array<number>, callback: AsyncCallback< **示例:** ```ts -sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], + (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`); return; } - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("Succeeded in getting data[" + i + "]: " + data[i]); } }) @@ -6271,13 +6789,16 @@ createQuaternion(rotationVector: Array<number>): Promise<Array<numbe **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]); -promise.then((data) => { +promise.then((data: Array) => { console.info('Succeeded in getting createQuaternion_promise'); - for (var i = 0; i < data.length; i++) { + for (let i = 0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.info(`Failed to get promise.`); }) ``` @@ -6302,13 +6823,16 @@ getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Arr **示例:** ```ts -sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], (err: BusinessError.BusinessError, data: Array) => { if (err) { console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`); return; } console.info("Succeeded in getting getDirection interface get data: " + data); - for (var i = 1; i < data.length; i++) { + for (let i = 1; i < data.length; i++) { console.info("Succeeded in getting sensor_getDirection_callback" + data[i]); } }) @@ -6339,13 +6863,16 @@ getDirection(rotationMatrix: Array<number>): Promise<Array<number> **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]); -promise.then((data) => { +promise.then((data: Array) => { console.info('Succeeded in getting sensor_getAltitude_Promise', data); - for (var i = 1; i < data.length; i++) { + for (let i = 1; i < data.length; i++) { console.info("Succeeded in getting sensor_getDirection_promise" + data[i]); } -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.info(`Failed to get promise.`); }) ``` @@ -6371,7 +6898,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& **示例:** ```ts -sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function (err, data) { +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + +sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], + (err: BusinessError.BusinessError, data: sensor.RotationMatrixResponse) => { if (err) { console.error(`Failed to get create rotationMatrix. Code: ${err.code}, message: ${err.message}`); return; @@ -6406,10 +6937,13 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& **示例:** ```ts +import sensor from '@ohos.sensor'; +import BusinessError from '@ohos.base'; + const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]); -promise.then((data) => { +promise.then((data: sensor.RotationMatrixResponse) => { console.info(JSON.stringify(data)); -}).catch((err) => { +}).catch((err: BusinessError.BusinessError) => { console.info(`Failed to get promise.`); }) - ``` +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md index 7a17fd7c56e4c767dac5a32fe67a8b8eac6ebba7..b1ca158ad766f477f665a8fa4dfebfa5174654d5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md @@ -98,7 +98,10 @@ addListener(callback: (event: MediaQueryEvent) => void): void **示例:** ```ts -function maxWidthMatch(e){ +import mediaquery, { MediaQueryEvent } from '@system.mediaquery'; +let mMediaQueryList = mediaquery.matchMedia('(max-width: 466)'); + +function maxWidthMatch(e: MediaQueryEvent): void { if(e.matches){ // do something } @@ -124,13 +127,13 @@ removeListener(callback: (event: MediaQueryEvent) => void): void **示例:** ```ts -function maxWidthMatch(e){ +import mediaquery, { MediaQueryEvent } from '@system.mediaquery'; +let mMediaQueryList = mediaquery.matchMedia('(max-width: 466)'); + +function maxWidthMatch(e: MediaQueryEvent): void { if(e.matches){ // do something } } mMediaQueryList.removeListener(maxWidthMatch); -``` - - - +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md index 62de17e20deea8e360dd120e81514740aec84907..7b5e2a1cd329c489e32eaba466b4379469f5af12 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md @@ -50,18 +50,24 @@ show(options?: ShowNotificationOptions): void | options | ShowNotificationOptions | 否 | 通知标题。 | **示例:** -```javascript -export default { - show() { - notification.show({ - contentTitle: 'title info', - contentText: 'text', - clickAction: { - bundleName: 'com.example.testapp', - abilityName: 'notificationDemo', - uri: '/path/to/notification' - } - }); - } +```ts +class NotificationClass { + show: Function +} + +let notificationObj: NotificationClass = { + show() { + notification.show({ + contentTitle: 'title info', + contentText: 'text', + clickAction: { + bundleName: 'com.example.testapp', + abilityName: 'notificationDemo', + uri: '/path/to/notification' + } + }); + } } + +export default notificationObj ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md b/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md index c85b447f4b4f38ca40d39b7c290654816e2af2d3..43cefdea82f00f941d1f57e12bca63ce516cb7ef 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md @@ -69,7 +69,7 @@ get(key: string, callback: AsyncCallback<string>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.get("const.ohos.apiversion", (err:BusinessError, data:string) => { + systemparameter.get("const.ohos.apiversion", (err: BusinessError, data: string) => { if (err == undefined) { console.log("get test.parameter.key value success:" + data) } else { @@ -102,7 +102,7 @@ get(key: string, def: string, callback: AsyncCallback<string>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.get("const.ohos.apiversion", "default", (err:BusinessError, data:string) => { + systemparameter.get("const.ohos.apiversion", "default", (err: BusinessError, data: string) => { if (err == undefined) { console.log("get test.parameter.key value success:" + data) } else { @@ -142,9 +142,9 @@ import { BusinessError } from '@ohos.base'; try { let p = systemparameter.get("const.ohos.apiversion"); - p.then((value:string) => { + p.then((value: string) => { console.log("get test.parameter.key success: " + value); - }).catch((err:BusinessError) => { + }).catch((err: BusinessError) => { console.log("get test.parameter.key error: " + err.code); }); } catch(e) { @@ -208,7 +208,7 @@ set(key: string, value: string, callback: AsyncCallback<void>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.set("test.parameter.key", "testValue", (err:BusinessError, data:string) =>{ + systemparameter.set("test.parameter.key", "testValue", (err: BusinessError, data: void) =>{ if (err == undefined) { console.log("set test.parameter.key value success :" + data) } else { @@ -251,9 +251,9 @@ import { BusinessError } from '@ohos.base'; try { let p = systemparameter.set("test.parameter.key", "testValue"); - p.then((value:string) => { + p.then((value: void) => { console.log("set test.parameter.key success: " + value); - }).catch((err:BusinessError) => { + }).catch((err: BusinessError) => { console.log(" set test.parameter.key error: " + err.code); }); } catch(e) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-parameterEnhance.md b/zh-cn/application-dev/reference/apis/js-apis-system-parameterEnhance.md index 9ee0568cccc3d95b42867ebfbc880744638b2743..6a26247644f0768fdd8d589e2921f8907c399118 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-system-parameterEnhance.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-parameterEnhance.md @@ -69,7 +69,7 @@ get(key: string, callback: AsyncCallback<string>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.get("const.ohos.apiversion", (err:BusinessError, data:string) => { + systemparameter.get("const.ohos.apiversion", (err: BusinessError, data: string) => { if (err == undefined) { console.log("get test.parameter.key value success:" + data) } else { @@ -102,7 +102,7 @@ get(key: string, def: string, callback: AsyncCallback<string>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.get("const.ohos.apiversion", "default", (err:BusinessError, data:string) => { + systemparameter.get("const.ohos.apiversion", "default", (err: BusinessError, data: string) => { if (err == undefined) { console.log("get test.parameter.key value success:" + data) } else { @@ -142,9 +142,9 @@ import { BusinessError } from '@ohos.base'; try { let p = systemparameter.get("const.ohos.apiversion"); - p.then((value:string) => { + p.then((value: string) => { console.log("get test.parameter.key success: " + value); - }).catch((err:BusinessError) => { + }).catch((err: BusinessError) => { console.log("get test.parameter.key error: " + err.code); }); } catch(e) { @@ -201,7 +201,7 @@ set(key: string, value: string, callback: AsyncCallback<void>): void import { BusinessError } from '@ohos.base'; try { - systemparameter.set("test.parameter.key", "testValue", (err:BusinessError, data:string) => { + systemparameter.set("test.parameter.key", "testValue", (err: BusinessError, data: void) => { if (err == undefined) { console.log("set test.parameter.key value success :" + data) } else { @@ -240,9 +240,9 @@ import { BusinessError } from '@ohos.base'; try { let p = systemparameter.set("test.parameter.key", "testValue"); - p.then((value:string) => { + p.then((value: void) => { console.log("set test.parameter.key success: " + value); - }).catch((err:BusinessError) => { + }).catch((err: BusinessError) => { console.log(" set test.parameter.key error: " + err.code); }); } catch(e) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md index cd5336f77bd2790f53e8901d2745cd2e423ba3a1..b2d267a33562302267cb96bca65a4ce38767c2a3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md @@ -38,17 +38,21 @@ import sensor from '@system.sensor'; **示例:** ```ts -sensor.subscribeAccelerometer({ +import sensor from '@system.sensor'; +import { AccelerometerResponse, subscribeAccelerometerOptions } from '@system.sensor'; + +let accelerometerOptions: subscribeAccelerometerOptions = { interval: 'normal', - success: function (ret) { + success: (ret: AccelerometerResponse) => { console.info('Succeeded in subscribing. X-axis data: ' + ret.x); console.info('Succeeded in subscribing. Y-axis data: ' + ret.y); console.info('Succeeded in subscribing. Z-axis data: ' + ret.z); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeAccelerometer(accelerometerOptions); ``` > **说明:** @@ -87,14 +91,18 @@ sensor.unsubscribeAccelerometer(); **示例:** ```ts -sensor.subscribeCompass({ - success: function (ret) { +import sensor from '@system.sensor'; +import { CompassResponse, SubscribeCompassOptions } from '@system.sensor'; + +let subscribeCompassOptions: SubscribeCompassOptions = { + success: (ret: CompassResponse) => { console.info('Succeeded in subscribing. Get data direction:' + ret.direction); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeCompass(subscribeCompassOptions); ``` > **说明:** @@ -131,15 +139,18 @@ sensor.unsubscribeCompass(); **示例:** ```ts -sensor.subscribeProximity({ - success: function (ret) { +import sensor from '@system.sensor'; +import { ProximityResponse, SubscribeProximityOptions } from '@system.sensor'; + +let subscribeProximityOptions: SubscribeProximityOptions = { + success: (ret: ProximityResponse) => { console.info('Succeeded in subscribing. Get data distance:' + ret.distance); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); - }, -}); +}; +sensor.subscribeProximity(subscribeProximityOptions); ``` > **说明:** @@ -176,14 +187,18 @@ sensor.unsubscribeProximity(); **示例:** ```ts -sensor.subscribeLight({ - success: function (ret) { +import sensor from '@system.sensor'; +import { LightResponse, SubscribeLightOptions } from '@system.sensor'; + +let subscribeLightOptions: SubscribeLightOptions = { + success: (ret: LightResponse) => { console.info('Succeeded in subscribing. Get data intensity:' + ret.intensity); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeLight(subscribeLightOptions); ``` > **说明:** @@ -222,14 +237,18 @@ sensor.unsubscribeLight(); **示例:** ```ts -sensor.subscribeStepCounter({ - success: function (ret) { +import sensor from '@system.sensor'; +import { StepCounterResponse, SubscribeStepCounterOptions } from '@system.sensor'; + +let subscribeStepCounterOptions: SubscribeStepCounterOptions = { + success: (ret: StepCounterResponse) => { console.info('Succeeded in subscribing. Get step value:' + ret.steps); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeStepCounter(subscribeStepCounterOptions); ``` > **说明:** @@ -269,14 +288,18 @@ subscribeBarometer(options: SubscribeBarometerOptions): void **示例:** ```ts -sensor.subscribeBarometer({ - success: function (ret) { +import sensor from '@system.sensor'; +import { BarometerResponse, SubscribeBarometerOptions } from '@system.sensor'; + +let subscribeBarometerOptions: SubscribeBarometerOptions = { + success: (ret: BarometerResponse) => { console.info('Succeeded in subscribing. Get data value:' + ret.pressure); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeBarometer(subscribeBarometerOptions); ``` > **说明:** @@ -317,14 +340,18 @@ sensor.unsubscribeBarometer(); **示例:** ```ts -sensor.subscribeHeartRate({ - success: function (ret) { +import sensor from '@system.sensor'; +import { HeartRateResponse, SubscribeHeartRateOptions } from '@system.sensor'; + +let subscribeHeartRateOptions: SubscribeHeartRateOptions = { + success: (ret: HeartRateResponse) => { console.info('Succeeded in subscribing. Get heartrate value:' + ret.heartRate); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeHeartRate(subscribeHeartRateOptions); ``` > **说明:** @@ -364,14 +391,18 @@ sensor.unsubscribeHeartRate(); **示例:** ```ts -sensor.subscribeOnBodyState({ - success: function (ret) { +import sensor from '@system.sensor'; +import { OnBodyStateResponse, SubscribeOnBodyStateOptions } from '@system.sensor'; + +let subscribeOnBodyStateOptions: SubscribeOnBodyStateOptions = { + success: (ret: OnBodyStateResponse) => { console.info('Succeeded in subscribing. Get on-body state value:' + ret.value); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.subscribeOnBodyState(subscribeOnBodyStateOptions); ``` > **说明:** @@ -408,14 +439,18 @@ sensor.unsubscribeOnBodyState(); **示例:** ```ts -sensor.getOnBodyState({ - success: function (ret) { +import sensor from '@system.sensor'; +import { OnBodyStateResponse, GetOnBodyStateOptions } from '@system.sensor'; + +let getOnBodyStateOptions: GetOnBodyStateOptions = { + success: (ret: OnBodyStateResponse) => { console.info('Succeeded in subscribing. On body state: ' + ret.value); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); }, -}); +}; +sensor.getOnBodyState(getOnBodyStateOptions); ``` ## sensor.subscribeDeviceOrientation6+ @@ -437,17 +472,21 @@ sensor.getOnBodyState({ **示例:** ```ts -sensor.subscribeDeviceOrientation({ +import sensor from '@system.sensor'; +import { DeviceOrientationResponse, SubscribeDeviceOrientationOptions } from '@system.sensor'; + +let subscribeDeviceOrientationOptions: SubscribeDeviceOrientationOptions = { interval: 'normal', - success: function (ret) { + success: (ret: DeviceOrientationResponse) => { console.info('Succeeded in subscribing. Alpha data: ' + ret.alpha); console.info('Succeeded in subscribing. Beta data: ' + ret.beta); console.info('Succeeded in subscribing. Gamma data: ' + ret.gamma); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); - } -}); + } +}; +sensor.subscribeDeviceOrientation(subscribeDeviceOrientationOptions); ``` > **说明:** @@ -488,17 +527,21 @@ sensor.unsubscribeDeviceOrientation(); **示例:** ```ts -sensor.subscribeGyroscope({ +import sensor from '@system.sensor'; +import { GyroscopeResponse, SubscribeGyroscopeOptions } from '@system.sensor'; + +let subscribeGyroscopeOptions: SubscribeGyroscopeOptions = { interval: 'normal', - success: function (ret) { + success: (ret: GyroscopeResponse) => { console.info('Succeeded in subscribing. X-axis data: ' + ret.x); console.info('Succeeded in subscribing. Y-axis data: ' + ret.y); console.info('Succeeded in subscribing. Z-axis data: ' + ret.z); }, - fail: function (data, code) { + fail: (data: string, code: number) => { console.error(`Failed to subscription. Code: ${code}, data: ${data}`); } -}); +}; +sensor.subscribeGyroscope(subscribeGyroscopeOptions); ``` > **说明:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-vibrate.md b/zh-cn/application-dev/reference/apis/js-apis-system-vibrate.md index 6eced16953a0283befe2206102d05316cf2703f8..133ce92544baa66cc6023f71068bfbbf76153d3e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-vibrate.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-vibrate.md @@ -37,18 +37,22 @@ import vibrator from '@system.vibrator'; **示例:** ```ts -vibrator.vibrate({ +import vibrator from '@system.vibrator'; +import { VibrateOptions } from '@system.vibrator'; + +let vibrateOptions: VibrateOptions = { mode: 'short', - success: function() { + success: () => { console.info('Succeed in vibrating'); }, - fail: function(data, code) { + fail: (data: string, code: number) => { console.info(`Failed to vibrate. Data: ${data}, code: ${code}`); }, - complete: function() { + complete: () => { console.info('completed in vibrating'); } -}); +}; +vibrator.vibrate(vibrateOptions); ``` ## VibrateOptions diff --git a/zh-cn/application-dev/reference/apis/js-apis-uitest.md b/zh-cn/application-dev/reference/apis/js-apis-uitest.md index 83e02f23576b652c0f09226766acef321bdaafe2..64f8f48376eec85566706e143c267af6cfe3f127 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uitest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uitest.md @@ -3840,6 +3840,15 @@ assertComponentExist(by: By): Promise\ | ------ | ------------------- | ---- | -------------------- | | by | [By](#bydeprecated) | 是 | 目标控件的属性要求。 | +**错误码:** + +以下错误码的详细介绍请参见[uitest测试框架错误码](../errorcodes/errorcode-uitest.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------ | +| 17000002 | if the async function was not called with await. | +| 17000003 | if the assertion failed. | + **示例:** ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-userFileManager.md b/zh-cn/application-dev/reference/apis/js-apis-userFileManager.md index 522b3a0a95eb5a478ff07863b83fb889654647d2..d3de83d97f966af987e24878e62edf1648a1b01a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-userFileManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-userFileManager.md @@ -1433,37 +1433,35 @@ getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions, callbac import dataSharePredicates from '@ohos.data.dataSharePredicates'; async function example() { - console.info('getPhotoIndexDemo'); - let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); - let fetchOp = { - fetchColumns: [], - predicates: predicatesForGetAsset - }; - //Obtain the uri of the album - let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubtype.FAVORITE, fetchOp); - let album = await albumFetchResult.getFirstObject(); - - let predicates = new dataSharePredicates.DataSharePredicates(); - predicates.orderByAsc("add_modified"); - let fetchOptions = { - fetchColumns: [], - predicates: predicates - }; - let photoFetchResult = await album.getPhotoAssets(fetchOptions); - let expectIndex = 1; - //Obtain the uri of the second file - let photoAsset = await photoFetchResult.getPositionObject(expectIndex); - - mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => { - try { + try { + console.info('getPhotoIndexDemo'); + let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); + let fetchOp = { + fetchColumns: [], + predicates: predicatesForGetAsset + }; + // Obtain the uri of the album + let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.FAVORITE, fetchOp); + let album = await albumFetchResult.getFirstObject(); + let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.orderByAsc(userFileManager.ImageVideoKey.DATE_MODIFIED); + let fetchOptions = { + fetchColumns: [userFileManager.ImageVideoKey.DATE_MODIFIED], + predicates: predicates + }; + let photoFetchResult = await album.getPhotoAssets(fetchOptions); + let expectIndex = 1; + // Obtain the uri of the second file + let photoAsset = await photoFetchResult.getPositionObject(expectIndex); + mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => { if (err == undefined) { console.info(`getPhotoIndex successfully and index is : ${index}`); } else { console.info(`getPhotoIndex failed;`); } - } catch (error) { - console.info(`getPhotoIndex failed; error: ${error}`); - } + }); + } catch (error) { + console.info(`getPhotoIndex failed; error: ${error}`); } } ``` @@ -1508,33 +1506,34 @@ getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promis import dataSharePredicates from '@ohos.data.dataSharePredicates'; async function example() { - console.info('getPhotoIndexDemo'); - let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); - let fetchOp = { - fetchColumns: [], - predicates: predicatesForGetAsset - }; - //Obtain the uri of the album - let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubtype.FAVORITE, fetchOp); - let album = await albumFetchResult.getFirstObject(); - - let predicates = new dataSharePredicates.DataSharePredicates(); - predicates.orderByAsc("add_modified"); - let fetchOptions = { - fetchColumns: [], - predicates: predicates - }; - let photoFetchResult = await album.getPhotoAssets(fetchOptions); - let expectIndex = 1; - //Obtain the uri of the second file - let photoAsset = await photoFetchResult.getPositionObject(expectIndex); - - mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions) - .then((index) => { - console.info(`getPhotoIndex successfully and index is : ${index}`); - }).catch((err) => { + try { + console.info('getPhotoIndexDemo'); + let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates(); + let fetchOp = { + fetchColumns: [], + predicates: predicatesForGetAsset + }; + // Obtain the uri of the album + let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.FAVORITE, fetchOp); + let album = await albumFetchResult.getFirstObject(); + let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.orderByAsc(userFileManager.ImageVideoKey.DATE_MODIFIED); + let fetchOptions = { + fetchColumns: [userFileManager.ImageVideoKey.DATE_MODIFIED], + predicates: predicates + }; + let photoFetchResult = await album.getPhotoAssets(fetchOptions); + let expectIndex = 1; + // Obtain the uri of the second file + let photoAsset = await photoFetchResult.getPositionObject(expectIndex); + mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions).then((index) => { + console.info(`getPhotoIndex successfully and index is : ${index}`); + }).catch((err) => { console.info(`getPhotoIndex failed; error: ${err}`); - }) + }); + } catch (error) { + console.info(`getPhotoIndex failed; error: ${error}`); + } } ``` @@ -2566,15 +2565,18 @@ async function example() { try { console.info('getExifDemo'); let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.isNotNull('all_exif') let fetchOptions = { - fetchColumns: [ 'all_exif', ImageVideoKey.USER_COMMENT], + fetchColumns: ['all_exif', userFileManager.ImageVideoKey.USER_COMMENT], predicates: predicates }; let fetchResult = await mgr.getPhotoAssets(fetchOptions); let fileAsset = await fetchResult.getFirstObject(); + console.info('getExifDemo fileAsset displayName: ' + JSON.stringify(fileAsset.displayName)); let exifMessage = await fileAsset.getExif(); let userCommentKey = 'UserComment'; let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]); + console.info('getExifDemo userComment: ' + JSON.stringify(userComment)); fetchResult.close(); } catch (err) { console.error('getExifDemoCallback failed with error: ' + err); @@ -2653,16 +2655,19 @@ async function example() { try { console.info('getExifDemo'); let predicates = new dataSharePredicates.DataSharePredicates(); + predicates.isNotNull('all_exif') let fetchOptions = { - fetchColumns: [ 'all_exif', ImageVideoKey.USER_COMMENT], + fetchColumns: ['all_exif', userFileManager.ImageVideoKey.USER_COMMENT], predicates: predicates }; let fetchResult = await mgr.getPhotoAssets(fetchOptions); let fileAsset = await fetchResult.getFirstObject(); + console.info('getExifDemo fileAsset displayName: ' + JSON.stringify(fileAsset.displayName)); let userCommentKey = 'UserComment'; fileAsset.getExif((err, exifMessage) => { if (exifMessage != undefined) { let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]); + console.info('getExifDemo userComment: ' + JSON.stringify(userComment)); } else { console.error('getExif failed, message = ', err); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md index 4b07abbbc692bfff851eab2f465e1bbc425ac726..01d5f72676fc95c255a5aa245d3db6b41d004353 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md @@ -43,6 +43,7 @@ startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: Asy ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { vibrator.startVibration({ @@ -51,7 +52,7 @@ try { }, { id: 0, usage: 'alarm' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -59,7 +60,8 @@ try { console.info('Succeed in starting vibration'); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -98,6 +100,7 @@ startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise<v ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { vibrator.startVibration({ @@ -108,11 +111,12 @@ try { usage: 'alarm' }).then(() => { console.info('Succeed in starting vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -137,6 +141,7 @@ stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback<void>): ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 按照固定时长振动 @@ -146,7 +151,7 @@ try { }, { id: 0, usage: 'alarm' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -154,12 +159,13 @@ try { console.info('Succeed in starting vibration'); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } try { // 按照VIBRATOR_STOP_MODE_TIME模式停止振动 - vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) { + vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, (error: BusinessError) => { if (error) { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -167,7 +173,8 @@ try { console.info('Succeed in stopping vibration'); }) } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -197,33 +204,36 @@ stopVibration(stopMode: VibratorStopMode): Promise<void> ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 按照固定时长振动 vibrator.startVibration({ type: 'time', - duration: 1000 + duration: 1000, }, { id: 0, usage: 'alarm' }).then(() => { console.info('Succeed in starting vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } try { // 按照VIBRATOR_STOP_MODE_TIME模式停止振动 vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => { console.info('Succeed in stopping vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (err) { - console.error(`An unexpected error occurred. Code: ${err.code}, message: ${err.message}`); + let e: BusinessError = err as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -247,6 +257,7 @@ stopVibration(callback: AsyncCallback<void>): void ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 按照固定时长振动 @@ -256,7 +267,7 @@ try { }, { id: 0, usage: 'alarm' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -264,12 +275,13 @@ try { console.info('Succeed in starting vibration'); }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } try { // 停止所有模式的马达振动 - vibrator.stopVibration(function (error) { + vibrator.stopVibration((error: BusinessError) => { if (error) { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); return; @@ -277,7 +289,8 @@ try { console.info('Succeed in stopping vibration'); }) } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -301,33 +314,36 @@ stopVibration(): Promise<void> ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 按照固定时长振动 vibrator.startVibration({ type: 'time', - duration: 1000 + duration: 1000, }, { id: 0, usage: 'alarm' }).then(() => { console.info('Succeed in starting vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } try { // 停止所有模式的马达振动 vibrator.stopVibration().then(() => { console.info('Succeed in stopping vibration'); - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to stop vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -350,10 +366,11 @@ isSupportEffect(effectId: string, callback: AsyncCallback<boolean>): void ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 查询是否支持'haptic.clock.timer' - vibrator.isSupportEffect('haptic.clock.timer', function (err, state) { + vibrator.isSupportEffect('haptic.clock.timer', (err: BusinessError, state: boolean) => { if (err) { console.error(`Failed to query effect. Code: ${err.code}, message: ${err.message}`); return; @@ -361,13 +378,14 @@ try { console.info('Succeed in querying effect'); if (state) { try { - vibrator.startVibration({ // 使用startVibration需要添加ohos.permission.VIBRATE权限 + // 使用startVibration需要添加ohos.permission.VIBRATE权限 + vibrator.startVibration({ type: 'preset', effectId: 'haptic.clock.timer', count: 1, }, { usage: 'unknown' - }, (error) => { + }, (error: BusinessError) => { if (error) { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); } else { @@ -375,12 +393,14 @@ try { } }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } } }) } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -408,10 +428,11 @@ isSupportEffect(effectId: string): Promise<boolean> ```ts import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; try { // 查询是否支持'haptic.clock.timer' - vibrator.isSupportEffect('haptic.clock.timer').then((state) => { + vibrator.isSupportEffect('haptic.clock.timer').then((state: boolean) => { console.info(`The query result is ${state}`); if (state) { try { @@ -423,18 +444,20 @@ try { usage: 'unknown' }).then(() => { console.info('Succeed in starting vibration'); - }).catch((error) => { + }).catch((error: BusinessError) => { console.error(`Failed to start vibration. Code: ${error.code}, message: ${error.message}`); }); } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } } - }, (error) => { + }, (error: BusinessError) => { console.error(`Failed to query effect. Code: ${error.code}, message: ${error.message}`); }) } catch (error) { - console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); + let e: BusinessError = error as BusinessError; + console.error(`An unexpected error occurred. Code: ${e.code}, message: ${e.message}`); } ``` @@ -574,9 +597,12 @@ vibrate(duration: number): Promise<void> **示例:** ```ts +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + vibrator.vibrate(1000).then(() => { console.info('Succeed in vibrating'); -}, (error) => { +}, (error: BusinessError) => { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); }); ``` @@ -603,7 +629,10 @@ vibrate(duration: number, callback?: AsyncCallback<void>): void **示例:** ```ts -vibrator.vibrate(1000, function (error) { +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + +vibrator.vibrate(1000, (error: BusinessError) => { if (error) { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); } else { @@ -640,9 +669,12 @@ vibrate(effectId: EffectId): Promise<void> **示例:** ```ts +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(() => { console.info('Succeed in vibrating'); -}, (error) => { +}, (error: BusinessError) => { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); }); ``` @@ -670,7 +702,10 @@ vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void **示例:** ```ts -vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + +vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, (error: BusinessError) => { if (error) { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); } else { @@ -706,8 +741,11 @@ stop(stopMode: VibratorStopMode): Promise<void> **示例:** ```ts +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + // 按照effectId类型启动振动 -vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { +vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, (error: BusinessError) => { if (error) { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); } else { @@ -717,7 +755,7 @@ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { // 使用VIBRATOR_STOP_MODE_PRESET模式停止振动 vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(() => { console.info('Succeed in stopping'); -}, (error) => { +}, (error: BusinessError) => { console.error(`Failed to stop. Code: ${error.code}, message: ${error.message}`); }); ``` @@ -745,8 +783,11 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void **示例:** ```ts +import vibrator from '@ohos.vibrator'; +import { BusinessError } from '@ohos.base'; + // 按照effectId类型启动振动 -vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { +vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, (error: BusinessError) => { if (error) { console.error(`Failed to vibrate. Code: ${error.code}, message: ${error.message}`); } else { @@ -754,11 +795,11 @@ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) { } }) // 使用VIBRATOR_STOP_MODE_PRESET模式停止振动 -vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function (error) { +vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, (error: BusinessError) => { if (error) { console.error(`Failed to stop. Code: ${error.code}, message: ${error.message}`); } else { - onsole.info('Succeed in stopping'); + console.info('Succeed in stopping'); } }) ``` diff --git a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md index 7483e00c88d4d0c6dc1f1a0652b71fea1b5aa70a..5c3d84a57f7637d25763872ba8850c69cb1a493a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md +++ b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md @@ -40,7 +40,7 @@ - [分布式迁移标识](ts-universal-attributes-restoreId.md) - [前景色设置](ts-universal-attributes-foreground-color.md) - [组件内容模糊](ts-universal-attributes-foreground-blur-style.md) - - [点击回弹](ts-universal-attributes-click-effect.md) + - [点击回弹效果](ts-universal-attributes-click-effect.md) - [无障碍属性](ts-universal-attributes-accessibility.md) - 触摸交互控制 - [触摸热区设置](ts-universal-attributes-touch-target.md) @@ -117,6 +117,7 @@ - [Column](ts-container-column.md) - [ColumnSplit](ts-container-columnsplit.md) - [Counter](ts-container-counter.md) + - [EffectComponent](ts-container-effectcomponent.md) - [Flex](ts-container-flex.md) - [FlowItem](ts-container-flowitem.md) - [FormLink](ts-container-formlink.md) @@ -142,7 +143,6 @@ - [TabContent](ts-container-tabcontent.md) - [UIExtensionComponent](ts-container-ui-extension-component.md) - [WaterFlow](ts-container-waterflow.md) - - [EffectComponent](ts-container-effectcomponent.md) - 媒体组件 - [Video](ts-media-components-video.md) - 绘制组件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-formcomponent.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-formcomponent.md index 8c9b596310be174239fcbd7eb201908aff7c9f21..ed40dbbe5ed015c66d3e54a1913665b1e464dad1 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-formcomponent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-formcomponent.md @@ -72,7 +72,7 @@ FormComponent(value: { | 名称 | 功能描述 | | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | onAcquired(callback: (info: { id: number }) => void) | 获取到卡片后触发,返回卡片的id. | -| onError(callback: (info: { errcode: number, msg: string }) => void) | 组件加载错误回调。
errcode: 错误码。
msg: 错误信息。 | +| onError(callback: (info: { errcode: number, msg: string }) => void) | 组件加载错误回调。
errcode: 错误码。
msg: 错误信息。
具体可参考[卡片错误码说明文档](../errorcodes/errorcode-form.md) | | onRouter(callback: (info: any) => void) | 组件路由事件回调,返回[routerEvent](../js-service-widget-ui/js-service-widget-syntax-hml.md#事件绑定)中的信息。 | | onUninstall(callback: (info: { id: number }) => void) | 组件卸载回调,返回卸载卡片的id. | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-menu.md index 161dc5cf8e0fd3bcb7a059a9387081541e14dce1..b04f78697cc9f4bcca493878df516d27a27c79cf 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-menu.md @@ -27,7 +27,8 @@ Menu() | fontSize(deprecated) | [Length](ts-types.md#length) | 统一设置Menu中所有文本的尺寸,Length为number类型时,使用fp单位。
从API Version 10开始废弃,建议使用font代替。 | | font10+ | [Font](ts-types.md#font) | 统一设置Menu中所有文本的字体样式。 | | fontColor10+ | [ResourceColor](ts-types.md#resourcecolor) | 统一设置Menu中所有文本的颜色。 | -| radius10+ | [Dimension](ts-types.md#dimension10) \| [BorderRadiuses](#borderradiuses9) | 设置Menu边框圆角半径。
默认值跟随主题。 | +| radius10+ | [Dimension](ts-types.md#dimension10) \| [BorderRadiuses](#borderradiuses9) | 设置Menu边框圆角半径。
默认值跟随主题。数值低于menu宽度的一半时,走默认值。 | +| width10+ | [Length](ts-types.md#length) | 设置Menu边框宽度。
支持设置的最小宽度为64vp。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navdestination.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navdestination.md index fd2ca1a9b280cbea25ead154b267da9ae8167e85..5f4904999aa1b210f774b06f1dad54ed25d690b8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navdestination.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navdestination.md @@ -26,7 +26,7 @@ NavDestination() | 名称 | 参数类型 | 描述 | | ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| title | string \| [CustomBuilder](ts-types.md#custombuilder8) \| [NavigationCommonTitle](ts-basic-components-navigation.md#navigationcommontitle类型说明) \| [NavigationCustomTitle](ts-basic-components-navigation.md##navigationcustomtitle类型说明) | 页面标题。
**说明:**
使用NavigationCustomTitle类型设置height高度时,titleMode属性不会生效。
字符串超长时,如果不设置副标题,先缩小再换行2行后以...截断。如果设置副标题,先缩小后以...截断。 | +| title | string \| [CustomBuilder](ts-types.md#custombuilder8) \| [NavigationCommonTitle](ts-basic-components-navigation.md#navigationcommontitle类型说明) \| [NavigationCustomTitle](ts-basic-components-navigation.md#navigationcustomtitle类型说明) | 页面标题。
**说明:**
使用NavigationCustomTitle类型设置height高度时,titleMode属性不会生效。
字符串超长时,如果不设置副标题,先缩小再换行2行后以...截断。如果设置副标题,先缩小后以...截断。 | | hideTitleBar | boolean | 是否显示标题栏。
默认值:false
true: 隐藏标题栏。
false: 显示标题栏。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click-effect.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click-effect.md index ee0065f626e3e91548618f2c602f5a479b191d10..31e254f8fa45296c20eb8f18b03caae211178e0e 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click-effect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click-effect.md @@ -7,20 +7,20 @@ > 从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -### 属性 +## 属性 | 名称 | 参数类型 | 描述 | | ----------- | ------------------------------------------- | ------------------------------------------------------------ | | clickEffect | [ClickEffect](#clickeffect对象说明) \| null | 设置当前组件点击回弹效果。
**说明:**
可通过undefined或者null取消点击回弹效果。
不建议在组件大小动态变化的场景中使用该功能。
当组件无法触发通用事件时,不支持该属性。 | -### ClickEffect对象说明 +## ClickEffect对象说明 | 名称 | 参数类型 | 必填 | 描述 | | ----- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | | level | [ClickEffectLevel](ts-appendix-enums.md#clickeffectlevel10) | 是 | 设置当前组件点击回弹效果。
**说明:**
level等于undefined或者null时, ClickEffect采用ClickEffectLevel.LIGHT对应的回弹效果, 缩放比参照scale说明。 | | scale | number | 否 | 回弹缩放比例,支持在设置ClickEffectLevel的基础上微调回弹缩放比例。
**说明:**
level等于ClickEffectLevel.LIGHT时,默认值:0.90
level等于ClickEffectLevel.MIDDLE或者ClickEffectLevel.HEAVY时,默认值:0.95
level等于undefined或者null时,level为ClickEffectLevel.LIGHT,默认值:0.90
scale等于undefined或者null时,scale与当前设置的level对应的默认缩放比相同。
| -### 示例 +## 示例 ```ts // xxx.ets diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-drag-drop.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-drag-drop.md index b6fdbb6102b2f24ea840502baeaaf2c6bb22d471..92b52a7f8b6867d173c717b63bd5a31b70041f6c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-drag-drop.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-drag-drop.md @@ -6,7 +6,7 @@ > > 从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -ArkUI组件默认支持拖拽。 +ArkUI组件默认不支持拖拽。 当以下组件的draggable属性设置为true时可以响应拖拽事件,此时,组件不需要配置数据传输,即可进行拖拽。其他组件需要开发者将draggable属性设置为true且在onDragStart等接口中实现数据传输相关内容,才能完成拖拽。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md index a9309ac3e26c482aecda550352b57fde64676a1b..43ed23aa807d0601dff6569eafa9f1bd1de7aa30 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md @@ -8,7 +8,7 @@ > > 应用本身预置的资源文件(即应用在安装前的HAP包中已经存在的资源文件)仅支持本地应用内拖拽。 -ArkUI组件默认支持拖拽。 +ArkUI组件默认不支持拖拽。 当以下组件的[draggable](ts-universal-attributes-drag-drop.md)属性设置为true时可以响应拖拽事件,此时,组件不需要配置数据传输,即可进行拖拽。其他组件需要开发者将[draggable](ts-universal-attributes-drag-drop.md)属性设置为true且在onDragStart等接口中实现数据传输相关内容,才能完成拖拽。 @@ -22,7 +22,7 @@ ArkUI组件默认支持拖拽。 | 名称 | 支持冒泡 | 功能描述 | | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| onDragStart(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) =>  [CustomBuilder](ts-types.md#custombuilder8) \| [DragItemInfo](#dragiteminfo说明)) | 否 | 第一次拖拽此事件绑定的组件时,触发回调。
- event:拖拽事件信息,详见[DragEvent](#dragevent说明)。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
返回值:拖拽过程中显示的组件信息。
触发条件:长按时间 >= 500ms。
事件优先级:长按触发时间 < 500ms,长按事件 > 拖拽事件
其他: 拖拽事件 > 长按事件。 | +| onDragStart(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) =>  [CustomBuilder](ts-types.md#custombuilder8) \| [DragItemInfo](#dragiteminfo说明)) | 否 | 第一次拖拽此事件绑定的组件时,触发回调。
- event:拖拽事件信息,详见[DragEvent](#dragevent说明)。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
返回值:拖拽过程中显示的组件信息。
触发条件:长按时间 >= 500ms。
事件优先级:长按触发时间 < 500ms,长按事件 > 拖拽事件
其他: 拖拽事件 > 长按事件。
**说明:**
当前不支持同时配置[dragController.executeDrag](../apis/js-apis-arkui-dragController.md#dragcontrollerexecutedrag)和onDragStart。| | onDragEnter(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 拖拽进入组件范围内时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
当监听了onDrop事件时,此事件才有效。 | | onDragMove(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 拖拽在组件范围内移动时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
当监听了onDrop事件时,此事件才有效。 | | onDragLeave(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 拖拽离开组件范围内时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
当监听了onDrop事件时,此事件才有效。 | diff --git a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md index 5b4332201142200ab3d3de57c0300979ee061418..a1f4847bd3210c5ff1e5bb57cc3a064288251619 100644 --- a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md +++ b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md @@ -14,12 +14,12 @@ - [事件错误码](errorcode-CommonEventService.md) - [通知错误码](errorcode-notification.md) - [DistributedNotificationService错误码](errorcode-DistributedNotificationService.md) - - [拖拽事件错误码](errorcode-drag-event.md) - UI界面 - [动画错误码](errorcode-animator.md) - [弹窗错误码](errorcode-promptAction.md) - [页面路由错误码](errorcode-router.md) - [用户界面外观服务错误码](errorcode-uiappearance.md) + - [拖拽事件错误码](errorcode-drag-event.md) - 图形图像 - [色彩管理错误码](errorcode-colorspace-manager.md) - [屏幕错误码](errorcode-display.md) diff --git a/zh-cn/application-dev/reference/native-apis/_native_vsync.md b/zh-cn/application-dev/reference/native-apis/_native_vsync.md index 0487dbc7c286827dd833fb9798d592dc5ee84718..83a9586f575fcbde8f1cf7f50c1af6a368488fc7 100644 --- a/zh-cn/application-dev/reference/native-apis/_native_vsync.md +++ b/zh-cn/application-dev/reference/native-apis/_native_vsync.md @@ -19,7 +19,7 @@ | 名称 | 描述 | | -------- | -------- | -| [native_vsync.h](native__vsync_8h.md) | 定义获取和使用NativeVsync的相关函数
引用文件:<native_vsync/native_vsync.h> | +| [native_vsync.h](native__vsync_8h.md) | 定义获取和使用NativeVsync的相关函数
**引用文件:** <native_vsync/native_vsync.h>
**库:** libnative_vsync.so | ### 类型定义 @@ -37,7 +37,7 @@ | [OH_NativeVSync_Create](#oh_nativevsync_create) (const char \*name, unsigned int length) | 创建一个OH_NativeVSync实例,每次调用都会产生一个新的实例 | | [OH_NativeVSync_Destroy](#oh_nativevsync_destroy) ([OH_NativeVSync](#oh_nativevsync) \*nativeVsync) | 销毁OH_NativeVSync实例 | | [OH_NativeVSync_RequestFrame](#oh_nativevsync_requestframe) ([OH_NativeVSync](#oh_nativevsync) \*nativeVsync, [OH_NativeVSync_FrameCallback](#oh_nativevsync_framecallback) callback, void \*data) | 请求下一次vsync信号,当信号到来时,调用回调函数callback | - +| [OH_NativeVSync_GetPeriod](#oh_nativevsync_getperiod) ([OH_NativeVSync](#oh_nativevsync) \*nativeVsync, long long \*period) |获取vsync周期。| ## 类型定义说明 @@ -77,6 +77,34 @@ VSync回调函数类型 ## 函数说明 +### OH_NativeVSync_GetPeriod() + + +``` +int OH_NativeVSync_GetPeriod (OH_NativeVSync * nativeVsync, long long * period ) +``` + +**描述:** + +获取vsync周期。 + +\@syscap SystemCapability.Graphic.Graphic2D.NativeVsync + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| nativeVsync | 一个指向OH_NativeVSync实例的指针。| +| period | 用于获取vsync周期的变量。 | + +**返回:** + +返回值为0表示执行成功。 + +**起始版本:** + +10 + ### OH_NativeVSync_Create() diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer.md b/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer.md index 18e79e28c1f3733d0074f5b1ff0f408db1da5bc7..ba9381e58e64bc32083898c438e2559c1570bab9 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer.md @@ -19,7 +19,7 @@ | 名称 | 描述 | | -------- | -------- | -| [native_buffer.h](native__buffer_8h.md) | 定义获取和使用NativeBuffer的相关函数。
引用文件:<native_buffer/native_buffer.h> | +| [native_buffer.h](native__buffer_8h.md) | 定义获取和使用NativeBuffer的相关函数。
**引用文件:** <native_buffer/native_buffer.h>
**库:** libnative_buffer.so| ### 结构体 @@ -35,6 +35,12 @@ | -------- | -------- | | [OH_NativeBuffer](#oh_nativebuffer) | 提供OH_NativeBuffer结构体声明。 | +### 枚举 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_NativeBuffer_Usage](#oh_nativebuffer_usage) { NATIVEBUFFER_USAGE_CPU_READ = (1ULL << 0), NATIVEBUFFER_USAGE_CPU_WRITE = (1ULL << 1), NATIVEBUFFER_USAGE_MEM_DMA = (1ULL << 3) } | OH_NativeBuffer的用途。 | +| [OH_NativeBuffer_Format](#oh_nativebuffer_format) {
NATIVEBUFFER_PIXEL_FMT_RGB_565 = 3, NATIVEBUFFER_PIXEL_FMT_RGBA_5658, NATIVEBUFFER_PIXEL_FMT_RGBX_4444, NATIVEBUFFER_PIXEL_FMT_RGBA_4444,
NATIVEBUFFER_PIXEL_FMT_RGB_444, NATIVEBUFFER_PIXEL_FMT_RGBX_5551, NATIVEBUFFER_PIXEL_FMT_RGBA_5551, NATIVEBUFFER_PIXEL_FMT_RGB_555,
NATIVEBUFFER_PIXEL_FMT_RGBX_8888, NATIVEBUFFER_PIXEL_FMT_RGBA_8888, NATIVEBUFFER_PIXEL_FMT_RGB_888, NATIVEBUFFER_PIXEL_FMT_BGR_565,
NATIVEBUFFER_PIXEL_FMT_BGRX_4444, NATIVEBUFFER_PIXEL_FMT_BGRA_4444, NATIVEBUFFER_PIXEL_FMT_BGRX_5551, NATIVEBUFFER_PIXEL_FMT_BGRA_5551,
NATIVEBUFFER_PIXEL_FMT_BGRX_8888, NATIVEBUFFER_PIXEL_FMT_BGRA_8888, NATIVEBUFFER_PIXEL_FMT_BUTT = 0X7FFFFFFF
} | OH_NativeBuffer的格式。 | ### 函数 @@ -63,6 +69,70 @@ typedef struct OH_NativeBuffer OH_NativeBuffer 提供OH_NativeBuffer结构体声明。 +## 枚举类型说明 + + +### OH_NativeBuffer_Format + +``` +enum OH_NativeBuffer_Format +``` + +**描述:** + +OH_NativeBuffer的格式。 + +\@SysCap SystemCapability.Graphic.Graphic2D.NativeBuffer + +| 枚举值 | 描述 | +| -------- | -------- | +| NATIVEBUFFER_PIXEL_FMT_RGB_565 | RGB565格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBA_5658 | RGBA5658格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBX_4444 | RGBX4444格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBA_4444 | RGBA4444格式 | +| NATIVEBUFFER_PIXEL_FMT_RGB_444 | RGB444格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBX_5551 | RGBX5551格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBA_5551 | RGBA5551格式 | +| NATIVEBUFFER_PIXEL_FMT_RGB_555 | RGB555格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBX_8888 | RGBX8888格式 | +| NATIVEBUFFER_PIXEL_FMT_RGBA_8888 | RGBA8888格式 | +| NATIVEBUFFER_PIXEL_FMT_RGB_888 | RGB888格式 | +| NATIVEBUFFER_PIXEL_FMT_BGR_565 | BGR565格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRX_4444 | BGRX4444格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRA_4444 | BGRA4444格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRX_5551 | BGRX5551格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRA_5551 | BGRA5551格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRX_8888 | BGRX8888格式 | +| NATIVEBUFFER_PIXEL_FMT_BGRA_8888 | BGRA8888格式 | +| NATIVEBUFFER_PIXEL_FMT_BUTT | 无效格式 | + +**起始版本:** + +10 + + +### OH_NativeBuffer_Usage + +``` +enum OH_NativeBuffer_Usage +``` + +**描述:** + +OH_NativeBuffer的用途。 + +\@SysCap SystemCapability.Graphic.Graphic2D.NativeBuffer + +| 枚举值 | 描述 | +| -------- | -------- | +| NATIVEBUFFER_USAGE_CPU_READ | CPU可读 | +| NATIVEBUFFER_USAGE_CPU_WRITE | CPU可写 | +| NATIVEBUFFER_USAGE_MEM_DMA | 直接内存访问缓冲区 | + +**起始版本:** + +10 + ## 函数说明 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer___config.md b/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer___config.md index 73dcff7c6944290528f4ff7ba6bf4be3197dbedf..45783932327ccd5f11842c6d31354ce30cb0997a 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer___config.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___native_buffer___config.md @@ -21,9 +21,72 @@ OH_NativeBuffer的属性配置,用于申请新的OH_NativeBuffer实例或查 ### 成员变量 -| 成员变量名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| width | 宽度(像素)。 | -| height | 高度(像素)。 | -| format | 像素格式。 | -| usage | buffer的用途说明。 | +| [width](#width) | 宽度(像素)。 | +| [height](#height) | 高度(像素)。 | +| [format](#format) | 像素格式。 | +| [usage](#usage) | buffer的用途说明。 | +| [stride](#stride) | 本地窗口缓冲区步幅。 | + + +## 结构体成员变量说明 + + +### format + +``` +int32_t OH_NativeBuffer_Config::format +``` + +**描述:** + +像素格式 + + +### height + +``` +int32_t OH_NativeBuffer_Config::height +``` + +**描述:** + +高度(像素)。 + + +### stride + +``` +int32_t OH_NativeBuffer_Config::stride +``` + +**描述:** + +本地窗口缓冲区步幅。 + +**起始版本:** + +10 + + +### usage + +``` +int32_t OH_NativeBuffer_Config::usage +``` + +**描述:** + +buffer的用途说明。 + + +### width + +``` +int32_t OH_NativeBuffer_Config::width +``` + +**描述:** + +宽度(像素)。 diff --git a/zh-cn/application-dev/reference/native-apis/native__buffer_8h.md b/zh-cn/application-dev/reference/native-apis/native__buffer_8h.md index 07e37cf965ea928fa016826e10e6600621fe67e0..68f6ec4751d8e3c5bb517059fb47f927d40ec9a1 100644 --- a/zh-cn/application-dev/reference/native-apis/native__buffer_8h.md +++ b/zh-cn/application-dev/reference/native-apis/native__buffer_8h.md @@ -30,6 +30,12 @@ | -------- | -------- | | [OH_NativeBuffer](_o_h___native_buffer.md#oh_nativebuffer) | 提供OH_NativeBuffer结构体声明 | +### 枚举 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_NativeBuffer_Usage](_o_h___native_buffer.md#oh_nativebuffer_usage) { NATIVEBUFFER_USAGE_CPU_READ = (1ULL << 0), NATIVEBUFFER_USAGE_CPU_WRITE = (1ULL << 1), NATIVEBUFFER_USAGE_MEM_DMA = (1ULL << 3) } | OH_NativeBuffer的用途。 | +| [OH_NativeBuffer_Format](_o_h___native_buffer.md#oh_nativebuffer_format) {
NATIVEBUFFER_PIXEL_FMT_RGB_565 = 3, NATIVEBUFFER_PIXEL_FMT_RGBA_5658, NATIVEBUFFER_PIXEL_FMT_RGBX_4444, NATIVEBUFFER_PIXEL_FMT_RGBA_4444,
NATIVEBUFFER_PIXEL_FMT_RGB_444, NATIVEBUFFER_PIXEL_FMT_RGBX_5551, NATIVEBUFFER_PIXEL_FMT_RGBA_5551, NATIVEBUFFER_PIXEL_FMT_RGB_555,
NATIVEBUFFER_PIXEL_FMT_RGBX_8888, NATIVEBUFFER_PIXEL_FMT_RGBA_8888, NATIVEBUFFER_PIXEL_FMT_RGB_888, NATIVEBUFFER_PIXEL_FMT_BGR_565,
NATIVEBUFFER_PIXEL_FMT_BGRX_4444, NATIVEBUFFER_PIXEL_FMT_BGRA_4444, NATIVEBUFFER_PIXEL_FMT_BGRX_5551, NATIVEBUFFER_PIXEL_FMT_BGRA_5551,
NATIVEBUFFER_PIXEL_FMT_BGRX_8888, NATIVEBUFFER_PIXEL_FMT_BGRA_8888, NATIVEBUFFER_PIXEL_FMT_BUTT = 0X7FFFFFFF
} | OH_NativeBuffer的格式。 | ### 函数 diff --git a/zh-cn/application-dev/reference/native-apis/native__vsync_8h.md b/zh-cn/application-dev/reference/native-apis/native__vsync_8h.md index f127e04ce8e7028d9ce1a9d27547577d59df05c2..c1001d8bffd2d7639ca32e49b9128e6e35c6882e 100644 --- a/zh-cn/application-dev/reference/native-apis/native__vsync_8h.md +++ b/zh-cn/application-dev/reference/native-apis/native__vsync_8h.md @@ -32,3 +32,4 @@ | [OH_NativeVSync_Create](_native_vsync.md#oh_nativevsync_create) (const char \*name, unsigned int length) | 创建一个OH_NativeVSync实例,每次调用都会产生一个新的实例 | | [OH_NativeVSync_Destroy](_native_vsync.md#oh_nativevsync_destroy) (OH_NativeVSync \*nativeVsync) | 销毁OH_NativeVSync实例 | | [OH_NativeVSync_RequestFrame](_native_vsync.md#oh_nativevsync_requestframe) (OH_NativeVSync \*nativeVsync, OH_NativeVSync_FrameCallback callback, void \*data) | 请求下一次vsync信号,当信号到来时,调用回调函数callback | +| [OH_NativeVSync_GetPeriod](_native_vsync.md#oh_nativevsync_getperiod) (OH_NativeVSync \*nativeVsync, long long \*period) |获取vsync周期。| \ No newline at end of file