diff --git a/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md b/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md index 3b3a18170e3cdfb1c301174c940ff9e14b6fa7f0..079c89cb0b3abf962e8d26ec2e4577e636d0dd44 100644 --- a/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md +++ b/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md @@ -32,7 +32,7 @@ Registers the continuation management service and obtains a token. This API does **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -73,7 +73,7 @@ Registers the continuation management service and obtains a token. This API uses **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -123,7 +123,7 @@ Registers the continuation management service and obtains a token. This API uses **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -167,7 +167,7 @@ Registers the continuation management service and obtains a token. This API does **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -212,7 +212,7 @@ Registers the continuation management service and obtains a token. This API uses **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -265,7 +265,7 @@ Registers the continuation management service and obtains a token. This API uses **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -314,7 +314,7 @@ Subscribes to device connection events. This API uses an asynchronous callback t **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -353,7 +353,7 @@ Subscribes to device disconnection events. This API uses an asynchronous callbac **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -390,7 +390,7 @@ Unsubscribes from device connection events. This API uses an asynchronous callba **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -429,7 +429,7 @@ Unsubscribes from device disconnection events. This API uses an asynchronous cal **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -467,7 +467,7 @@ Subscribes to device connection events. This API uses an asynchronous callback t **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -514,7 +514,7 @@ Subscribes to device disconnection events. This API uses an asynchronous callbac **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -561,7 +561,7 @@ Unsubscribes from device connection events. **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -600,7 +600,7 @@ Unsubscribes from device disconnection events. **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -639,7 +639,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -683,7 +683,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -735,7 +735,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -781,7 +781,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -826,7 +826,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -879,7 +879,7 @@ Starts the device selection module to show the list of available devices on the **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -928,7 +928,7 @@ Instructs the device selection module to update the device connection state. Thi **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -979,7 +979,7 @@ Instructs the device selection module to update the device connection state. Thi **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1025,7 +1025,7 @@ Instructs the device selection module to update the device connection state. Thi **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1077,7 +1077,7 @@ Instructs the device selection module to update the device connection state. Thi **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1123,7 +1123,7 @@ Deregisters the continuation management service. This API uses an asynchronous c **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1168,7 +1168,7 @@ Deregisters the continuation management service. This API uses a promise to retu **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1208,7 +1208,7 @@ Deregisters the continuation management service. This API uses an asynchronous c **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | @@ -1257,7 +1257,7 @@ Deregisters the continuation management service. This API uses a promise to retu **Error codes** -For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errcode-DistributedSchedule.md). +For details about the error codes, see [Distributed Scheduler Error Codes](../errorcodes/errorcode-DistributedSchedule.md). | ID| Error Message| | ------- | -------------------------------------------- | diff --git a/en/application-dev/reference/apis/js-apis-cooperate.md b/en/application-dev/reference/apis/js-apis-cooperate.md index 96fa3ebc9ff8fadf13097fd6042339ad202f186c..0d46d9bda98672572ac415da0a5d92444d88a082 100644 --- a/en/application-dev/reference/apis/js-apis-cooperate.md +++ b/en/application-dev/reference/apis/js-apis-cooperate.md @@ -102,7 +102,7 @@ Starts screen hopping. This API uses an asynchronous callback to return the resu **Error codes** -For details about the error codes, see [Screen Hopping Error Codes](../errorcodes/errorcodes-multimodalinput.md). +For details about the error codes, see [Screen Hopping Error Codes](../errorcodes/errorcode-multimodalinput.md). | ID| Error Message| | -------- | ---------------------------------------- | @@ -150,7 +150,7 @@ Starts screen hopping. This API uses a promise to return the result. **Error codes** -For details about the error codes, see [Screen Hopping Error Codes](../errorcodes/errorcodes-multimodalinput.md). +For details about the error codes, see [Screen Hopping Error Codes](../errorcodes/errorcode-multimodalinput.md). | ID| Error Message| | -------- | ---------------------------------------- | diff --git a/en/application-dev/reference/apis/js-apis-url.md b/en/application-dev/reference/apis/js-apis-url.md index 7d9c9e068863e9466b81145849c0b8507be62efe..383dd4b3862b849db5e9292d4b841acbc8e3cc33 100755 --- a/en/application-dev/reference/apis/js-apis-url.md +++ b/en/application-dev/reference/apis/js-apis-url.md @@ -713,9 +713,11 @@ for (var value of searchParams.values()) { ### [Symbol.iterator](deprecated) + > **NOTE** > -> This API is deprecated since API version 9. You are advised to use [URLParams9+.[Symbol.iterator]9+](#symbol.iterator9) instead. +> This API is deprecated since API version 9. You are advised to use [[Symbol.iterator]9+](#symboliterator9) instead. + [Symbol.iterator]\(): IterableIterator<[string, string]> diff --git a/en/application-dev/reference/apis/js-apis-util.md b/en/application-dev/reference/apis/js-apis-util.md index 4dbed0653a8618af5c0f83628dbc412e6639f0e1..226f7686f490b2d3fd28e8263d7226eb02091c09 100755 --- a/en/application-dev/reference/apis/js-apis-util.md +++ b/en/application-dev/reference/apis/js-apis-util.md @@ -661,7 +661,7 @@ let rationalNumber = new util.RationalNumber(); rationalNumber.parseRationalNumber(1,2) ``` -### constructor8+(deprecated) +### constructor(deprecated) > **NOTE** > @@ -846,7 +846,7 @@ let rationalNumber = new util.RationalNumber(1,2); let result = util.RationalNumber.getCommonFactor(4,6); ``` -### getCommonDivisor8+(deprecated) +### getCommonDivisor(deprecated) > **NOTE** > > This API is deprecated since API version 9. You are advised to use [getCommonFactor9+](#getcommonfactor9) instead. @@ -1541,7 +1541,7 @@ pro.put(2,10); let result = pro[Symbol.iterator](); ``` -## LruBuffer8+(deprecated) +## LruBuffer(deprecated) > **NOTE** > @@ -1563,7 +1563,7 @@ let result = pro[Symbol.iterator](); let result = pro.length; ``` -### constructor8+(deprecated) +### constructor(deprecated) > **NOTE** > @@ -1586,7 +1586,7 @@ A constructor used to create a **LruBuffer** instance. The default capacity of t let lrubuffer= new util.LruBuffer(); ``` -### updateCapacity8+(deprecated) +### updateCapacity(deprecated) > **NOTE** > @@ -1610,7 +1610,7 @@ Changes the **LruBuffer** capacity. If the new capacity is less than or equal to let result = pro.updateCapacity(100); ``` -### toString8+(deprecated) +### toString(deprecated) > **NOTE** > @@ -1637,7 +1637,7 @@ Obtains the string representation of this **LruBuffer** object. let result = pro.toString(); ``` -### getCapacity8+(deprecated) +### getCapacity(deprecated) > **NOTE** > @@ -1661,7 +1661,7 @@ Obtains the capacity of this buffer. let result = pro.getCapacity(); ``` -### clear8+(deprecated) +### clear(deprecated) > **NOTE** > @@ -1681,7 +1681,7 @@ Clears key-value pairs from this buffer. The **afterRemoval()** method will be c pro.clear(); ``` -### getCreateCount8+(deprecated) +### getCreateCount(deprecated) > **NOTE** > @@ -1706,7 +1706,7 @@ Obtains the number of return values for **createDefault()**. let result = pro.getCreateCount(); ``` -### getMissCount8+(deprecated) +### getMissCount(deprecated) > **NOTE** > @@ -1732,7 +1732,7 @@ Obtains the number of times that the queried values are mismatched. let result = pro.getMissCount(); ``` -### getRemovalCount8+(deprecated) +### getRemovalCount(deprecated) > **NOTE** > @@ -1759,7 +1759,7 @@ Obtains the number of removals from this buffer. let result = pro.getRemovalCount(); ``` -### getMatchCount8+(deprecated) +### getMatchCount(deprecated) > **NOTE** > @@ -1785,7 +1785,7 @@ Obtains the number of times that the queried values are matched. let result = pro.getMatchCount(); ``` -### getPutCount8+(deprecated) +### getPutCount(deprecated) > **NOTE** > @@ -1810,7 +1810,7 @@ Obtains the number of additions to this buffer. let result = pro.getPutCount(); ``` -### isEmpty8+(deprecated) +### isEmpty(deprecated) > **NOTE** > @@ -1835,7 +1835,7 @@ Checks whether this buffer is empty. let result = pro.isEmpty(); ``` -### get8+(deprecated) +### get(deprecated) > **NOTE** > @@ -1866,7 +1866,7 @@ Obtains the value of the specified key. let result = pro.get(2); ``` -### put8+(deprecated) +### put(deprecated) > **NOTE** > @@ -1897,7 +1897,7 @@ Adds a key-value pair to this buffer. let result = pro.put(2,10); ``` -### values8+(deprecated) +### values(deprecated) > **NOTE** > @@ -1924,7 +1924,7 @@ Obtains all values in this buffer, listed from the most to the least recently ac let result = pro.values(); ``` -### keys8+(deprecated) +### keys(deprecated) > **NOTE** > @@ -1949,7 +1949,7 @@ Obtains all keys in this buffer, listed from the most to the least recently acce let result = pro.keys(); ``` -### remove8+(deprecated) +### remove(deprecated) > **NOTE** > @@ -1980,7 +1980,7 @@ Removes the specified key and its value from this buffer. let result = pro.remove(20); ``` -### afterRemoval8+(deprecated) +### afterRemoval(deprecated) > **NOTE** > @@ -2022,7 +2022,7 @@ Performs subsequent operations after a value is removed. lru.afterRemoval(false,10,30,null); ``` -### contains8+(deprecated) +### contains(deprecated) > **NOTE** > @@ -2053,7 +2053,7 @@ Checks whether this buffer contains the specified key. let result = pro.contains(20); ``` -### createDefault8+(deprecated) +### createDefault(deprecated) > **NOTE** > @@ -2083,7 +2083,7 @@ Creates a value if the value of the specified key is not available. let result = pro.createDefault(50); ``` -### entries8+(deprecated) +### entries(deprecated) > **NOTE** > @@ -2108,11 +2108,11 @@ Obtains a new iterator object that contains all key-value pairs in this object. let result = pro.entries(); ``` -### [Symbol.iterator]8+(deprecated) +### [Symbol.iterator](deprecated) > **NOTE** > -> This API is deprecated since API version 9. You are advised to use [Symbol.iterator9+](#symboliterator9) instead. +> This API is deprecated since API version 9. You are advised to use [Symbol.iterator9+](#symboliterator9) instead. [Symbol.iterator]\(): IterableIterator<[K, V]> @@ -2524,13 +2524,13 @@ let range = new util.ScopeHelper(tempLower, tempUpper); let result = range.clamp(tempMiDF); ``` -## Scope8+(deprecated) +## Scope(deprecated) > **NOTE** > > This class is deprecated since API version 9. You are advised to use [ScopeHelper9+](#scopehelper9) instead. -### constructor8+(deprecated) +### constructor(deprecated) > **NOTE** > @@ -2556,7 +2556,7 @@ A constructor used to create a **Scope** object with the specified upper and low let range = new util.Scope(tempLower, tempUpper); ``` -### toString8+(deprecated) +### toString(deprecated) > **NOTE** > @@ -2582,7 +2582,7 @@ Obtains a string representation that contains this **Scope**. let result = range.toString(); ``` -### intersect8+(deprecated) +### intersect(deprecated) > **NOTE** > @@ -2598,13 +2598,13 @@ Obtains the intersection of this **Scope** and the given **Scope**. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| +| range | [Scope](#scopedeprecated) | Yes| **Scope** specified.| **Return value** | Type| Description| | -------- | -------- | -| [Scope](#scope8) | Intersection of this **Scope** and the given **Scope**.| +| [Scope](#scopedeprecated) | Intersection of this **Scope** and the given **Scope**.| **Example** @@ -2618,7 +2618,7 @@ Obtains the intersection of this **Scope** and the given **Scope**. range.intersect(rangeFir ); ``` -### intersect8+(deprecated) +### intersect(deprecated) > **NOTE** > @@ -2641,7 +2641,7 @@ Obtains the intersection of this **Scope** and the given lower and upper limits. | Type| Description| | -------- | -------- | -| [Scope](#scope8) | Intersection of this **Scope** and the given lower and upper limits.| +| [Scope](#scopedeprecated) | Intersection of this **Scope** and the given lower and upper limits.| **Example** ```js @@ -2653,7 +2653,7 @@ Obtains the intersection of this **Scope** and the given lower and upper limits. let result = range.intersect(tempMiDF, tempMidS); ``` -### getUpper8+(deprecated) +### getUpper(deprecated) > **NOTE** > @@ -2679,7 +2679,7 @@ Obtains the upper limit of this **Scope**. let result = range.getUpper(); ``` -### getLower8+(deprecated) +### getLower(deprecated) > **NOTE** > @@ -2705,7 +2705,7 @@ Obtains the lower limit of this **Scope**. let result = range.getLower(); ``` -### expand8+(deprecated) +### expand(deprecated) > **NOTE** > @@ -2728,7 +2728,7 @@ Obtains the union set of this **Scope** and the given lower and upper limits. | Type| Description| | -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given lower and upper limits.| +| [Scope](#scopedeprecated) | Union set of this **Scope** and the given lower and upper limits.| **Example** @@ -2741,7 +2741,7 @@ Obtains the union set of this **Scope** and the given lower and upper limits. let result = range.expand(tempMiDF, tempMidS); ``` -### expand8+(deprecated) +### expand(deprecated) > **NOTE** > @@ -2757,13 +2757,13 @@ Obtains the union set of this **Scope** and the given **Scope**. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| +| range | [Scope](#scopedeprecated) | Yes| **Scope** specified.| **Return value** | Type| Description| | -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given **Scope**.| +| [Scope](#scopedeprecated) | Union set of this **Scope** and the given **Scope**.| **Example** ```js @@ -2776,7 +2776,7 @@ Obtains the union set of this **Scope** and the given **Scope**. let result = range.expand(rangeFir); ``` -### expand8+(deprecated) +### expand(deprecated) > **NOTE** > @@ -2798,7 +2798,7 @@ Obtains the union set of this **Scope** and the given value. | Type| Description| | -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given value.| +| [Scope](#scopedeprecated) | Union set of this **Scope** and the given value.| **Example** ```js @@ -2809,7 +2809,7 @@ Obtains the union set of this **Scope** and the given value. let result = range.expand(tempMiDF); ``` -### contains8+(deprecated) +### contains(deprecated) > **NOTE** > @@ -2842,7 +2842,7 @@ Checks whether a value is within this **Scope**. range.contains(tempMiDF); ``` -### contains8+(deprecated) +### contains(deprecated) > **NOTE** > @@ -2858,7 +2858,7 @@ Checks whether a range is within this **Scope**. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| +| range | [Scope](#scopedeprecated) | Yes| **Scope** specified.| **Return value** @@ -2878,7 +2878,7 @@ Checks whether a range is within this **Scope**. let result = range.contains(rangeSec); ``` -### clamp8+(deprecated) +### clamp(deprecated) > **NOTE** > @@ -3113,13 +3113,13 @@ that.decode(array).then(val=>{ ``` -## Base648+(deprecated) +## Base64(deprecated) > **NOTE** > > This class is deprecated since API version 9. You are advised to use [Base64Helper9+](#base64helper9) instead. -### constructor8+(deprecated) +### constructor(deprecated) > **NOTE** > @@ -3136,7 +3136,7 @@ A constructor used to create a **Base64** object. let base64 = new util.Base64(); ``` -### encodeSync8+(deprecated) +### encodeSync(deprecated) > **NOTE** > @@ -3168,7 +3168,7 @@ Encodes the input content. let result = that.encodeSync(array); ``` -### encodeToStringSync8+(deprecated) +### encodeToStringSync(deprecated) > **NOTE** > @@ -3199,7 +3199,7 @@ Encodes the input content. let result = that.encodeToStringSync(array); ``` -### decodeSync8+(deprecated) +### decodeSync(deprecated) > **NOTE** > @@ -3230,7 +3230,7 @@ Decodes the input content. let result = that.decodeSync(buff); ``` -### encode8+(deprecated) +### encode(deprecated) > **NOTE** > @@ -3266,7 +3266,7 @@ Encodes the input content asynchronously. }) ``` -### encodeToString8+(deprecated) +### encodeToString(deprecated) > **NOTE** > @@ -3299,7 +3299,7 @@ Encodes the input content asynchronously. }) ``` -### decode8+(deprecated) +### decode(deprecated) > **NOTE** > diff --git a/en/application-dev/reference/arkui-js/js-components-svg.md b/en/application-dev/reference/arkui-js/js-components-svg.md index 5211d35eb04004f778dfeb151b70f1fe17fefe04..f5045ded91f30f684a19476f2afa512aa23d35ab 100644 --- a/en/application-dev/reference/arkui-js/js-components-svg.md +++ b/en/application-dev/reference/arkui-js/js-components-svg.md @@ -4,9 +4,9 @@ The **\** component is a basic container. It can be used as the root node o > **NOTE** -> - This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version. -> -> - The width and height must be defined for the **\** parent component or **\** component. Otherwise, the component is not drawn. +> - This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version. +> +> - The width and height must be defined for the **\** parent component or **\** component. Otherwise, the component is not drawn. ## Required Permissions @@ -15,21 +15,21 @@ None ## Child Components -The following are supported: [\](js-components-svg.md), [\](js-components-svg-rect.md), [\](js-components-svg-circle.md), [\](../arkui-js/js-components-svg-ellipse.md), [\](js-components-svg-path.md), [\](../arkui-js/js-components-svg-polygon.md), [\](js-components-svg-polyline.md), [\](js-components-svg-text.md), [\](js-components-svg-animate.md), and [\](js-components-svg-animateTransform.md). +The following are supported: [\](js-components-svg.md), [\](js-components-svg-rect.md), [\](js-components-svg-circle.md), [\](../arkui-js/js-components-svg-ellipse.md), [\](js-components-svg-path.md), [\](../arkui-js/js-components-svg-polygon.md), [\](js-components-svg-polyline.md), [\](js-components-svg-text.md), [\](js-components-svg-animate.md), and [\](js-components-svg-animatetransform.md). ## Attributes The [universal attributes](../arkui-js/js-components-svg-common-attributes.md) and the attributes listed below are supported. The configured universal attributes are passed to the child components. -| Name| Type| Default Value| Mandatory| Description| -| -------- | -------- | -------- | -------- | -------- | -| id | string | - | No| Unique ID of the component.| -| width | <length>\|<percentage> | - | No| Component width.| -| height | <length>\|<percentage> | - | No| Component height.| -| x | <length>\|<percentage> | - | No| X-coordinate of the current **\** component. The settings do not work for the root **\** node. | -| y | <length>\|<percentage> | | No| Y-coordinate of the current **\** component. The settings do not work for the root **\** node. | -| viewBox | string | - | No| View box of the current **\** component. The supported format is \. The four parameters indicate **min-x**, **min-y**, **width**, and **height**, respectively. The width and height of the view box are different from those of the **\** component. The view box is scaled in center-aligned mode. | +| Name | Type | Default Value | Mandatory | Description | +| ------- | ---------------------------------- | ------------- | --------- | ---------------------------------------- | +| id | string | - | No | Unique ID of the component. | +| width | <length>\|<percentage> | - | No | Component width. | +| height | <length>\|<percentage> | - | No | Component height. | +| x | <length>\|<percentage> | - | No | X-coordinate of the current **\** component. The settings do not work for the root **\** node. | +| y | <length>\|<percentage> | | No | Y-coordinate of the current **\** component. The settings do not work for the root **\** node. | +| viewBox | string | - | No | View box of the current **\** component. The supported format is \. The four parameters indicate **min-x**, **min-y**, **width**, and **height**, respectively. The width and height of the view box are different from those of the **\** component. The view box is scaled in center-aligned mode. | ## Example diff --git a/zh-cn/application-dev/application-models/Readme-CN.md b/zh-cn/application-dev/application-models/Readme-CN.md index 822394ac65279cfde1949bf5198f397a685de4bc..161ea7785a99824ee82721f55ab88df125096d95 100644 --- a/zh-cn/application-dev/application-models/Readme-CN.md +++ b/zh-cn/application-dev/application-models/Readme-CN.md @@ -28,7 +28,7 @@ - [使用显式Want启动Ability](ability-startup-with-explicit-want.md) - [使用隐式Want打开网址](ability-startup-with-implicit-want.md) - [应用间使用Want分享数据](data-share-via-want.md) - - [组件启动规则](component-startup-rules.md) + - [组件启动规则（Stage模型）](component-startup-rules.md) - 应用组件跨设备交互（流转） - [流转概述](inter-device-interaction-hop-overview.md) - [跨端迁移（仅对系统应用开放）](hop-cross-device-migration.md) @@ -84,6 +84,7 @@ - [服务卡片开发指导](widget-development-fa.md) - [FA模型的Context](application-context-fa.md) - [信息传递载体Want](want-fa.md) + - [组件启动规则（FA模型）](component-startup-rules-fa.md) - 进程间通信 - [进程模型](process-model-fa.md) - [公共事件](common-event-fa.md) diff --git a/zh-cn/application-dev/application-models/component-startup-rules-fa.md b/zh-cn/application-dev/application-models/component-startup-rules-fa.md new file mode 100644 index 0000000000000000000000000000000000000000..825dffece76a429fea1591616f4b8c8b6083d7ed --- /dev/null +++ b/zh-cn/application-dev/application-models/component-startup-rules-fa.md @@ -0,0 +1,68 @@ +# 组件启动规则（FA模型） + + +启动组件是指一切启动或连接应用组件的行为： + + +- 启动PageAbility、ServiceAbility，如使用startAbility()等相关接口。 + +- 连接ServiceAbility、DataAbility，如使用connectAbility()、acquireDataAbilityHelper()等相关接口。 + + +在OpenHarmony中，为了保证用户具有更好的使用体验，对以下几种易影响用户体验与系统安全的行为做了限制： + + +- 后台应用任意弹框，如各种广告弹窗，影响用户使用。 + +- 后台应用相互唤醒，不合理的占用系统资源，导致系统功耗增加或系统卡顿。 + +- 前台应用任意跳转至其他应用，如随意跳转到其他应用的支付页面，存在安全风险。 + + +鉴于此，OpenHarmony制订了一套组件启动规则，主要包括： + + +- **跨应用启动组件，需校验目标组件Visible** + - 只针对跨应用场景 + - 若目标组件visible字段配置为false，则需校验`ohos.permission.START_INVISIBLE_ABILITY`权限 + - [组件visible配置参考](../quick-start/module-configuration-file.md#abilities标签) + +- **位于后台的应用，启动组件需校验BACKGROUND权限** + - 应用前后台判断标准：若应用进程获焦或所属的UIAbility位于前台则判定为前台应用，否则为后台应用 + - 需校验`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + +- **跨应用启动FA模型的ServiceAbility组件或DataAbility组件，对端应用需配置关联启动** + - 只针对跨应用场景 + - 只针对目标组件为ServiceAbility与DataAbility生效 + - 目标应用的AssociateWakeUp为**ture**，其提供的ServiceAbility与DataAbility才允许被其他应用访问 + - 只有系统预置应用才允许配置AssociateWakeUp字段，其余应用AssociateWakeUp默认为**false** + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 1. 组件启动管控自OpenHarmony v3.2 Release版本开始落地。 +> +> 2. 与原本的启动规则不同，新的组件启动规则较为严格，开发者需熟知启动规则，避免业务功能异常。 + +启动组件的具体校验流程见下文。 + + +## 同设备组件启动规则 + + 设备内启动组件，不同场景下的规则不同，可分为如下两种场景： + +- 启动PageAbility。 + +- 启动ServiceAbility或DataAbility。 + +![startup-rule](figures/component-startup-inner-fa.png) + + +## 分布式跨设备组件启动规则 + + 跨设备启动组件，不同场景下的规则不同，可分为如下两种场景： + +- 启动PageAbility。 + +- 启动ServiceAbility。 + +![component-startup-rules](figures/component-startup-inter-fa.png) diff --git a/zh-cn/application-dev/application-models/component-startup-rules.md b/zh-cn/application-dev/application-models/component-startup-rules.md index 0db14d77922b96d3eb9387fd65e5bbf323f96967..0994ebeec37440350e42c02685520d4394e0de03 100644 --- a/zh-cn/application-dev/application-models/component-startup-rules.md +++ b/zh-cn/application-dev/application-models/component-startup-rules.md @@ -1,12 +1,12 @@ -# 组件启动规则 +# 组件启动规则（Stage模型） -启动组件是指一切启动或连接Ability的行为： +启动组件是指一切启动或连接应用组件的行为： -- 启动Ability，如使用startAbility()、startServiceExtensionAbility()、startAbilityByCall()等相关接口。 +- 启动UIAbility、ServiceExtensionAbility、DataShareExtensionAbility，如使用startAbility()、startServiceExtensionAbility()、startAbilityByCall()等相关接口。 -- 连接Ability，如使用connectAbility()、connectServiceExtensionAbility()、acquireDataAbilityHelper()、createDataShareHelper()等相关接口。 +- 连接ServiceExtensionAbility、DataShareExtensionAbility，如使用connectServiceExtensionAbility()、createDataShareHelper()等相关接口。 在OpenHarmony中，为了保证用户具有更好的使用体验，对以下几种易影响用户体验与系统安全的行为做了限制： @@ -16,19 +16,22 @@ - 后台应用相互唤醒，不合理的占用系统资源，导致系统功耗增加或系统卡顿。 -- 前台应用任意跳转至其他应用，如随意跳转到其他应用的支付Ability，存在安全风险。 +- 前台应用任意跳转至其他应用，如随意跳转到其他应用的支付页面，存在安全风险。 鉴于此，OpenHarmony制订了一套组件启动规则，主要包括： -- 应用位于后台时，启动组件需鉴权。 +- **跨应用启动组件，需校验目标组件Visible** + - 若目标组件visible字段配置为false，则需校验`ohos.permission.START_INVISIBLE_ABILITY`权限 + - [组件visible配置参考](../quick-start/module-configuration-file.md#abilities标签) -- 跨应用启动visible为false的组件，需鉴权。 +- **位于后台的应用，启动组件需校验BACKGROUND权限** + - 应用前后台判断标准：若应用进程获焦或所属的UIAbility位于前台则判定为前台应用，否则为后台应用 + - 需校验`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 -- 跨应用启动FA模型的ServiceAbility组件或DataAbility组件，对端应用需配置关联启动。 - -- 使用startAbilityByCall接口，需鉴权（使用方式参考：[Call调用开发指南](hop-multi-device-collaboration.md#通过跨设备call调用实现多端协同)） +- **使用startAbilityByCall接口，需校验CALL权限**（使用方式参考：[Call调用开发指南（同设备）](uiability-intra-device-interaction.md#通过call调用实现uiability交互仅对系统应用开放)，[Call调用开发指南（跨设备）](hop-multi-device-collaboration.md#通过跨设备call调用实现多端协同)） + - 需校验`ohos.permission.ABILITY_BACKGROUND_COMMUNICATION`权限 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** @@ -36,87 +39,26 @@ > > 2. 与原本的启动规则不同，新的组件启动规则较为严格，开发者需熟知启动规则，避免业务功能异常。 - -## 相关概念说明 - -为方便开发者理解管控规则，此处对所涉及的相关概念进行解释。 - -- **应用APL(Ability Privilege Level)**，表示应用的权限申请优先级的定义，不同APL等级的应用所能申请的权限不同，APL分为3个等级： - - 操作系统核心能力APL="system_core" (APL = 3) - - 系统基础服务APL="system_basic" (APL = 2) - - 三方应用程序APL="normal" (APL = 1) - - **注：三方应用默认都是APL="normal"** - -- **BACKGROUND校验** - - 对发起端应用进程的状态进行判断，若应用进程获焦或所属的Ability位于前台则判定为前台应用，否则为后台应用 - - 若发起端为后台应用，则需校验START_ABILITIES_FROM_BACKGROUND权限 - -- **VISIBLE校验** - - 只针对跨应用启动的场景 - - 若目标组件visible配置为false，则需校验START_INVISIBLE_ABILITY权限 - -- **CALL校验** - - 只针对startAbilityByCall接口 - - 需校验ABILITY_BACKGROUND_COMMUNICATION权限 - -- **关联启动(AssociateWakeUp)** - - 只有系统预置应用才允许配置AssociateWakeUp字段，其余应用AssociateWakeUp默认为**false** - - 只针对跨应用场景 - - 只针对目标组件为**FA**模型的**ServiceAbility**与**DataAbility**生效 - - 目标应用的AssociateWakeUp为**ture**，其提供的ServiceAbility与DataAbility才允许被其他应用访问 - -- **相关权限** - - ```json - { - "name": "ohos.permission.START_ABILITIES_FROM_BACKGROUND", - "grantMode": "system_grant", - "availableLevel": "system_basic", // APL等级至少为system_basic才可申请 - "since": 9, - "deprecated": "", - "provisionEnable": true, // 支持ACL方式申请权限 - "distributedSceneEnable": false - }, - { - "name": "ohos.permission.START_INVISIBLE_ABILITY", - "grantMode": "system_grant", - "availableLevel": "system_core", // APL等级至少为system_core才可申请 - "since": 9, - "deprecated": "", - "provisionEnable": true, // 支持ACL方式申请权限 - "distributedSceneEnable": false - }, - { - "name": "ohos.permission.ABILITY_BACKGROUND_COMMUNICATION", - "grantMode": "system_grant", - "availableLevel": "system_basic", // APL等级至少为system_basic才可申请 - "since": 9, - "deprecated": "", - "provisionEnable": true, // 支持ACL方式申请权限 - "distributedSceneEnable": false - } - ``` +启动组件的具体校验流程见下文。 -## 同设备组件启动管控 +## 同设备组件启动规则 - 不同场景下的管控规则不同，可分为如下三种场景： -- 启动一般组件：（FA模型）PageAbility，（Stage模型）UIAbility、ServiceExtensionAbility、DataShareExtensionAbility。 + 设备内启动组件，不同场景下的规则不同，可分为如下两种场景： -- 启动FA模型的ServiceAbility或DataAbility。 +- 启动或连接组件：UIAbility、ServiceExtensionAbility、DataShareExtensionAbility。 -- 通过startAbilityByCall接口启动（Stage模型）UIAbility。 +- 通过startAbilityByCall接口启动UIAbility。 -![startup-rule](figures/startup-rule.png) +![startup-rule](figures/component-startup-inner-stage.png) -## 分布式跨设备组件启动管控 +## 分布式跨设备组件启动规则 - 不同场景下的管控规则不同，可分为如下三种场景： -- 启动一般组件：（FA模型）PageAbility，（Stage模型）UIAbility、ServiceExtensionAbility。 + 跨设备启动组件，不同场景下的规则不同，可分为如下两种场景： -- 启动FA模型的ServiceAbility。 +- 启动或连接组件：UIAbility、ServiceExtensionAbility、DataShareExtensionAbility。 -- 通过startAbilityByCall接口启动（Stage模型）UIAbility。 +- 通过startAbilityByCall接口启动UIAbility。 -![component-startup-rules](figures/component-startup-rules.jpg) +![component-startup-rules](figures/component-startup-inter-stage.png) diff --git a/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle-WindowStage.png b/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle-WindowStage.png index aa7205eb6d14fb97d7112043bd58bfd4dc9efd51..2c1a3d5f1171dc6a52f533a12980cfffd762562e 100644 Binary files a/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle-WindowStage.png and b/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle-WindowStage.png differ diff --git a/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle.png b/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle.png index cb58cd28debfcdc748e30f29f1b4ae50f44e08e5..1be3960c4af6a7cd3d81be6ac0cde0a6f3fc6eed 100644 Binary files a/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle.png and b/zh-cn/application-dev/application-models/figures/Ability-Life-Cycle.png differ diff --git a/zh-cn/application-dev/application-models/figures/ExtensionAbility-start.png b/zh-cn/application-dev/application-models/figures/ExtensionAbility-start.png index 937f8c8c56c9c590024ef2e10df8dae0c9a435b3..9cc8c65bd24e24ffce61971ee9f62ac524a94d25 100644 Binary files a/zh-cn/application-dev/application-models/figures/ExtensionAbility-start.png and b/zh-cn/application-dev/application-models/figures/ExtensionAbility-start.png differ diff --git a/zh-cn/application-dev/application-models/figures/FAvsStage-uri.png b/zh-cn/application-dev/application-models/figures/FAvsStage-uri.png index b1dc73561994590d55768418318f9139d09961d5..132c1ba0f09f7da7344d6edcfae3c59fe355e7f9 100644 Binary files a/zh-cn/application-dev/application-models/figures/FAvsStage-uri.png and b/zh-cn/application-dev/application-models/figures/FAvsStage-uri.png differ diff --git a/zh-cn/application-dev/application-models/figures/ServiceExtensionAbility-lifecycle.png b/zh-cn/application-dev/application-models/figures/ServiceExtensionAbility-lifecycle.png index 213c8450223031bf4ff24e9e0b475eb44db907c8..f9dd2e7bceabf685e7e0ed66f63b73036b06ea19 100644 Binary files a/zh-cn/application-dev/application-models/figures/ServiceExtensionAbility-lifecycle.png and b/zh-cn/application-dev/application-models/figures/ServiceExtensionAbility-lifecycle.png differ diff --git a/zh-cn/application-dev/application-models/figures/application-component-configuration-stage.png b/zh-cn/application-dev/application-models/figures/application-component-configuration-stage.png index a32fd245c5436bc2a5fabed06214c8b052304ec9..a813bf83b044dba0d271a3902d06325e2ec58822 100644 Binary files a/zh-cn/application-dev/application-models/figures/application-component-configuration-stage.png and b/zh-cn/application-dev/application-models/figures/application-component-configuration-stage.png differ diff --git a/zh-cn/application-dev/application-models/figures/call.png b/zh-cn/application-dev/application-models/figures/call.png index 5aaf0fa4b2418926965dd92d9892d88326e263e2..12e735b868d94ca750f2fb1a0677af9dcd130bd4 100644 Binary files a/zh-cn/application-dev/application-models/figures/call.png and b/zh-cn/application-dev/application-models/figures/call.png differ diff --git a/zh-cn/application-dev/application-models/figures/coexistence-of-FAandStage.png b/zh-cn/application-dev/application-models/figures/coexistence-of-FAandStage.png index 63c7f650e783512bbef765cf51f54909b7564c7f..d1d44408ae49e9dd24fc8517bc5d4ded591893ca 100644 Binary files a/zh-cn/application-dev/application-models/figures/coexistence-of-FAandStage.png and b/zh-cn/application-dev/application-models/figures/coexistence-of-FAandStage.png differ diff --git a/zh-cn/application-dev/application-models/figures/common-event.png b/zh-cn/application-dev/application-models/figures/common-event.png index b4633c2fe1fc555768ae5395d5ecb0b15d8065ca..bcc0cc15ff9d6ed4d9c70531de473bc619af41a9 100644 Binary files a/zh-cn/application-dev/application-models/figures/common-event.png and b/zh-cn/application-dev/application-models/figures/common-event.png differ diff --git a/zh-cn/application-dev/application-models/figures/comparison-of-configuration-file.png b/zh-cn/application-dev/application-models/figures/comparison-of-configuration-file.png index e5cdbf9a6bbe683c67cf981a99ca726571554ff3..d92b5281e3787e8248ed1976dd8dee6be4c74d8a 100644 Binary files a/zh-cn/application-dev/application-models/figures/comparison-of-configuration-file.png and b/zh-cn/application-dev/application-models/figures/comparison-of-configuration-file.png differ diff --git a/zh-cn/application-dev/application-models/figures/component-startup-inner-fa.png b/zh-cn/application-dev/application-models/figures/component-startup-inner-fa.png new file mode 100644 index 0000000000000000000000000000000000000000..aa2a376e76886e5c9ec2ba67c1d3186ba35c1307 Binary files /dev/null and b/zh-cn/application-dev/application-models/figures/component-startup-inner-fa.png differ diff --git a/zh-cn/application-dev/application-models/figures/component-startup-inner-stage.png b/zh-cn/application-dev/application-models/figures/component-startup-inner-stage.png new file mode 100644 index 0000000000000000000000000000000000000000..756f26e8bf8812142c26c593ce46c3ac1bc2235e Binary files /dev/null and b/zh-cn/application-dev/application-models/figures/component-startup-inner-stage.png differ diff --git a/zh-cn/application-dev/application-models/figures/component-startup-inter-fa.png b/zh-cn/application-dev/application-models/figures/component-startup-inter-fa.png new file mode 100644 index 0000000000000000000000000000000000000000..1438dc856d0ee4b18ba755c1f46564e36f8c6c55 Binary files /dev/null and b/zh-cn/application-dev/application-models/figures/component-startup-inter-fa.png differ diff --git a/zh-cn/application-dev/application-models/figures/component-startup-inter-stage.png b/zh-cn/application-dev/application-models/figures/component-startup-inter-stage.png new file mode 100644 index 0000000000000000000000000000000000000000..09693c02ecb985ab7347d2a10d7602acb67738c4 Binary files /dev/null and b/zh-cn/application-dev/application-models/figures/component-startup-inter-stage.png differ diff --git a/zh-cn/application-dev/application-models/figures/component-startup-rules.jpg b/zh-cn/application-dev/application-models/figures/component-startup-rules.jpg deleted file mode 100644 index e943f43a9309ca587c7aa7efc6441c24ca644f2c..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/application-models/figures/component-startup-rules.jpg and /dev/null differ diff --git a/zh-cn/application-dev/application-models/figures/globalThis1.png b/zh-cn/application-dev/application-models/figures/globalThis1.png index f07ca70189c14f88771062f05410a267e87bee8c..33a87fbb8a211b7e190414f825b2d5be46ebeb4b 100644 Binary files a/zh-cn/application-dev/application-models/figures/globalThis1.png and b/zh-cn/application-dev/application-models/figures/globalThis1.png differ diff --git a/zh-cn/application-dev/application-models/figures/globalThis2.png b/zh-cn/application-dev/application-models/figures/globalThis2.png index e71888954018a5b8d18b5a7155f9ddddd0c61257..86a2356a73619491ce73cdaf8f6b27dfdc918958 100644 Binary files a/zh-cn/application-dev/application-models/figures/globalThis2.png and b/zh-cn/application-dev/application-models/figures/globalThis2.png differ diff --git a/zh-cn/application-dev/application-models/figures/hop-cross-device-migration.png b/zh-cn/application-dev/application-models/figures/hop-cross-device-migration.png index b61132afd70765bb41d7215a93ff4d76c483b0cc..6c5c343855af5e4c5d8473d7df26869468c19a0a 100644 Binary files a/zh-cn/application-dev/application-models/figures/hop-cross-device-migration.png and b/zh-cn/application-dev/application-models/figures/hop-cross-device-migration.png differ diff --git a/zh-cn/application-dev/application-models/figures/hop-multi-device-collaboration.png b/zh-cn/application-dev/application-models/figures/hop-multi-device-collaboration.png index fe734939b399f4f1ef7d2d9b56a378dc3ef4bfb6..1d12bdff36d293c06746f52de864f0666f818e39 100644 Binary files a/zh-cn/application-dev/application-models/figures/hop-multi-device-collaboration.png and b/zh-cn/application-dev/application-models/figures/hop-multi-device-collaboration.png differ diff --git a/zh-cn/application-dev/application-models/figures/hop-structure.png b/zh-cn/application-dev/application-models/figures/hop-structure.png index ef21dfc6f18eefa0c265b1ae0d222ee3a8a40e82..8d902c7ba88196a870b65b71d155efc368504a3d 100644 Binary files a/zh-cn/application-dev/application-models/figures/hop-structure.png and b/zh-cn/application-dev/application-models/figures/hop-structure.png differ diff --git a/zh-cn/application-dev/application-models/figures/multi-process.png b/zh-cn/application-dev/application-models/figures/multi-process.png index 7ebf826cb558f040c906a2d0e36ebd5bd298d82c..4d4b2c6ad2058a2cc05a6bffb9c4e2e042deda19 100644 Binary files a/zh-cn/application-dev/application-models/figures/multi-process.png and b/zh-cn/application-dev/application-models/figures/multi-process.png differ diff --git a/zh-cn/application-dev/application-models/figures/process-model.png b/zh-cn/application-dev/application-models/figures/process-model.png index b0e7bb1bc3706a4919cc662403a06c5814088a96..74979c6da1e7f99909f5edeb446c1cb91f312821 100644 Binary files a/zh-cn/application-dev/application-models/figures/process-model.png and b/zh-cn/application-dev/application-models/figures/process-model.png differ diff --git a/zh-cn/application-dev/application-models/figures/stage-concepts.png b/zh-cn/application-dev/application-models/figures/stage-concepts.png index a8ad9b72c065496aaa072c96b6da6b2242222b6a..af9525dfb45d8763aad3c515008d9b5eed10a3d5 100644 Binary files a/zh-cn/application-dev/application-models/figures/stage-concepts.png and b/zh-cn/application-dev/application-models/figures/stage-concepts.png differ diff --git a/zh-cn/application-dev/application-models/figures/stage-want1.png b/zh-cn/application-dev/application-models/figures/stage-want1.png index 460cb8eeb2bd9bdd7481729c608ebe048c34a6d0..f66eab8faee885eb07bc1a507490adc565913d56 100644 Binary files a/zh-cn/application-dev/application-models/figures/stage-want1.png and b/zh-cn/application-dev/application-models/figures/stage-want1.png differ diff --git a/zh-cn/application-dev/application-models/figures/stage-want2.png b/zh-cn/application-dev/application-models/figures/stage-want2.png index 691857aeac4140f6e12d4d34506edb46ea91b0ef..f431479bef0e5352535d9846c151ebc503dbf461 100644 Binary files a/zh-cn/application-dev/application-models/figures/stage-want2.png and b/zh-cn/application-dev/application-models/figures/stage-want2.png differ diff --git a/zh-cn/application-dev/application-models/figures/standard-mode.png b/zh-cn/application-dev/application-models/figures/standard-mode.png index 9ce470f8fd5a0ef6df1ca160e64c9a1277134a40..f392471c0361cbf04e531b12403b7b00d773bef5 100644 Binary files a/zh-cn/application-dev/application-models/figures/standard-mode.png and b/zh-cn/application-dev/application-models/figures/standard-mode.png differ diff --git a/zh-cn/application-dev/application-models/figures/startup-rule.png b/zh-cn/application-dev/application-models/figures/startup-rule.png deleted file mode 100644 index a8a48bb691fb5ddfa717a62cc6be4a41572a4f8e..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/application-models/figures/startup-rule.png and /dev/null differ diff --git a/zh-cn/application-dev/application-models/figures/thread-model-stage.png b/zh-cn/application-dev/application-models/figures/thread-model-stage.png index 0448f36d5aee69c41dfadcf2ec9dfe879045c43d..e4f42a4d246c6e57a345ff5739c298608f8cd6d3 100644 Binary files a/zh-cn/application-dev/application-models/figures/thread-model-stage.png and b/zh-cn/application-dev/application-models/figures/thread-model-stage.png differ diff --git a/zh-cn/application-dev/application-models/figures/uiability-launch-type1.png b/zh-cn/application-dev/application-models/figures/uiability-launch-type1.png index 14f60d1f3714bd5c4d6428df3c5e4fa68c35d3c2..f282915d8c5be11fdc8ce07fb0f42b0d8c562a8c 100644 Binary files a/zh-cn/application-dev/application-models/figures/uiability-launch-type1.png and b/zh-cn/application-dev/application-models/figures/uiability-launch-type1.png differ diff --git a/zh-cn/application-dev/application-models/figures/uiability_not_first_started.png b/zh-cn/application-dev/application-models/figures/uiability_not_first_started.png new file mode 100644 index 0000000000000000000000000000000000000000..58fca49e517144264a58951cb8e165613a507cf0 Binary files /dev/null and b/zh-cn/application-dev/application-models/figures/uiability_not_first_started.png differ diff --git a/zh-cn/application-dev/application-models/figures/usage-of-want.png b/zh-cn/application-dev/application-models/figures/usage-of-want.png index 06a02bef9fbe4708caf5b05a37898027226928ec..53199efc47422294ba22104a965f8f494b98fe75 100644 Binary files a/zh-cn/application-dev/application-models/figures/usage-of-want.png and b/zh-cn/application-dev/application-models/figures/usage-of-want.png differ diff --git a/zh-cn/application-dev/application-models/figures/want-action.png b/zh-cn/application-dev/application-models/figures/want-action.png index ed61723af3f1ec31aaf84ef1764bb75bb2c4c81a..1bc30791a3ec5d5564bf293b632d52ef5d4b7671 100644 Binary files a/zh-cn/application-dev/application-models/figures/want-action.png and b/zh-cn/application-dev/application-models/figures/want-action.png differ diff --git a/zh-cn/application-dev/application-models/figures/want-entities.png b/zh-cn/application-dev/application-models/figures/want-entities.png index 41636212601bfbdb974bf50c689ea68d7c436290..1ea74c5252ced5bd92c62f95a505fe85eba77285 100644 Binary files a/zh-cn/application-dev/application-models/figures/want-entities.png and b/zh-cn/application-dev/application-models/figures/want-entities.png differ diff --git a/zh-cn/application-dev/application-models/figures/want-uri-type1.png b/zh-cn/application-dev/application-models/figures/want-uri-type1.png index e07e616c33d0722392a1da6051cdf87f8f11b135..6dd4117fb44fb8010e4fdbffff5739634680bcd7 100644 Binary files a/zh-cn/application-dev/application-models/figures/want-uri-type1.png and b/zh-cn/application-dev/application-models/figures/want-uri-type1.png differ diff --git a/zh-cn/application-dev/application-models/figures/want-uri-type2.png b/zh-cn/application-dev/application-models/figures/want-uri-type2.png index 5510dcaca06ac7049492f30cb62135367ae2d72d..7d8e900267f2e0f3d3782d22f0d22411f8410e16 100644 Binary files a/zh-cn/application-dev/application-models/figures/want-uri-type2.png and b/zh-cn/application-dev/application-models/figures/want-uri-type2.png differ diff --git a/zh-cn/application-dev/application-models/module-switch.md b/zh-cn/application-dev/application-models/module-switch.md index 013d422607d4f745d7523fbd762f77b599be9a34..cb69887ed939ac068c084fe33fc85a4002f68f86 100644 --- a/zh-cn/application-dev/application-models/module-switch.md +++ b/zh-cn/application-dev/application-models/module-switch.md @@ -15,8 +15,8 @@ | distro对象中的moduleType | 标识当前HAP的类型，包括两种类型：entry和feature。另外，如果表示HAR包类型，请设置为har | type | 标签变更。 | | distro对象中的installationFree | 标识当前HAP是否支持免安装特性 | installationFree | 标签变更。 | | distro对象中的deliveryWithInstall | 标识当前HAP是否支持随应用安装 | deliveryWithInstall | 标签变更。 | -| metaData | 标识HAP的元信息 | metadata | 具体差异如[表2](#表2 FA模型metaData和Stage中metadata对比)。 | -| abilities | 标识当前模块内的所有Ability | abilities | 具体差异如[表5](#表5 FA模型和Stage中abilities差异对比)。 | +| metaData | 标识HAP的元信息 | metadata | 具体差异如[表2](#表2-fa模型metadata和stage中metadata对比)。 | +| abilities | 标识当前模块内的所有Ability | abilities | 具体差异如[表5](#表5-fa模型和stage中abilities差异对比)。 | | js | 标识基于ArkUI框架开发的JS模块集合，其中的每个元素代表一个JS模块的信息 | pages | Stage模型在module标签下保留该对象中的pages，window配置与pages的下一级。 | | shortcuts | 标识应用的快捷方式信息 | shortcut_config.json文件 | 在开发视图的resources/base/profile下面定义配置文件shortcut_config.json。 | | reqPermissions | 标识应用运行时向系统申请的权限 | requestPermissions | 标签名称变更。 | @@ -33,7 +33,7 @@ | -------- | -------- | -------- | -------- | | parameters | 标识调用Ability时所有调用参数的元信息 | / | Stage模型不支持。 | | results | 标识Ability返回值的元信息 | / | Stage模型不支持。 | -| customizeData | 该标签标识父级组件的自定义元信息，Parameters和results在application不可配 | metadata | 具体差异见[表3](#表3 FA模型metaData的customizeData和Stage中metadata对比)。 | +| customizeData | 该标签标识父级组件的自定义元信息，Parameters和results在application不可配 | metadata | 具体差异见[表3](#表3-fa模型metadata的customizedata和stage中metadata对比)。 | ### 表3 FA模型metaData的customizeData和Stage中metadata对比 @@ -41,7 +41,7 @@ | -------- | -------- | -------- | -------- | | name | 标识数据项的键名称。字符串最大长度为255字节 | name | 无。 | | value | 标识数据项的值。字符串最大长度为255字节。 | value | 无。 | -| extra | 标识当前custom数据的格式，取值为表示extra的资源值。 | resource | 标签变更。具体实例见[表4](#表4 FA模型metaData和Stage中metadata示例)。 | +| extra | 标识当前custom数据的格式，取值为表示extra的资源值。 | resource | 标签变更。具体实例见[表4](#表4-fa模型metadata和stage中metadata示例)。 | ### 表4 FA模型metaData和Stage中metadata示例 @@ -58,7 +58,7 @@ | process | 运行应用程序或Ability的进程名称 | / | Stage模型不支持abilities中配置，在module标签下配置process | | uri | 标识Ability的统一资源标识符 | / | Stage模型不支持 | | deviceCapability | 标识Ability运行时要求设备具有的能力，采用字符串数组的格式表示 | / | Stage模型不支持 | -| metaData | 该标签标识ability的元信息。 | metadata | 具体差异如[表2](#表2 FA模型metaData和Stage中metadata对比) | +| metaData | 该标签标识ability的元信息。 | metadata | 具体差异如[表2](#表2-fa模型metadata和stage中metadata对比) | | type | 标识Ability的类型 | / | Stage模型不支持 | | grantPermission | 指定是否可以向Ability内任何数据授予权限 | / | abilities内不支持； | | readPermission | 标识读取Ability的数据所需的权限。该标签仅适用于data类型的Ability | / | abilities内不支持；在extensionAbilities标签中支持 | diff --git a/zh-cn/application-dev/application-models/uiability-intra-device-interaction.md b/zh-cn/application-dev/application-models/uiability-intra-device-interaction.md index d40848647471a8f3618f05c2ccde3dd37d095daa..560a2ce17accbcd8529b0be47e922b7d1e7a7d11 100644 --- a/zh-cn/application-dev/application-models/uiability-intra-device-interaction.md +++ b/zh-cn/application-dev/application-models/uiability-intra-device-interaction.md @@ -367,7 +367,7 @@ export default class FuncAbility extends UIAbility { 经常还会遇到一类场景，当应用A已经启动且处于主页面时，回到桌面，打开应用B，并从应用B再次启动应用A，且需要跳转到应用A的指定页面。例如联系人应用和短信应用配合使用的场景。打开短信应用主页，回到桌面，此时短信应用处于已打开状态且当前处于短信应用的主页。再打开联系人应用主页，进入联系人用户A查看详情，点击短信图标，准备给用户A发送短信，此时会再次拉起短信应用且当前处于短信应用的发送页面。 - ![uiability_not_first_started](figures/uiability_not_first_started.png) +![uiability_not_first_started](figures/uiability_not_first_started.png) 针对以上场景，即当应用A的UIAbility实例已创建，并且处于该UIAbility实例对应的主页面中，此时，从应用B中需要再次启动应用A的该UIAbility，并且需要跳转到不同的页面，这种情况下要如何实现呢？ @@ -432,12 +432,12 @@ Call调用的使用场景主要包括： **表1** Call调用相关名词解释 -| 名词 | 描述 | +| 名词 | 描述 | | -------- | -------- | -| CallerAbility | 进行Call调用的UIAbility（调用方）。 | -| CalleeAbility | 被Call调用的UIAbility（被调用方）。 | -| Caller | 实际对象，由startAbilityByCall接口返回，CallerAbility可使用Caller与CalleeAbility进行通信。 | -| Callee | 实际对象，被CalleeAbility持有，可与Caller进行通信。 | +| CallerAbility | 进行Call调用的UIAbility（调用方）。 | +| CalleeAbility | 被Call调用的UIAbility（被调用方）。 | +| Caller | 实际对象，由startAbilityByCall接口返回，CallerAbility可使用Caller与CalleeAbility进行通信。 | +| Callee | 实际对象，被CalleeAbility持有，可与Caller进行通信。 | Call调用示意图如下所示。 @@ -462,15 +462,15 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe **表2** Call功能主要接口 -| 接口名 | 描述 | +| 接口名 | 描述 | | -------- | -------- | -| startAbilityByCall(want: Want): Promise<Caller> | 启动指定UIAbility并获取其Caller通信接口，默认为后台启动，通过配置want可实现前台启动，详见[接口文档](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall)。AbilityContext与ServiceExtensionContext均支持该接口。 | -| on(method: string, callback: CalleeCallBack): void | 通用组件Callee注册method对应的callback方法。 | -| off(method: string): void | 通用组件Callee解注册method的callback方法。 | -| call(method: string, data: rpc.Sequenceable): Promise<void> | 向通用组件Callee发送约定序列化数据。 | -| callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel> | 向通用组件Callee发送约定序列化数据, 并将Callee返回的约定序列化数据带回。 | -| release(): void | 释放通用组件的Caller通信接口。 | -| on(type: "release", callback: OnReleaseCallback): void | 注册通用组件通信断开监听通知。 | +| startAbilityByCall(want: Want): Promise<Caller> | 启动指定UIAbility并获取其Caller通信接口，默认为后台启动，通过配置want可实现前台启动，详见[接口文档](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall)。AbilityContext与ServiceExtensionContext均支持该接口。 | +| on(method: string, callback: CalleeCallBack): void | 通用组件Callee注册method对应的callback方法。 | +| off(method: string): void | 通用组件Callee解注册method的callback方法。 | +| call(method: string, data: rpc.Sequenceable): Promise<void> | 向通用组件Callee发送约定序列化数据。 | +| callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel> | 向通用组件Callee发送约定序列化数据, 并将Callee返回的约定序列化数据带回。 | +| release(): void | 释放通用组件的Caller通信接口。 | +| on(type: "release", callback: OnReleaseCallback): void | 注册通用组件通信断开监听通知。 | 设备内通过Call调用实现UIAbility交互，涉及如下两部分开发： @@ -486,9 +486,9 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe 1. 配置Ability的启动模式。 配置module.json5，将CalleeAbility配置为单实例"singleton"。 - | Json字段 | 字段说明 | + | Json字段 | 字段说明 | | -------- | -------- | - | "launchType" | Ability的启动模式，设置为"singleton"类型。 | + | "launchType" | Ability的启动模式，设置为"singleton"类型。 | Ability配置标签示例如下： diff --git a/zh-cn/application-dev/device/figures/zh-cn_image_0000001196654004.png b/zh-cn/application-dev/device/figures/zh-cn_image_0000001196654004.png deleted file mode 100644 index 48b1613b6e67f2dd57cd480fdb7fd0312594e049..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/device/figures/zh-cn_image_0000001196654004.png and /dev/null differ diff --git a/zh-cn/application-dev/device/figures/zh-cn_image_0000001241693881.png b/zh-cn/application-dev/device/figures/zh-cn_image_0000001241693881.png deleted file mode 100644 index 5c54c71606ce2f81308923d8d4c579f1b9b3ad3c..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/device/figures/zh-cn_image_0000001241693881.png and /dev/null differ diff --git a/zh-cn/application-dev/device/figures/zh-cn_image_0000001241733907.png b/zh-cn/application-dev/device/figures/zh-cn_image_0000001241733907.png deleted file mode 100644 index d0a680b7138b81e6e9a1e598634b66dd598dd603..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/device/figures/zh-cn_image_0000001241733907.png and /dev/null differ diff --git a/zh-cn/application-dev/faqs/faqs-ability.md b/zh-cn/application-dev/faqs/faqs-ability.md index e65ff4e19df5d458aad4fd8fa7f40df5826e94d2..1a41bf3371c3ec4c5a29bcd50d83a49ee4200ef6 100644 --- a/zh-cn/application-dev/faqs/faqs-ability.md +++ b/zh-cn/application-dev/faqs/faqs-ability.md @@ -60,7 +60,7 @@ build() { Ability配置中缺少startWindowIcon属性配置，需要在module.json5中abilities中配置startWindowIcon。 -参考文档：[Stage模型应用程序包结构](../quick-start/application-package-structure-stage.md) +参考文档：[Stage模型应用程序包结构](../quick-start/module-configuration-file.md) 示例： @@ -95,7 +95,7 @@ Ability配置中缺少startWindowIcon属性配置，需要在module.json5中abil ## 如何在应用A中去获取应用B的Hap包的安装路径 -适用于：OpenHarmony SDK 3..0以上版本， API9 Stage模型 +适用于：OpenHarmony SDK 3.0以上版本， API9 Stage模型 首先需要申请系统权限，具体参看文档：[自动化签名](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-auto-configuring-signature-information-0000001271659465)。导入bundle模块，通过调用bundle.getApplicationInfo()接口，通过包名获取应用信息。然后通过application.moduleSourceDirs获取应用存储路径。 diff --git a/zh-cn/application-dev/faqs/faqs-media.md b/zh-cn/application-dev/faqs/faqs-media.md index 7ced8a1d5ab3c80f6a9401565c410e84f18ad5d6..df0d20f24017763056f434ddc81d9ab8e372d3fd 100644 --- a/zh-cn/application-dev/faqs/faqs-media.md +++ b/zh-cn/application-dev/faqs/faqs-media.md @@ -34,7 +34,7 @@ for(let cameraIndex = 0; cameraIndex < this.cameraArray.length; cameraIndex++) { break } } -cameraInput = await this.cameraManager.createCameraInput(cameraId)熊文帅 +cameraInput = await this.cameraManager.createCameraInput(cameraId) ``` ## 如何进行图片剪切 diff --git a/zh-cn/application-dev/key-features/multi-device-app-dev/figures/zh-cn_image_0000001313517281.png b/zh-cn/application-dev/key-features/multi-device-app-dev/figures/zh-cn_image_0000001313517281.png deleted file mode 100644 index 23ef4160b4f363d512d317ef85ca4788b7dcc0d4..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/key-features/multi-device-app-dev/figures/zh-cn_image_0000001313517281.png and /dev/null differ diff --git a/zh-cn/application-dev/notification/figures/notification-with-wantagent.png b/zh-cn/application-dev/notification/figures/notification-with-wantagent.png index 09afc47cac503bf10f2dac78b75d6757dd8da82c..9fce8cab810d8093575bab3d21f64baac2439f7a 100644 Binary files a/zh-cn/application-dev/notification/figures/notification-with-wantagent.png and b/zh-cn/application-dev/notification/figures/notification-with-wantagent.png differ diff --git a/zh-cn/application-dev/quick-start/application-package-structure-fa.md b/zh-cn/application-dev/quick-start/application-package-structure-fa.md index 90b144c28a7aaaf96c1adaef26d051d6c5ea09ac..3e75f3b114fc2865f54ebbcc70bd0f6e9d39ced6 100644 --- a/zh-cn/application-dev/quick-start/application-package-structure-fa.md +++ b/zh-cn/application-dev/quick-start/application-package-structure-fa.md @@ -1,7 +1,7 @@ # FA模型应用程序包结构 -基于[FA模型](application-configuration-file-overview-fa.md)开发的应用，其应用程序包结构如图[应用程序包结构（FA模型）](figures/FA_3.png)所示。开发者需要熟悉应用程序包结构相关的基本概念。 +基于[FA模型](application-configuration-file-overview-fa.md)开发的应用，其应用程序包结构如下图**应用程序包结构（FA模型）**所示。开发者需要熟悉应用程序包结构相关的基本概念。 FA模型与Stage模型不同之处在于HAP内部文件存放位置不同，FA模型将所有的资源文件、库文件和代码文件都放在assets文件夹中，在文件夹内部进一步区分。 @@ -11,7 +11,7 @@ FA模型与Stage模型不同之处在于HAP内部文件存放位置不同，FA - assets是HAP所有的资源文件、库文件和代码文件的集合，内部可以分为entry和js文件夹。entry文件夹中存放的是resources目录和resources.index文件。 -- resources目录用于存放应用的资源文件（字符串、图片等），便于开发者使用和维护，详见[资源文件的使用](../key-features/multi-device-app-dev/resource-usage.md/)。 +- resources目录用于存放应用的资源文件（字符串、图片等），便于开发者使用和维护，详见[资源文件的使用](../key-features/multi-device-app-dev/resource-usage.md)。 - resources.index是资源索引表，由IDE调用SDK工具生成。 @@ -19,6 +19,5 @@ FA模型与Stage模型不同之处在于HAP内部文件存放位置不同，FA - pack.info是Bundle中用于描述每个HAP属性的文件，例如app中的bundleName和versionCode信息、module中的name、type和abilities等信息，由IDE工具生成Bundle包时自动生成。 - -**图1** 应用程序包结构（FA模型）   -![FA_3](figures/FA_3.png) +**图1** 应用程序包结构（FA模型） +![app-pack-fa](figures/app-pack-fa.png) \ No newline at end of file diff --git a/zh-cn/application-dev/quick-start/application-package-structure-stage.md b/zh-cn/application-dev/quick-start/application-package-structure-stage.md index 9802e5b7ed37812ecd581afc24bb49a47c4ef38b..0c640afb9e98af04bf070154e615a350defb2615 100644 --- a/zh-cn/application-dev/quick-start/application-package-structure-stage.md +++ b/zh-cn/application-dev/quick-start/application-package-structure-stage.md @@ -1,13 +1,13 @@ # Stage模型应用程序包结构 -基于[Stage模型](application-configuration-file-overview-stage.md)开发的应用，经编译打包后，其应用程序包结构如图[应用程序包结构（Stage模型）](figures/Stage-.png)所示。开发者需要熟悉应用程序包结构相关的基本概念。 +基于[Stage模型](application-configuration-file-overview-stage.md)开发的应用，经编译打包后，其应用程序包结构如下图**应用程序包结构（Stage模型）**所示。开发者需要熟悉应用程序包结构相关的基本概念。 - 在开发态，一个应用包含一个或者多个Module，可以在[DevEco Studio](https://developer.harmonyos.com/cn/develop/deveco-studio/)工程中[创建一个或者多个Module](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/ohos-adding-deleting-module-0000001218760594-V3)。Module是OpenHarmony应用/服务的基本功能单元，包含了源代码、资源文件、第三方库及应用/服务配置文件，每一个Module都可以独立进行编译和运行。Module分为“Ability”和“Library”两种类型，“Ability”类型的Module对应于编译后的HAP（Harmony Ability Package）；“Library”类型的Module对应于[HAR](har-structure.md)（Harmony Ability Resources）包，即编译后的.tgz文件。 一个Module可以包含一个或多个[UIAbility](../application-models/uiability-overview.md)组件，如[Module与UIAbility组件关系示意图](figures/ability-and-module.png)所示。 - **图1** Module与UIAbility组件关系示意图   + **图1** Module与UIAbility组件关系示意图 ![ability-and-module](figures/ability-and-module.png) 全文中介绍到的Module默认指的是“Ability”类型的Module。 @@ -21,10 +21,10 @@ - 打包后的HAP包结构包括ets、libs、resources等文件夹和resources.index、module.json、pack.info等文件。 - ets目录用于存放应用代码编译后的字节码文件。 - libs目录用于存放库文件。库文件是OpenHarmony应用依赖的第三方代码（例如.so、.jar、.bin、.har等二进制文件）。 - - resources目录用于存放应用的资源文件（字符串、图片等），便于开发者使用和维护，详见[资源文件的使用](../key-features/multi-device-app-dev/resource-usage.md/)。 + - resources目录用于存放应用的资源文件（字符串、图片等），便于开发者使用和维护，详见[资源文件的使用](../key-features/multi-device-app-dev/resource-usage.md)。 - resources.index是资源索引表，由IDE编译工程时生成。 - module.json是HAP的配置文件，内容由工程配置中的module.json5和app.json5组成，该文件是HAP中必不可少的文件。IDE会自动生成一部分默认配置，开发者按需修改其中的配置。详细字段请参见[应用配置文件](application-configuration-file-overview-stage.md)。 - pack.info是Bundle中用于描述每个HAP属性的文件，例如app中的bundleName和versionCode信息、module中的name、type和abilities等信息，由IDE工具生成Bundle包时自动生成。 - **图2** 应用程序包结构（Stage模型）   - ![Stage-](figures/Stage-.png) + **图2** 应用程序包结构（Stage模型） + ![app-pack-stage](figures/app-pack-stage.png) diff --git a/zh-cn/application-dev/quick-start/figures/FA_3.png b/zh-cn/application-dev/quick-start/figures/FA_3.png deleted file mode 100644 index 946f05500c4f325fe4a030fc54229fa891ec1d3b..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/quick-start/figures/FA_3.png and /dev/null differ diff --git a/zh-cn/application-dev/quick-start/figures/Stage-.png b/zh-cn/application-dev/quick-start/figures/Stage-.png deleted file mode 100644 index 4db7d66ec6cb25cceed7807ec889b4334f76028f..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/quick-start/figures/Stage-.png and /dev/null differ diff --git a/zh-cn/application-dev/quick-start/figures/ability-and-module.png b/zh-cn/application-dev/quick-start/figures/ability-and-module.png index e81ec6ecacf456079f4d0ca0745513a40de47213..8910b0f30e8fc6808498155263939dbcb1a21336 100644 Binary files a/zh-cn/application-dev/quick-start/figures/ability-and-module.png and b/zh-cn/application-dev/quick-start/figures/ability-and-module.png differ diff --git a/zh-cn/application-dev/quick-start/figures/app-pack-fa.png b/zh-cn/application-dev/quick-start/figures/app-pack-fa.png new file mode 100644 index 0000000000000000000000000000000000000000..51c78e2625228cfbce44d694a0eefae2b0f22782 Binary files /dev/null and b/zh-cn/application-dev/quick-start/figures/app-pack-fa.png differ diff --git a/zh-cn/application-dev/quick-start/figures/app-pack-stage.png b/zh-cn/application-dev/quick-start/figures/app-pack-stage.png new file mode 100644 index 0000000000000000000000000000000000000000..355681fd15a3d8365ab690002fdb9f88b35e2360 Binary files /dev/null and b/zh-cn/application-dev/quick-start/figures/app-pack-stage.png differ diff --git a/zh-cn/application-dev/quick-start/figures/hap-intall-uninstall.png b/zh-cn/application-dev/quick-start/figures/hap-intall-uninstall.png index cadc8c243bc18ec36b308cc4431f92c4d7fecdf1..5ae1b1c43baecde88142c1da654f6c22f6890623 100644 Binary files a/zh-cn/application-dev/quick-start/figures/hap-intall-uninstall.png and b/zh-cn/application-dev/quick-start/figures/hap-intall-uninstall.png differ diff --git a/zh-cn/application-dev/quick-start/figures/hap-multi-view.png b/zh-cn/application-dev/quick-start/figures/hap-multi-view.png index 9b176541c70f98cc4c7845e2a53187a8c7c9e27c..c5e714b341f093781a5d77efd8b14ca903005706 100644 Binary files a/zh-cn/application-dev/quick-start/figures/hap-multi-view.png and b/zh-cn/application-dev/quick-start/figures/hap-multi-view.png differ diff --git a/zh-cn/application-dev/quick-start/figures/hap-release.png b/zh-cn/application-dev/quick-start/figures/hap-release.png index f8467537adf6d8982b3196e4bf66ebc25d2cef5f..535c7ab70ee83ff9ef6ad69936e629c97a930035 100644 Binary files a/zh-cn/application-dev/quick-start/figures/hap-release.png and b/zh-cn/application-dev/quick-start/figures/hap-release.png differ diff --git a/zh-cn/application-dev/quick-start/start-with-ets-fa.md b/zh-cn/application-dev/quick-start/start-with-ets-fa.md index a284ff8306427451dc755a3a8f56a8327f4595d3..b57284c4d4b4d9c43fb58d345d29adb55c720b1a 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-fa.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-fa.md @@ -40,7 +40,7 @@ - **src > main > ets > MainAbility > pages > index.ets**：pages列表中的第一个页面，即应用的首页入口。 - **src > main > ets > MainAbility > app.ets**：承载Ability生命周期。 - **src > main > resources**：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件，详见[资源文件的分类](resource-categories-and-access.md#资源分类)。 - - **src > main > config.json**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[FA模型应用程序包结构](application-package-structure-fa.md)。 + - **src > main > config.json**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[应用配置文件（FA模型）](application-configuration-file-overview-fa.md)。 - **build-profile.json5**：当前的模块信息 、编译信息配置项，包括buildOption、targets配置等。 - **hvigorfile.ts**：模块级编译构建任务脚本，开发者可以自定义相关任务和代码实现。 diff --git a/zh-cn/application-dev/quick-start/start-with-ets-stage.md b/zh-cn/application-dev/quick-start/start-with-ets-stage.md index 842a7612513646953d95c605a72eaaf0a4fe06b2..95e548d8009c18c20328d6afa904883602499e12 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-stage.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-stage.md @@ -38,7 +38,7 @@ - **src > main > ets > entryability**：应用/服务的入口。 - **src > main > ets > pages**：应用/服务包含的页面。 - **src > main > resources**：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件，详见[资源文件的分类](resource-categories-and-access.md#资源分类)。 - - **src > main > module.json5**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[Stage模型应用程序包结构](application-package-structure-stage.md)。 + - **src > main > module.json5**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[module.json5配置文件](module-configuration-file.md)。 - **build-profile.json5**：当前的模块信息 、编译信息配置项，包括buildOption、targets配置等。 - **hvigorfile.ts**：模块级编译构建任务脚本，开发者可以自定义相关任务和代码实现。 diff --git a/zh-cn/application-dev/quick-start/start-with-js-fa.md b/zh-cn/application-dev/quick-start/start-with-js-fa.md index b65d744d58a8e41aa6c18abcbc7da8d25b111096..8dc0d1b5f542dda575ef77925d3b265d21b2cfe9 100644 --- a/zh-cn/application-dev/quick-start/start-with-js-fa.md +++ b/zh-cn/application-dev/quick-start/start-with-js-fa.md @@ -39,7 +39,7 @@ - **src > main > js > MainAbility > app.js**：承载Ability生命周期。 - **src > main > resources**：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件，详见[资源限定与访问](../ui/js-framework-resource-restriction.md)。 - - **src > main > config.json**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[FA模型应用程序包结构](application-package-structure-fa.md)。 + - **src > main > config.json**：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明，详见[应用配置文件（FA模型）](application-configuration-file-overview-fa.md)。 - **build-profile.json5**：当前的模块信息 、编译信息配置项，包括buildOption、targets配置等。 - **hvigorfile.ts**：模块级编译构建任务脚本，开发者可以自定义相关任务和代码实现。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md b/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md deleted file mode 100644 index d89a009989af69d006cbb4caabd1abe9847c8e1e..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md +++ /dev/null @@ -1,73 +0,0 @@ -# Want - -Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 - -> **说明：** -> -> 本模块首批接口从API version 6开始支持，从API version 9废弃，替换模块为[Want (Want)](js-apis-app-ability-Want.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import Want from '@ohos.application.Want' -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | -| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 | -| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | -| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | -| type | 是 | 否 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | -| flags | 是 | 否 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 | -| action | 是 | 否 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | -| parameters | 是 | 否 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | -| entities | 是 | 否 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 | - -具体字段描述参考ability/want.d.ts文件 - -**示例：** - -- 基础用法 - - ``` ts - var want = { - "deviceId": "", // deviceId为空表示本设备 - "bundleName": "com.extreme.test", - "abilityName": "MainAbility", - "moduleName": "entry" // moduleName非必选 - }; - this.context.startAbility(want, (error) => { - // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability - console.log("error.code = " + error.code) - }) - ``` - -- 传递FD数据，FD表示文件描述符(FileDescriptor) - - ``` ts - import fileio from '@ohos.fileio'; - var fd; - try { - fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); - } catch(e) { - console.log("openSync fail:" + JSON.stringify(e)); - } - var want = { - "deviceId": "", // deviceId为空表示本设备 - "bundleName": "com.extreme.test", - "abilityName": "MainAbility", - "moduleName": "entry", // moduleName非必选 - "parameters": { - "keyFd":{"type":"FD", "value":fd} - } - }; - this.context.startAbility(want, (error) => { - // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability - console.log("error.code = " + error.code) - }) - ``` - diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md b/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md index 473f7205a65f12057ca108f9e0903e71f975ad03..120d44bd117704f46223e5c8885211e72391707c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md @@ -15,24 +15,25 @@ import ability from '@ohos.ability.ability' **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | -| DataAbilityHelper | 是 | 否 | number | 否 | DataAbilityHelper二级模块。 | -| PacMap | 是 | 否 | Want | 否 | PacMap二级模块。 | -| DataAbilityOperation | 是 | 否 | Want | 否 | DataAbilityOperation二级模块。 | -| DataAbilityResult | 是 | 否 | Want | 否 | DataAbilityResult二级模块。 | -| AbilityResult | 是 | 否 | Want | 否 | AbilityResult二级模块。 | -| ConnectOptions | 是 | 否 | Want | 否 | ConnectOptions二级模块。 | -| StartAbilityParameter | 是 | 否 | Want | 否 | StartAbilityParameter二级模块。 | +| 名称 | 类型 | 必填 | 描述 | +| ----------- | -------------------- | ---- | ------------------------------------------------------------ | +| DataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 否 | DataAbilityHelper二级模块。 | +| PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 | +| DataAbilityOperation | [DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md) | 否 | DataAbilityOperation二级模块。 | +| DataAbilityResult | [DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md) | 否 | DataAbilityResult二级模块。 | +| AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 | +| ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 | +| StartAbilityParameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 否 | StartAbilityParameter二级模块。 | **示例：** - - ```ts - let dataAbilityHelper: ability.DataAbilityHelper; - let pacMap: ability.PacMap; - let dataAbilityOperation: ability.DataAbilityOperation; - let dataAbilityResult: ability.DataAbilityResult; - let abilityResult: ability.AbilityResult; - let connectOptions: ability.ConnectOptions; - let startAbilityParameter: ability.StartAbilityParameter; - ``` \ No newline at end of file +```ts +import ability from '@ohos.ability.ability'; + +let dataAbilityHelper: ability.DataAbilityHelper; +let pacMap: ability.PacMap; +let dataAbilityOperation: ability.DataAbilityOperation; +let dataAbilityResult: ability.DataAbilityResult; +let abilityResult: ability.AbilityResult; +let connectOptions: ability.ConnectOptions; +let startAbilityParameter: ability.StartAbilityParameter; +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index 46993cecb7612502669e7972a14fa79e541d7f2f..8f1df40ecb7d2f0680ff2e011a77e3f27b0a5c18 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -28,11 +28,11 @@ class MainAbility extends Ability { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | -| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 表示配置信息。 | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 | ## AbilityContext.startAbility @@ -46,7 +46,7 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | **错误码：** @@ -54,7 +54,7 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -95,8 +95,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | **错误码：** @@ -104,7 +104,7 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -148,8 +148,8 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 | **返回值：** @@ -162,7 +162,7 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -206,15 +206,15 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | +| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -256,16 +256,16 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | -| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | +| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -311,22 +311,22 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityRes | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | Promise形式返回执行结果。 | +| Promise<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回执行结果。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -373,7 +373,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数，返回Ability结果。 | @@ -382,7 +382,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -430,9 +430,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** @@ -440,7 +440,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -491,9 +491,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 | **返回值：** @@ -506,7 +506,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -553,7 +553,7 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** @@ -561,7 +561,7 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -604,14 +604,14 @@ startServiceExtensionAbility(want: Want): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -656,7 +656,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | @@ -665,7 +665,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -711,7 +711,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | **错误码：** @@ -719,7 +719,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -762,7 +762,7 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** @@ -770,7 +770,7 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -813,14 +813,14 @@ stopServiceExtensionAbility(want: Want): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -865,7 +865,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | @@ -874,7 +874,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -920,7 +920,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | **错误码：** @@ -928,7 +928,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -977,7 +977,7 @@ terminateSelf(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1014,7 +1014,7 @@ terminateSelf(): Promise<void>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1042,7 +1042,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | | callback | AsyncCallback<void> | 是 | callback形式返回停止结果。 | **错误码：** @@ -1050,7 +1050,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1097,7 +1097,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult 调用方的信息。 | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult 调用方的信息。 | **返回值：** @@ -1110,7 +1110,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1153,12 +1153,14 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**: 此接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | 远端对象实例。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 | **返回值：** @@ -1171,7 +1173,7 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1214,9 +1216,9 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | 远端对象实例。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 | **返回值：** @@ -1229,7 +1231,7 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1264,6 +1266,8 @@ disconnectServiceExtensionAbility(connection: number): Promise\; **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**: 此接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1281,12 +1285,12 @@ disconnectServiceExtensionAbility(connection: number): Promise\; | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** ```ts - // connection为connectAbility中的返回值 + // connection为connectServiceExtensionAbility中的返回值 var connection = 1; try { @@ -1315,6 +1319,8 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\ | 是 | 启动Ability的回调函数。 | @@ -1467,7 +1471,7 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1514,9 +1518,9 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。| -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** @@ -1524,7 +1528,7 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1574,16 +1578,16 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) **示例：** @@ -1629,7 +1633,7 @@ requestPermissionsFromUser(permissions: Array<string>, requestCallback: As | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | permissions | Array<string> | 是 | 权限列表。 | -| callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | +| callback | AsyncCallback<[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | **示例：** @@ -1660,7 +1664,7 @@ requestPermissionsFromUser(permissions: Array<string>) : Promise<Permis | 类型 | 说明 | | -------- | -------- | -| Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 返回一个Promise，包含接口的结果。 | +| Promise<[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)> | 返回一个Promise，包含接口的结果。 | **示例：** @@ -1831,7 +1835,7 @@ restoreWindowStage(localStorage: LocalStorage) : void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| localStorage | LocalStorage | 是 | 用于恢复window stage的存储数据。 | +| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md similarity index 94% rename from zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md rename to zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md index 0332b8e41ed1e3e567e70403dad7627f9fb6ce9c..2c2e70e3cba9d90ea4dbadd1724b1b21fbbe76d4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md @@ -8,7 +8,7 @@ DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实 ## 导入模块 -```js +```ts import dataUriUtils from '@ohos.ability.dataUriUtils'; ``` @@ -34,7 +34,7 @@ getId(uri: string): number **示例：** -```js +```ts dataUriUtils.getId("com.example.dataUriUtils/1221") ``` @@ -63,7 +63,7 @@ attachId(uri: string, id: number): string **示例：** -```js +```ts var idint = 1122; dataUriUtils.attachId( "com.example.dataUriUtils", @@ -95,7 +95,7 @@ deleteId(uri: string): string **示例：** -```js +```ts dataUriUtils.deleteId("com.example.dataUriUtils/1221") ``` @@ -124,7 +124,7 @@ updateId(uri: string, id: number): string **示例：** -```js +```ts var idint = 1122; dataUriUtils.updateId( "com.example.dataUriUtils", diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md index c07de214397189e8a7e398658bd5170b1d01d71c..f6920f90812f2216b5c0418f539f007e5b4c8fc5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md @@ -10,7 +10,7 @@ ErrorCode是定义启动功能时使用的错误代码。 ## 导入模块 -``` +```ts import errorCode from '@ohos.ability.errorCode' ``` @@ -24,5 +24,5 @@ import errorCode from '@ohos.ability.errorCode' | ------------------------------ | ---- | ---------------------------------------- | | NO_ERROR | 0 | 没有错误。 | | INVALID_PARAMETER | -1 | 无效的参数。 | -| ABILITY_NOT_FOUND | -2 | 找不到能力。 | +| ABILITY_NOT_FOUND | -2 | 找不到ABILITY。 | | PERMISSION_DENY | -3 | 拒绝许可。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md similarity index 76% rename from zh-cn/application-dev/reference/apis/js-apis-featureAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md index e2b69809cec615ad647fd038d59bc0a413907685..fc088036e35587e3e3b27896c7c78b8422fec7cc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md @@ -1,947 +1,784 @@ -# FeatureAbility模块(JS端SDK接口) - -FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。 - -> **说明：** -> -> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在FA模型下使用。 - -## 使用限制 - -FeatureAbility模块的接口只能在Page类型的Ability调用 - -## 导入模块 - -``` -import featureAbility from '@ohos.ability.featureAbility'; -``` - -## featureAbility.startAbility - -startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void - -启动新的ability（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.startAbility( - { - want: - { - action: "", - entities: [""], - type: "", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri: "" - }, - }, - (err, data) => { - console.info("startAbility err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); - } -); -``` - - - -## featureAbility.startAbility - -startAbility(parameter: StartAbilityParameter): Promise\ - -启动新的ability（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.startAbility( - { - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri: "" - }, - } -).then((data) => { - console.info("startAbility data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.acquireDataAbilityHelper7+ - -acquireDataAbilityHelper(uri: string): DataAbilityHelper - -获取dataAbilityHelper。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------------ | -| uri | string | 是 | 指示要打开的文件的路径。 | - -**返回值：** - -| 类型 | 说明 | -| ----------------- | ------------------------------- | -| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -``` - -## featureAbility.startAbilityForResult7+ - -startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void - -启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.startAbilityForResult( - { - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri:"" - }, - }, - (err, data) => { - console.info("startAbilityForResult err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); - } -); -``` - -## featureAbility.startAbilityForResult7+ - -startAbilityForResult(parameter: StartAbilityParameter): Promise\ - -启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | ------------- | -| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability | - -**返回值：** - -| 类型 | 说明 | -| ---------------------------------------- | ------- | -| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.startAbilityForResult( - { - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri:"", - parameters: - { - mykey0: 1111, - mykey1: [1, 2, 3], - mykey2: "[1, 2, 3]", - mykey3: "xxxxxxxxxxxxxxxxxxxxxx", - mykey4: [1, 15], - mykey5: [false, true, false], - mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], - mykey7: true, - }, - }, - }, -).then((data) => { - console.info("startAbilityForResult data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.terminateSelfWithResult7+ - -terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void - -设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------------- | ---- | -------------- | -| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.terminateSelfWithResult( - { - resultCode: 1, - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri:"", - parameters: { - mykey0: 2222, - mykey1: [1, 2, 3], - mykey2: "[1, 2, 3]", - mykey3: "ssssssssssssssssssssssssss", - mykey4: [1, 15], - mykey5: [false, true, false], - mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], - mykey7: true, - } - }, - }, - (err) => { - console.info("err: " + JSON.stringify(err)) - } -); -``` - -## featureAbility.terminateSelfWithResult7+ - -terminateSelfWithResult(parameter: AbilityResult): Promise\ - -设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------------- | ---- | ------------- | -| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability | - -**返回值：** - -| 类型 | 说明 | -| -------------- | --------------- | -| Promise\ | 以Promise形式返回结果。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; -featureAbility.terminateSelfWithResult( - { - resultCode: 1, - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.myapplication", - /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", - uri:"", - parameters: { - mykey0: 2222, - mykey1: [1, 2, 3], - mykey2: "[1, 2, 3]", - mykey3: "ssssssssssssssssssssssssss", - mykey4: [1, 15], - mykey5: [false, true, false], - mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], - mykey7: true, - } - }, - } -).then((data) => { - console.info("==========================>terminateSelfWithResult=======================>"); -}); -``` - -## featureAbility.hasWindowFocus7+ - -hasWindowFocus(callback: AsyncCallback\): void - -检查Ability的主窗口是否具有窗口焦点（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------------- | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.hasWindowFocus((err, data) => { - console.info("hasWindowFocus err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.hasWindowFocus7+ - -hasWindowFocus(): Promise\ - -检查Ability的主窗口是否具有窗口焦点（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| ----------------- | ------------------------------------- | -| Promise\ | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.hasWindowFocus().then((data) => { - console.info("hasWindowFocus data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.getWant - -getWant(callback: AsyncCallback\): void - -获取从Ability发送的Want（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------- | ---- | --------- | -| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是 | 被指定的回调方法。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.getWant((err, data) => { - console.info("getWant err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.getWant - -getWant(): Promise\ - -获取从Ability发送的Want（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| ----------------------- | ---------------- | -| Promise\<[Want](js-apis-application-Want.md)> | 以Promise的形式返回结果。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.getWant().then((data) => { - console.info("getWant data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.getContext - -getContext(): Context - -获取应用上下文。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------- | -| Context | 返回应用程序上下文。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -var context = featureAbility.getContext() -context.getBundleName((err, data) => { - console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); -}); -``` - -## featureAbility.terminateSelf7+ - -terminateSelf(callback: AsyncCallback\): void - -设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------- | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.terminateSelf( - (err) => { - console.info("err: " + JSON.stringify(err)) - } -) -``` - -## featureAbility.terminateSelf7+ - -terminateSelf(): Promise\ - -设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| -------------- | ---------------- | -| Promise\ | 以Promise的形式返回结果。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility'; -featureAbility.terminateSelf().then((data) => { - console.info("==========================>terminateSelf=======================>"); -}); -``` - -## featureAbility.connectAbility7+ - -connectAbility(request: Want, options:ConnectOptions): number - -将当前ability连接到指定ServiceAbility（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | -------------- | ---- | --------------------- | -| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | -| options | [ConnectOptions](#connectoptions) | 是 | 被指定的回调方法。 | - -## ConnectOptions - -ConnectOptions类型说明 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 参数名 | 可读|可写 | 类型 | 必填 | 说明 | -| ------------ | -- | -- | -------- | ---- | ------------------------- | -| onConnect7+ | 是|否 | function | 是 | 连接成功时的回调函数。 | -| onDisconnect7+ | 是|否 | function | 是 | 连接失败时的回调函数。 | -| onFailed7+ | 是|否 | function | 是 | ConnectAbility调用失败时的回调函数。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | -------------------- | -| number | 连接的ServiceAbilityID。 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - deviceId: "", - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -``` - -## featureAbility.disconnectAbility7+ - -disconnectAbility(connection: number, callback:AsyncCallback\): void - -断开与指定ServiceAbility的连接（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | -------------------- | ---- | ----------------------- | -| connection | number | 是 | 指定断开连接的ServiceAbilityID | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -var result = featureAbility.disconnectAbility(connectId, - (error) => { - console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code) - }, -); -``` - -## featureAbility.disconnectAbility7+ - -disconnectAbility(connection: number): Promise\ - -断开与指定ServiceAbility的连接（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | ----------------------- | -| connection | number | 是 | 指定断开连接的ServiceAbilityID | - -**返回值：** - -| 类型 | 说明 | -| -------------- | --------------- | -| Promise\ | 以Promise形式返回结果。 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); - -featureAbility.disconnectAbility(connectId).then((data) => { - console.log('data : ' + data); -}).catch((error)=>{ - console.log('featureAbilityTest result errCode : ' + error.code); -}); -``` - - -## featureAbility.getWindow7+ - -getWindow(callback: AsyncCallback\): void - -获取当前Ability对应的窗口（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------- | ---- | ----------------------------- | -| callback | AsyncCallback\ | 是 | 返回与当前Ability对应的窗口。 | - -**示例：** - -```javascript -featureAbility.getWindow((err, data) => { - console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data)); -}); -``` - -## featureAbility.getWindow7+ - -getWindow(): Promise\; - -获取当前Ability对应的窗口（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| ----------------------- | ----------------------------- | -| Promise\ | 返回与当前Ability对应的窗口。 | - -**示例：** - -```javascript -featureAbility.getWindow().then((data) => { - console.info("getWindow data: " + typeof(data)); -}); -``` - -## ConnectOptions.onConnect7+ - -onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void; - -连接成功时的回调函数。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ----------------- | ---- | -------- | -| elementName | ElementName | 是 | 元素名。 | -| remote | rpc.IRemoteObject | 是 | rpc远程对象。 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - deviceId: "", - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -``` - -## ConnectOptions.onDisconnect7+ - -onDisconnect(elementName: ElementName): void; - -连接失败时的回调函数。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ----------- | ---- | ---- | -| elementName | ElementName | 是 | 元素名。 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - deviceId: "", - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -``` - -## ConnectOptions.onFailed7+ - -onFailed(code: number): void; - -ConnectAbility调用失败时的回调函数。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| code | number | 是 | number类型。 | - -**示例：** - -```javascript -import rpc from '@ohos.rpc'; -import featureAbility from '@ohos.ability.featureAbility'; -function onConnectCallback(element, remote){ - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} -function onDisconnectCallback(element){ - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} -function onFailedCallback(code){ - console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) -} -var connectId = featureAbility.connectAbility( - { - deviceId: "", - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -``` - - - - - -## AbilityWindowConfiguration - -使用时通过featureAbility.AbilityWindowConfiguration获取。 - -**示例：** - -``` -featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 值 | 说明 | -| ---------------------------------------- | ---- | ---------------------------------------- | -| WINDOW_MODE_UNDEFINED7+ | 0 | 未定义。 | -| WINDOW_MODE_FULLSCREEN7+ | 1 | 全屏。 | -| WINDOW_MODE_SPLIT_PRIMARY7+ | 100 | 分屏主屏。 | -| WINDOW_MODE_SPLIT_SECONDARY7+ | 101 | 分屏次屏。 | -| WINDOW_MODE_FLOATING7+ | 102 | 悬浮窗。 | - - -## AbilityStartSetting - -abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。 - -使用时通过featureAbility.AbilityStartSetting获取。 - -**示例：** - -``` -featureAbility.AbilityStartSetting.BOUNDS_KEY -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 值 | 说明 | -| ---------------------------- | --------------- | ---------------------------------------- | -| BOUNDS_KEY7+ | "abilityBounds" | 窗口显示大小属性的参数名。 | -| WINDOW_MODE_KEY7+ | "windowMode" | 窗口显示模式属性的参数名。| -| DISPLAY_ID_KEY7+ | "displayId" | 窗口显示设备ID属性的参数名。 | - -## ErrorCode - -获取错误代码。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 值 | 说明 | -| ------------------------------ | ---- | ---------------------------------------- | -| NO_ERROR7+ | 0 | 没有错误。 | -| INVALID_PARAMETER7+ | -1 | 无效的参数。 | -| ABILITY_NOT_FOUND7+ | -2 | 找不到能力。 | -| PERMISSION_DENY7+ | -3 | 拒绝许可。 | - - -## DataAbilityOperationType - -指示数据的操作类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 值 | 说明 | -| ------------------------ | ---- | ---------------------------------------- | -| TYPE_INSERT7+ | 1 | 插入类型。 | -| TYPE_UPDATE7+ | 2 | 修改类型。 | -| TYPE_DELETE7+ | 3 | 删除类型。 | -| TYPE_ASSERT7+ | 4 | 声明类型。 | - - - -## AbilityResult - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 类型 | 可读| 可写 | 必填 | 说明 | -| --------------- |-------- | ------ | ------------- | ---- | ------------------------------------- | -| resultCode7+| number| 是 | 否 | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 | -| want7+ | [Want](js-apis-application-Want.md)| 是 | 否 | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | - -## StartAbilityParameter - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 类型 | 可读| 可写 | 必填 | 说明 | -| ------------------- | -------- | -------------------- | ---- | -------------------------------------- | -| want | [Want](js-apis-application-Want.md)| 是 | 否 | 是 | 表示需要包含有关目标启动能力的信息。 | -| abilityStartSetting | {[key: string]: any} | 是 |否 | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 | - -## flags说明 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| ------------------------------------ | ---------- | ---------------------------------------- | -| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 | -| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 | -| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 | -| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 | -| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 | -| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | -| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 | -| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | -| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 | -| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | -| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | - +# FeatureAbility模块(JS端SDK接口) + +FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。 + +> **说明：** +> +> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在FA模型下使用。 + +## 使用限制 + +FeatureAbility模块的接口只能在Page类型的Ability调用 + +## 导入模块 + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +``` + +## featureAbility.startAbility + +startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void + +启动新的ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | -------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | +| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.startAbility( + { + want: + { + action: "", + entities: [""], + type: "", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri: "" + }, + }, + (err, data) => { + console.info("startAbility err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); + } +); +``` + + + +## featureAbility.startAbility + +startAbility(parameter: StartAbilityParameter): Promise\ + +启动新的ability（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | -------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.startAbility( + { + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri: "" + }, + } +).then((data) => { + console.info("startAbility data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.acquireDataAbilityHelper7+ + +acquireDataAbilityHelper(uri: string): DataAbilityHelper + +获取dataAbilityHelper。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| uri | string | 是 | 指示要打开的文件的路径。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------- | ------------------------------- | +| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +``` + +## featureAbility.startAbilityForResult7+ + +startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void + +启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | -------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | +| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 被指定的回调方法。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.startAbilityForResult( + { + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri:"" + }, + }, + (err, data) => { + console.info("startAbilityForResult err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); + } +); +``` + +## featureAbility.startAbilityForResult7+ + +startAbilityForResult(parameter: StartAbilityParameter): Promise\ + +启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | ------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------- | +| Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 返回执行结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.startAbilityForResult( + { + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri:"", + parameters: + { + mykey0: 1111, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "xxxxxxxxxxxxxxxxxxxxxx", + mykey4: [1, 15], + mykey5: [false, true, false], + mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], + mykey7: true, + }, + }, + }, +).then((data) => { + console.info("startAbilityForResult data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.terminateSelfWithResult7+ + +terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void + +设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------------- | ---- | -------------- | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability。 | +| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.terminateSelfWithResult( + { + resultCode: 1, + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri:"", + parameters: { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [1, 15], + mykey5: [false, true, false], + mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey7: true, + } + }, + }, + (err) => { + console.info("err: " + JSON.stringify(err)) + } +); +``` + +## featureAbility.terminateSelfWithResult7+ + +terminateSelfWithResult(parameter: AbilityResult): Promise\ + +设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------------- | ---- | ------------- | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability | + +**返回值：** + +| 类型 | 说明 | +| -------------- | --------------- | +| Promise\ | 以Promise形式返回结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import wantConstant from '@ohos.ability.wantConstant'; +featureAbility.terminateSelfWithResult( + { + resultCode: 1, + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.myapplication", + /* FA模型中abilityName由package + Ability name组成 */ + abilityName: "com.example.entry.secondAbility", + uri:"", + parameters: { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [1, 15], + mykey5: [false, true, false], + mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey7: true, + } + }, + } +).then((data) => { + console.info("==========================>terminateSelfWithResult=======================>"); +}); +``` + +## featureAbility.hasWindowFocus7+ + +hasWindowFocus(callback: AsyncCallback\): void + +检查Ability的主窗口是否具有窗口焦点（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ---------------------------------------- | +| callback | AsyncCallback\ | 是 | 被指定的回调方法。
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.hasWindowFocus((err, data) => { + console.info("hasWindowFocus err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.hasWindowFocus7+ + +hasWindowFocus(): Promise\ + +检查Ability的主窗口是否具有窗口焦点（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| ----------------- | ------------------------------------- | +| Promise\ | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.hasWindowFocus().then((data) => { + console.info("hasWindowFocus data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.getWant + +getWant(callback: AsyncCallback\): void + +获取从Ability发送的Want（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------- | ---- | --------- | +| callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 被指定的回调方法。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.getWant((err, data) => { + console.info("getWant err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.getWant + +getWant(): Promise\ + +获取从Ability发送的Want（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| ----------------------- | ---------------- | +| Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.getWant().then((data) => { + console.info("getWant data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.getContext + +getContext(): Context + +获取应用上下文。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------- | +| Context | 返回应用程序上下文。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +var context = featureAbility.getContext() +context.getBundleName((err, data) => { + console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); +}); +``` + +## featureAbility.terminateSelf7+ + +terminateSelf(callback: AsyncCallback\): void + +设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------- | +| callback | AsyncCallback\ | 是 | 被指定的回调方法 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.terminateSelf( + (err) => { + console.info("err: " + JSON.stringify(err)) + } +) +``` + +## featureAbility.terminateSelf7+ + +terminateSelf(): Promise\ + +设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| -------------- | ---------------- | +| Promise\ | 以Promise的形式返回结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; +featureAbility.terminateSelf().then((data) => { + console.info("==========================>terminateSelf=======================>"); +}); +``` + +## featureAbility.connectAbility7+ + +connectAbility(request: Want, options:ConnectOptions): number + +将当前ability连接到指定ServiceAbility（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------------- | ---- | --------------------- | +| request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 被指定的回调方法。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | -------------------- | +| number | 连接的ServiceAbilityID。 | + +**示例：** + +```ts +import rpc from '@ohos.rpc'; +import featureAbility from '@ohos.ability.featureAbility'; +function onConnectCallback(element, remote){ + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} +function onDisconnectCallback(element){ + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} +function onFailedCallback(code){ + console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) +} +var connectId = featureAbility.connectAbility( + { + deviceId: "", + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); +``` + +## featureAbility.disconnectAbility7+ + +disconnectAbility(connection: number, callback:AsyncCallback\): void + +断开与指定ServiceAbility的连接（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | -------------------- | ---- | ----------------------- | +| connection | number | 是 | 指定断开连接的ServiceAbilityID | +| callback | AsyncCallback\ | 是 | 被指定的回调方法 | + +**示例：** + +```ts +import rpc from '@ohos.rpc'; +import featureAbility from '@ohos.ability.featureAbility'; +function onConnectCallback(element, remote){ + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} +function onDisconnectCallback(element){ + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} +function onFailedCallback(code){ + console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) +} +var connectId = featureAbility.connectAbility( + { + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); +var result = featureAbility.disconnectAbility(connectId, + (error) => { + console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code) + }, +); +``` + +## featureAbility.disconnectAbility7+ + +disconnectAbility(connection: number): Promise\ + +断开与指定ServiceAbility的连接（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ----------------------- | +| connection | number | 是 | 指定断开连接的ServiceAbilityID | + +**返回值：** + +| 类型 | 说明 | +| -------------- | --------------- | +| Promise\ | 以Promise形式返回结果。 | + +**示例：** + +```ts +import rpc from '@ohos.rpc'; +import featureAbility from '@ohos.ability.featureAbility'; +function onConnectCallback(element, remote){ + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} +function onDisconnectCallback(element){ + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} +function onFailedCallback(code){ + console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) +} +var connectId = featureAbility.connectAbility( + { + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); + +featureAbility.disconnectAbility(connectId).then((data) => { + console.log('data : ' + data); +}).catch((error)=>{ + console.log('featureAbilityTest result errCode : ' + error.code); +}); +``` + + +## featureAbility.getWindow7+ + +getWindow(callback: AsyncCallback\): void + +获取当前Ability对应的窗口（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------- | ---- | ----------------------------- | +| callback | AsyncCallback\ | 是 | 返回与当前Ability对应的窗口。 | + +**示例：** + +```ts +featureAbility.getWindow((err, data) => { + console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data)); +}); +``` + +## featureAbility.getWindow7+ + +getWindow(): Promise\; + +获取当前Ability对应的窗口（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| ----------------------- | ----------------------------- | +| Promise\ | 返回与当前Ability对应的窗口。 | + +**示例：** + +```ts +featureAbility.getWindow().then((data) => { + console.info("getWindow data: " + typeof(data)); +}); +``` + +## AbilityWindowConfiguration + +使用时通过featureAbility.AbilityWindowConfiguration获取。 + +**示例：** + +``` +featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED +``` + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 值 | 说明 | +| ---------------------------------------- | ---- | ---------------------------------------- | +| WINDOW_MODE_UNDEFINED7+ | 0 | 未定义。 | +| WINDOW_MODE_FULLSCREEN7+ | 1 | 全屏。 | +| WINDOW_MODE_SPLIT_PRIMARY7+ | 100 | 分屏主屏。 | +| WINDOW_MODE_SPLIT_SECONDARY7+ | 101 | 分屏次屏。 | +| WINDOW_MODE_FLOATING7+ | 102 | 悬浮窗。 | + + +## AbilityStartSetting + +abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。 + +使用时通过featureAbility.AbilityStartSetting获取。 + +**示例：** + +``` +featureAbility.AbilityStartSetting.BOUNDS_KEY +``` + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 值 | 说明 | +| ---------------------------- | --------------- | ---------------------------------------- | +| BOUNDS_KEY7+ | "abilityBounds" | 窗口显示大小属性的参数名。 | +| WINDOW_MODE_KEY7+ | "windowMode" | 窗口显示模式属性的参数名。| +| DISPLAY_ID_KEY7+ | "displayId" | 窗口显示设备ID属性的参数名。 | + +## ErrorCode + +获取错误代码。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 值 | 说明 | +| ------------------------------ | ---- | ---------------------------------------- | +| NO_ERROR7+ | 0 | 没有错误。 | +| INVALID_PARAMETER7+ | -1 | 无效的参数。 | +| ABILITY_NOT_FOUND7+ | -2 | 找不到能力。 | +| PERMISSION_DENY7+ | -3 | 拒绝许可。 | + + +## DataAbilityOperationType + +指示数据的操作类型。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 值 | 说明 | +| ------------------------ | ---- | ---------------------------------------- | +| TYPE_INSERT7+ | 1 | 插入类型。 | +| TYPE_UPDATE7+ | 2 | 修改类型。 | +| TYPE_DELETE7+ | 3 | 删除类型。 | +| TYPE_ASSERT7+ | 4 | 声明类型。 | + +## flags说明 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase + +| 名称 | 值 | 说明 | +| ------------------------------------ | ---------- | ---------------------------------------- | +| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 | +| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 | +| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 | +| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 | +| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 | +| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | +| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 | +| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | +| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 | +| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | +| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | + diff --git a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md b/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md similarity index 91% rename from zh-cn/application-dev/reference/apis/js-apis-particleAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md index b414aab9865a84fcee7e2e891625b63a558e2420..1faf7510e057bbfb0fe87c446746da9d6feb8be0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md @@ -1,556 +1,556 @@ -# particleAbility模块 - -particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。 - -> **说明：** -> -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在FA模型下使用。 - -## 使用限制 - -particleAbility模块用来对Data和Service类型的Ability进行操作。 - -## 导入模块 - -```js -import particleAbility from '@ohos.ability.particleAbility' -``` - -## particleAbility.startAbility - -startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void - -使用此方法启动指定的particleAbility（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ----------------------------------------------- | ---- | ----------------- | -| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | - -**示例：** - -```js -import particleAbility from '@ohos.ability.particleAbility' -import wantConstant from '@ohos.ability.wantConstant' - -particleAbility.startAbility( - { - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.Data", - abilityName: "com.example.Data.MainAbility", - uri: "" - }, - }, - (error, result) => { - console.log('particleAbility startAbility errCode:' + error + 'result:' + result) - }, -) -``` - -## particleAbility.startAbility - -startAbility(parameter: StartAbilityParameter): Promise\; - -使用此方法启动指定的particleAbility（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ----------------------------------------------- | ---- | ----------------- | -| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | - -**示例：** - -```js -import particleAbility from '@ohos.ability.particleAbility' -import wantConstant from '@ohos.ability.wantConstant' - -particleAbility.startAbility( - { - want: - { - action: "action.system.home", - entities: ["entity.system.home"], - type: "MIMETYPE", - flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, - deviceId: "", - bundleName: "com.example.Data", - abilityName: "com.example. Data.MainAbility", - uri: "" - }, - }, -).then((data) => { - console.info("particleAbility startAbility"); -}); -``` - -## particleAbility.terminateSelf - -terminateSelf(callback: AsyncCallback\): void - -终止particleAbility（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法 | - -**示例：** - -```js -import particleAbility from '@ohos.ability.particleAbility' - -particleAbility.terminateSelf( - (error, result) => { - console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result) - } -) -``` - -## particleAbility.terminateSelf - -terminateSelf(): Promise\ - -终止particleAbility（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | - -**示例：** - -```js -import particleAbility from '@ohos.ability.particleAbility' - -particleAbility.terminateSelf().then((data) => { - console.info("particleAbility terminateSelf"); -}); -``` - - - -## particleAbility.acquireDataAbilityHelper - -acquireDataAbilityHelper(uri: string): DataAbilityHelper - -获取dataAbilityHelper。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| :--- | ------ | ---- | ------------------------ | -| uri | string | 是 | 指示要打开的文件的路径。 | - -**返回值：** - -| 类型 | 说明 | -| ----------------- | -------------------------------------------- | -| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | - -**示例：** - -```js -import particleAbility from '@ohos.ability.particleAbility' - -var uri = ""; -particleAbility.acquireDataAbilityHelper(uri) -``` - - -## particleAbility.startBackgroundRunning - -startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback<void>): void; - -向系统申请长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8)。 - -**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING - -**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | id | number | 是 | 长时任务通知id号 | - | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果 | - - **示例**： - -```js -import notification from '@ohos.notification'; -import particleAbility from '@ohos.ability.particleAbility'; -import wantAgent from '@ohos.wantAgent'; - -function callback(err, data) { - if (err) { - console.error("Operation failed cause: " + JSON.stringify(err)); - } else { - console.info("Operation succeeded"); - } -} - -let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "com.example.myapplication.MainAbility" - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] -}; - -wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let basicContent = { - title: "title", - text: "text" - }; - let notificationContent = { - contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, - normal: basicContent - }; - let request = { - content: notificationContent, - wantAgent: wantAgentObj - }; - let id = 1; - particleAbility.startBackgroundRunning(id, request, callback); -}); - -``` - -## particleAbility.startBackgroundRunning - -startBackgroundRunning(id: number, request: NotificationRequest): Promise<void> - -**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING - -**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask - -向系统申请长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8-1)。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| id | number | 是 | 长时任务通知id号 | -| request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | - -**示例**： - -```js -import notification from '@ohos.notification'; -import particleAbility from '@ohos.ability.particleAbility'; -import wantAgent from '@ohos.wantAgent'; - -let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "com.example.myapplication.MainAbility" - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] -}; - -wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - let basicContent = { - title: "title", - text: "text" - }; - let notificationContent = { - contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, - normal: basicContent - }; - let request = { - content: notificationContent, - wantAgent: wantAgentObj - }; - let id = 1; - particleAbility.startBackgroundRunning(id, request).then(() => { - console.info("Operation succeeded"); - }).catch((err) => { - console.error("Operation failed cause: " + JSON.stringify(err)); - }); -}); - -``` - -## particleAbility.cancelBackgroundRunning - -cancelBackgroundRunning(callback: AsyncCallback<void>): void; - -向系统申请取消长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8)。 - -**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask - - **参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果 | - - **示例**： - -```js -import particleAbility from '@ohos.ability.particleAbility'; - -function callback(err, data) { - if (err) { - console.error("Operation failed cause: " + JSON.stringify(err)); - } else { - console.info("Operation succeeded"); - } -} - -particleAbility.cancelBackgroundRunning(callback); - -``` - -## particleAbility.cancelBackgroundRunning - -cancelBackgroundRunning(): Promise<void>; - -向系统申请取消长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8-1)。 - -**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | - - **示例**： - -```js -import particleAbility from '@ohos.ability.particleAbility'; - -particleAbility.cancelBackgroundRunning().then(() => { - console.info("Operation succeeded"); -}).catch((err) => { - console.error("Operation failed cause: " + JSON.stringify(err)); -}); - -``` - -## particleAbility.connectAbility - -connectAbility(request: Want, options:ConnectOptions): number - -将当前ability连接到指定ServiceAbility（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | -------------- | ---- | ---------------------------- | -| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | -| options | ConnectOptions | 是 | 被指定的回调方法。 | - - -**ConnectOptions类型说明：** - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 参数名 | 读写属性 | 类型 | 必填 | 说明 | -| ------------ | ---- | -------- | ---- | ------------------------- | -| onConnect | 只读 | function | 是 | 连接成功时的回调函数。 | -| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 | -| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。 | - -**示例**： - -```js -import rpc from '@ohos.rpc' - -function onConnectCallback(element, remote) { - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} - -function onDisconnectCallback(element) { - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} - -function onFailedCallback(code) { - console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) -} - -var connId = particleAbility.connectAbility( - { - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); - -particleAbility.disconnectAbility(connId).then((data) => { - console.log(" data: " + data); -}).catch((error) => { - console.log('particleAbilityTest result errCode : ' + error.code) -}); - -``` - -## particleAbility.disconnectAbility - -disconnectAbility(connection: number, callback:AsyncCallback\): void; - -将功能与服务功能断开连接。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | callback形式返回断开连接的结果 | - -**示例**： - -```js -import rpc from '@ohos.rpc' - -function onConnectCallback(element, remote) { - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} - -function onDisconnectCallback(element) { - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} - -function onFailedCallback(code) { - console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) -} - -var connId = particleAbility.connectAbility( - { - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); -var result = particleAbility.disconnectAbility(connId).then((data) => { - console.log(" data: " + data); -}).catch((error) => { - console.log('particleAbilityTest result errCode : ' + error.code) -}); -``` - - -## particleAbility.disconnectAbility - -disconnectAbility(connection: number): Promise\; - -将功能与服务功能断开连接。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | - -**示例**： - -```js -import rpc from '@ohos.rpc' - -function onConnectCallback(element, remote) { - console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); -} - -function onDisconnectCallback(element) { - console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) -} - -function onFailedCallback(code) { - console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) -} - -var connId = particleAbility.connectAbility( - { - bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", - }, - { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback, - onFailed: onFailedCallback, - }, -); - -particleAbility.disconnectAbility(connId).then((data) => { - console.log(" data: " + data); -}).catch((error) => { - console.log('particleAbilityTest result errCode : ' + error.code) -}); - -``` - -## ErrorCode - -获取错误代码。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| INVALID_PARAMETER | -1 | 无效的参数。 | - - - - - - - - - +# particleAbility模块 + +particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。 + +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在FA模型下使用。 + +## 使用限制 + +particleAbility模块用来对Data和Service类型的Ability进行操作。 + +## 导入模块 + +```ts +import particleAbility from '@ohos.ability.particleAbility' +``` + +## particleAbility.startAbility + +startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void + +使用此方法启动指定的particleAbility（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ----------------------------------------------- | ---- | ----------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability | +| callback | AsyncCallback\ | 是 | 被指定的回调方法 | + +**示例：** + +```ts +import particleAbility from '@ohos.ability.particleAbility' +import wantConstant from '@ohos.ability.wantConstant' + +particleAbility.startAbility( + { + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.Data", + abilityName: "com.example.Data.MainAbility", + uri: "" + }, + }, + (error, result) => { + console.log('particleAbility startAbility errCode:' + error + 'result:' + result) + }, +) +``` + +## particleAbility.startAbility + +startAbility(parameter: StartAbilityParameter): Promise\; + +使用此方法启动指定的particleAbility（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ----------------------------------------------- | ---- | ----------------- | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability | + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用Promise形式返回结果。 | + +**示例：** + +```ts +import particleAbility from '@ohos.ability.particleAbility' +import wantConstant from '@ohos.ability.wantConstant' + +particleAbility.startAbility( + { + want: + { + action: "action.system.home", + entities: ["entity.system.home"], + type: "MIMETYPE", + flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, + deviceId: "", + bundleName: "com.example.Data", + abilityName: "com.example. Data.MainAbility", + uri: "" + }, + }, +).then((data) => { + console.info("particleAbility startAbility"); +}); +``` + +## particleAbility.terminateSelf + +terminateSelf(callback: AsyncCallback\): void + +终止particleAbility（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------------------- | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法 | + +**示例：** + +```ts +import particleAbility from '@ohos.ability.particleAbility' + +particleAbility.terminateSelf( + (error, result) => { + console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result) + } +) +``` + +## particleAbility.terminateSelf + +terminateSelf(): Promise\ + +终止particleAbility（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用Promise形式返回结果。 | + +**示例：** + +```ts +import particleAbility from '@ohos.ability.particleAbility' + +particleAbility.terminateSelf().then((data) => { + console.info("particleAbility terminateSelf"); +}); +``` + + + +## particleAbility.acquireDataAbilityHelper + +acquireDataAbilityHelper(uri: string): DataAbilityHelper + +获取dataAbilityHelper。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| :--- | ------ | ---- | ------------------------ | +| uri | string | 是 | 指示要打开的文件的路径。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------- | -------------------------------------------- | +| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | + +**示例：** + +```ts +import particleAbility from '@ohos.ability.particleAbility' + +var uri = ""; +particleAbility.acquireDataAbilityHelper(uri) +``` + + +## particleAbility.startBackgroundRunning + +startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback<void>): void; + +向系统申请长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8)。 + +**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING + +**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | number | 是 | 长时任务通知id号 | + | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | + | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果 | + + **示例**： + +```ts +import notification from '@ohos.notification'; +import particleAbility from '@ohos.ability.particleAbility'; +import wantAgent from '@ohos.wantAgent'; + +function callback(err, data) { + if (err) { + console.error("Operation failed cause: " + JSON.stringify(err)); + } else { + console.info("Operation succeeded"); + } +} + +let wantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "com.example.myapplication.MainAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +}; + +wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { + let basicContent = { + title: "title", + text: "text" + }; + let notificationContent = { + contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, + normal: basicContent + }; + let request = { + content: notificationContent, + wantAgent: wantAgentObj + }; + let id = 1; + particleAbility.startBackgroundRunning(id, request, callback); +}); + +``` + +## particleAbility.startBackgroundRunning + +startBackgroundRunning(id: number, request: NotificationRequest): Promise<void> + +**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING + +**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + +向系统申请长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8-1)。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| id | number | 是 | 长时任务通知id号 | +| request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用Promise形式返回结果。 | + +**示例**： + +```ts +import notification from '@ohos.notification'; +import particleAbility from '@ohos.ability.particleAbility'; +import wantAgent from '@ohos.wantAgent'; + +let wantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "com.example.myapplication.MainAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +}; + +wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { + let basicContent = { + title: "title", + text: "text" + }; + let notificationContent = { + contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, + normal: basicContent + }; + let request = { + content: notificationContent, + wantAgent: wantAgentObj + }; + let id = 1; + particleAbility.startBackgroundRunning(id, request).then(() => { + console.info("Operation succeeded"); + }).catch((err) => { + console.error("Operation failed cause: " + JSON.stringify(err)); + }); +}); + +``` + +## particleAbility.cancelBackgroundRunning + +cancelBackgroundRunning(callback: AsyncCallback<void>): void; + +向系统申请取消长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8)。 + +**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + + **参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果 | + + **示例**： + +```ts +import particleAbility from '@ohos.ability.particleAbility'; + +function callback(err, data) { + if (err) { + console.error("Operation failed cause: " + JSON.stringify(err)); + } else { + console.info("Operation succeeded"); + } +} + +particleAbility.cancelBackgroundRunning(callback); + +``` + +## particleAbility.cancelBackgroundRunning + +cancelBackgroundRunning(): Promise<void>; + +向系统申请取消长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8-1)。 + +**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用Promise形式返回结果。 | + + **示例**： + +```ts +import particleAbility from '@ohos.ability.particleAbility'; + +particleAbility.cancelBackgroundRunning().then(() => { + console.info("Operation succeeded"); +}).catch((err) => { + console.error("Operation failed cause: " + JSON.stringify(err)); +}); + +``` + +## particleAbility.connectAbility + +connectAbility(request: Want, options:ConnectOptions): number + +将当前ability连接到指定ServiceAbility（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------------- | ---- | ---------------------------- | +| request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 | +| options | ConnectOptions | 是 | 被指定的回调方法。 | + + +**ConnectOptions类型说明：** + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 必填 | 说明 | +| ------------ | -------- | ---- | ------------------------- | +| onConnect | function | 是 | 连接成功时的回调函数。 | +| onDisconnect | function | 是 | 连接失败时的回调函数。 | +| onFailed | function | 是 | ConnectAbility调用失败时的回调函数。 | + +**示例**： + +```ts +import rpc from '@ohos.rpc' + +function onConnectCallback(element, remote) { + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} + +function onDisconnectCallback(element) { + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} + +function onFailedCallback(code) { + console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) +} + +var connId = particleAbility.connectAbility( + { + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); + +particleAbility.disconnectAbility(connId).then((data) => { + console.log(" data: " + data); +}).catch((error) => { + console.log('particleAbilityTest result errCode : ' + error.code) +}); + +``` + +## particleAbility.disconnectAbility + +disconnectAbility(connection: number, callback:AsyncCallback\): void; + +将功能与服务功能断开连接。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | callback形式返回断开连接的结果 | + +**示例**： + +```ts +import rpc from '@ohos.rpc' + +function onConnectCallback(element, remote) { + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} + +function onDisconnectCallback(element) { + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} + +function onFailedCallback(code) { + console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) +} + +var connId = particleAbility.connectAbility( + { + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); +var result = particleAbility.disconnectAbility(connId).then((data) => { + console.log(" data: " + data); +}).catch((error) => { + console.log('particleAbilityTest result errCode : ' + error.code) +}); +``` + + +## particleAbility.disconnectAbility + +disconnectAbility(connection: number): Promise\; + +将功能与服务功能断开连接。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用Promise形式返回结果。 | + +**示例**： + +```ts +import rpc from '@ohos.rpc' + +function onConnectCallback(element, remote) { + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} + +function onDisconnectCallback(element) { + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} + +function onFailedCallback(code) { + console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) +} + +var connId = particleAbility.connectAbility( + { + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); + +particleAbility.disconnectAbility(connId).then((data) => { + console.log(" data: " + data); +}).catch((error) => { + console.log('particleAbilityTest result errCode : ' + error.code) +}); + +``` + +## ErrorCode + +获取错误代码。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| INVALID_PARAMETER | -1 | 无效的参数。 | + + + + + + + + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index f59251079e3feb37f06349cfe2646bb8cde16168..f38f18bb47d632cc24fb8aa484dd13c5602a5dea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -8,7 +8,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。 ## 导入模块 -```js +```ts import wantConstant from '@ohos.ability.wantConstant'; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md deleted file mode 100644 index 6b743460466bca27d096415d25b2f0c9ae0e1d04..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md +++ /dev/null @@ -1,73 +0,0 @@ -# Want - -Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import Want from '@ohos.app.ability.Want' -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | -| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 | -| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | -| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | -| type | 是 | 否 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | -| flags | 是 | 否 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 | -| action | 是 | 否 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | -| parameters | 是 | 否 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | -| entities | 是 | 否 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 | - -具体字段描述参考ability/want.d.ts文件 - -**示例：** - -- 基础用法 - - ``` ts - var want = { - "deviceId": "", // deviceId为空表示本设备 - "bundleName": "com.extreme.test", - "abilityName": "MainAbility", - "moduleName": "entry" // moduleName非必选 - }; - this.context.startAbility(want, (error) => { - // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability - console.log("error.code = " + error.code) - }) - ``` - -- 传递FD数据，FD表示文件描述符(FileDescriptor) - - ``` ts - import fileio from '@ohos.fileio'; - var fd; - try { - fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); - } catch(e) { - console.log("openSync fail:" + JSON.stringify(e)); - } - var want = { - "deviceId": "", // deviceId为空表示本设备 - "bundleName": "com.extreme.test", - "abilityName": "MainAbility", - "moduleName": "entry", // moduleName非必选 - "parameters": { - "keyFd":{"type":"FD", "value":fd} - } - }; - this.context.startAbility(want, (error) => { - // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability - console.log("error.code = " + error.code) - }) - ``` - diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md new file mode 100644 index 0000000000000000000000000000000000000000..71c6c349bc1beec65715f7c0cd78e057c36d83c5 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md @@ -0,0 +1,62 @@ +# Ability + +Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 导入模块 + +```ts +import Ability from '@ohos.app.ability.Ability'; +``` + +## Ability.onConfigurationUpdate + +onConfigurationUpdate(config: Configuration): void; + +当系统配置更新时调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | + +**示例：** + + ```ts + class myAbility extends Ability { + onConfigurationUpdate(config) { + console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); + } + } + ``` + +## Ability.onMemoryLevel + +onMemoryLevel(level: AbilityConstant.MemoryLevel): void; + +当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| + +**示例：** + + ```ts + class myAbility extends Ability { + onMemoryLevel(level) { + console.log('onMemoryLevel, level:' + JSON.stringify(level)); + } + } + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md index ce0db92ecdf2117d475bc6ebe13adbcd2c2e08b3..5f2a30122da43e3a73bbc7b0916f239ddc9039be 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md @@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始 ## 导入模块 -```js +```ts import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegator.md deleted file mode 100644 index ac2b5235cc5930b55bb4557eb27da89b18eeeabe..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegator.md +++ /dev/null @@ -1,1146 +0,0 @@ -# AbilityDelegator - -AbilityDelegator提供添加用于监视指定ability的生命周期状态更改的AbilityMonitor对象的能力，包括对AbilityMonitor实例的添加、删除、等待ability到达OnCreate生命周期、设置等待时间等、获取指定ability的生命周期状态、获取当前应用顶部ability、启动指定ability等。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' -``` - -## 使用说明 - -通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。 -```js -import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' - -var abilityDelegator; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); - -``` - -## AbilityDelegator - -### addAbilityMonitor - -addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void - -添加AbilityMonitor实例（callback形式） - -**系统能力：**SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填说明 | 说明 | -| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityMonitor(monitor, (err : any) => { - console.info("addAbilityMonitor callback"); -}); -``` - - - -### addAbilityMonitor - -addAbilityMonitor(monitor: AbilityMonitor): Promise\ - -添加AbilityMonitor实例（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityMonitor(monitor).then(() => { - console.info("addAbilityMonitor promise"); -}); -``` - - - -### removeAbilityMonitor - -removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void - -删除已经添加的AbilityMonitor实例（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.removeAbilityMonitor(monitor, (err : any) => { - console.info("removeAbilityMonitor callback"); -}); -``` - - - -### removeAbilityMonitor - -removeAbilityMonitor(monitor: AbilityMonitor): Promise\ - -删除已经添加的AbilityMonitor实例（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -- 示例 - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.removeAbilityMonitor(monitor).then(() => { - console.info("removeAbilityMonitor promise"); -}); -``` - - - -### waitAbilityMonitor - -waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void - -等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | -| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => { - console.info("waitAbilityMonitor callback"); -}); -``` - - - -### waitAbilityMonitor - -waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback\): void - -设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | -| timeout | number | 是 | 最大等待时间，单位毫秒（ms） | -| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var timeout = 100; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) => { - console.info("waitAbilityMonitor callback"); -}); -``` - - - -### waitAbilityMonitor - -waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\ - -设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-app-ability-abilityMonitor.md#AbilityMonitor)实例 | -| timeout | number | 否 | 最大等待时间，单位毫秒（ms） | - -**返回值：** - -| 类型 | 说明 | -| ----------------------------------------------------------- | -------------------------- | -| Promise\<[Ability](js-apis-application-ability.md#Ability)> | 以Promise形式返回Ability。 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => { - console.info("waitAbilityMonitor promise"); -}); -``` - - - -### getAppContext - -getAppContext(): Context - -获取应用Context - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------- | ------------------------------------------- | -| [Context](js-apis-Context.md#Context) | 应用[Context](js-apis-Context.md#Context)。 | - -**示例：** - -```js -var abilityDelegator; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -var context = abilityDelegator.getAppContext(); -``` - - - -### getAbilityState9+ - -getAbilityState(ability: Ability): number - -获取指定ability的生命周期状态 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------- | ---- | --------------- | -| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 指定Ability对象 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------------------------------------------ | -| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-abilityDelegatorRegistry.md#AbilityLifecycleState)。 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; - var state = abilityDelegator.getAbilityState(ability); - console.info("getAbilityState" + state); -}); -``` - - - -### getCurrentTopAbility - -getCurrentTopAbility(callback: AsyncCallback\): void - -获取当前应用顶部ability（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------ | -| callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; -}); -``` - - - -### getCurrentTopAbility - -getCurrentTopAbility(): Promise\ - -获取当前应用顶部ability（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| ----------------------------------------------------------- | -------------------------------------- | -| Promise\<[Ability](js-apis-application-ability.md#Ability)> | 以Promise形式返回当前应用顶部ability。 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility().then((data : any) => { - console.info("getCurrentTopAbility promise"); - ability = data; -}); -``` - - - -### startAbility - -startAbility(want: Want, callback: AsyncCallback\): void - -启动指定ability（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | ------------------ | -| want | [Want](js-apis-app-ability-Want.md) | 是 | 启动Ability参数 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var want = { - bundleName: "bundleName", - abilityName: "abilityName" -}; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.startAbility(want, (err : any, data : any) => { - console.info("startAbility callback"); -}); -``` - - - -### startAbility - -startAbility(want: Want): Promise\ - -启动指定ability（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | -------------------------------------- | ---- | --------------- | -| want | [Want](js-apis-app-ability-Want.md) | 是 | 启动Ability参数 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; -var want = { - bundleName: "bundleName", - abilityName: "abilityName" -}; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.startAbility(want).then((data: any) => { - console.info("startAbility promise"); -}); -``` - - - -### doAbilityForeground - -doAbilityForeground(ability: Ability, callback: AsyncCallback\): void - -调度指定ability生命周期状态到Foreground状态（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------- | -| ability | Ability | 是 | 指定Ability对象 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法
\- true：成功
\- false：失败 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; - abilityDelegator.doAbilityForeground(ability, (err : any, data : any) => { - console.info("doAbilityForeground callback"); - }); -}); -``` - - - -### doAbilityForeground - -doAbilityForeground(ability: Ability): Promise\ - -调度指定ability生命周期状态到Foreground状态（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ---- | --------------- | -| ability | Ability | 是 | 指定Ability对象 | - -**返回值：** - -| 类型 | 说明 | -| ----------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回执行结果。
\- true：成功
\- false：失败 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; - abilityDelegator.doAbilityForeground(ability).then((data : any) => { - console.info("doAbilityForeground promise"); - }); -}); -``` - - - -### doAbilityBackground - -doAbilityBackground(ability: Ability, callback: AsyncCallback\): void - -调度指定ability生命周期状态到Background状态（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------- | -| ability | Ability | 是 | 指定Ability对象 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法
\- true：成功
\- false：失败 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; - abilityDelegator.doAbilityBackground(ability, (err : any, data : any) => { - console.info("doAbilityBackground callback"); - }); -}); -``` - - - -### doAbilityBackground - -doAbilityBackground(ability: Ability): Promise\ - -调度指定ability生命周期状态到Background状态（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ---- | --------------- | -| ability | Ability | 是 | 指定Ability对象 | - -**返回值：** - -| 类型 | 说明 | -| ----------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回执行结果。
\- true：成功
\- false：失败 | - -**示例：** - -```js -var abilityDelegator; -var ability; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err : any, data : any) => { - console.info("getCurrentTopAbility callback"); - ability = data; - abilityDelegator.doAbilityBackground(ability).then((data : any) => { - console.info("doAbilityBackground promise"); - }); -}); -``` - - - -### printSync - -printSync(msg: string): void - -打印日志信息到单元测试终端控制台 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------- | -| msg | string | 是 | 日志字符串 | - -**示例：** - -```js -var abilityDelegator; -var msg = "msg"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.printSync(msg); -``` - - - -### print - -print(msg: string, callback: AsyncCallback\): void - -打印日志信息到单元测试终端控制台（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------ | -| msg | string | 是 | 日志字符串 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var msg = "msg"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.print(msg, (err : any) => { - console.info("print callback"); -}); -``` - - - -### print - -print(msg: string): Promise\ - -打印日志信息到单元测试终端控制台（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------- | -| msg | string | 是 | 日志字符串 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; -var msg = "msg"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.print(msg).then(() => { - console.info("print promise"); -}); -``` - - - -### executeShellCommand - -executeShellCommand(cmd: string, callback: AsyncCallback\): void - -执行指定的shell命令（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------ | -| cmd | string | 是 | shell命令字符串 | -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var cmd = "cmd"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => { - console.info("executeShellCommand callback"); -}); -``` - - - -### executeShellCommand - -executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\): void - -指定超时时间，并执行指定的shell命令（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- | -| cmd | string | 是 | shell命令字符串 | -| timeoutSecs | number | 是 | 设定命令超时时间，单位秒（s） | -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var cmd = "cmd"; -var timeout = 100; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { - console.info("executeShellCommand callback"); -}); -``` - - - -### executeShellCommand - -executeShellCommand(cmd: string, timeoutSecs?: number): Promise\ - -指定超时时间，并执行指定的shell命令（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | ----------------------------- | -| cmd | string | 是 | shell命令字符串 | -| timeoutSecs | number | 否 | 设定命令超时时间，单位秒（s） | - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| Promise\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)对象。 | - -**示例：** - -```js -var abilityDelegator; -var cmd = "cmd"; -var timeout = 100; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { - console.info("executeShellCommand promise"); -}); -``` - - - -### finishTest - -finishTest(msg: string, code: number, callback: AsyncCallback\): void - -结束测试并打印日志信息到单元测试终端控制台（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------ | -| msg | string | 是 | 日志字符串 | -| code | number | 是 | 日志码 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; -var msg = "msg"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.finishTest(msg, 0, (err : any) => { - console.info("finishTest callback"); -}); -``` - - - -### finishTest - -finishTest(msg: string, code: number): Promise\ - -结束测试并打印日志信息到单元测试终端控制台（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------- | -| msg | string | 是 | 日志字符串 | -| code | number | 是 | 日志码 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; -var msg = "msg"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.finishTest(msg, 0).then(() => { - console.info("finishTest promise"); -}); -``` - -### addAbilityStageMonitor - -addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; - -添加一个AbilityStageMonitor对象，用于监视指定abilityStage的生命周期状态更改。（callback形式） - -**系统能力：**SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填说明 | 说明 | -| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => { - console.info("addAbilityStageMonitor callback"); -}); -``` - - - -### addAbilityStageMonitor - -addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; - -添加一个AbilityStageMonitor对象，用于监视指定abilityStage的生命周期状态更改。（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityStageMonitor(monitor).then(() => { - console.info("addAbilityStageMonitor promise"); -}); -``` - -### removeAbilityStageMonitor - -removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; - -从应用程序内存中删除指定的AbilityStageMonitor对象。（callback形式） - -**系统能力：**SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填说明 | 说明 | -| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | - -**示例：** - -```js -var abilityDelegator; - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => { - console.info("removeAbilityStageMonitor callback"); -}); -``` - - - -### removeAbilityStageMonitor - -removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; - -从应用程序内存中删除指定的AbilityStageMonitor对象。（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 以Promise形式返回。 | - -**示例：** - -```js -var abilityDelegator; - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.removeAbilityStageMonitor(monitor).then(() => { - console.info("removeAbilityStageMonitor promise"); -}); -``` - -### waitAbilityStageMonitor - -waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; - -等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（callback形式） - -**系统能力：**SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填说明 | 说明 | -| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | -| callback | AsyncCallback\ | 是 | 成功返回AbilityStage对象，失败返回空。 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityStageMonitor(monitor, (err : any, data : any) => { - console.info("waitAbilityStageMonitor callback"); -}); -``` - -### waitAbilityStageMonitor - -waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise\; - -等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（promise形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | -| timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------- | -| Promise\ | 成功返回AbilityStage对象，失败返回空。 | - -**示例：** - -```js -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityStageMonitor(monitor).then((data : any) => { - console.info("waitAbilityStageMonitor promise"); -}); -``` - -### waitAbilityStageMonitor - -waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: AsyncCallback\): void; - -等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（callback形式） - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | -| timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | -| callback | AsyncCallback\ | 是 | 成功返回AbilityStage对象，失败返回空。 | - -**示例：** - -```js -var abilityDelegator; -var timeout = 100; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - moduleName: "moduleName", - srcEntrance: "srcEntrance", -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => { - console.info("waitAbilityStageMonitor callback"); -}); -``` - -## AbilityStageMonitor - -提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 - -系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| moduleName | string | 是 | 是 | 要监视的abilityStage的模块名。 | -| srcEntrance | string | 是 | 是 | 要监视的abilityStage的源路径。 | - diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md new file mode 100644 index 0000000000000000000000000000000000000000..eb7895c4f97884aaf9ec50bf4006013c684e2bbd --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md @@ -0,0 +1,71 @@ +# AbilityDelegatorRegistry + +AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' +``` + +## AbilityLifecycleState + +Ability生命周期状态。 + +**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| ------------- | ---- | --------------------------- | +| UNINITIALIZED | 0 | 表示无效状态。 | +| CREATE | 1 | 表示Ability处于已创建状态。 | +| FOREGROUND | 2 | 表示Ability处于前台状态。 | +| BACKGROUND | 3 | 表示Ability处于后台状态。 | +| DESTROY | 4 | 表示Ability处于已销毁状态。 | + +## AbilityDelegatorRegistry.getAbilityDelegator + +getAbilityDelegator(): AbilityDelegator + +获取应用程序的AbilityDelegator对象 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 | + +**示例：** + +```ts +var abilityDelegator; +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +``` + +## AbilityDelegatorRegistry.getArguments + +getArguments(): AbilityDelegatorArgs + +获取单元测试参数AbilityDelegatorArgs对象 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。可以用来获取测试参数。 | + +**示例：** + +```ts +var args = AbilityDelegatorRegistry.getArguments(); +console.info("getArguments bundleName:" + args.bundleName); +console.info("getArguments testCaseNames:" + args.testCaseNames); +console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md index 67ce1e966047b552c27793b472f356cea33edbf2..74afea1750f032f272f9a10a9eaedb96854e2946 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md @@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命 ## 导入模块 -```js +```ts import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback"; ``` @@ -156,7 +156,7 @@ onAbilityContinue(ability: UIAbility): void; **示例：** - ```js + ```ts import UIAbility from "@ohos.app.ability.UIAbility"; export default class MyAbility extends UIAbility { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md index bc152a69374aec5d81263678c05bf142668f1e80..e7fc3496716c502f2735448b17553ebd41723974 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md @@ -9,7 +9,7 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、 ## 导入模块 -```js +```ts import AbilityManager from '@ohos.app.ability.abilityManager' ``` @@ -48,7 +48,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\): void **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; var config = { @@ -89,7 +89,7 @@ updateConfiguration(config: Configuration): Promise\ **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; var config = { @@ -126,7 +126,7 @@ getAbilityRunningInfos(callback: AsyncCallback\>): vo **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; try { @@ -157,7 +157,7 @@ getAbilityRunningInfos(): Promise\> **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; try { @@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\): void; **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; try { @@ -292,7 +292,7 @@ getTopAbility(): Promise\; **示例**： -```js +```ts import abilitymanager from '@ohos.app.ability.abilityManager'; try { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityMonitor.md deleted file mode 100644 index 673b63407689981807a936908280af8cd8c4f469..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityMonitor.md +++ /dev/null @@ -1,61 +0,0 @@ -# AbilityMonitor - -AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力，最近匹配的ability对象将保存在AbilityMonitor对象中。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import AbilityMonitor from '@ohos.app.ability.abilityDelegatorRegistry' -``` - -## 使用说明 - -通过abilityDelegator中的addAbilityMonitor来设置。 - -```js -import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' -var abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -var monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -} - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -try { - abilityDelegator.addAbilityMonitor(monitor, (err : any) => { - console.info("addAbilityMonitor callback"); - }); -} catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); -} -``` - -## AbilityMonitor - -Ability监听器 - -系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称 | -| moduleName? | string | 是 | 是 | 当前AbilityMonitor绑定的module名称 | -| onAbilityCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被启动初始化时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityForeground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成前台时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityBackground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成后台时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被创建时的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageRestore?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被重载时的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| - - diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilitystage.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md similarity index 83% rename from zh-cn/application-dev/reference/apis/js-apis-app-ability-abilitystage.md rename to zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md index 91f4e49d1dab44df11ed63187c22e5893177228e..35de909edc6e8918c1bfa27d65f5a31d13c27cd9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilitystage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md @@ -2,7 +2,7 @@ AbilityStage是HAP包的运行时类。 -AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。 +AbilityStage类提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。 > **说明：** > @@ -11,7 +11,7 @@ AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此 ## 导入模块 -```js +```ts import AbilityStage from '@ohos.app.ability.AbilityStage'; ``` @@ -25,7 +25,7 @@ onCreate(): void **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onCreate() { console.log("MyAbilityStage.onCreate is called") @@ -46,7 +46,7 @@ onAcceptWant(want: Want): string; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | **返回值：** @@ -56,7 +56,7 @@ onAcceptWant(want: Want): string; **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onAcceptWant(want) { console.log("MyAbilityStage.onAcceptWant called"); @@ -78,11 +78,11 @@ onConfigurationUpdate(newConfig: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | + | newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onConfigurationUpdate(config) { console.log('onConfigurationUpdate, language:' + config.language); @@ -102,11 +102,11 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| + | level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onMemoryLevel(level) { console.log('onMemoryLevel, level:' + JSON.stringify(level)); @@ -124,4 +124,4 @@ context: AbilityStageContext; | 属性名 | 类型 | 说明 | | ----------- | --------------------------- | ------------------------------------------------------------ | -| context | [AbilityStageContext](js-apis-abilitystagecontext.md) | 在启动能力阶段进行初始化时回调。 | +| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md similarity index 51% rename from zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md rename to zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md index ab7823ef3f4f62bae5f15a99e53d5ef8a7a09497..e6554c2496fed02258bf31efc177c36ac0bef28c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md @@ -8,11 +8,11 @@ appManager模块提供App管理的能力，包括查询当前是否处于稳定 ## 导入模块 -```js -import app from '@ohos.app.ability.appManager'; +```ts +import appManager from '@ohos.app.ability.appManager'; ``` -## appManager.isRunningInStabilityTest +## appManager.isRunningInStabilityTest9+ static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void @@ -28,15 +28,15 @@ static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void **示例：** - ```js - import app from '@ohos.app.ability.appManager'; + ```ts + import app from '@ohos.application.appManager'; app.isRunningInStabilityTest((err, flag) => { console.log('startAbility result:' + JSON.stringify(err)); }) ``` -## appManager.isRunningInStabilityTest +## appManager.isRunningInStabilityTest9+ static isRunningInStabilityTest(): Promise<boolean> @@ -52,12 +52,12 @@ static isRunningInStabilityTest(): Promise<boolean> **示例：** - ```js - import app from '@ohos.app.ability.appManager'; + ```ts + import app from '@ohos.application.appManager'; app.isRunningInStabilityTest().then((flag) => { console.log('success:' + JSON.stringify(flag)); }).catch((error) => { - console.log('failed:' + JSON.stringify(err)); + console.log('failed:' + JSON.stringify(error)); }); ``` @@ -78,12 +78,12 @@ isRamConstrainedDevice(): Promise\; **示例：** - ```js - app.isRamConstrainedDevice().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(err)); - }); + ```ts + app.isRamConstrainedDevice().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); ``` ## appManager.isRamConstrainedDevice @@ -102,11 +102,11 @@ isRamConstrainedDevice(callback: AsyncCallback\): void; **示例：** - ```js - app.isRamConstrainedDevice((err, data) => { - console.log('startAbility result failed:' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) + ```ts + app.isRamConstrainedDevice((err, data) => { + console.log('startAbility result failed:' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) ``` ## appManager.getAppMemorySize @@ -125,12 +125,12 @@ getAppMemorySize(): Promise\; **示例：** - ```js - app.getAppMemorySize().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + error.code + ', ' + error.message); - }); + ```ts + app.getAppMemorySize().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); ``` ## appManager.getAppMemorySize @@ -149,14 +149,72 @@ getAppMemorySize(callback: AsyncCallback\): void; **示例：** - ```js - app.getAppMemorySize((err, data) => { - console.log('startAbility result failed :' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) + ```ts + app.getAppMemorySize((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` +## appManager.getProcessRunningInfos(deprecated) + +getProcessRunningInfos(): Promise\>; + +获取有关运行进程的信息。 + +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9)替代。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInfos().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); ``` -## appManager.getProcessRunningInformation +## appManager.getProcessRunningInfos(deprecated) + +getProcessRunningInfos(callback: AsyncCallback\>): void; + +获取有关运行进程的信息。 + +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 否 | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInfos((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` + +## appManager.getProcessRunningInformation9+ getProcessRunningInformation(): Promise\>; @@ -172,19 +230,19 @@ getProcessRunningInformation(): Promise\>; | 类型 | 说明 | | -------- | -------- | -| Promise\> | 获取有关运行进程的信息。 | +| Promise\> | 获取有关运行进程的信息。 | **示例：** - ```js - app.getProcessRunningInformation().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); + ```ts + app.getProcessRunningInformation().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); ``` -## appManager.getProcessRunningInformation +## appManager.getProcessRunningInformation9+ getProcessRunningInformation(callback: AsyncCallback\>): void; @@ -194,21 +252,19 @@ getProcessRunningInformation(callback: AsyncCallback\> | 是 | 获取有关运行进程的信息。 | +| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | **示例：** - ```js - app.getProcessRunningInformation((err, data) => { - console.log('startAbility result failed :' + JSON.stringify(error)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) + ```ts + app.getProcessRunningInformation((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) ``` ## appManager.on @@ -228,7 +284,7 @@ on(type: "applicationState", observer: ApplicationStateObserver): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 调用接口类型 | -| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | +| observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 | **示例：** @@ -276,7 +332,7 @@ on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 调用接口类型 | -| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | +| observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 | | bundleNameList | Array | 是 | 表示需要注册监听的bundleName数组。最大值128。 | **示例：** @@ -362,7 +418,7 @@ off(type: "applicationState", observerId: number): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 调用接口类型 | -| observerId | number | 是 | 表示观察者的编号代码。 | +| observerId | number | 否 | 表示观察者的编号代码。 | **返回值：** @@ -419,7 +475,73 @@ getForegroundApplications(callback: AsyncCallback\>): void; app.getForegroundApplications(getForegroundApplicationsCallback); ``` -## appManager.getForegroundApplications +unregisterApplicationStateObserver(observerId: number): Promise\; + +取消注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observerId | number | 是 | 表示观察者的编号代码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```ts + var observerId = 100; + app.unregisterApplicationStateObserver(observerId) + .then((data) => { + console.log('----------- unregisterApplicationStateObserver success ----------', data); + }) + .catch((err) => { + console.log('----------- unregisterApplicationStateObserver fail ----------', err); + }) + ``` + +## appManager.getForegroundApplications9+ + +getForegroundApplications(callback: AsyncCallback\>): void; + +获取前台进程的应用程序。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 是 | 表示应用的状态数据。 | + +**示例：** + + ```ts + function getForegroundApplicationsCallback(err, data) { + if (err) { + console.log('--------- getForegroundApplicationsCallback fail ---------', err); + } else { + console.log('--------- getForegroundApplicationsCallback success ---------', data) + } + } + app.getForegroundApplications(getForegroundApplicationsCallback); + ``` + +## appManager.getForegroundApplications9+ getForegroundApplications(): Promise\>; @@ -439,17 +561,17 @@ getForegroundApplications(): Promise\>; **示例：** - ```js - app.getForegroundApplications() - .then((data) => { - console.log('--------- getForegroundApplications success -------', data); - }) - .catch((err) => { - console.log('--------- getForegroundApplications fail -------', err.code + ': ' + err.message); - }) + ```ts + app.getForegroundApplications() + .then((data) => { + console.log('--------- getForegroundApplications success -------', data); + }) + .catch((err) => { + console.log('--------- getForegroundApplications fail -------', err); + }) ``` -## appManager.killProcessWithAccount +## appManager.killProcessWithAccount9+ killProcessWithAccount(bundleName: string, accountId: number): Promise\ @@ -470,24 +592,20 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\ **示例：** -```js +```ts var bundleName = 'bundleName'; var accountId = 0; -try { - app.killProcessWithAccount(bundleName, accountId) - .then((data) => { +app.killProcessWithAccount(bundleName, accountId) + .then((data) => { console.log('------------ killProcessWithAccount success ------------', data); - }) - .catch((err) => { + }) + .catch((err) => { console.log('------------ killProcessWithAccount fail ------------', err); - }) -} catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); -} + }) ``` -## appManager.killProcessWithAccount +## appManager.killProcessWithAccount9+ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\): void @@ -509,7 +627,7 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal **示例：** -```js +```ts var bundleName = 'bundleName'; var accountId = 0; function killProcessWithAccountCallback(err, data) { @@ -519,14 +637,10 @@ function killProcessWithAccountCallback(err, data) { console.log('------------- killProcessWithAccountCallback success, data: --------------', data); } } -try { - app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); -} catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); -} +app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); ``` -## appManager.killProcessesByBundleName +## appManager.killProcessesByBundleName9+ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); @@ -547,23 +661,19 @@ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); **示例：** - ```js - var bundleName = 'bundleName'; - function killProcessesByBundleNameCallback(err, data) { - if (err) { - console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); - } else { - console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); - } - } - try { - app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); + ```ts + var bundleName = 'bundleName'; + function killProcessesByBundleNameCallback(err, data) { + if (err) { + console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); + } else { + console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); } + } + app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); ``` -## appManager.killProcessesByBundleName +## appManager.killProcessesByBundleName9+ killProcessesByBundleName(bundleName: string): Promise\; @@ -579,7 +689,7 @@ killProcessesByBundleName(bundleName: string): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| bundleName | string | 是| 表示包名。 | +| bundleName | string | 是 | 表示包名。 | **返回值：** @@ -589,23 +699,18 @@ killProcessesByBundleName(bundleName: string): Promise\; **示例：** - ```js + ```ts var bundleName = 'bundleName'; -try { - app.killProcessesByBundleName(bundleName) +app.killProcessesByBundleName(bundleName) .then((data) => { console.log('------------ killProcessesByBundleName success ------------', data); }) .catch((err) => { console.log('------------ killProcessesByBundleName fail ------------', err); }) -} catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); -} - ``` -## appManager.clearUpApplicationData +## appManager.clearUpApplicationData9+ clearUpApplicationData(bundleName: string, callback: AsyncCallback\); @@ -626,24 +731,19 @@ clearUpApplicationData(bundleName: string, callback: AsyncCallback\); **示例：** - ```js - var bundleName = 'bundleName'; - function clearUpApplicationDataCallback(err, data) { - if (err) { - console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); - } else { - console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); - } - } - try { - app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); + ```ts + var bundleName = 'bundleName'; + function clearUpApplicationDataCallback(err, data) { + if (err) { + console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); + } else { + console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); } - + } + app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); ``` -## appManager.clearUpApplicationData +## appManager.clearUpApplicationData9+ clearUpApplicationData(bundleName: string): Promise\; @@ -669,323 +769,18 @@ clearUpApplicationData(bundleName: string): Promise\; **示例：** - ```js + ```ts var bundleName = 'bundleName'; - try { - app.clearUpApplicationData(bundleName) - .then((data) => { + app.clearUpApplicationData(bundleName) + .then((data) => { console.log('------------ clearUpApplicationData success ------------', data); - }) - .catch((err) => { + }) + .catch((err) => { console.log('------------ clearUpApplicationData fail ------------', err); - }) - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } - + }) ``` -## ApplicationStateObserver.onForegroundApplicationChanged - -onForegroundApplicationChanged(appStateData: AppStateData): void; - -将在前台或后台应用程序更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| appStateData | [AppStateData](#appstatedata) | 否 | 状态更改的应用程序信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - try { - const observerCode = app.on("applicationState", applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } - -``` - -## ApplicationStateObserver.onAbilityStateChanged - -onAbilityStateChanged(abilityStateData: AbilityStateData): void; - -将在能力状态更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| abilityStateData | [AbilityStateData](#abilitystatedata) | 否 | 状态更改的能力信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - try { - const observerCode = app.on("applicationState", applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } -``` - -## ApplicationStateObserver.onProcessCreated - -onProcessCreated(processData: ProcessData): void; - -将在创建进程时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 否 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - try { - const observerCode = app.on("applicationState", applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } -``` - -## ApplicationStateObserver.onProcessDied - -onProcessDied(processData: ProcessData): void; - -将在进程终止时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 否 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - try { - const observerCode = app.on("applicationState", applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } -``` - -## ApplicationStateObserver.onProcessStateChanged - - onProcessStateChanged(processData: ProcessData): void; - -当进程状态更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 否 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - try { - const observerCode = app.on("applicationState", applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } -``` - -## AppStateData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | -| bundleName | 是 | 否 | string | 否 | 包名。 | -| uid | 是 | 否 | number | 否 | 用户ID。 | -| state | 是 | 否 | number | 否 | 应用状态。 | - -## AbilityStateData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid | number | 是 | 否 | 进程ID。 | -| bundleName | string | 是 | 否 | 应用包名。 | -| abilityName | string | 是 | 否 | Ability名称。 | -| uid | number | 是 | 否 | 用户ID。 | -| state | number | 是 | 否 | Ability状态。 | -| moduleName | string | 是 | 否 | Ability所属的HAP包的名称。 | -| abilityType | string | 是 | 否 | 能力类型、页面或服务等。 | - -## ProcessData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid | number | 是 | 否 | 进程ID。 | -| bundleName | string | 是 | 否 | 应用包名。 | -| uid | number | 是 | 否 | 用户ID。 | -| isContinuousTas | boolean | 是 | 否 | 判断过程是否为连续任务。 | -| isKeepAlive | boolean | 是 | 否 | 判断该过程是否保持活跃。 | - -## ProcessRunningInfo - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid | 是 | 否 | number | 否 | 进程ID。 | -| uid | 是 | 否 | number | 否 | 用户ID。 | -| processName | 是 | 否 | string | 否 | 进程的名称。 | -| bundleNames | 是 | 否 | Array\ | 否 | 进程中运行的bundleName数组。 | - -## ApplicationStateObserver - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| [onForegroundApplicationChanged](#applicationstateobserveronforegroundapplicationchanged) | AsyncCallback\ | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 | -| [onAbilityStateChanged](#applicationstateobserveronabilitystatechanged) | AsyncCallback\ | 是 | 否 | ability状态发生变化时执行的回调函数。 | -| [onProcessCreated](#applicationstateobserveronprocesscreated) | AsyncCallback\ | 是 | 否 | 进程创建时执行的回调函数。 | -| [onProcessDied](#applicationstateobserveronprocessdied) | AsyncCallback\ | 是 | 否 | 进程销毁时执行的回调函数。 | - -## ProcessRunningInformation - -进程的运行信息。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | -| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid | 是 | 否 | number | 否 | 进程ID。 | -| uid | 是 | 否 | number | 否 | 用户ID。 | -| processName | 是 | 否 | string | 否 | 进程的名称。 | -| bundleNames | 是 | 否 | Array\ | 否 | 进程中运行的bundleName数组。 | - -## ApplicationState +## ApplicationState9+ **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -999,7 +794,7 @@ onProcessDied(processData: ProcessData): void; | STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 | | STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 | -## ProcessState +## ProcessState9+ **系统能力**：SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md index a4d9aafa5fd89a16ba8840c7c7674ba4de4e693b..1f87ef14e76ebd855c43990ce2d84dbcb2ee3832 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md @@ -7,7 +7,7 @@ appRecovery模块提供了应用在故障状态下的恢复能力。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前版本仅支持单进程中单Ability的应用恢复。 ## 导入模块 -``` +```ts import appRecovery from '@ohos.app.ability.appRecovery' ``` @@ -78,7 +78,7 @@ export default class MyAbilityStage extends AbilityStage { restartApp(): void; -重启当前App进程，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用。 +重启当前App进程，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -99,7 +99,7 @@ var observer = { saveAppState(): boolean; -保存当前App状态，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用 +保存当前App状态，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -118,5 +118,4 @@ var observer = { appRecovery.saveAppState(); } } - ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md new file mode 100644 index 0000000000000000000000000000000000000000..e6137aebb793a24632cfd0eb3549bd422947bfea --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md @@ -0,0 +1,62 @@ +# Common + +Common模块将二级模块API组织在一起方便开发者进行导出。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用 + +## 导入模块 + +```ts +import common from '@ohos.app.ability.common' +``` + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase + +| 名称 | 类型 | 必填 | 说明 | +| ----------- | -------------------- | ---- | ------------------------------------------------------------ | +| UIAbilityContext | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 否 | UIAbilityContext二级模块。 | +| AbilityStageContext | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 | +| ApplicationContext | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 | +| BaseContext | [BaseContext](js-apis-inner-application-baseContext.md) | 否 | BaseContext二级模块。 | +| Context | [Context](js-apis-inner-application-context.md) | 否 | Context二级模块。 | +| ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 否 | ExtensionContext二级模块。 | +| FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 否 | FormExtensionContext二级模块。 | +| AreaMode | [AreaMode](#areamode) | 否 | AreaMode枚举值。 | +| EventHub | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 | +| PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 | +| PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 | +| AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 | +| ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 | + +**示例：** +```ts +import common from '@ohos.app.ability.common' + +let uiAbilityContext: common.UIAbilityContext; +let abilityStageContext: common.AbilityStageContext; +let applicationContext: common.ApplicationContext; +let baseContext: common.BaseContext; +let context: common.Context; +let extensionContext: common.ExtensionContext; +let formExtensionContext: common.FormExtensionContext; +let areaMode: common.AreaMode; +let eventHub: common.EventHub; +let permissionRequestResult: common.PermissionRequestResult; +let pacMap: common.PacMap; +let abilityResult: common.AbilityResult; +let connectOptions: common.ConnectOptions; +``` + +## AreaMode + +访问的文件分区，每个文件分区有对应自己的内容。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| --------------- | ---- | --------------- | +| EL1 | 0 | 设备级加密区。 | +| EL2 | 1 | 用户凭据加密区。默认为EL2。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md index 0d54a27d01945bd4530b44844ccbbeed80764eb9..6324254303644d708d1ca9c9eb0d85a0dc20cc15 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md @@ -17,7 +17,7 @@ import Configuration from '@ohos.app.ability.Configuration' | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language | string | 是 | 是 | 表示应用程序的当前语言。 | -| colorMode | [ColorMode](js-apis-app-ability-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | +| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | | direction | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | | screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | | displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationconstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationConstant.md similarity index 84% rename from zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationconstant.md rename to zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationConstant.md index 227c900fe14216c14119c5ab9f9c3b19b7e8a931..9250525023954ee7d1d25255e5e9458cee30676c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationconstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationConstant.md @@ -8,8 +8,7 @@ ConfigurationConstant模块提供配置信息枚举值定义的能力。 ## 导入模块 - -```js +```ts import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; ``` @@ -17,12 +16,6 @@ import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; 使用时通过ConfigurationConstant.ColorMode获取。 -**示例：** - -``` -ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 值 | 说明 | @@ -32,16 +25,10 @@ ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT | COLOR_MODE_LIGHT | 1 | 浅色模式。 | -## ConfigurationConstant.Direction +## ConfigurationConstant.Direction9+ 使用时通过ConfigurationConstant.Direction获取。 -**示例：** - -``` -ConfigurationConstant.Direction.DIRECTION_VERTICAL -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 值 | 说明 | @@ -51,16 +38,10 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL | DIRECTION_HORIZONTAL | 1 | 水平方向。 | -## ConfigurationConstant.ScreenDensity +## ConfigurationConstant.ScreenDensity9+ 使用时通过ConfigurationConstant.ScreenDensity获取。 -**示例：** - -``` -ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 值 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md new file mode 100644 index 0000000000000000000000000000000000000000..b64e0d35d838aae642e8986bcc99ccc8b5fba2f8 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md @@ -0,0 +1,25 @@ +# ContextConstant + +ContextConstant模块提供数据加密等级定义的能力。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 导入模块 + +```ts +import contextConstant from '@ohos.app.ability.contextConstant'; +``` + +## ContextConstant.AreaMode + +使用时通过ContextConstant.AreaMode获取。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| -------- | -------- | -------- | +| EL1 | 0 | 设备级加密区。 | +| EL2 | 1 | 用户凭据加密区。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-EnvironmentCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md old mode 100755 new mode 100644 similarity index 73% rename from zh-cn/application-dev/reference/apis/js-apis-app-ability-EnvironmentCallback.md rename to zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md index b2cf2d5f88cceccbe6052d6d170981fea0f35089..607978f6ba30774aed87430bff710d896339e833 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-EnvironmentCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md @@ -10,7 +10,7 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境 ## 导入模块 -```js +```ts import EnvironmentCallback from "@ohos.app.ability.EnvironmentCallback"; ``` @@ -27,13 +27,13 @@ onConfigurationUpdated(config: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-configuration.md) | 是 | 变化后的Configuration对象。 | + | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 变化后的Configuration对象。 | **示例：** - ```js -import Ability from "@ohos.app.ability.Ability"; + ```ts +import Ability from "@ohos.application.Ability"; var callbackId; @@ -49,18 +49,14 @@ export default class MyAbility extends Ability { // 1.获取applicationContext let applicationContext = globalThis.applicationContext; // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.on("environment", EnvironmentCallback); + callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); } onDestroy() { let applicationContext = globalThis.applicationContext; - try { - applicationContext.off("environment", callbackId, (error, data) => { - console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); - }); - } catch (paramError) { - console.log("error: " + paramError.code + ", " + paramError.message); - } + applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { + console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); + }); } } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-errorManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-errorManager.md index b1fa2e091453274448ed647a06d74d3235d6c31a..43a6a8e6d1835be75cf7dd2608211b39899ac385 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-errorManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-errorManager.md @@ -24,7 +24,7 @@ on(type: "error", observer: ErrorObserver): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 调用接口类型 | -| observer | [ErrorObserver](#errorobserver) | 是 | 返回观察者的数字代码。 | +| observer | [ErrorObserver](./js-apis-inner-application-errorObserver.md) | 是 | 返回观察者的数字代码。 | **示例：** @@ -112,28 +112,3 @@ try { } ``` - -## ErrorObserver - -onUnhandledException(errMsg: string): void; - -将在js运行时引发用户未捕获的异常时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| errMsg | string | 否 | 有关异常的消息和错误堆栈跟踪。 | - -**示例：** - -```js -var observer = { - onUnhandledException(errorMsg) { - console.log('onUnhandledException, errorMsg: ', errorMsg) - } -} -errorManager.on(observer) -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md new file mode 100644 index 0000000000000000000000000000000000000000..3dc4961effd5c1a0acf40b84bedaca3d1cdd92fb --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md @@ -0,0 +1,30 @@ +# ExtensionAbility + +ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 导入模块 + +```ts +import ExtensionAbility from '@ohos.app.ability.ExtensionAbility'; +``` + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**示例：** + + ```ts + class MyExtensionAbility extends ExtensionAbility { + onConfigurationUpdated(config) { + console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); + } + + onMemoryLevel(level) { + console.log('onMemoryLevel, level:' + JSON.stringify(level)); + } + } + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md index 5d52a9484587e64c924ba436c83296bf3bdac1c2..aa3241d8f53a43136c6c232c48d9ab011601e0f5 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md @@ -8,7 +8,7 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行 ## 导入模块 -``` +```ts import missionManager from '@ohos.app.ability.missionManager' ``` @@ -42,7 +42,7 @@ on(type:"mission", listener: MissionListener): number; **示例：** -```js +```ts var listener = { onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, @@ -81,7 +81,7 @@ off(type: "mission", listenerId: number, callback: AsyncCallback<void>): v **示例：** -```js +```ts var listener = { onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, @@ -129,7 +129,7 @@ off(type: "mission", listenerId: number): Promise<void>; **示例：** -```js +```ts var listener = { onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, @@ -173,7 +173,7 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<M **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -220,7 +220,7 @@ getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>; **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -255,7 +255,7 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Arr **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -297,7 +297,7 @@ getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionIn **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -328,11 +328,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback& | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | + | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -376,11 +376,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnaps | 类型 | 说明 | | -------- | -------- | - | Promise<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 任务快照信息。 | + | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -418,11 +418,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | + | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -466,11 +466,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\ { @@ -801,7 +801,7 @@ clearAllMissions(): Promise<void>; **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' missionManager.clearAllMissions().catch(function (err){ console.log(err); @@ -830,7 +830,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback<void>): void **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -867,12 +867,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | missionId | number | 是 | 任务ID。 | - | options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | + | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 | **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -909,7 +909,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | missionId | number | 是 | 任务ID。 | - | options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | + | options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | **返回值：** @@ -919,7 +919,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g **示例：** - ```js + ```ts import missionManager from '@ohos.app.ability.missionManager' try { @@ -953,7 +953,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g | runningState | number | 是 | 是 | 表示运行状态。 | | lockedState | boolean | 是 | 是 | 表示锁定状态。 | | timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 | -| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 是 | 表示任务的Want信息。 | | label | string | 是 | 是 | 表示任务的标签。 | | iconPath | string | 是 | 是 | 表示任务的图标路径。 | | continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md index 4ace0a546c0f3360c5efeb52d8ab5b266b21b079..0f2d943aa526835c41db0e62c38ae6fa5f71c028 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md @@ -8,7 +8,7 @@ quickFixManager模块提供快速修复的能力，快速修复是OpenHarmony提 ## 导入模块 -``` +```ts import quickFixManager from '@ohos.app.ability.quickFixManager'; ``` @@ -64,7 +64,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\, callback: AsyncCallback\): Promise\; **示例：** -```js +```ts import quickFixManager from '@ohos.app.ability.quickFixManager' let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] @@ -143,7 +143,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\ **说明：** > -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.ServiceExtensionAbility](js-apis-app-ability-serviceExtensionAbility.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -``` +```ts import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; ``` @@ -23,9 +23,9 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | +| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | ## ServiceExtensionAbility.onCreate @@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onCreate(want) { console.log('onCreate, want:' + want.abilityName); @@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onDestroy() { console.log('onDestroy'); @@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onRequest(want, startId) { console.log('onRequest, want:' + want.abilityName); @@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **返回值：** @@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC **示例：** - ```js + ```ts import rpc from '@ohos.rpc' class StubTest extends rpc.RemoteObject{ constructor(des) { @@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onDisconnect(want) { console.log('onDisconnect, want:' + want.abilityName); @@ -186,11 +186,11 @@ onReconnect(want: Want): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onReconnect(want) { console.log('onReconnect, want:' + want.abilityName); @@ -200,7 +200,7 @@ onReconnect(want: Want): void; ## ServiceExtensionAbility.onConfigurationUpdate -onConfigurationUpdate(newConfig: Configuration): void; +onConfigurationUpdate(config: Configuration): void; 当Extension更新配置信息时调用。 @@ -212,11 +212,11 @@ onConfigurationUpdate(newConfig: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | + | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onConfigurationUpdate(config) { console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); @@ -230,7 +230,7 @@ onDump(params: Array\): Array\; 转储客户端信息时调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **系统API**: 此接口为系统接口，三方应用不支持调用。 @@ -242,7 +242,7 @@ onDump(params: Array\): Array\; **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onDump(params) { console.log('dump, params:' + JSON.stringify(params)); diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md similarity index 83% rename from zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md rename to zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md index a1059d171aac46bce10d803700f17746eb9b650e..4b13c1aaea72b8b1b9c0209b78e724e81be952e0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md @@ -9,15 +9,16 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力 ## 导入模块 -``` +```ts import StartOptions from '@ohos.app.ability.StartOptions'; ``` ## 属性 + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| [windowMode](js-apis-window.md#windowmodesup7sup) | number | 否 | 窗口模式。 | +| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 | | displayId | number | 否 | 显示ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md new file mode 100644 index 0000000000000000000000000000000000000000..52dbfec46bc28a8e36d3f59f1ea4110b09fa7e07 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md @@ -0,0 +1,700 @@ +# Ability + +Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 + +该模块提供以下Ability相关的常用功能： + +- [Caller](#caller)：通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。 +- [Callee](#callee)：通用组件服务端注册和解除客户端caller通知送信的callback接口。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 导入模块 + +```ts +import Ability from '@ohos.app.ability.UIAbility'; +``` + +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | +| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 | +| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。| +| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| + +## Ability.onCreate + +onCreate(want: Want, param: AbilityConstant.LaunchParam): void; + +Ability创建时回调，执行初始化业务逻辑操作。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | + | param | AbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | + +**示例：** + + ```ts + class myAbility extends Ability { + onCreate(want, param) { + console.log('onCreate, want:' + want.abilityName); + } + } + ``` + + +## Ability.onWindowStageCreate + +onWindowStageCreate(windowStage: window.WindowStage): void + +当WindowStage创建后调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + +**示例：** + + ```ts + class myAbility extends Ability { + onWindowStageCreate(windowStage) { + console.log('onWindowStageCreate'); + } + } + ``` + + +## Ability.onWindowStageDestroy + +onWindowStageDestroy(): void + +当WindowStage销毁后调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**示例：** + + ```ts + class myAbility extends Ability { + onWindowStageDestroy() { + console.log('onWindowStageDestroy'); + } + } + ``` + + +## Ability.onWindowStageRestore + +onWindowStageRestore(windowStage: window.WindowStage): void + +当迁移多实例ability时，恢复WindowStage后调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + +**示例：** + + ```ts + class myAbility extends Ability { + onWindowStageRestore(windowStage) { + console.log('onWindowStageRestore'); + } + } + ``` + + +## Ability.onDestroy + +onDestroy(): void; + +Ability生命周期回调，在销毁时回调，执行资源清理等操作。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**示例：** + + ```ts + class myAbility extends Ability { + onDestroy() { + console.log('onDestroy'); + } + } + ``` + + +## Ability.onForeground + +onForeground(): void; + +Ability生命周期回调，当应用从后台转到前台时触发。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**示例：** + + ```ts + class myAbility extends Ability { + onForeground() { + console.log('onForeground'); + } + } + ``` + + +## Ability.onBackground + +onBackground(): void; + +Ability生命周期回调，当应用从前台转到后台时触发。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**示例：** + + ```ts + class myAbility extends Ability { + onBackground() { + console.log('onBackground'); + } + } + ``` + + +## Ability.onContinue + +onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; + +当ability迁移准备迁移时触发，保存数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | wantParam | {[key: string]: any} | 是 | want相关参数。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | AbilityConstant.OnContinueResult | 继续的结果。 | + +**示例：** + + ```ts + import AbilityConstant from "@ohos.application.AbilityConstant" + class myAbility extends Ability { + onContinue(wantParams) { + console.log('onContinue'); + wantParams["myData"] = "my1234567"; + return AbilityConstant.OnContinueResult.AGREE; + } + } + ``` + + +## Ability.onNewWant + +onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; + +当ability的启动模式设置为单例时回调会被调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 | + | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | + +**示例：** + + ```ts + class myAbility extends Ability { + onNewWant(want) { + console.log('onNewWant, want:' + want.abilityName); + } + } + ``` + +## Ability.onDump + +onDump(params: Array\): Array\; + +转储客户端信息时调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | params | Array\ | 是 | 表示命令形式的参数。| + +**示例：** + + ```ts + class myAbility extends Ability { + onDump(params) { + console.log('dump, params:' + JSON.stringify(params)); + return ["params"] + } + } + ``` + + +## Ability.onSaveState + +onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult; + +该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存Ability状态。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | reason | [AbilityConstant.StateType](js-apis-application-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 | + | wantParam | {[key: string]: any} | 是 | want相关参数。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 | + +**示例：** + + ```ts +import AbilityConstant from '@ohos.application.AbilityConstant' + +class myAbility extends Ability { + onSaveState(reason, wantParam) { + console.log('onSaveState'); + wantParam["myData"] = "my1234567"; + return AbilityConstant.OnSaveResult.RECOVERY_AGREE; + } +} + ``` + + + +## Caller + +通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。 + +## Caller.call + +call(method: string, data: rpc.Sequenceable): Promise<void>; + +向通用组件服务端发送约定序列化数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | method | string | 是 | 约定的服务端注册事件字符串。 | + | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | Promise形式返回应答。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + class MyMessageAble{ // 自定义的Sequenceable数据结构 + name:"" + str:"" + num: 1 + constructor(name, str) { + this.name = name; + this.str = str; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + }; + var method = 'call_Function'; // 约定的通知消息字符串 + var caller; + export default class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + let msg = new MyMessageAble("msg", "world"); // 参考Sequenceable数据定义 + caller.call(method, msg) + .then(() => { + console.log('Caller call() called'); + }) + .catch((callErr) => { + console.log('Caller.call catch error, error.code: ' + JSON.stringify(callErr.code) + + ' error.message: ' + JSON.stringify(callErr.message)); + }); + }).catch((err) => { + console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` + + +## Caller.callWithResult + +callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel>; + +向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | method | string | 是 | 约定的服务端注册事件字符串。 | + | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + class MyMessageAble{ + name:"" + str:"" + num: 1 + constructor(name, str) { + this.name = name; + this.str = str; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + }; + var method = 'call_Function'; + var caller; + export default class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + let msg = new MyMessageAble(1, "world"); + caller.callWithResult(method, msg) + .then((data) => { + console.log('Caller callWithResult() called'); + let retmsg = new MyMessageAble(0, ""); + data.readSequenceable(retmsg); + }) + .catch((callErr) => { + console.log('Caller.callWithResult catch error, error.code: ' + JSON.stringify(callErr.code) + + ' error.message: ' + JSON.stringify(callErr.message)); + }); + }).catch((err) => { + console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` + + +## Caller.release + +release(): void; + +主动释放通用组件服务端的通信接口。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | Invalid input parameter. | +| 16200001 | Caller released. The caller has been released. | +| 16200002 | Callee invalid. The callee does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + var caller; + export default class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + try { + caller.release(); + } catch (releaseErr) { + console.log('Caller.release catch error, error.code: ' + JSON.stringify(releaseErr.code) + + ' error.message: ' + JSON.stringify(releaseErr.message)); + } + }).catch((err) => { + console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` + + +## Caller.on + + on(type: "release", callback: OnReleaseCallback): void; + +注册通用组件服务端Stub（桩）断开监听通知。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 监听releaseCall事件，固定为'release'。 | + | callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + var caller; + export default class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + try { + caller.on("release", (str) => { + console.log(' Caller OnRelease CallBack is called ' + str); + }); + } catch (error) { + console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + } + }).catch((err) => { + console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` + + +## Callee + +通用组件服务端注册和解除客户端caller通知送信的callback接口。 + +## Callee.on + +on(method: string, callback: CalleeCallback): void; + +通用组件服务端注册消息通知callback。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | method | string | 是 | 与客户端约定的通知消息字符串。 | + | callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + class MyMessageAble{ + name:"" + str:"" + num: 1 + constructor(name, str) { + this.name = name; + this.str = str; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']'); + return true; + } + }; + var method = 'call_Function'; + function funcCallBack(pdata) { + console.log('Callee funcCallBack is called ' + pdata); + let msg = new MyMessageAble("test", ""); + pdata.readSequenceable(msg); + return new MyMessageAble("test1", "Callee test"); + } + export default class MainAbility extends Ability { + onCreate(want, launchParam) { + console.log('Callee onCreate is called'); + try { + this.callee.on(method, funcCallBack); + } catch (error) { + console.log('Callee.on catch error, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + } + } + } + ``` + +## Callee.off + +off(method: string): void; + +解除通用组件服务端注册消息通知callback。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | method | string | 是 | 已注册的通知事件字符串。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + + +**示例：** + + ```ts + import Ability from '@ohos.app.ability.UIAbility'; + var method = 'call_Function'; + export default class MainAbility extends Ability { + onCreate(want, launchParam) { + console.log('Callee onCreate is called'); + try { + this.callee.off(method); + } catch (error) { + console.log('Callee.off catch error, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + } + } + } + ``` + +## OnReleaseCallback + +(msg: string): void; + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +| 名称 | 可读 | 可写 | 类型 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 | + +## CalleeCallback + +(indata: rpc.MessageParcel): rpc.Sequenceable; + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +| 名称 | 可读 | 可写 | 类型 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md new file mode 100644 index 0000000000000000000000000000000000000000..006fa77174247cffc574fe386db4ee7e7ded5431 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md @@ -0,0 +1,136 @@ +# Want + +Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import Want from '@ohos.app.ability.Want'; +``` + +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase + +| 名称 | 类型 | 必填 | 说明 | +| ----------- | -------------------- | ---- | ------------------------------------------------------------ | +| deviceId | string | 否 | 表示运行指定Ability的设备ID。 | +| bundleName | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | +| abilityName | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | +| uri | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | +| type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | +| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | +| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | +| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | +| entities | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | +| moduleName | string | 否 | 表示待启动的Ability所属的模块（module）。 | + +**示例：** + +- 基础用法 + + ```ts + var want = { + "deviceId": "", // deviceId为空表示本设备 + "bundleName": "com.extreme.test", + "abilityName": "MainAbility", + "moduleName": "entry" // moduleName非必选 + }; + this.context.startAbility(want, (error) => { + // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability + console.log("error.code = " + error.code) + }) + ``` + +- 通过自定字段传递数据, 以下为当前支持类型。 + + * 字符串（String） + ```ts + let want = { + bundleName: "com.example.demo", + abilityName: "com.example.demo.MainAbility", + parameters: { + keyForString: "str", + }, + } + ``` + * 数字（Number） + ```ts + let want = { + bundleName: "com.example.demo", + abilityName: "com.example.demo.MainAbility", + parameters: { + keyForInt: 100, + keyForDouble: 99.99, + }, + } + ``` + * 布尔（Boolean） + ```ts + let want = { + bundleName: "com.example.demo", + abilityName: "com.example.demo.MainAbility", + parameters: { + keyForBool: true, + }, + } + ``` + * 对象（Object） + ```ts + let want = { + bundleName: "com.example.demo", + abilityName: "com.example.demo.MainAbility", + parameters: { + keyForObject: { + keyForObjectString: "str", + keyForObjectInt: -200, + keyForObjectDouble: 35.5, + keyForObjectBool: false, + }, + }, + } + ``` + * 数组（Array） + ```ts + let want = { + bundleName: "com.example.demo", + abilityName: "com.example.demo.MainAbility", + parameters: { + keyForArrayString: ["str1", "str2", "str3"], + keyForArrayInt: [100, 200, 300, 400], + keyForArrayDouble: [0.1, 0.2], + keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}], + }, + } + ``` + * 文件描述符（FD） + ```ts + import fileio from '@ohos.fileio'; + var fd; + try { + fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); + } catch(e) { + console.log("openSync fail:" + JSON.stringify(e)); + } + var want = { + "deviceId": "", // deviceId为空表示本设备 + "bundleName": "com.extreme.test", + "abilityName": "MainAbility", + "moduleName": "entry", // moduleName非必选 + "parameters": { + "keyFd":{"type":"FD", "value":fd} + } + }; + this.context.startAbility(want, (error) => { + // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability + console.log("error.code = " + error.code) + }) + ``` + + + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md index 2966bad9ff16633292c517fc6aa9bfd1e963b87d..55f6b9b286e49ddbb8e875a47f4e5eb9602f3f81 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md @@ -1132,16 +1132,16 @@ try { | 名称 | 值 | 说明 | | ------------------- | -------------- | ------------------------------------------------------------ | -| ONE_TIME_FLAG | WantAgentFlags | WantAgent仅能使用一次。 | -| NO_BUILD_FLAG | WantAgentFlags | 如果描述WantAgent对象不存在，则不创建它，直接返回null。 | -| CANCEL_PRESENT_FLAG | WantAgentFlags | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。 | -| UPDATE_PRESENT_FLAG | WantAgentFlags | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。 | -| CONSTANT_FLAG | WantAgentFlags | WantAgent是不可变的。 | -| REPLACE_ELEMENT | WantAgentFlags | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 | -| REPLACE_ACTION | WantAgentFlags | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 | -| REPLACE_URI | WantAgentFlags | 当前Want中的uri属性可被WantAgent.trigger()中Want的uri属性取代 | -| REPLACE_ENTITIES | WantAgentFlags | 当前Want中的entities属性可被WantAgent.trigger()中Want的entities属性取代 | -| REPLACE_BUNDLE | WantAgentFlags | 当前Want中的bundleName属性可被WantAgent.trigger()中Want的bundleName属性取代 | +| ONE_TIME_FLAG | 0 | WantAgent仅能使用一次。 | +| NO_BUILD_FLAG | 1 | 如果描述WantAgent对象不存在，则不创建它，直接返回null。 | +| CANCEL_PRESENT_FLAG | 2 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。 | +| UPDATE_PRESENT_FLAG | 3 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。 | +| CONSTANT_FLAG | 4 | WantAgent是不可变的。 | +| REPLACE_ELEMENT | 5 | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 | +| REPLACE_ACTION | 6 | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 | +| REPLACE_URI | 7 | 当前Want中的uri属性可被WantAgent.trigger()中Want的uri属性取代 | +| REPLACE_ENTITIES | 8 | 当前Want中的entities属性可被WantAgent.trigger()中Want的entities属性取代 | +| REPLACE_BUNDLE | 9 | 当前Want中的bundleName属性可被WantAgent.trigger()中Want的bundleName属性取代 | @@ -1151,11 +1151,11 @@ try { | 名称 | 值 | 说明 | | ----------------- | ------------- | ------------------------- | -| UNKNOWN_TYPE | OperationType | 不识别的类型。 | -| START_ABILITY | OperationType | 开启一个有页面的Ability。 | -| START_ABILITIES | OperationType | 开启多个有页面的Ability。 | -| START_SERVICE | OperationType | 开启一个无页面的ability。 | -| SEND_COMMON_EVENT | OperationType | 发送一个公共事件。 | +| UNKNOWN_TYPE | 0 | 不识别的类型。 | +| START_ABILITY | 1 | 开启一个有页面的Ability。 | +| START_ABILITIES | 2 | 开启多个有页面的Ability。 | +| START_SERVICE | 3 | 开启一个无页面的ability。 | +| SEND_COMMON_EVENT | 4 | 发送一个公共事件。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md index aa11c2d7c8e5b69cd143e9cf6c48c2a3c7feda13..603a0ce3a0a4c71da7e18e9cad23e61fe72a1972 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md @@ -33,8 +33,8 @@ want操作的常数。 | ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 指示启动页面功能以关闭计时器的操作。 | | ACTION_SEND_SMS | ohos.want.action.sendSms | 指示启动发送sms的页面功能的操作。 | | ACTION_CHOOSE | ohos.want.action.choose | 指示启动页面功能以打开联系人或图片的操作。 | -| ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 | -| ACTION_VIDEO_CAPTURE8+ | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 | +| ACTION_IMAGE_CAPTURE | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 | +| ACTION_VIDEO_CAPTURE | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 | | ACTION_SELECT | ohos.want.action.select | 指示显示应用程序选择对话框的操作。 | | ACTION_SEND_DATA | ohos.want.action.sendData | 指示发送单个数据记录的操作。 | | ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 指示发送多个数据记录的操作。 | @@ -44,8 +44,7 @@ want操作的常数。 | INTENT_PARAMS_INTENT | ability.want.params.INTENT | 指示用行为选择器来展示选择的操作。 | | INTENT_PARAMS_TITLE | ability.want.params.TITLE | 指示与行为选择器一起使用时的字符序列对话框标题。 | | ACTION_FILE_SELECT | ohos.action.fileSelect | 指示选择文件的操作。 | -| PARAMS_STREAM | ability.params.stream | 指示发送数据时与目标关联的数据流的URI | -| ACTION_APP_ACCOUNT_OAUTH | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 | +| PARAMS_STREAM | ability.params.stream | 指示发送数据时与目标关联的数据流的URI | | | ACTION_APP_ACCOUNT_AUTH | account.appAccount.action.auth | 指示提供auth服务的操作。 | | ACTION_MARKET_DOWNLOAD | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | | ACTION_MARKET_CROWDTEST | ohos.want.action.marketCrowdTest | 指示从应用程序市场众测应用程序的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | 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 e7fd328da252d41f4261535aa1d69eabaf09606d..b4fb8ec0721903bfd1593390c2e737b645ab6ae5 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 @@ -8,7 +8,7 @@ ## 导入模块 -``` +```ts import formBindingData from '@ohos.app.form.formBindingData'; ``` @@ -47,7 +47,7 @@ createFormBindingData(obj?: Object | string): FormBindingData **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; import fileio from '@ohos.fileio'; let context=featureAbility.getContext(); 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 902ffdecc3e6592df4017991bfc6082efc3362a4..e5555f3e0c5977014e086499e0a501291f562d0b 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 @@ -9,7 +9,7 @@ FormExtensionAbility模块提供了卡片扩展相关接口。 ## 导入模块 -``` +```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ``` @@ -19,7 +19,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; | 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | +| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | ## onAddForm @@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | +| want | [Want](js-apis-application-want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | **返回值：** @@ -43,7 +43,7 @@ onAddForm(want: Want): formBindingData.FormBindingData **示例：** -```js +```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; export default class MyFormExtensionAbility extends FormExtensionAbility { onAddForm(want) { @@ -74,7 +74,7 @@ onCastToNormalForm(formId: string): void **示例：** -```js +```ts export default class MyFormExtensionAbility extends FormExtensionAbility { onCastToNormalForm(formId) { console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId); @@ -86,7 +86,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { onUpdateForm(formId: string): void -卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。 +卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。 **系统能力**：SystemCapability.Ability.Form @@ -98,7 +98,7 @@ onUpdateForm(formId: string): void **示例：** -```js +```ts import formBindingData from '@ohos.app.form.formBindingData' export default class MyFormExtensionAbility extends FormExtensionAbility { onUpdateForm(formId) { @@ -128,7 +128,7 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void **示例：** -```js +```ts import formBindingData from '@ohos.app.form.formBindingData' export default class MyFormExtensionAbility extends FormExtensionAbility { onChangeFormVisibility(newStatus) { @@ -163,7 +163,7 @@ onFormEvent(formId: string, message: string): void **示例：** -```js +```ts export default class MyFormExtension extends FormExtensionAbility { onFormEvent(formId, message) { console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message); @@ -187,7 +187,7 @@ onRemoveForm(formId: string): void **示例：** -```js +```ts export default class MyFormExtensionAbility extends FormExtensionAbility { onRemoveForm(formId) { console.log('FormExtensionAbility onRemoveForm, formId:' + formId); @@ -211,7 +211,7 @@ onConfigurationUpdate(newConfig: Configuration): void; **示例：** -```js +```ts class MyFormExtensionAbility extends FormExtensionAbility { onConfigurationUpdate(config) { console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); @@ -231,11 +231,11 @@ onAcquireFormState?(want: Want): formInfo.FormState; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | +| want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | **示例：** -```js +```ts import formInfo from '@ohos.app.form.formInfo'; class MyFormExtensionAbility extends FormExtensionAbility { onAcquireFormState(want) { @@ -269,7 +269,7 @@ onShareForm?(formId: string): { [key: string]: any } **示例：** -```js +```ts class MyFormExtensionAbility extends FormExtensionAbility { onShareForm(formId) { console.log('FormExtensionAbility onShareForm, formId:' + formId); 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 08b84e8668156d137620cc598441706f4b1fa2f2..21017c8932f32ba3146f784026647c3c78945f87 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 @@ -9,7 +9,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方 ## 导入模块 -``` +```ts import formHost from '@ohos.app.form.formHost'; ``` @@ -35,11 +35,11 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.deleteForm(formId, (error, data) => { @@ -83,11 +83,11 @@ deleteForm(formId: string): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **参数：** -```js +```ts try { var formId = "12400633174999288"; formHost.deleteForm(formId).then(() => { @@ -122,11 +122,11 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.releaseForm(formId, (error, data) => { @@ -162,11 +162,11 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.releaseForm(formId, true, (error, data) => { @@ -207,11 +207,11 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.releaseForm(formId, true).then(() => { @@ -246,11 +246,11 @@ requestForm(formId: string, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.requestForm(formId, (error, data) => { @@ -290,11 +290,11 @@ requestForm(formId: string): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.requestForm(formId).then(() => { @@ -330,11 +330,11 @@ castToNormalForm(formId: string, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.castToNormalForm(formId, (error, data) => { @@ -374,11 +374,11 @@ castToNormalForm(formId: string): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.castToNormalForm(formId).then(() => { @@ -413,11 +413,11 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.notifyVisibleForms(formId, (error, data) => { @@ -457,11 +457,11 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.notifyVisibleForms(formId).then(() => { @@ -496,11 +496,11 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.notifyInvisibleForms(formId, (error, data) => { @@ -540,11 +540,11 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.notifyInvisibleForms(formId).then(() => { @@ -579,11 +579,11 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.enableFormsUpdate(formId, (error, data) => { @@ -623,11 +623,11 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.enableFormsUpdate(formId).then(() => { @@ -662,11 +662,11 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.disableFormsUpdate(formId, (error, data) => { @@ -706,11 +706,11 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { var formId = ["12400633174999288"]; formHost.disableFormsUpdate(formId).then(() => { @@ -739,7 +739,7 @@ isSystemReady(callback: AsyncCallback<void>): void **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.isSystemReady((error, data) => { @@ -768,7 +768,7 @@ isSystemReady(): Promise<void> **示例：** -```js +```ts try { var formId = "12400633174999288"; formHost.isSystemReady().then(() => { @@ -795,11 +795,11 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **示例：** -```js +```ts try { formHost.getAllFormsInfo((error, data) => { if (error) { @@ -827,11 +827,11 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象，返回查询到的卡片信息。 | +| Promise<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | Promise对象，返回查询到的卡片信息。 | **示例：** -```js +```ts try { formHost.getAllFormsInfo().then((data) => { console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); @@ -858,18 +858,18 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { if (error) { @@ -899,18 +899,18 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< | ------ | ------ | ---- | ------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | | moduleName | string | 是 | 要查询的模块名称。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { if (error) { @@ -945,18 +945,18 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象，返回查询到的卡片信息。 | +| Promise<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | Promise对象，返回查询到的卡片信息。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); @@ -987,7 +987,7 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb **示例：** -```js +```ts try { var formIds = new Array("12400633174999288", "12400633174999289"); formHost.deleteInvalidForms(formIds, (error, data) => { @@ -1026,7 +1026,7 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> **示例：** -```js +```ts try { var formIds = new Array("12400633174999288", "12400633174999289"); formHost.deleteInvalidForms(formIds).then((data) => { @@ -1053,19 +1053,19 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | -| callback | AsyncCallback<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | +| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | +| callback | AsyncCallback<[FormStateInfo](js-apis-app-form-forminfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var want = { "deviceId": "", "bundleName": "ohos.samples.FormApplication", @@ -1103,24 +1103,24 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | Promise对象，返回卡片状态。 | +| Promise<[FormStateInfo](js-apis-app-form-forminfo.md#formstateinfo)> | Promise对象，返回卡片状态。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var want = { "deviceId": "", "bundleName": "ohos.samples.FormApplication", @@ -1159,7 +1159,7 @@ on(type: "formUninstall", callback: Callback<string>): void **示例：** -```js +```ts let callback = function(formId) { console.log('formHost on formUninstall, formId:' + formId); } @@ -1183,7 +1183,7 @@ off(type: "formUninstall", callback?: Callback<string>): void **示例：** -```js +```ts let callback = function(formId) { console.log('formHost on formUninstall, formId:' + formId); } @@ -1213,11 +1213,11 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); try { formHost.notifyFormsVisible(formIds, true, (error, data) => { @@ -1258,11 +1258,11 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise< | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); try { formHost.notifyFormsVisible(formIds, true).then(() => { @@ -1298,11 +1298,11 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); try { formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { @@ -1343,11 +1343,11 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); try { formHost.notifyFormsEnableUpdate(formIds, true).then(() => { @@ -1382,12 +1382,12 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>) | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formId = "12400633174999288"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; try { @@ -1429,11 +1429,11 @@ shareForm(formId: string, deviceId: string): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **参数：** -```js +```ts var formId = "12400633174999288"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; try { @@ -1462,7 +1462,7 @@ notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean, callb | formId | string | 是 | 卡片标识。 | | deviceId | string | 是 | 远程设备标识。 | -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); try { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md index 34a4a5b3328c6ceb6916ee3deff7a1d9fd7d5c0d..b19dc03d379beae42c381f15353646f569559951 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md @@ -8,7 +8,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询 ## 导入模块 -``` +```ts import formInfo from '@ohos.app.form.formInfo'; ``` @@ -93,7 +93,7 @@ import formInfo from '@ohos.app.form.formInfo'; | 名称 | 值 | 说明 | | ----------- | ---- | ------------ | -| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。
**系统接口**: 此接口为系统接口。 | +| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。 | | DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式。 | | NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称。 | | MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 | 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 63207234e439130de606c06253c432bdfefe4617..8a3149afde470a52b5c7f6f9dd854a9c2dbbd3f2 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 @@ -7,7 +7,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在 ## 导入模块 -``` +```ts import formProvider from '@ohos.app.form.formProvider'; ``` @@ -32,11 +32,11 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formId = "12400633174999288"; try { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { @@ -77,11 +77,11 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var formId = "12400633174999288"; try { formProvider.setFormNextRefreshTime(formId, 5).then(() => { @@ -107,7 +107,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | formId | string | 是 | 请求更新的卡片标识。 | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | +| formBindingData.FormBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | **错误码：** @@ -115,11 +115,11 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData'; var formId = "12400633174999288"; try { @@ -149,7 +149,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | formId | string | 是 | 请求更新的卡片标识。 | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | +| formBindingData.FormBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | **返回值：** @@ -162,11 +162,11 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData'; var formId = "12400633174999288"; let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); @@ -193,19 +193,19 @@ getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): voi | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | 是 | 回调函数。返回查询到的卡片信息。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts try { formProvider.getFormsInfo((error, data) => { if (error) { @@ -230,19 +230,19 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | +| filter | [formInfo.FormInfoFilter](js-apis-app-form-forminfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. @@ -273,24 +273,24 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 卡片信息过滤器。 | +| filter | [formInfo.FormInfoFilter](js-apis-app-form-forminfo.md#forminfofilter) | 否 | 卡片信息过滤器。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | +| Promise<Array<[FormInfo](js-apis-app-form-forminfo.md)>> | Promise对象。返回查询到符合条件的卡片信息。 | **错误码：** | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. @@ -321,8 +321,8 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| formBindingData.FormBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | | callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | **错误码：** @@ -330,11 +330,11 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData'; var want = { abilityName: "FormAbility", @@ -372,7 +372,7 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | | callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | **错误码：** @@ -380,11 +380,11 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var want = { abilityName: "FormAbility", parameters: { @@ -421,8 +421,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData | 参数名 | 类型 | 必填 | 说明 | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| formBindingData.FormBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | **返回值：** @@ -435,11 +435,11 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData | 错误码ID | 错误信息 | | -------- | -------- | | 401 | If the input parameter is not valid parameter. | -以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-form.md)。 +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** -```js +```ts var want = { abilityName: "FormAbility", parameters: { @@ -477,7 +477,7 @@ isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void **示例：** -```js +```ts try { formProvider.isRequestPublishFormSupported((error, isSupported) => { if (error) { @@ -530,7 +530,7 @@ isRequestPublishFormSupported(): Promise<boolean> **示例：** -```js +```ts try { formProvider.isRequestPublishFormSupported().then((isSupported) => { if (isSupported) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index 60639f1d02161c02e9a9273845eb514bb3cdc686..599bdfcc6c372882d0cd8816b26b9c3aea14ffda 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -14,7 +14,7 @@ Ability模块提供对Ability生命周期、上下文环境等调用管理的能 ## 导入模块 -``` +```ts import Ability from '@ohos.application.Ability'; ``` @@ -24,9 +24,9 @@ import Ability from '@ohos.application.Ability'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [AbilityContext](js-apis-ability-context.md) | 是 | 否 | 上下文。 | -| launchWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability启动时的参数。 | -| lastRequestWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability最后请求时的参数。| +| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | +| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 | +| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。| | callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| ## Ability.onCreate @@ -41,7 +41,7 @@ Ability创建时回调，执行初始化业务逻辑操作。 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | | param | AbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | **示例：** @@ -227,7 +227,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，如ability名称，包名等。 | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 | | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | **示例：** @@ -240,31 +240,6 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; } ``` - -## Ability.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -当系统配置更新时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | - -**示例：** - - ```ts - class myAbility extends Ability { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); - } - } - ``` - ## Ability.dump dump(params: Array\): Array\; @@ -290,30 +265,6 @@ dump(params: Array\): Array\; } ``` -## Ability.onMemoryLevel - -onMemoryLevel(level: AbilityConstant.MemoryLevel): void; - -当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| - -**示例：** - - ```ts - class myAbility extends Ability { - onMemoryLevel(level) { - console.log('onMemoryLevel, level:' + JSON.stringify(level)); - } - } - ``` - ## Ability.onSaveState @@ -338,7 +289,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}) **示例：** - ```js + ```ts import AbilityConstant from '@ohos.application.AbilityConstant' class myAbility extends Ability { @@ -390,7 +341,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; class MyMessageAble{ // 自定义的Sequenceable数据结构 name:"" str:"" @@ -474,7 +425,7 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; class MyMessageAble{ name:"" str:"" @@ -546,7 +497,7 @@ release(): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; var caller; export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -570,9 +521,9 @@ release(): void; } ``` -## Caller.on +## Caller.onRelease - on(type: "release", callback: OnReleaseCallback): void; + onRelease(callback: OnReleaseCallBack): void; 注册通用组件服务端Stub（桩）断开监听通知。 @@ -582,21 +533,12 @@ release(): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 监听releaseCall事件，固定为'release'。 | - | callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------- | -| 401 | Invalid input parameter. | -| 16200001 | Caller released. The caller has been released. | -| 16000050 | Internal Error. | + | callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; var caller; export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -607,7 +549,7 @@ release(): void; }).then((obj) => { caller = obj; try { - caller.on("release", (str) => { + caller.onRelease((str) => { console.log(' Caller OnRelease CallBack is called ' + str); }); } catch (error) { @@ -653,7 +595,7 @@ on(method: string, callback: CalleeCallBack): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; class MyMessageAble{ name:"" str:"" @@ -678,9 +620,9 @@ on(method: string, callback: CalleeCallBack): void; var method = 'call_Function'; function funcCallBack(pdata) { console.log('Callee funcCallBack is called ' + pdata); - let msg = new MyMessageAble(0, ""); + let msg = new MyMessageAble("test", ""); pdata.readSequenceable(msg); - return new MyMessageAble(10, "Callee test"); + return new MyMessageAble("test1", "Callee test"); } export default class MainAbility extends Ability { onCreate(want, launchParam) { @@ -721,7 +663,7 @@ off(method: string): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; + import Ability from '@ohos.application.Ability'; var method = 'call_Function'; export default class MainAbility extends Ability { onCreate(want, launchParam) { @@ -736,7 +678,7 @@ off(method: string): void; } ``` -## OnReleaseCallback +## OnReleaseCallBack (msg: string): void; @@ -746,7 +688,7 @@ off(method: string): void; | -------- | -------- | -------- | -------- | -------- | | (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 | -## CalleeCallback +## CalleeCallBack (indata: rpc.MessageParcel): rpc.Sequenceable; @@ -754,4 +696,4 @@ off(method: string): void; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 | +| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index ea4b5d4a263390d6e3895548956d987b1b5e02b6..cee27c5054fa6cf05511fa668f25f376bf2fbed1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始 ## 导入模块 -```js +```ts import AbilityConstant from '@ohos.application.AbilityConstant'; ``` @@ -70,7 +70,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 取值 | 说明 | +| 名称 | 值 | 说明 | | --- | --- | --- | | WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 | | WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 | @@ -84,7 +84,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 取值 | 说明 | +| 名称 | 值 | 说明 | | --- | --- | --- | | MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 | | MEMORY_LEVEL_LOW | 1 | 内存占用低。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md similarity index 82% rename from zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md rename to zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md index 1f252068811dfc1a90dfc1b0a64d72e363fd057a..488b266d0cff1262aea623ce5d31870d02bebb99 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md @@ -1,74 +1,72 @@ -# AbilityDelegatorRegistry - -AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```js -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' -``` - -## AbilityLifecycleState - -Ability生命周期状态。 - -**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ------------- | ---- | --------------------------- | -| UNINITIALIZED | 0 | 表示无效状态。 | -| CREATE | 1 | 表示Ability处于已创建状态。 | -| FOREGROUND | 2 | 表示Ability处于前台状态。 | -| BACKGROUND | 3 | 表示Ability处于后台状态。 | -| DESTROY | 4 | 表示Ability处于已销毁状态。 | - -## AbilityDelegatorRegistry.getAbilityDelegator - -getAbilityDelegator(): AbilityDelegator - -获取应用程序的AbilityDelegator对象 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 | - -**示例：** - -```js -var abilityDelegator; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -``` - - - -## AbilityDelegatorRegistry.getArguments - -getArguments(): AbilityDelegatorArgs - -获取单元测试参数AbilityDelegatorArgs对象 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 | - -**示例：** - -```js -var args = AbilityDelegatorRegistry.getArguments(); -console.info("getArguments bundleName:" + args.bundleName); -console.info("getArguments testCaseNames:" + args.testCaseNames); -console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); -``` +# AbilityDelegatorRegistry + +AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 + +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +``` + +## AbilityLifecycleState + +Ability生命周期状态。 + +**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| ------------- | ---- | --------------------------- | +| UNINITIALIZED | 0 | 表示无效状态。 | +| CREATE | 1 | 表示Ability处于已创建状态。 | +| FOREGROUND | 2 | 表示Ability处于前台状态。 | +| BACKGROUND | 3 | 表示Ability处于后台状态。 | +| DESTROY | 4 | 表示Ability处于已销毁状态。 | + +## AbilityDelegatorRegistry.getAbilityDelegator + +getAbilityDelegator(): AbilityDelegator + +获取应用程序的AbilityDelegator对象 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 | + +**示例：** + +```ts +var abilityDelegator; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +``` + +## AbilityDelegatorRegistry.getArguments + +getArguments(): AbilityDelegatorArgs + +获取单元测试参数AbilityDelegatorArgs对象 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 | + +**示例：** + +```ts +var args = AbilityDelegatorRegistry.getArguments(); +console.info("getArguments bundleName:" + args.bundleName); +console.info("getArguments testCaseNames:" + args.testCaseNames); +console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index 08bad2d65f1b7e08ba19b551d01e04d2ccca2918..59fb80485ca99bb78d85658c9e33ba08c67fa2ee 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命 ## 导入模块 -```js +```ts import AbilityLifecycleCallback from "@ohos.application.AbilityLifecycleCallback"; ``` @@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void; **示例：** -```js +```ts import AbilityStage from "@ohos.application.AbilityStage"; var lifecycleid; diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md index 27d00eda16234cb9b4292262b90a995c6f29efcf..18509a193c3c0836190c2c595b9e0ba96ddb7fa4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md @@ -4,12 +4,12 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、 > **说明：** > -> 本模块首批接口从API version 8开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.abilityManager](js-apis-app-ability-abilityManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口均为系统接口，三方应用不支持调用。 ## 导入模块 -```js +```ts import AbilityManager from '@ohos.application.abilityManager' ``` @@ -43,12 +43,12 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | -| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 新的配置项。 | | callback | AsyncCallback\ | 是 | 被指定的回调方法。 | **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; var config = { @@ -74,7 +74,7 @@ updateConfiguration(config: Configuration): Promise\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | -| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 新的配置项。 | **返回值：** @@ -84,7 +84,7 @@ updateConfiguration(config: Configuration): Promise\ **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; var config = { @@ -116,7 +116,7 @@ getAbilityRunningInfos(callback: AsyncCallback\>): vo **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getAbilityRunningInfos((err,data) => { @@ -142,7 +142,7 @@ getAbilityRunningInfos(): Promise\> **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getAbilityRunningInfos().then((data) => { @@ -171,7 +171,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\): void; **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getTopAbility((err,data) => { @@ -257,7 +257,7 @@ getTopAbility(): Promise\; **示例**： -```js +```ts import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getTopAbility().then((data) => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md similarity index 87% rename from zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md rename to zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md index d82f8bf3bd992db094d6200894d349df1fa946b7..03ca4caf483575aecb18e6049892203b7710e0c4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md @@ -6,12 +6,12 @@ AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此 > **说明：** > -> 本模块首批接口从API version 9 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.AbilityStage](js-apis-app-ability-abilitystage.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.AbilityStage](js-apis-app-ability-abilityStage.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -```js +```ts import AbilityStage from '@ohos.application.AbilityStage'; ``` @@ -25,7 +25,7 @@ onCreate(): void **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onCreate() { console.log("MyAbilityStage.onCreate is called") @@ -46,7 +46,7 @@ onAcceptWant(want: Want): string; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | **返回值：** @@ -56,7 +56,7 @@ onAcceptWant(want: Want): string; **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onAcceptWant(want) { console.log("MyAbilityStage.onAcceptWant called"); @@ -78,11 +78,11 @@ onConfigurationUpdated(config: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | + | config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onConfigurationUpdated(config) { console.log('onConfigurationUpdated, language:' + config.language); @@ -106,7 +106,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; **示例：** - ```js + ```ts class MyAbilityStage extends AbilityStage { onMemoryLevel(level) { console.log('onMemoryLevel, level:' + JSON.stringify(level)); @@ -124,4 +124,4 @@ context: AbilityStageContext; | 属性名 | 类型 | 说明 | | ----------- | --------------------------- | ------------------------------------------------------------ | -| context | [AbilityStageContext](js-apis-abilitystagecontext.md) | 在启动能力阶段进行初始化时回调。 | +| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md similarity index 97% rename from zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md index ed1dd73836c31f85a2918e5bf1da6886d0618298..351276ea9f1e82b7d1a54c3f44635c14d23b94a4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md @@ -5,8 +5,6 @@ >![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > >本模块首批接口从API version 9开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> ->本模块接口仅可在Stage模型下使用。 ## 导入模块 @@ -20,7 +18,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------- | ---- | ---- | ------------------------- | -| context | [AccessibilityExtensionContext](js-apis-accessibility-extension-context.md) | 是 | 否 | 表示辅助扩展能力上下文。 | +| context | [AccessibilityExtensionContext](js-apis-inner-application-accessibilityExtensionContext.md) | 是 | 否 | 表示辅助扩展能力上下文。 | ## AccessibilityEvent diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md new file mode 100644 index 0000000000000000000000000000000000000000..31360a8b4f2135f41b0429224fc3c372bae6a88a --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md @@ -0,0 +1,715 @@ +# appManager + +appManager模块提供App管理的能力，包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。 + +> **说明：** +> +> 本模块首批接口从API version 7 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.appManager](js-apis-app-ability-appManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import app from '@ohos.application.appManager'; +``` + +## appManager.isRunningInStabilityTest8+ + +static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void + +查询当前是否处于稳定性测试场景。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 返回当前是否处于稳定性测试场景。 | + +**示例：** + + ```ts + import app from '@ohos.application.appManager'; + app.isRunningInStabilityTest((err, flag) => { + console.log('startAbility result:' + JSON.stringify(err)); + }) + ``` + + +## appManager.isRunningInStabilityTest8+ + +static isRunningInStabilityTest(): Promise<boolean> + +查询当前是否处于稳定性测试场景。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<boolean> | 返回当前是否处于稳定性测试场景。 | + +**示例：** + + ```ts + import app from '@ohos.application.appManager'; + app.isRunningInStabilityTest().then((flag) => { + console.log('success:' + JSON.stringify(flag)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` + + +## appManager.isRamConstrainedDevice + +isRamConstrainedDevice(): Promise\; + +查询是否为ram受限设备。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<boolean> | 是否为ram受限设备。 | + +**示例：** + + ```ts + app.isRamConstrainedDevice().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` + +## appManager.isRamConstrainedDevice + +isRamConstrainedDevice(callback: AsyncCallback\): void; + +查询是否为ram受限设备。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 返回当前是否是ram受限设备。 | + +**示例：** + + ```ts + app.isRamConstrainedDevice((err, data) => { + console.log('startAbility result failed:' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` + +## appManager.getAppMemorySize + +getAppMemorySize(): Promise\; + +获取应用程序的内存大小。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<number> | 应用程序内存大小。 | + +**示例：** + + ```ts + app.getAppMemorySize().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` + +## appManager.getAppMemorySize + +getAppMemorySize(callback: AsyncCallback\): void; + +获取应用程序的内存大小。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | 是 | 应用程序内存大小。 | + +**示例：** + + ```ts + app.getAppMemorySize((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` +## appManager.getProcessRunningInfos(deprecated) + +getProcessRunningInfos(): Promise\>; + +获取有关运行进程的信息。 + +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9)替代。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInfos().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` + +## appManager.getProcessRunningInfos(deprecated) + +getProcessRunningInfos(callback: AsyncCallback\>): void; + +获取有关运行进程的信息。 + +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInfos((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` + +## appManager.getProcessRunningInformation9+ + +getProcessRunningInformation(): Promise\>; + +获取有关运行进程的信息。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInformation().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` + +## appManager.getProcessRunningInformation9+ + +getProcessRunningInformation(callback: AsyncCallback\>): void; + +获取有关运行进程的信息。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | + +**示例：** + + ```ts + app.getProcessRunningInformation((err, data) => { + console.log('startAbility result failed :' + JSON.stringify(err)); + console.log('startAbility result success:' + JSON.stringify(data)); + }) + ``` + +## appManager.registerApplicationStateObserver8+ + +registerApplicationStateObserver(observer: ApplicationStateObserver): number; + +注册全部应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 | + +**示例：** + + ```ts + var applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('------------ onForegroundApplicationChanged -----------', appStateData); + }, + onAbilityStateChanged(abilityStateData) { + console.log('------------ onAbilityStateChanged -----------', abilityStateData); + }, + onProcessCreated(processData) { + console.log('------------ onProcessCreated -----------', processData); + }, + onProcessDied(processData) { + console.log('------------ onProcessDied -----------', processData); + }, + onProcessStateChanged(processData) { + console.log('------------ onProcessStateChanged -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); + ``` + +## appManager.registerApplicationStateObserver9+ + +registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\): number; + +注册指定应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 | +| bundleNameList | Array | 是 | 表示需要注册监听的bundleName数组。最大值128。 | + +**示例：** + + ```ts + var applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('------------ onForegroundApplicationChanged -----------', appStateData); + }, + onAbilityStateChanged(abilityStateData) { + console.log('------------ onAbilityStateChanged -----------', abilityStateData); + }, + onProcessCreated(processData) { + console.log('------------ onProcessCreated -----------', processData); + }, + onProcessDied(processData) { + console.log('------------ onProcessDied -----------', processData); + }, + onProcessStateChanged(processData) { + console.log('------------ onProcessStateChanged -----------', processData); + } + } + var bundleNameList = ['bundleName1', 'bundleName2']; + const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList); + console.log('-------- observerCode: ---------', observerCode); + ``` +## appManager.unregisterApplicationStateObserver8+ + +unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\): void; + +取消注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observerId | number | 是 | 表示观察者的编号代码。 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**示例：** + + ```ts + var observerId = 100; + + function unregisterApplicationStateObserverCallback(err) { + if (err) { + console.log('------------ unregisterApplicationStateObserverCallback ------------', err); + } + } + app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback); + ``` + +## appManager.unregisterApplicationStateObserver8+ + +unregisterApplicationStateObserver(observerId: number): Promise\; + +取消注册应用程序状态观测器。 + +**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| observerId | number | 是 | 表示观察者的编号代码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```ts + var observerId = 100; + + app.unregisterApplicationStateObserver(observerId) + .then((data) => { + console.log('----------- unregisterApplicationStateObserver success ----------', data); + }) + .catch((err) => { + console.log('----------- unregisterApplicationStateObserver fail ----------', err); + }) + ``` + +## appManager.getForegroundApplications8+ + +getForegroundApplications(callback: AsyncCallback\>): void; + +获取前台进程的应用程序。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback\> | 是 | 表示应用的状态数据。 | + +**示例：** + + ```ts + function getForegroundApplicationsCallback(err, data) { + if (err) { + console.log('--------- getForegroundApplicationsCallback fail ---------', err); + } else { + console.log('--------- getForegroundApplicationsCallback success ---------', data) + } + } + app.getForegroundApplications(getForegroundApplicationsCallback); + ``` + +## appManager.getForegroundApplications8+ + +getForegroundApplications(): Promise\>; + +获取前台进程的应用程序。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 返回进程运行信息的数组。 | + +**示例：** + + ```ts + app.getForegroundApplications() + .then((data) => { + console.log('--------- getForegroundApplications success -------', data); + }) + .catch((err) => { + console.log('--------- getForegroundApplications fail -------', err); + }) + ``` + +## appManager.killProcessWithAccount8+ + +killProcessWithAccount(bundleName: string, accountId: number): Promise\ + +切断account进程（Promise形式）。 + +**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 应用包名。 | + | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | + +**示例：** + +```ts +var bundleName = 'bundleName'; +var accountId = 0; +app.killProcessWithAccount(bundleName, accountId) + .then((data) => { + console.log('------------ killProcessWithAccount success ------------', data); + }) + .catch((err) => { + console.log('------------ killProcessWithAccount fail ------------', err); + }) +``` + + +## appManager.killProcessWithAccount8+ + +killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\): void + +切断account进程（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 应用包名。 | + | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | + | callback | AsyncCallback\ | 是 | 切断account进程的回调函数。 | + +**示例：** + +```ts +var bundleName = 'bundleName'; +var accountId = 0; +function killProcessWithAccountCallback(err, data) { + if (err) { + console.log('------------- killProcessWithAccountCallback fail, err: --------------', err); + } else { + console.log('------------- killProcessWithAccountCallback success, data: --------------', data); + } +} +app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); +``` + +## appManager.killProcessesByBundleName8+ + +killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); + +通过包名终止进程。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 表示包名。 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**示例：** + + ```ts + var bundleName = 'bundleName'; + function killProcessesByBundleNameCallback(err, data) { + if (err) { + console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); + } else { + console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); + } + } + app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); + ``` + +## appManager.killProcessesByBundleName8+ + +killProcessesByBundleName(bundleName: string): Promise\; + +通过包名终止进程。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 表示包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```ts + var bundleName = 'bundleName'; + app.killProcessesByBundleName(bundleName) + .then((data) => { + console.log('------------ killProcessesByBundleName success ------------', data); + }) + .catch((err) => { + console.log('------------ killProcessesByBundleName fail ------------', err); + }) + ``` + +## appManager.clearUpApplicationData8+ + +clearUpApplicationData(bundleName: string, callback: AsyncCallback\); + +通过包名清除应用数据。 + +**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 表示包名。 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**示例：** + + ```ts + var bundleName = 'bundleName'; + function clearUpApplicationDataCallback(err, data) { + if (err) { + console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); + } else { + console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); + } + } + app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); + ``` + +## appManager.clearUpApplicationData8+ + +clearUpApplicationData(bundleName: string): Promise\; + +通过包名清除应用数据。 + +**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 表示包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**示例：** + + ```ts + var bundleName = 'bundleName'; + app.clearUpApplicationData(bundleName) + .then((data) => { + console.log('------------ clearUpApplicationData success ------------', data); + }) + .catch((err) => { + console.log('------------ clearUpApplicationData fail ------------', err); + }) + ``` + +## ApplicationState9+ + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +| 名称 | 值 | 说明 | +| -------------------- | --- | --------------------------------- | +| STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 | +| STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 | +| STATE_ACTIVE | 3 | 当应用在获焦的时候处于的状态。 | +| STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 | +| STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 | + +## ProcessState9+ + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +| 名称 | 值 | 说明 | +| -------------------- | --- | --------------------------------- | +| STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 | +| STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 | +| STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 | +| STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 | +| STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md deleted file mode 100644 index 8198bf7aaadeb3f076c9dbab74535e5cf7283479..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md +++ /dev/null @@ -1,491 +0,0 @@ -# ApplicationContext - -ApplicationContext模块提供开发者应用级别的的上下文的能力，包括提供注册及取消注册应用内组件生命周期的监听接口。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 使用说明 - -在使用ApplicationContext的功能前，需要通过context的实例获取。 - -```js -let applicationContext = this.context.getApplicationContext(); -``` - -## ApplicationContext.registerAbilityLifecycleCallback - -registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**; - -注册监听应用内生命周期 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| callback | [AbilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------------ | -| number | 返回的此次注册监听生命周期的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| - -**示例：** - -```js -import Ability from "@ohos.application.Ability"; - -var lifecycleId; - -export default class MyAbility extends Ability { - onCreate() { - console.log("MyAbility onCreate") - let AbilityLifecycleCallback = { - onAbilityCreate(ability) { - console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); - }, - onWindowStageCreate(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageActive(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageInactive(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageDestroy(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); - }, - onAbilityDestroy(ability) { - console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); - }, - onAbilityForeground(ability) { - console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); - }, - onAbilityBackground(ability) { - console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); - }, - onAbilityContinue(ability) { - console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); - } - } - // 1.通过context属性获取applicationContext - let applicationContext = this.context.getApplicationContext(); - // 2.通过applicationContext注册监听应用内生命周期 - lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); - console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); - } -} -``` - -## ApplicationContext.unregisterAbilityLifecycleCallback - -unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; - -取消监听应用内生命周期 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------- | -------- | ---- | -------------------------- | -| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**示例：** - -```js -import Ability from "@ohos.application.Ability"; - -var lifecycleId; - -export default class MyAbility extends Ability { - onDestroy() { - let applicationContext = this.context.getApplicationContext(); - console.log("stage applicationContext: " + JSON.stringify(applicationContext)); - applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { - console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); - }); - } -} -``` - -## ApplicationContext.registerEnvironmentCallback - -registerEnvironmentCallback(callback: EnvironmentCallback): **number**; - -注册对系统环境变化的监听。使用callback异步回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| callback | [EnvironmentCallback](js-apis-application-EnvironmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------------ | -| number | 返回的此次注册监听系统环境变化的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| - -**示例：** - -```js -import Ability from "@ohos.application.Ability"; - -var callbackId; - -export default class MyAbility extends Ability { - onCreate() { - console.log("MyAbility onCreate") - globalThis.applicationContext = this.context.getApplicationContext(); - let EnvironmentCallback = { - onConfigurationUpdated(config){ - console.log("onConfigurationUpdated config:" + JSON.stringify(config)); - }, - } - // 1.获取applicationContext - let applicationContext = globalThis.applicationContext; - // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); - console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); - } -} -``` - -## ApplicationContext.unregisterEnvironmentCallback - -unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; - -取消对系统环境变化的监听。使用callback异步回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------- | -------- | ---- | -------------------------- | -| callbackId | number | 是 | 注册监听系统环境变化的ID。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**示例：** - - ```js - let applicationContext = this.context.getApplicationContext(); - let callbackId = 1; - applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { - console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); - }); - ``` - -## ApplicationContext.on - -on(type: "abilityLifecycle", callback: AbilityLifecycleCallback): **number**; - -注册监听应用内生命周期 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| type | string | 是 | 调用接口类型 | -| callback | [AbilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------------ | -| number | 返回的此次注册监听生命周期的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| - -**示例：** - - ```js -import Ability from "@ohos.application.Ability"; - -var lifecycleId; - -export default class MyAbility extends Ability { - onCreate() { - console.log("MyAbility onCreate") - let AbilityLifecycleCallback = { - onAbilityCreate(ability){ - console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); - }, - onWindowStageCreate(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageActive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageInactive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); - }, - onWindowStageDestroy(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); - }, - onAbilityDestroy(ability){ - console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); - }, - onAbilityForeground(ability){ - console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); - }, - onAbilityBackground(ability){ - console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); - }, - onAbilityContinue(ability){ - console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); - } - } - // 1.通过context属性获取applicationContext - let applicationContext = this.context.getApplicationContext(); - // 2.通过applicationContext注册监听应用内生命周期 - try { - lifecycleId = applicationContext.on("abilityLifecycle", AbilityLifecycleCallback); - console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - }, - onDestroy() { - let applicationContext = this.context.getApplicationContext(); - try { - applicationContext.off("abilityLifecycle", lifecycleId, (error, data) => { - console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); - }); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - } -} - ``` - -## ApplicationContext.off - -off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): **void**; - -取消监听应用内生命周期 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------- | -------- | ---- | -------------------------- | -| type | string | 是 | 调用接口类型 | -| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**示例：** - - ```js - let applicationContext = this.context.getApplicationContext(); - let lifecycleId = 1; - console.log("stage applicationContext: " + JSON.stringify(applicationContext)); - try { - applicationContext.off("abilityLifecycle", lifecycleId, (error, data) => { - console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); - }); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - ``` - -## ApplicationContext.off - -off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): Promise<void>; - -取消监听应用内生命周期 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------- | -------- | ---- | -------------------------- | -| type | string | 是 | 调用接口类型 | -| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<void> | Promise形式返回执行结果。 | - -**示例：** - - ```js - let applicationContext = this.context.getApplicationContext(); - let lifecycleId = 1; - console.log("stage applicationContext: " + JSON.stringify(applicationContext)); - try { - applicationContext.off("abilityLifecycle", lifecycleId) - .then((data) => { - console.log("unregisterAbilityLifecycleCallback success"); - }) - .catch((error) => { - console.log("unregisterAbilityLifecycleCallback failed, err.code: " + JSON.stringify(err.code) + - "err.message: " + JSON.stringify(err.message)); - }); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - ``` - -## ApplicationContext.on - -on(type: "environment", callback: EnvironmentCallback): **number**; - -注册对系统环境变化的监听。使用callback异步回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| callback | [EnvironmentCallback](js-apis-application-EnvironmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------------ | -| number | 返回的此次注册监听系统环境变化的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| - -**示例：** - - ```js -import Ability from "@ohos.application.Ability"; - -var callbackId; - -export default class MyAbility extends Ability { - onCreate() { - console.log("MyAbility onCreate") - globalThis.applicationContext = this.context.getApplicationContext(); - let EnvironmentCallback = { - onConfigurationUpdated(config){ - console.log("onConfigurationUpdated config:" + JSON.stringify(config)); - }, - } - // 1.获取applicationContext - let applicationContext = globalThis.applicationContext; - try { - // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.on("environment", EnvironmentCallback); - console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - } - onDestroy() { - let applicationContext = globalThis.applicationContext; - try { - applicationContext.off("environment", callbackId, (error, data) => { - console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); - }); - } catch (paramError) { - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } - } -} - ``` - -## ApplicationContext.off - -off("environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**; - -取消对系统环境变化的监听。使用callback异步回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------- | -------- | ---- | -------------------------- | -| callbackId | number | 是 | 注册监听系统环境变化的ID。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**示例：** - - ```js - let applicationContext = this.context.getApplicationContext(); - let callbackId = 1; - try { - applicationContext.off("environment", callbackId, (error, data) => { - console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); - }); - } catch (paramError) { - console.log("error: " + paramError.code + ", " + paramError.message); - } - ``` - -## getProcessRunningInfomation - -getProcessRunningInformation(callback: AsyncCallback<Array<ProcessRunningInformation>>): void; - -获取正在运行的进程信息 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| callback | AsyncCallback<Array<[ProcessRunningInformation](js-apis-processrunninginformation.md)>> | 是 | 回调方法，返回正在运行的进程信息。 | - -**示例：** -```js -let applicationContext = this.context.getApplicationContext(); -applicationContext.getProcessRunningInfomation((err, datas) => { - for (let data of datas) { - console.log("ProcessRunningInformation: " + JSON.stringify(data)); - } -}) -``` - -## killProcessesBySelf - -killProcessesBySelf(callback: AsyncCallback<void>): void; - -杀死自身运行的进程 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------------------ | -------- | ---- | ------------------------------ | -| callback | AsyncCallback<void> | 是 | 回调方法，返回处理信息。 | - -**示例：** -```js -let applicationContext = this.context.getApplicationContext(); -applicationContext.killProcessesBySelf((err, datas) => { - console.log("killProcessesBySelf success, err: " + JSON.stringify(err)); -}) -``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md index 52acd17bb8f13921e4cbfc84e4d89f70a46bce86..200f8fda9e41c77d910415c8b85b89b6e34b678d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md @@ -17,9 +17,9 @@ import Configuration from '@ohos.application.Configuration' | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language8+ | string | 是 | 是 | 表示应用程序的当前语言。 | -| colorMode8+ | [ColorMode](js-apis-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | -| direction9+ | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | -| screenDensity9+ | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | +| colorMode8+ | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | +| direction9+ | [Direction](js-apis-application-configurationConstant.md#configurationconstantdirection9) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | +| screenDensity9+ | [ScreenDensity](js-apis-application-configurationConstant.md#configurationconstantscreendensity9) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | | displayId9+ | number | 是 | 否 | 表示应用所在的物理屏幕Id。 | | hasPointerDevice9+ | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 | @@ -28,17 +28,43 @@ import Configuration from '@ohos.application.Configuration' **示例：** ```ts - let envCallback = { - onConfigurationUpdated(config) { - console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) - let language = config.language; - let colorMode = config.colorMode; - let direction = config.direction; - let screenDensity = config.screenDensity; - let displayId = config.displayId; - let hasPointerDevice = config.hasPointerDevice; +import hilog from '@ohos.hilog'; +import Ability from '@ohos.application.Ability' +import Window from '@ohos.window' + +export default class MainAbility extends Ability { + onCreate(want, launchParam) { + } + + onDestroy() { + } + + onWindowStageCreate(windowStage: Window.WindowStage) { + let envCallback = { + onConfigurationUpdated(config) { + console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) + let language = config.language; + let colorMode = config.colorMode; + let direction = config.direction; + let screenDensity = config.screenDensity; + let displayId = config.displayId; + let hasPointerDevice = config.hasPointerDevice; + } + }; + + let applicationContext = this.context.getApplicationContext(); + applicationContext.registerEnvironmentCallback(envCallback); + + windowStage.loadContent('pages/index', (err, data) => { + if (err.code) { + hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.ERROR); + hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? ''); + return; + } + hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.INFO); + hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? ''); + }); } - }; - var callbackId = applicationContext.registerEnvironmentCallback(envCallback); +} ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md index 864816ecd85aca561c32180cd9884cf057f90b10..596f14e2f191d15ad72349ada8a1a78c2917feba 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-context.md @@ -1,185 +1,41 @@ # Context -Context模块提供开发者运行代码的上下文环境的能力，包括查询和设置应用信息、ResourceManager等信息。 +Context模块将二级模块API组织在一起方便开发者进行导出。 > **说明：** > -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用 -## 使用说明 +## 导入模块 -通过AbilityContext等继承实现。 - -```js -import Ability from '@ohos.application.Ability' - -class MainAbility extends Ability { - onWindowStageCreate(windowStage) { - let test = "com.example.test"; - let context = this.context.createBundleContext(test); - } -} -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| resourceManager | resmgr.ResourceManager; | 是 | 否 | ResourceManager对象。 | -| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。 | -| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。 | -| tempDir | string | 是 | 否 | 应用的临时文件路径。 | -| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 | -| databaseDir | string | 是 | 否 | 获取本地数据存储路径。 | -| bundleCodeDir | string | 是 | 否 | 应用安装路径。 | -| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 | -| eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。| -| area | [AreaMode](#areamode) | 是 | 是 | 文件分区。| -| preferencesDir | string | 是 | 是 | 指示应用程序首选项目录。| - -## Context.createBundleContext - -createBundleContext(bundleName: string): Context; - -创建指定应用上下文。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用bundle名。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Context | 对应创建应用的上下文context。 | - -**示例：** - -```js -import Ability from '@ohos.application.Ability' - -class MainAbility extends Ability { - onWindowStageCreate(windowStage) { - let test = "com.example.test"; - let context = this.context.createBundleContext(test); - } -} -``` - -## Context.createModuleContext - -createModuleContext(moduleName: string): Context; - -创建指定hap上下文。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | moduleName | string | 是 | 应用内hap名。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Context | 对应创建hap的上下文context。 | - -**示例：** - -```js -import Ability from '@ohos.application.Ability' - -class MainAbility extends Ability { - onWindowStageCreate(windowStage) { - let moduleName = "module"; - let context = this.context.createModuleContext(moduleName); - } -} +```ts +import context from '@ohos.application.context' ``` -## Context.createModuleContext - -createModuleContext(bundleName: string, moduleName: string): Context; - -创建指定应用上下文。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用bundle名。 | - | moduleName | string | 是 | 应用内hap名。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Context | 对应创建应用内hap的上下文context。 | +| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | +| AbilityContext | 只读 | [AbilityContext](js-apis-ability-context.md) | 否 | AbilityContext二级模块。 | +| AbilityStageContext | 只读 | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 | +| ApplicationContext | 只读 | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 | +| BaseContext | 只读 | [BaseContext](js-apis-inner-application-baseContext.md) | 否 | BaseContext二级模块。 | +| Context | 只读 | [Context](js-apis-inner-application-context.md) | 否 | Context二级模块。 | +| ExtensionContext | 只读 | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 否 | ExtensionContext二级模块。 | +| FormExtensionContext | 只读 | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 否 | FormExtensionContext二级模块。 | +| EventHub | 只读 | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 | +| PermissionRequestResult | 只读 | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 | **示例：** - -```js -import Ability from '@ohos.application.Ability' - -class MainAbility extends Ability { - onWindowStageCreate(windowStage) { - let bundleName = "com.example.bundle"; - let moduleName = "module"; - let context = this.context.createModuleContext(bundleName, moduleName); - } -} -``` - -## Context.getApplicationContext - -getApplicationContext(): ApplicationContext; - -获取当前applicationContext。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| ApplicationContext | 当前ApplicationContext对象信息。 | - -**示例：** - -```js -import Ability from '@ohos.application.Ability' - -class MainAbility extends Ability { - onWindowStageCreate(windowStage) { - let applicationContext = this.context.getApplicationContext(); - } -} -``` - -## AreaMode - -访问的文件分区，每个文件分区有对应自己的内容。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| --------------- | ---- | --------------- | -| EL1 | 0 | 设备级加密区。 | -| EL2 | 1 | 用户凭据加密区。默认为EL2。 | +```ts +let abilityContext: context.AbilityContext; +let abilityStageContext: context.AbilityStageContext; +let applicationContext: context.ApplicationContext; +let baseContext: context.BaseContext; +let context: context.Context; +let extensionContext: context.ExtensionContext; +let formExtensionContext: context.FormExtensionContext; +let eventHub: context.EventHub; +let permissionRequestResult: context.PermissionRequestResult; +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-dataShareExtensionAbility.md similarity index 96% rename from zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-application-dataShareExtensionAbility.md index ae0674c7f4425bf08ad369aa8ba396251d397d7d..5c1b201dadc365a3718ea33a607a2910e98066b4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-dataShareExtensionAbility.md @@ -23,7 +23,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [ExtensionContext](js-apis-extension-context.md) | 是 | 否 |表示数据共享扩展能力上下文。 | +| context | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 是 | 否 |表示数据共享扩展能力上下文。 | ## onCreate @@ -37,7 +37,7 @@ DataShare客户端连接DataShareExtensionAbility服务端时，服务端回调 | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | -| want | [Want](js-apis-application-Want.md#want) | 是 | Want类型信息，包括ability名称、bundle名称等。 | +| want | [Want](js-apis-application-want.md#want) | 是 | Want类型信息，包括ability名称、bundle名称等。 | | callback | AsyncCallback<void> | 是 | 回调函数。无返回值。 | **示例：** @@ -83,7 +83,7 @@ insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<numbe | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | | uri |string | 是 | 指示要插入的数据的路径。 | -| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 | +| valueBucket |[ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 | | callback |AsyncCallback<number> | 是 | 回调函数。返回插入数据记录的索引。 | **示例：** @@ -128,7 +128,7 @@ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueB | ----- | ------ | ------ | ------ | | uri | string | 是 | 指示要更新的数据的路径。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | -| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 | +| valueBucket | [ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 | | callback | AsyncCallback<number> | 是 | 回调函数。返回更新的数据记录数。 | **示例：** @@ -258,7 +258,7 @@ batchInsert?(uri: string, valueBuckets: Array<ValuesBucket>, callback: Asy | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------------------------------------------ | ---- | -------------------------------- | | uri | string | 是 | 指示要批量插入的数据的路径。 | -| valueBuckets | Array<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是 | 指示要批量插入的数据。 | +| valueBuckets | Array<[ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket)> | 是 | 指示要批量插入的数据。 | | callback | AsyncCallback<number> | 是 | 回调函数。返回插入的数据记录数。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-EnvironmentCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md similarity index 91% rename from zh-cn/application-dev/reference/apis/js-apis-application-EnvironmentCallback.md rename to zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md index 22d93d3682cafba55cc0fc9da651bd80a2759f24..d4dcfaacf224743a145579cc9876e97f1ef5717c 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-application-EnvironmentCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md @@ -4,13 +4,13 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境 > **说明：** > -> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-EnvironmentCallback.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-environmentCallback.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -```js +```ts import EnvironmentCallback from "@ohos.application.EnvironmentCallback"; ``` @@ -27,12 +27,12 @@ onConfigurationUpdated(config: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-configuration.md) | 是 | 变化后的Configuration对象。 | + | config | [Configuration](js-apis-application-configuration.md) | 是 | 变化后的Configuration对象。 | **示例：** - ```js + ```ts import Ability from "@ohos.application.Ability"; var callbackId; diff --git a/zh-cn/application-dev/reference/apis/js-apis-errorManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-errorManager.md similarity index 70% rename from zh-cn/application-dev/reference/apis/js-apis-errorManager.md rename to zh-cn/application-dev/reference/apis/js-apis-application-errorManager.md index c68d575d7c2c3d36b9df083faef240bbec5e4268..07fec114eb304e896db830f0bedfc1a59e3fb80d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-errorManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-errorManager.md @@ -4,10 +4,10 @@ ErrorManager模块提供对错误观察器的注册和注销的能力。 > **说明：** > -> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换接口为[@ohos.app.ability.errorManager](js-apis-app-ability-errorManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```ts import errorManager from '@ohos.application.errorManager' ``` @@ -23,11 +23,11 @@ registerErrorObserver(observer: ErrorObserver): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| observer | [ErrorObserver](#errorobserver) | 是 | 返回观察者的数字代码。 | +| observer | [ErrorObserver](js-apis-inner-application-errorObserver.md) | 是 | 返回观察者的数字代码。 | **示例：** -```js +```ts var observer = { onUnhandledException(errorMsg) { console.log('onUnhandledException, errorMsg: ', errorMsg) @@ -53,7 +53,7 @@ unregisterErrorObserver(observerId: number, callback: AsyncCallback\): vo **示例：** -```js +```ts var observerId = 100; function unregisterErrorObserverCallback(err) { @@ -87,7 +87,7 @@ unregisterErrorObserver(observerId: number): Promise\; **示例：** -```js +```ts var observerId = 100; errorManager.unregisterErrorObserver(observerId) .then((data) => { @@ -97,29 +97,4 @@ errorManager.unregisterErrorObserver(observerId) console.log('----------- unregisterErrorObserver fail ----------', err); }) -``` - -## ErrorObserver - -onUnhandledException(errMsg: string): void; - -将在js运行时引发用户未捕获的异常时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| errMsg | string | 否 | 有关异常的消息和错误堆栈跟踪。 | - -**示例：** - -```js -var observer = { - onUnhandledException(errorMsg) { - console.log('onUnhandledException, errorMsg: ', errorMsg) - } -} -errorManager.registerErrorObserver(observer) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md similarity index 57% rename from zh-cn/application-dev/reference/apis/js-apis-application-ExtensionAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md index af681189d10fbc7783502c97ddeadd95a5f3a393..f0ded5d8c559fe46e8a2b1aaf1f1c2882a277e4e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md @@ -1,23 +1,23 @@ # ExtensionAbility -ExtensionAbility，是Stage模型中新增的扩展组件的基类，一般用于处理无界面的任务，生命周期较简单，没有前后台生命周期。 +ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。 > **说明：** > -> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 本模块接口仅可在Stage模型下使用。 +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 ## 导入模块 -```js +```ts import ExtensionAbility from '@ohos.application.ExtensionAbility'; ``` -## AbilityStage.onConfigurationUpdated +## ExtensionAbility.onConfigurationUpdated onConfigurationUpdated(newConfig: Configuration): void; -环境变化通知接口，发生全局配置变更时回调。 +当系统配置更新时调用。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -25,20 +25,19 @@ onConfigurationUpdated(newConfig: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | + | newConfig | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** - ```js - class MyExtension extends ExtensionAbility { + ```ts + class MyExtensionAbility extends ExtensionAbility { onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, language:' + config.language); + console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); } } ``` - -## AbilityStage.onMemoryLevel +## ExtensionAbility.onMemoryLevel onMemoryLevel(level: AbilityConstant.MemoryLevel): void; @@ -54,8 +53,8 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; **示例：** - ```js - class MyExtension extends ExtensionAbility { + ```ts + class MyExtensionAbility extends ExtensionAbility { onMemoryLevel(level) { console.log('onMemoryLevel, level:' + JSON.stringify(level)); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md similarity index 70% rename from zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md index 4111ba835dc3c608484a85c228a95681b23de307..cecc7bacab564555893f5468c239260887202391 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md @@ -8,7 +8,7 @@ > 从API version 9 开始不再维护，建议使用[FormBindingData](js-apis-app-form-formbindingdata.md)替代。 ## 导入模块 -``` +```ts import formBindingData from '@ohos.application.formBindingData'; ``` @@ -18,7 +18,7 @@ FormBindingData相关描述。 **系统能力**：SystemCapability.Ability.Form -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | data | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。| @@ -47,30 +47,17 @@ createFormBindingData(obj?: Object | string): FormBindingData **示例：** - ```js - import featureAbility from '@ohos.ability.featureAbility'; - import fileio from '@ohos.fileio'; - let context=featureAbility.getContext(); - context.getOrCreateLocalDir((err,data)=>{ - let path=data+"/xxx.jpg"; - let fd = fileio.openSync(path); - let obj = { - "temperature": "21°", - "formImages": {"image": fd} - }; - let formBindingDataObj = formBindingData.createFormBindingData(obj); - }) - - - ``` - -## 属性 - -FormBindingData相关描述。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| data | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。| - +```ts +import featureAbility from '@ohos.ability.featureAbility'; +import fileio from '@ohos.fileio'; +let context=featureAbility.getContext(); +context.getOrCreateLocalDir((err,data)=>{ + let path=data+"/xxx.jpg"; + let fd = fileio.openSync(path); + let obj = { + "temperature": "21°", + "formImages": {"image": fd} + }; + let formBindingDataObj = formBindingData.createFormBindingData(obj); +}) +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formerror.md b/zh-cn/application-dev/reference/apis/js-apis-application-formError.md similarity index 97% rename from zh-cn/application-dev/reference/apis/js-apis-formerror.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formError.md index 36b638a3633db86761e4eb2d87e4d10268820825..feb3ee715afe8d12fed2a707abae3ca8f2c3619c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formerror.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formError.md @@ -5,11 +5,11 @@ FormError模块提供获取卡片错误码的能力。 > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 从API version 9 开始不再维护，建议使用[Form错误码](../errorcodes/errcode-form.md)替代。 +> 从API version 9 开始不再维护，建议使用[Form错误码](../errorcodes/errorcode-form.md)替代。 ## 导入模块 -``` +```ts import formError from '@ohos.application.formError'; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextension.md b/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md similarity index 91% rename from zh-cn/application-dev/reference/apis/js-apis-formextension.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md index 02811ef15d73e19af52ddab5a2013f3ed7d02ee5..a3de47ace0238979eb91999bfe67b377f8ee5099 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md @@ -10,7 +10,7 @@ FormExtension模块提供了FormExtension卡片扩展相关接口。 ## 导入模块 -``` +```ts import FormExtension from '@ohos.application.FormExtension'; ``` @@ -20,7 +20,7 @@ import FormExtension from '@ohos.application.FormExtension'; | 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | +| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | ## onCreate @@ -34,17 +34,17 @@ onCreate(want: Want): formBindingData.FormBindingData | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | +| want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | **返回值：** | 类型 | 说明 | | ------------------------------------------------------------ | ----------------------------------------------------------- | -| [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 | +| [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 | **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData' export default class MyFormExtension extends FormExtension { onCreate(want) { @@ -75,7 +75,7 @@ onCastToNormal(formId: string): void **示例：** -```js +```ts export default class MyFormExtension extends FormExtension { onCastToNormal(formId) { console.log('FormExtension onCastToNormal, formId:' + formId); @@ -87,7 +87,7 @@ export default class MyFormExtension extends FormExtension { onUpdate(formId: string): void -卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。 +卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。 **系统能力**：SystemCapability.Ability.Form @@ -99,7 +99,7 @@ onUpdate(formId: string): void **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData' export default class MyFormExtension extends FormExtension { onUpdate(formId) { @@ -129,7 +129,7 @@ onVisibilityChange(newStatus: { [key: string]: number }): void **示例：** -```js +```ts import formBindingData from '@ohos.application.formBindingData' export default class MyFormExtension extends FormExtension { onVisibilityChange(newStatus) { @@ -164,7 +164,7 @@ onEvent(formId: string, message: string): void **示例：** -```js +```ts export default class MyFormExtension extends FormExtension { onEvent(formId, message) { console.log('FormExtension onEvent, formId:' + formId + ", message:" + message); @@ -188,7 +188,7 @@ onDestroy(formId: string): void **示例：** -```js +```ts export default class MyFormExtension extends FormExtension { onDestroy(formId) { console.log('FormExtension onDestroy, formId:' + formId); @@ -208,11 +208,11 @@ onConfigurationUpdated(config: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** -```js +```ts class MyFormExtension extends FormExtension { onConfigurationUpdated(config) { console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); @@ -232,11 +232,11 @@ onAcquireFormState?(want: Want): formInfo.FormState; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | +| want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | **示例：** -```js +```ts import formInfo from '@ohos.application.formInfo' class MyFormExtension extends FormExtension { onAcquireFormState(want) { @@ -270,7 +270,7 @@ onShare?(formId: string): {[key: string]: any}; **示例：** -```js +```ts class MyFormExtension extends FormExtension { onShare(formId) { console.log('FormExtension onShare, formId:' + formId); diff --git a/zh-cn/application-dev/reference/apis/js-apis-formhost.md b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md similarity index 94% rename from zh-cn/application-dev/reference/apis/js-apis-formhost.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formHost.md index c5417fe8bd88b043cdd667a794a75103abc07024..ad32683220ce9a8907999a9a4358ef51797f2d1b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formhost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md @@ -10,7 +10,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方 ## 导入模块 -``` +```ts import formHost from '@ohos.application.formHost'; ``` @@ -33,7 +33,7 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void **示例：** -```js +```ts var formId = "12400633174999288"; formHost.deleteForm(formId, (error, data) => { if (error.code) { @@ -66,7 +66,7 @@ deleteForm(formId: string): Promise<void> **参数：** -```js +```ts var formId = "12400633174999288"; formHost.deleteForm(formId).then(() => { console.log('formHost deleteForm success'); @@ -94,7 +94,7 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void **示例：** -```js +```ts var formId = "12400633174999288"; formHost.releaseForm(formId, (error, data) => { if (error.code) { @@ -123,7 +123,7 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< **示例：** -```js +```ts var formId = "12400633174999288"; formHost.releaseForm(formId, true, (error, data) => { if (error.code) { @@ -157,7 +157,7 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> **示例：** -```js +```ts var formId = "12400633174999288"; formHost.releaseForm(formId, true).then(() => { console.log('formHost releaseForm success'); @@ -185,7 +185,7 @@ requestForm(formId: string, callback: AsyncCallback<void>): void **示例：** -```js +```ts var formId = "12400633174999288"; formHost.requestForm(formId, (error, data) => { if (error.code) { @@ -218,7 +218,7 @@ requestForm(formId: string): Promise<void> **示例：** -```js +```ts var formId = "12400633174999288"; formHost.requestForm(formId).then(() => { console.log('formHost requestForm success'); @@ -246,7 +246,7 @@ castTempForm(formId: string, callback: AsyncCallback<void>): void **示例：** -```js +```ts var formId = "12400633174999288"; formHost.castTempForm(formId, (error, data) => { if (error.code) { @@ -279,7 +279,7 @@ castTempForm(formId: string): Promise<void> **示例：** -```js +```ts var formId = "12400633174999288"; formHost.castTempForm(formId).then(() => { console.log('formHost castTempForm success'); @@ -307,7 +307,7 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.notifyVisibleForms(formId, (error, data) => { if (error.code) { @@ -340,7 +340,7 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.notifyVisibleForms(formId).then(() => { console.log('formHost notifyVisibleForms success'); @@ -368,7 +368,7 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.notifyInvisibleForms(formId, (error, data) => { if (error.code) { @@ -401,7 +401,7 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.notifyInvisibleForms(formId).then(() => { console.log('formHost notifyInvisibleForms success'); @@ -429,7 +429,7 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.enableFormsUpdate(formId, (error, data) => { if (error.code) { @@ -462,7 +462,7 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.enableFormsUpdate(formId).then(() => { console.log('formHost enableFormsUpdate success'); @@ -490,7 +490,7 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.disableFormsUpdate(formId, (error, data) => { if (error.code) { @@ -523,7 +523,7 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> **示例：** -```js +```ts var formId = ["12400633174999288"]; formHost.disableFormsUpdate(formId).then(() => { console.log('formHost disableFormsUpdate success'); @@ -548,7 +548,7 @@ isSystemReady(callback: AsyncCallback<void>): void **示例：** -```js +```ts var formId = "12400633174999288"; formHost.isSystemReady((error, data) => { if (error.code) { @@ -573,7 +573,7 @@ isSystemReady(): Promise<void> **示例：** -```js +```ts var formId = "12400633174999288"; formHost.isSystemReady().then(() => { console.log('formHost isSystemReady success'); @@ -596,11 +596,11 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-application-formInfo.md)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **示例：** -```js +```ts formHost.getAllFormsInfo((error, data) => { if (error.code) { console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); @@ -624,11 +624,11 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象，返回查询到的卡片信息。 | +| Promise<Array<[FormInfo](js-apis-application-formInfo.md)>> | Promise对象，返回查询到的卡片信息。 | **示例：** - ```js + ```ts formHost.getAllFormsInfo().then((data) => { console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); }).catch((error) => { @@ -651,11 +651,11 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-application-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **示例：** -```js +```ts formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { if (error.code) { console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); @@ -681,11 +681,11 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< | ------ | ------ | ---- | ------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | | moduleName | string | 是 | 要查询的模块名称。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | +| callback | AsyncCallback<Array<[FormInfo](js-apis-application-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | **示例：** -```js +```ts formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { if (error.code) { console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); @@ -716,11 +716,11 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象，返回查询到的卡片信息。 | +| Promise<Array<[FormInfo](js-apis-application-formInfo.md)>> | Promise对象，返回查询到的卡片信息。 | **示例：** - ```js + ```ts formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); }).catch((error) => { @@ -747,7 +747,7 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.deleteInvalidForms(formIds, (error, data) => { if (error.code) { @@ -782,7 +782,7 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.deleteInvalidForms(formIds).then((data) => { console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); @@ -805,12 +805,12 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | -| callback | AsyncCallback<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | +| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | +| callback | AsyncCallback<[FormStateInfo](js-apis-application-formInfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | **示例：** -```js +```ts var want = { "deviceId": "", "bundleName": "ohos.samples.FormApplication", @@ -844,17 +844,17 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | Promise对象，返回卡片状态。 | +| Promise<[FormStateInfo](js-apis-application-formInfo.md#formstateinfo)> | Promise对象，返回卡片状态。 | **示例：** -```js +```ts var want = { "deviceId": "", "bundleName": "ohos.samples.FormApplication", @@ -889,7 +889,7 @@ on(type: "formUninstall", callback: Callback<string>): void **示例：** -```js +```ts let callback = function(formId) { console.log('formHost on formUninstall, formId:' + formId); } @@ -913,7 +913,7 @@ off(type: "formUninstall", callback?: Callback<string>): void **示例：** -```js +```ts let callback = function(formId) { console.log('formHost on formUninstall, formId:' + formId); } @@ -940,7 +940,7 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.notifyFormsVisible(formIds, true, (error, data) => { if (error.code) { @@ -974,7 +974,7 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise< **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.notifyFormsVisible(formIds, true).then(() => { console.log('formHost notifyFormsVisible success'); @@ -1003,7 +1003,7 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { if (error.code) { @@ -1037,7 +1037,7 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): **示例：** -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.notifyFormsEnableUpdate(formIds, true).then(() => { console.log('formHost notifyFormsEnableUpdate success'); @@ -1065,7 +1065,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>) **示例：** -```js +```ts var formId = "12400633174999288"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; formHost.shareForm(formId, deviceId, (error, data) => { @@ -1100,7 +1100,7 @@ shareForm(formId: string, deviceId: string): Promise<void> **参数：** -```js +```ts var formId = "12400633174999288"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; formHost.shareForm(formId, deviceId).then(() => { @@ -1125,7 +1125,7 @@ notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean, callb | formId | string | 是 | 卡片标识。 | | deviceId | string | 是 | 远程设备标识。 | -```js +```ts var formIds = new Array("12400633174999288", "12400633174999289"); formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { console.log('formHost shareForm success'); diff --git a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md similarity index 99% rename from zh-cn/application-dev/reference/apis/js-apis-formInfo.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md index 8df1a0a28baa1e98b0fa5d49d652ec2f0dd88f37..0b470aaacbd4ceb3b078b69947865bdd93db009c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md @@ -9,7 +9,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询 ## 导入模块 -``` +```ts import formInfo from '@ohos.application.formInfo'; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md similarity index 90% rename from zh-cn/application-dev/reference/apis/js-apis-formprovider.md rename to zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md index a61e05264a6116cc609e20e7d690093767368074..4f03e1d20ccc51fd83385a2fb4c15700e4c28430 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md @@ -8,7 +8,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在 ## 导入模块 -``` +```ts import formProvider from '@ohos.application.formProvider'; ``` @@ -30,7 +30,7 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l **示例：** - ```js + ```ts var formId = "12400633174999288"; formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { if (error.code) { @@ -62,7 +62,7 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void> **示例：** - ```js + ```ts var formId = "12400633174999288"; formProvider.setFormNextRefreshTime(formId, 5).then(() => { console.log('formProvider setFormNextRefreshTime success'); @@ -84,12 +84,12 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | formId | string | 是 | 请求更新的卡片标识。 | - | formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | + | formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js + ```ts import formBindingData from '@ohos.application.formBindingData'; var formId = "12400633174999288"; let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); @@ -113,7 +113,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | formId | string | 是 | 请求更新的卡片标识。 | - | formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | + | formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdat) | 是 | 用于更新的数据。 | **返回值：** @@ -123,7 +123,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr **示例：** - ```js + ```ts import formBindingData from '@ohos.application.formBindingData'; var formId = "12400633174999288"; let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); @@ -146,11 +146,11 @@ getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): voi | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | +| callback | AsyncCallback<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | **示例：** -```js +```ts formProvider.getFormsInfo((error, data) => { if (error.code) { console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); @@ -171,12 +171,12 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | +| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | +| callback | AsyncCallback<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | **示例：** -```js +```ts import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. @@ -203,17 +203,17 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 卡片信息过滤器。 | +| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md) | 否 | 卡片信息过滤器。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | +| Promise<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | **示例：** -```js +```ts import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. @@ -240,13 +240,13 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | | callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | **示例：** - ```js + ```ts import formBindingData from '@ohos.application.formBindingData'; var want = { abilityName: "FormAbility", @@ -280,12 +280,12 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | | callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | **示例：** - ```js + ```ts var want = { abilityName: "FormAbility", parameters: { @@ -317,8 +317,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData | 参数名 | 类型 | 必填 | 说明 | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData.FormBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | +| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | +| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 | **返回值：** @@ -328,7 +328,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData **示例：** - ```js + ```ts var want = { abilityName: "FormAbility", parameters: { @@ -362,7 +362,7 @@ isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void **示例：** -```js +```ts formProvider.isRequestPublishFormSupported((error, isSupported) => { if (error.code) { console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); @@ -406,7 +406,7 @@ isRequestPublishFormSupported(): Promise<boolean> **示例：** -```js +```ts formProvider.isRequestPublishFormSupported().then((isSupported) => { if (isSupported) { var want = { diff --git a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md old mode 100755 new mode 100644 similarity index 88% rename from zh-cn/application-dev/reference/apis/js-apis-missionManager.md rename to zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md index 8988c958cd0022c7f6586eea139ccbeb846e63a7..eeb6bd1bb04c2c6f8efcdc33a67d006448821fb6 --- a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md @@ -4,11 +4,11 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行 > **说明：** > -> 本模块首批接口从API version 8开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.missionManager](js-apis-app-ability-missionManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```ts import missionManager from '@ohos.application.missionManager' ``` @@ -32,7 +32,7 @@ registerMissionListener(listener: MissionListener): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | listener | MissionListener | 是 | 系统任务监听方法。 | + | listener | [MissionListener](js-apis-inner-application-missionListener.md) | 是 | 系统任务监听方法。 | **返回值：** @@ -42,18 +42,18 @@ registerMissionListener(listener: MissionListener): number; **示例：** -```js - var listener = { - onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, - onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, - onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, - onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, - onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, - onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, - onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} - }; - console.log("registerMissionListener") - var listenerid = missionManager.registerMissionListener(listener); +```ts +var listener = { + onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, + onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, + onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, + onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, + onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, + onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, + onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} +}; +console.log("registerMissionListener") +var listenerid = missionManager.registerMissionListener(listener); ``` @@ -78,7 +78,7 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback<void> **示例：** -```js +```ts var listener = { onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, @@ -123,7 +123,7 @@ unregisterMissionListener(listenerId: number): Promise<void>; **示例：** -```js +```ts var listener = { onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, @@ -160,11 +160,11 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<M | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionInfo](#missioninfo)> | 是 | 执行结果回调函数，返回任务信息。 | + | callback | AsyncCallback<[MissionInfo](js-apis-inner-application-missionInfo.md)> | 是 | 执行结果回调函数，返回任务信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);}); @@ -203,11 +203,11 @@ getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>; | 类型 | 说明 | | -------- | -------- | - | Promise<[MissionInfo](#missioninfo)> | 任务信息。 | + | Promise<[MissionInfo](js-apis-inner-application-missionInfo.md)> | 任务信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var mission = missionManager.getMissionInfo("", 10).catch(function (err){ @@ -234,11 +234,11 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Arr | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | numMax | number | 是 | 任务信息数量上限。 | - | callback | AsyncCallback<Array<[MissionInfo](#missioninfo)>> | 是 | 执行结果回调函数，返回任务信息数组。 | + | callback | AsyncCallback<Array<[MissionInfo](js-apis-inner-application-missionInfo.md)>> | 是 | 执行结果回调函数，返回任务信息数组。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -272,11 +272,11 @@ getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionIn | 类型 | 说明 | | -------- | -------- | - | Promise<Array<[MissionInfo](#missioninfo)>> | 任务信息数组。 | + | Promise<Array<[MissionInfo](js-apis-inner-application-missionInfo.md)>> | 任务信息数组。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){ @@ -303,11 +303,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback& | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | + | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -347,11 +347,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnaps | 类型 | 说明 | | -------- | -------- | - | Promise<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 任务快照信息。 | + | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions; @@ -385,11 +385,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | + | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -429,11 +429,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\ { @@ -513,7 +513,7 @@ lockMission(missionId: number): Promise<void>; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions; missionManager.getMissionInfos("",10).then(function(res){ @@ -550,7 +550,7 @@ unlockMission(missionId: number, callback: AsyncCallback<void>): void; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -592,7 +592,7 @@ unlockMission(missionId: number): Promise<void>; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions; @@ -633,7 +633,7 @@ clearMission(missionId: number, callback: AsyncCallback<void>): void; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -675,7 +675,7 @@ clearMission(missionId: number): Promise<void>; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions; @@ -706,7 +706,7 @@ clearAllMissions(callback: AsyncCallback<void>): void; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.clearAllMissions().then(() => { @@ -735,7 +735,7 @@ clearAllMissions(): Promise<void>; **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.clearAllMissions().catch(function (err){ console.log(err); @@ -764,7 +764,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback<void>): void **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -797,12 +797,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | missionId | number | 是 | 任务ID。 | - | options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | + | options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 | **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' missionManager.getMissionInfos("", 10, (error, missions) => { @@ -835,7 +835,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | missionId | number | 是 | 任务ID。 | - | options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | + | options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | **返回值：** @@ -845,7 +845,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g **示例：** - ```js + ```ts import missionManager from '@ohos.application.missionManager' var allMissions; @@ -859,23 +859,4 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g missionManager.moveMissionToFront(id).catch(function (err){ console.log(err); }); - ``` - -## MissionInfo - -表示Ability对应任务信息的枚举。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| missionId | number | 是 | 是 | 表示任务ID。| -| runningState | number | 是 | 是 | 表示运行状态。 | -| lockedState | boolean | 是 | 是 | 表示锁定状态。 | -| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 | -| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 | -| label | string | 是 | 是 | 表示任务的标签。 | -| iconPath | string | 是 | 是 | 表示任务的图标路径。 | -| continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 | + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md similarity index 85% rename from zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md rename to zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md index 0dce7d4a04430de2f7a8246d715aa396322a23c0..2dd73056585223bd78fc684797d31fec79e7ac6e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md @@ -4,13 +4,13 @@ ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的 > **说明：** > -> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.ServiceExtensionAbility](js-apis-app-ability-service-extension-ability.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -``` -import ServiceExtension from '@ohos.application.ServiceExtensionAbility'; +```ts +import ServiceExtensionAbility from '@ohos.application.ServiceExtensionAbility'; ``` ## 权限 @@ -25,7 +25,7 @@ import ServiceExtension from '@ohos.application.ServiceExtensionAbility'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | +| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | ## ServiceExtensionAbility.onCreate @@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onCreate(want) { console.log('onCreate, want:' + want.abilityName); @@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onDestroy() { console.log('onDestroy'); @@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onRequest(want, startId) { console.log('onRequest, want:' + want.abilityName); @@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want | [Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **返回值：** @@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC **示例：** - ```js + ```ts import rpc from '@ohos.rpc' class StubTest extends rpc.RemoteObject{ constructor(des) { @@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onDisconnect(want) { console.log('onDisconnect, want:' + want.abilityName); @@ -186,11 +186,11 @@ onReconnect(want: Want): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onReconnect(want) { console.log('onReconnect, want:' + want.abilityName); @@ -212,11 +212,11 @@ onConfigurationUpdated(config: Configuration): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | + | config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { onConfigurationUpdated(config) { console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); @@ -242,7 +242,7 @@ dump(params: Array\): Array\; **示例：** - ```js + ```ts class ServiceExt extends ServiceExtension { dump(params) { console.log('dump, params:' + JSON.stringify(params)); diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md similarity index 91% rename from zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md rename to zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md index 8c1ad363b395d1345d4f1ce87ef90c1a7fe8a885..4582decb2918ed6f21707329d8f9384526f1577f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md @@ -4,12 +4,12 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力 > **说明：** > -> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.StartOptions](js-apis-app-ability-StartOptions.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.StartOptions](js-apis-app-ability-startOptions.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -``` +```ts import StartOptions from '@ohos.application.StartOptions'; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md index 3e283d2b9bee62f9c7145d02c13d5b85ecd93a9e..387c6d2e4b8bf88ae5323cef2c9cd1637795e923 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md @@ -8,7 +8,7 @@ StaticSubscriberExtensionAbility模块提供静态订阅者ExtensionAbility的 > 本模块接口仅可在Stage模型下使用。 ## 导入模块 -``` +```ts import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility' ``` @@ -30,7 +30,7 @@ onReceiveEvent(event: CommonEventData): void; **示例：** - ```js + ```ts var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility") { onReceiveEvent(event){ diff --git a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md b/zh-cn/application-dev/reference/apis/js-apis-application-testRunner.md similarity index 93% rename from zh-cn/application-dev/reference/apis/js-apis-testRunner.md rename to zh-cn/application-dev/reference/apis/js-apis-application-testRunner.md index 92b46f63b5eab5c062cef6d588f7c972ef815afc..e4937dfc14250526a280b839982368b83a3fae3d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-testRunner.md @@ -1,55 +1,55 @@ -# TestRunner - -TestRunner模块提供了框架测试的能力。包括准备单元测试环境、运行测试用例。 - -如果您想实现自己的单元测试框架，您必须继承这个类并覆盖它的所有方法。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```js -import TestRunner from '@ohos.application.testRunner' -``` - -## TestRunner.onPrepare - -onPrepare(): void - -为运行测试用例准备单元测试环境 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**示例：** - -```js -export default class UserTestRunner implements TestRunner { - onPrepare() { - console.log("Trigger onPrepare") - } - onRun() {} -}; -``` - - - -## TestRunner.onRun - -onRun(): void - -运行测试用例 - -**系统能力：** SystemCapability.Ability.AbilityRuntime.Core - -**示例：** - -```js -export default class UserTestRunner implements TestRunner { - onPrepare() {} - onRun() { - console.log("Trigger onRun") - } -}; -``` +# TestRunner + +TestRunner模块提供了框架测试的能力。包括准备单元测试环境、运行测试用例。 + +如果您想实现自己的单元测试框架，您必须继承这个类并覆盖它的所有方法。 + +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import TestRunner from '@ohos.application.testRunner' +``` + +## TestRunner.onPrepare + +onPrepare(): void + +为运行测试用例准备单元测试环境 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**示例：** + +```ts +export default class UserTestRunner implements TestRunner { + onPrepare() { + console.log("Trigger onPrepare") + } + onRun() {} +}; +``` + + + +## TestRunner.onRun + +onRun(): void + +运行测试用例 + +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core + +**示例：** + +```ts +export default class UserTestRunner implements TestRunner { + onPrepare() {} + onRun() { + console.log("Trigger onRun") + } +}; +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md b/zh-cn/application-dev/reference/apis/js-apis-application-want.md similarity index 91% rename from zh-cn/application-dev/reference/apis/js-apis-application-Want.md rename to zh-cn/application-dev/reference/apis/js-apis-application-want.md index cb516cc7544ad2e1dfb78b56beaf070c1e76c6f1..d1698794f90d41adaa1b5b19bf49527333741fb2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-want.md @@ -1,6 +1,6 @@ # Want -Want模块提供系统的基本通信组件的能力。 +Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 > **说明：** > @@ -8,7 +8,7 @@ Want模块提供系统的基本通信组件的能力。 ## 导入模块 -``` +```ts import Want from '@ohos.application.Want'; ``` @@ -23,7 +23,7 @@ import Want from '@ohos.application.Want'; | abilityName | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | | uri | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | -| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 | +| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | | parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | | entities | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | @@ -33,7 +33,7 @@ import Want from '@ohos.application.Want'; - 基础用法 - ``` js + ```ts var want = { "deviceId": "", // deviceId为空表示本设备 "bundleName": "com.extreme.test", @@ -131,6 +131,4 @@ import Want from '@ohos.application.Want'; }) ``` - - - + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-windowExtensionAbility.md similarity index 87% rename from zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md rename to zh-cn/application-dev/reference/apis/js-apis-application-windowExtensionAbility.md index c791e9c5264b9801b481a869699e783480dae451..e1f360e9cef4d3d7d26cd472ddd8c8deb54d2462 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-windowExtensionAbility.md @@ -21,7 +21,7 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility'; | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------- | ---- | ---- | ------------------------- | -| context | [ExtensionContext](js-apis-extension-context.md) | 是 | 否 | 上下文。 | +| context | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 是 | 否 | 上下文。 | ## WindowExtensionAbility.onConnect @@ -35,7 +35,7 @@ onConnect(want: Want): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 当前ability的Want类型信息，包括ability名称、bundle名称等。 | +| want | [Want](js-apis-application-want.md) | 是 | 当前ability的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -61,7 +61,7 @@ onDisconnect(want: Want): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | +| want | [Want](js-apis-application-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md deleted file mode 100644 index 1670f83685f84e8f5afc32ec07ddf79c368accd6..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ /dev/null @@ -1,1000 +0,0 @@ -# appManager - -appManager模块提供App管理的能力，包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。 - -> **说明：** -> -> 本模块首批接口从API version 7 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.appManager](js-apis-app-ability-appmanager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```js -import app from '@ohos.application.appManager'; -``` - -## appManager.isRunningInStabilityTest8+ - -static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void - -查询当前是否处于稳定性测试场景。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 返回当前是否处于稳定性测试场景。 | - -**示例：** - - ```js - import app from '@ohos.application.appManager'; - app.isRunningInStabilityTest((err, flag) => { - console.log('startAbility result:' + err.code + ', ' + err.message); - }) - ``` - - -## appManager.isRunningInStabilityTest8+ - -static isRunningInStabilityTest(): Promise<boolean> - -查询当前是否处于稳定性测试场景。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回当前是否处于稳定性测试场景。 | - -**示例：** - - ```js - import app from '@ohos.app.ability.appManager'; - app.isRunningInStabilityTest().then((flag) => { - console.log('success:' + JSON.stringify(flag)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); - ``` - - -## appManager.isRamConstrainedDevice - -isRamConstrainedDevice(): Promise\; - -查询是否为ram受限设备。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 是否为ram受限设备。 | - -**示例：** - - ```js - app.isRamConstrainedDevice().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); - ``` - -## appManager.isRamConstrainedDevice - -isRamConstrainedDevice(callback: AsyncCallback\): void; - -查询是否为ram受限设备。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 返回当前是否是ram受限设备。 | - -**示例：** - - ```js - app.isRamConstrainedDevice((err, data) => { - console.log('startAbility result failed:' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) - ``` - -## appManager.getAppMemorySize - -getAppMemorySize(): Promise\; - -获取应用程序的内存大小。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 应用程序内存大小。 | - -**示例：** - - ```js - app.getAppMemorySize().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); - ``` - -## appManager.getAppMemorySize - -getAppMemorySize(callback: AsyncCallback\): void; - -获取应用程序的内存大小。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<number> | 是 | 应用程序内存大小。 | - -**示例：** - - ```js - app.getAppMemorySize((err, data) => { - console.log('startAbility result failed :' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) - ``` -## appManager.getProcessRunningInfos(deprecated) - -getProcessRunningInfos(): Promise\>; - -获取有关运行进程的信息。 - -> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9)替代。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\> | 获取有关运行进程的信息。 | - -**示例：** - - ```js - app.getProcessRunningInfos().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); - ``` - -## appManager.getProcessRunningInfos(deprecated) - -getProcessRunningInfos(callback: AsyncCallback\>): void; - -获取有关运行进程的信息。 - -> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | - -**示例：** - - ```js - app.getProcessRunningInfos((err, data) => { - console.log('startAbility result failed :' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) - ``` - -## appManager.getProcessRunningInformation9+ - -getProcessRunningInformation(): Promise\>; - -获取有关运行进程的信息。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\> | 获取有关运行进程的信息。 | - -**示例：** - - ```js - app.getProcessRunningInformation().then((data) => { - console.log('success:' + JSON.stringify(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringify(error)); - }); - ``` - -## appManager.getProcessRunningInformation9+ - -getProcessRunningInformation(callback: AsyncCallback\>): void; - -获取有关运行进程的信息。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | - -**示例：** - - ```js - app.getProcessRunningInformation((err, data) => { - console.log('startAbility result failed :' + JSON.stringify(err)); - console.log('startAbility result success:' + JSON.stringify(data)); - }) - ``` - -## appManager.registerApplicationStateObserver8+ - -registerApplicationStateObserver(observer: ApplicationStateObserver): number; - -注册全部应用程序状态观测器。 - -**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | - -**示例：** - - ```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - - ``` - -## appManager.registerApplicationStateObserver9+ - -registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\): number; - -注册指定应用程序状态观测器。 - -**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | -| bundleNameList | Array\ | 是 | 表示需要注册监听的bundleName数组。最大值128。 | - -**示例：** - - ```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - var bundleNameList = ['bundleName1', 'bundleName2']; - const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList); - console.log('-------- observerCode: ---------', observerCode); - - ``` -## appManager.unregisterApplicationStateObserver8+ - -unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\): void; - -取消注册应用程序状态观测器。 - -**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| observerId | number | 是 | 表示观察者的编号代码。 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | - -**示例：** - - ```js - var observerId = 100; - - function unregisterApplicationStateObserverCallback(err) { - if (err) { - console.log('------------ unregisterApplicationStateObserverCallback ------------', err); - } - } - app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback); - ``` - -## appManager.unregisterApplicationStateObserver8+ - -unregisterApplicationStateObserver(observerId: number): Promise\; - -取消注册应用程序状态观测器。 - -**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| observerId | number | 是 | 表示观察者的编号代码。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\ | 返回执行结果。 | - -**示例：** - - ```js - var observerId = 100; - - app.unregisterApplicationStateObserver(observerId) - .then((data) => { - console.log('----------- unregisterApplicationStateObserver success ----------', data); - }) - .catch((err) => { - console.log('----------- unregisterApplicationStateObserver fail ----------', err); - }) - ``` - -## appManager.getForegroundApplications8+ - -getForegroundApplications(callback: AsyncCallback\>): void; - -获取前台进程的应用程序。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 表示应用的状态数据。 | - -**示例：** - - ```js - function getForegroundApplicationsCallback(err, data) { - if (err) { - console.log('--------- getForegroundApplicationsCallback fail ---------', err); - } else { - console.log('--------- getForegroundApplicationsCallback success ---------', data) - } - } - app.getForegroundApplications(getForegroundApplicationsCallback); - ``` - -## appManager.getForegroundApplications8+ - -getForegroundApplications(): Promise\>; - -获取前台进程的应用程序。 - -**需要权限**：ohos.permission.GET_RUNNING_INFO - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\> | 返回进程运行信息的数组。 | - -**示例：** - - ```js - app.getForegroundApplications() - .then((data) => { - console.log('--------- getForegroundApplications success -------', data); - }) - .catch((err) => { - console.log('--------- getForegroundApplications fail -------', err); - }) - ``` - -## appManager.killProcessWithAccount8+ - -killProcessWithAccount(bundleName: string, accountId: number): Promise\ - -切断account进程（Promise形式）。 - -**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用包名。 | - | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | - -**示例：** - -```js -var bundleName = 'bundleName'; -var accountId = 0; -app.killProcessWithAccount(bundleName, accountId) - .then((data) => { - console.log('------------ killProcessWithAccount success ------------', data); - }) - .catch((err) => { - console.log('------------ killProcessWithAccount fail ------------', err); - }) -``` - - -## appManager.killProcessWithAccount8+ - -killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\): void - -切断account进程（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用包名。 | - | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | - | callback | AsyncCallback\ | 是 | 切断account进程的回调函数。 | - -**示例：** - -```js -var bundleName = 'bundleName'; -var accountId = 0; -function killProcessWithAccountCallback(err, data) { - if (err) { - console.log('------------- killProcessWithAccountCallback fail, err: --------------', err); - } else { - console.log('------------- killProcessWithAccountCallback success, data: --------------', data); - } -} -app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); -``` - -## appManager.killProcessesByBundleName8+ - -killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); - -通过包名终止进程。 - -**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 表示包名。 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | - -**示例：** - - ```js - var bundleName = 'bundleName'; - function killProcessesByBundleNameCallback(err, data) { - if (err) { - console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); - } else { - console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); - } - } - app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); - ``` - -## appManager.killProcessesByBundleName8+ - -killProcessesByBundleName(bundleName: string): Promise\; - -通过包名终止进程。 - -**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 表示包名。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\ | 返回执行结果。 | - -**示例：** - - ```js -var bundleName = 'bundleName'; -app.killProcessesByBundleName(bundleName) - .then((data) => { - console.log('------------ killProcessesByBundleName success ------------', data); - }) - .catch((err) => { - console.log('------------ killProcessesByBundleName fail ------------', err); - }) - - ``` - -## appManager.clearUpApplicationData8+ - -clearUpApplicationData(bundleName: string, callback: AsyncCallback\); - -通过包名清除应用数据。 - -**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 表示包名。 | -| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | - -**示例：** - - ```js - var bundleName = 'bundleName'; - function clearUpApplicationDataCallback(err, data) { - if (err) { - console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); - } else { - console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); - } - } - app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); - - ``` - -## appManager.clearUpApplicationData8+ - -clearUpApplicationData(bundleName: string): Promise\; - -通过包名清除应用数据。 - -**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 表示包名。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise\ | 返回执行结果。 | - -**示例：** - - ```js - var bundleName = 'bundleName'; - app.clearUpApplicationData(bundleName) - .then((data) => { - console.log('------------ clearUpApplicationData success ------------', data); - }) - .catch((err) => { - console.log('------------ clearUpApplicationData fail ------------', err); - }) - - ``` - -## ApplicationStateObserver.onForegroundApplicationChanged8+ - -onForegroundApplicationChanged(appStateData: AppStateData): void; - -将在前台或后台应用程序更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| appStateData | [AppStateData](#appstatedata) | 是 | 状态更改的应用程序信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); - -``` - -## ApplicationStateObserver.onAbilityStateChanged8+ - -onAbilityStateChanged(abilityStateData: AbilityStateData): void; - -将在能力状态更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| abilityStateData | [AbilityStateData](#abilitystatedata) | 是 | 状态更改的能力信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); -``` - -## ApplicationStateObserver.onProcessCreated8+ - -onProcessCreated(processData: ProcessData): void; - -将在创建进程时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 是 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); -``` - -## ApplicationStateObserver.onProcessDied8+ - -onProcessDied(processData: ProcessData): void; - -将在进程终止时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 是 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); -``` - -## ApplicationStateObserver.onProcessStateChanged9+ - - onProcessStateChanged(processData: ProcessData): void; - -当进程状态更改时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| processData | [ProcessData](#processdata) | 是 | 进程信息。 | - -**示例：** - -```js - var applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - } - const observerCode = app.registerApplicationStateObserver(applicationStateObserver); - console.log('-------- observerCode: ---------', observerCode); -``` - -## AppStateData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------- | -------- | -------------------- | ---- | -------------------------------- | -| bundleName8+| string | 是 | 否 | 包名。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| state8+ | number | 是 | 否 | 应用状态。 | - -## AbilityStateData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid8+ | number | 是 | 否 | 进程ID。 | -| bundleName8+ | string | 是 | 否 | 应用包名。 | -| abilityName8+ | string | 是 | 否 | Ability名称。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| state8+ | number | 是 | 否 | Ability状态。 | -| moduleName9+ | string | 是 | 否 | Ability所属的HAP包的名称。 | -| abilityType8+ | number | 是 | 否 | 能力类型、页面或服务等。 | - -## ProcessData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid8+ | number | 是 | 否 | 进程ID。 | -| bundleName8+ | string | 是 | 否 | 应用包名。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| isContinuousTask9+ | boolean | 是 | 否 | 判断过程是否为连续任务。 | -| isKeepAlive9+ | boolean | 是 | 否 | 判断该过程是否保持活跃。 | - -## ProcessRunningInfo - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid8+ |number | 是 | 否 | 进程ID。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| processName8+ | string | 是 | 否 | 进程的名称。 | -| bundleNames8+ | Array\ | 是 | 否 | 进程中运行的bundleName数组。 | - -## ApplicationStateObserver - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------------------- | ---------| ---- | ---- | ------------------------- | -| [onForegroundApplicationChanged8+](#applicationstateobserveronforegroundapplicationchanged8) | AppStateData | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 | -| [onAbilityStateChanged8+](#applicationstateobserveronabilitystatechanged8) | AbilityStateData | 是 | 否 | ability状态发生变化时执行的回调函数。 | -| [onProcessCreated8+](#applicationstateobserveronprocesscreated8) | ProcessData | 是 | 否 | 进程创建时执行的回调函数。 | -| [onProcessDied8+](#applicationstateobserveronprocessdied8) |ProcessData | 是 | 否 | 进程销毁时执行的回调函数。 | - -## ProcessRunningInformation - -进程的运行信息。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid9+ | number | 是 | 否 | 进程ID。 | -| uid9+ | number | 是 | 否 | 用户ID。 | -| processName9+ | string | 是 | 否 | 进程的名称。 | -| bundleNames9+ | Array\ | 是 | 否 | 进程中运行的bundleName数组。 | - -## ApplicationState9+ - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 值 | 说明 | -| -------------------- | --- | --------------------------------- | -| STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 | -| STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 | -| STATE_ACTIVE | 3 | 当应用在获焦的时候处于的状态。 | -| STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 | -| STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 | - -## ProcessState9+ - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 值 | 说明 | -| -------------------- | --- | --------------------------------- | -| STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 | -| STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 | -| STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 | -| STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 | -| STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index d2364b5ed0b53f0d3471592f534af367b91ff0e3..313c1ddffc38a4c2a2bb1fba21d6ee0197ccdf0f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -1360,10 +1360,6 @@ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void > **说明：** > 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的[mute](#mute9)替代。 -**需要权限：** ohos.permission.ACCESS_NOTIFICATION_POLICY - -仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。 - **系统能力：** SystemCapability.Multimedia.Audio.Volume **参数：** @@ -1395,10 +1391,6 @@ mute(volumeType: AudioVolumeType, mute: boolean): Promise<void> > **说明：** > 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的[mute](#mute9)替代。 -**需要权限：** ohos.permission.ACCESS_NOTIFICATION_POLICY - -仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。 - **系统能力：** SystemCapability.Multimedia.Audio.Volume **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md index ee13cd0a36bab93aae06edef41bb8e7f3180ead1..b1d523498c284620a45524b9aef3229609804321 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md @@ -18,8 +18,8 @@ import batteryInfo from '@ohos.batteryInfo'; **系统能力**：SystemCapability.PowerManager.BatteryManager.Core -| 名称 | 类型 | 可读 | 可写 | 描述 | -| ----------------------------------------- | ---------------------------------------------- | ---- | ---- | ---------------------------------------------------------- | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------- | ------------------- | ---- | ---- | ---------------------| | batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 | | chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 | | healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 | @@ -34,45 +34,39 @@ import batteryInfo from '@ohos.batteryInfo'; | nowCurrent9+ | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口。 | | remainingEnergy9+ | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口。 | - ## BatteryPluggedType 表示连接的充电器类型的枚举。 **系统能力**：SystemCapability.PowerManager.BatteryManager.Core - -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | -------- | ---- | ----------------- | | NONE | 0 | 表示连接充电器类型未知。 | | AC | 1 | 表示连接的充电器类型为交流充电器。 | | USB | 2 | 表示连接的充电器类型为USB。 | | WIRELESS | 3 | 表示连接的充电器类型为无线充电器。 | - ## BatteryChargeState 表示电池充电状态的枚举。 **系统能力**：SystemCapability.PowerManager.BatteryManager.Core - -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | ------- | ---- | --------------- | | NONE | 0 | 表示电池充电状态未知。 | | ENABLE | 1 | 表示电池充电状态为使能状态。 | | DISABLE | 2 | 表示电池充电状态为停止状态。 | | FULL | 3 | 表示电池充电状态为已充满状态。 | - ## BatteryHealthState 表示电池健康状态的枚举。 **系统能力**：SystemCapability.PowerManager.BatteryManager.Core - -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | ----------- | ---- | -------------- | | UNKNOWN | 0 | 表示电池健康状态未知。 | | GOOD | 1 | 表示电池健康状态为正常。 | @@ -87,8 +81,7 @@ import batteryInfo from '@ohos.batteryInfo'; **系统能力**：SystemCapability.PowerManager.BatteryManager.Core - -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | -------------- | ------ | ---------------------------- | | LEVEL_NONE | 0 | 表示电池电量等级未知。 | | LEVEL_FULL | 1 | 表示电池电量等级为满电量。 | @@ -103,8 +96,7 @@ import batteryInfo from '@ohos.batteryInfo'; **系统能力**：SystemCapability.PowerManager.BatteryManager.Core - -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | -------------------- | ------ | -------------------------------------------------- | | EXTRA_SOC | 0 | 表示剩余电池电量百分比的查询键。 | | EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的查询键。 | @@ -117,4 +109,3 @@ import batteryInfo from '@ohos.batteryInfo'; | EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的查询键。 | | EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的查询键。 | | EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的查询键。 | - diff --git a/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md b/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md index 63b0af54c55ab3320817c1d2fd758cb047d3ffa5..4da0838acd44f3ef436c9b445171181936b4da9c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md @@ -133,7 +133,7 @@ getAppPowerPercent(uid: number): number 获取应用的耗电百分比。 -**系统能力：** 此接口为系统接口。 +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.BatteryStatistics diff --git a/zh-cn/application-dev/reference/apis/js-apis-call.md b/zh-cn/application-dev/reference/apis/js-apis-call.md index cc9679e4d6a085fea6c55236632694b200acddad..e11e71ef91874178d01285be1de88d5df58c3a0b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-call.md +++ b/zh-cn/application-dev/reference/apis/js-apis-call.md @@ -84,7 +84,7 @@ dial\(phoneNumber: string, options?: DialOptions\): Promise | 参数名 | 类型 | 必填 | 说明 | | ----------- | --------------------------- | ---- | -------------------------------------- | | phoneNumber | string | 是 | 电话号码。 | -| options | [DialOptions](#dialoptions) | 是 | 通话参数，选择为语音通话还是视频通话。 | +| options | [DialOptions](#dialoptions) | 否 | 通话参数，选择为语音通话还是视频通话。 | **返回值：** @@ -338,7 +338,7 @@ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): | 参数名 | 类型 | 必填 | 说明 | | ----------- | -------------------------------------------------- | ---- | -------------- | | phoneNumber | string | 是 | 电话号码。 | -| options | [EmergencyNumberOptions](#emergencynumberoptions7) | 是 | 电话号码参数。 | +| options | [EmergencyNumberOptions](#emergencynumberoptions7) | 否 | 电话号码参数。 | **返回值：** @@ -426,7 +426,7 @@ formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise | 参数名 | 类型 | 必填 | 说明 | | ----------- | -------------------------------------------- | ---- | ---------------------- | | phoneNumber | string | 是 | 电话号码。 | -| options | [NumberFormatOptions](#numberformatoptions7) | 是 | 格式化参数，如国家码。 | +| options | [NumberFormatOptions](#numberformatoptions7) | 否 | 格式化参数，如国家码。 | **返回值：** @@ -566,32 +566,6 @@ promise.then(data => { }); ``` -## call.answer7+ - -answer\(callback: AsyncCallback\): void - -接听来电。使用callback异步回调。 - -此接口为系统接口。 - -**需要权限**：ohos.permission.ANSWER_CALL - -**系统能力**：SystemCapability.Telephony.CallManager - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ---------- | -| callback | AsyncCallback<void> | 是 | 回调函数。 | - -**示例：** - -```js -call.answer((err, data) => { - console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); -}); -``` - ## call.answer7+ @@ -656,9 +630,10 @@ promise.then(data => { }); ``` + ## call.hangup7+ -hangup\(callback: AsyncCallback\): void +hangup\(callId: number, callback: AsyncCallback\): void 挂断电话。使用callback异步回调。 @@ -670,24 +645,25 @@ hangup\(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ---------- | -| callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------------------------------------- | +| callId | number | 是 | 呼叫id。可以通过订阅callDetailsChange事件获得。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** ```js -call.hangup((err, data) => { +call.hangup(1, (err, data) => { console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); }); ``` -## call.hangup7+ +## call.answer9+ -hangup\(callId: number, callback: AsyncCallback\): void +answer\(callback: AsyncCallback\): void -挂断电话。使用callback异步回调。 +接听来电。使用callback异步回调。 此接口为系统接口。 @@ -697,15 +673,14 @@ hangup\(callId: number, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ----------------------------------------------- | -| callId | number | 是 | 呼叫id。可以通过订阅callDetailsChange事件获得。 | -| callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** ```js -call.hangup(1, (err, data) => { +call.answer((err, data) => { console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); }); ``` @@ -746,11 +721,12 @@ promise.then(data => { }); ``` -## call.reject7+ -reject\(callback: AsyncCallback\): void +## call.hangup9+ -拒绝来电。使用callback异步回调。 +hangup\(callback: AsyncCallback\): void + +挂断电话。使用callback异步回调。 此接口为系统接口。 @@ -767,38 +743,7 @@ reject\(callback: AsyncCallback\): void **示例：** ```js -call.reject((err, data) => { - console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); -}); -``` - - -## call.reject7+ - -reject\(options: RejectMessageOptions, callback: AsyncCallback\): void - -拒绝来电。使用callback异步回调。 - -此接口为系统接口。 - -**需要权限**：ohos.permission.ANSWER_CALL - -**系统能力**：SystemCapability.Telephony.CallManager - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------------- | ---- | -------------- | -| options | [RejectMessageOptions](#rejectmessageoptions7) | 是 | 拒绝消息选项。 | -| callback | AsyncCallback<void> | 是 | 回调函数。 | - -**示例：** - -```js -let rejectMessageOptions={ - messageContent: "拦截陌生号码" -} -call.reject(rejectMessageOptions, (err, data) => { +call.hangup((err, data) => { console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); }); ``` @@ -831,6 +776,7 @@ call.reject(1, (err, data) => { }); ``` + ## call.reject7+ reject\(callId: number, options: RejectMessageOptions, callback: AsyncCallback\): void @@ -902,6 +848,65 @@ promise.then(data => { }); ``` + +## call.reject9+ + +reject\(callback: AsyncCallback\): void + +拒绝来电。使用callback异步回调。 + +此接口为系统接口。 + +**需要权限**：ohos.permission.ANSWER_CALL + +**系统能力**：SystemCapability.Telephony.CallManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例：** + +```js +call.reject((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); +``` + + +## call.reject9+ + +reject\(options: RejectMessageOptions, callback: AsyncCallback\): void + +拒绝来电。使用callback异步回调。 + +此接口为系统接口。 + +**需要权限**：ohos.permission.ANSWER_CALL + +**系统能力**：SystemCapability.Telephony.CallManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------- | ---- | -------------- | +| options | [RejectMessageOptions](#rejectmessageoptions7) | 是 | 拒绝消息选项。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例：** + +```js +let rejectMessageOptions={ + messageContent: "拦截陌生号码" +} +call.reject(rejectMessageOptions, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); +``` + + ## call.holdCall7+ holdCall\(callId: number, callback: AsyncCallback\): void @@ -2424,7 +2429,7 @@ call.setAudioDevice(1, (err, data) => { ``` -## call.setAudioDevice8+ +## call.setAudioDevice9+ setAudioDevice\(device: AudioDevice, options: AudioDeviceOptions, callback: AsyncCallback\): void @@ -2454,7 +2459,7 @@ call.setAudioDevice(1, audioDeviceOptions, (err, data) => { ``` -## call.setAudioDevice8+ +## call.setAudioDevice9+ setAudioDevice(device: AudioDevice, options?: AudioDeviceOptions): Promise @@ -2805,7 +2810,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------------------------ | ---------------------------------- | ---- | ------------------------------------------------------------ | | extras | boolean | 否 | 根据extras的值判断是否为视频通话，默认为语音通话。
- true：视频通话。
- false：语音通话。 | | accountId 8+ | number | 否 | 帐户Id。
- 0：卡槽1
- 1：卡槽2
此接口为系统接口。 | @@ -2832,7 +2837,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------------------------- | | slotId | number | 否 | 卡槽ID：
- 卡槽1：`0`。
- 卡槽2：`1`。 | @@ -2842,7 +2847,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ---------------------------------------------------------- | | countryCode | string | 否 | 国家码，支持所有国家的国家码，如：CN（中国）。默认为：CN。 | @@ -2905,7 +2910,7 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------- | ---------------------------------------------------- | ---- | ---------------- | | transferNum | string | 是 | 转移编号 | | type | [CallTransferType](#calltransfertype8) | 是 | 呼叫转移类型 | @@ -2949,7 +2954,7 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | ---------------------------------------- | ---- | -------------- | | accountNumber | string | 是 | 帐号号码 | | speakerphoneOn | boolean | 是 | 扬声器接通电话 | @@ -3033,7 +3038,7 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------- | ---- | ------------ | | type | [CallRestrictionType](#callrestrictiontype8) | 是 | 呼叫限制类型 | | password | string | 是 | 密码 | @@ -3060,7 +3065,7 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------ | ---- | -------------- | | eventId | [CallAbilityEventId](#callabilityeventid8) | 是 | 呼叫能力事件Id | @@ -3113,7 +3118,7 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | -------- | | messageContent | string | 是 | 消息内容 | @@ -3125,10 +3130,10 @@ IP多媒体系统调用模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ---------------------------------- | ---- | -------- | -| status | [TransferStatus](#transferstatus8) | 是 | 转移状态 | -| number | string | 是 | 号码 | +| status | [TransferStatus](#transferstatus8) | 是 | 转移状态 | +| number | string | 是 | 号码 | ## CallWaitingStatus7+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md b/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md index 662a9af618a06d34717e3ff7104db8fe068c5cd7..bdb5ff3ab5d80d383b686caa925b4033379e38bf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md @@ -15,7 +15,7 @@ import cardEmulation from '@ohos.nfc.cardEmulation'; 定义不同的NFC卡模拟类型。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -29,7 +29,7 @@ isSupported(feature: number): boolean 是否支持某种类型的卡模拟。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -53,9 +53,9 @@ startHCE(aidList: string[]): boolean 启动HCE业务功能。包括设置当前应用为前台优先，动态注册AID列表。 -**需要权限**：ohos.permission.NFC_CARD_EMULATION +**需要权限：** ohos.permission.NFC_CARD_EMULATION -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -69,7 +69,7 @@ stopHCE(): boolean 停止HCE业务功能。包括退出当前应用前台优先，释放动态注册的AID列表。 -**需要权限**：ohos.permission.NFC_CARD_EMULATION +**需要权限：** ohos.permission.NFC_CARD_EMULATION **系统能力：** SystemCapability.Communication.NFC.Core @@ -79,9 +79,9 @@ on(type: "hceCmd", callback: AsyncCallback): void; 订阅回调，用于接收对端读卡设备发送的APDU数据。 -**需要权限**：ohos.permission.NFC_CARD_EMULATION +**需要权限：** ohos.permission.NFC_CARD_EMULATION -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -96,9 +96,9 @@ sendResponse(responseApdu: number[]): void; 发送APDU数据到对端读卡设备。 -**需要权限**：ohos.permission.NFC_CARD_EMULATION +**需要权限：** ohos.permission.NFC_CARD_EMULATION -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md b/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md deleted file mode 100644 index 32a553012a3193e32b1b26671472eda8b4d13a65..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md +++ /dev/null @@ -1,74 +0,0 @@ -# ConfigurationConstant - -ConfigurationConstant模块提供配置信息枚举值定义的能力。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - - -```js -import ConfigurationConstant from '@ohos.application.ConfigurationConstant'; -``` - -## ConfigurationConstant.ColorMode - -使用时通过ConfigurationConstant.ColorMode获取。 - -**示例：** - -``` -ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 | -| COLOR_MODE_DARK | 0 | 深色模式。 | -| COLOR_MODE_LIGHT | 1 | 浅色模式。 | - - -## ConfigurationConstant.Direction9+ - -使用时通过ConfigurationConstant.Direction获取。 - -**示例：** - -``` -ConfigurationConstant.Direction.DIRECTION_VERTICAL -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| DIRECTION_NOT_SET | -1 | 未设置方向。 | -| DIRECTION_VERTICAL | 0 | 垂直方向。 | -| DIRECTION_HORIZONTAL | 1 | 水平方向。 | - - -## ConfigurationConstant.ScreenDensity9+ - -使用时通过ConfigurationConstant.ScreenDensity获取。 - -**示例：** - -``` -ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 | -| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 | -| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 | -| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 | -| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 | -| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 | -| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-contact.md b/zh-cn/application-dev/reference/apis/js-apis-contact.md index 674f65debd1491d3a6922b445d0fb73b08af3e00..b4325d8115f9ae89ea68708b63d69858cfacb95f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-contact.md +++ b/zh-cn/application-dev/reference/apis/js-apis-contact.md @@ -1518,7 +1518,7 @@ queryKey(id: number, holder?: Holder): Promise<string> ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------- | --------------------------------------- | ---- | ---- | -------------------------------------- | | id | number | 是 | 否 | 联系人的id。 | | key | string | 是 | 否 | 联系人的key。 | @@ -1580,7 +1580,7 @@ myContact.phoneNumbers = [phoneNumber]; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- | ------------------------- | ---- | ---- | ---------------- | | attributes | [Attribute](#attribute)[] | 是 | 是 | 联系人属性列表。 | @@ -1661,7 +1661,7 @@ let attributes = [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME, con ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------- | ---- | ---- | ---------------- | | email | string | 是 | 是 | 邮箱地址。 | | labelName | string | 是 | 是 | 邮箱的类型名称。 | @@ -1695,7 +1695,7 @@ email.email = "xxx@email.com"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------- | ---- | ---- | ---------- | | bundleName | string | 是 | 否 | 包名。 | | displayName | string | 是 | 否 | 应用名称。 | @@ -1739,7 +1739,7 @@ holder.holderId = 0; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------- | ---- | ---- | -------------- | | eventDate | string | 是 | 是 | 事件的日期。 | | labelName | string | 是 | 是 | 事件类型名称。 | @@ -1770,7 +1770,7 @@ event.eventDate = "xxxxxx"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | -------- | ---- | ---- | ------------------ | | groupId | number | 是 | 是 | 联系人群组的id。 | | title | string | 是 | 是 | 联系人群组的名称。 | @@ -1818,7 +1818,7 @@ group.title = "title"; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------- | ---- | ---- | ------------------ | | imAddress | string | 是 | 是 | 即时消息地址。 | | labelName | string | 是 | 是 | 即时消息类型名称。 | @@ -1851,7 +1851,7 @@ imAddress.imAddress = "imAddress"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------ | -------- | ---- | ---- | --------------------------- | | familyName | string | 是 | 是 | 联系人的家庭姓名。 | | familyNamePhonetic | string | 是 | 是 | 联系人的家庭姓名拼音。 | @@ -1890,7 +1890,7 @@ name.fullName = "fullName"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | ---- | ---- | -------------- | | nickName | string | 是 | 是 | 联系人的昵称。 | @@ -1919,7 +1919,7 @@ nickName.nickName = "nickName"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------- | ---- | ---- | ------------------ | | noteContent | string | 是 | 是 | 联系人的备注内容。 | @@ -1948,7 +1948,7 @@ note.noteContent = "noteContent"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----- | -------- | ---- | ---- | ---------- | | name | string | 是 | 是 | 组织名称。 | | title | string | 是 | 是 | 组织标题。 | @@ -2010,7 +2010,7 @@ organization.title = "title"; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------- | ---- | ---- | ------------------ | | labelName | string | 是 | 是 | 电话号码类型名称。 | | phoneNumber | string | 是 | 是 | 电话号码。 | @@ -2042,7 +2042,7 @@ phoneNumber.phoneNumber = "138xxxxxxxx"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ---- | -------- | ---- | ---- | -------------- | | uri | string | 是 | 是 | 联系人的头像。 | @@ -2084,7 +2084,7 @@ portrait.uri = "uri"; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | -------- | ---- | ---- | -------------------------- | | city | string | 是 | 是 | 联系人所在的城市。 | | country | string | 是 | 是 | 联系人所在的国家。 | @@ -2146,7 +2146,7 @@ postalAddress.city = "city"; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------------ | -------- | ---- | ---- | -------------- | | labelName | string | 是 | 是 | 关系类型名称。 | | relationName | string | 是 | 是 | 关系名称。 | @@ -2192,7 +2192,7 @@ relation.labelId = contact.Relation.RELATION_ASSISTANT; ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- | -------- | ---- | ---- | --------------------------------- | | labelName | string | 是 | 是 | 会话发起协议（SIP）地址类型名称。 | | sipAddress | string | 是 | 是 | 会话发起协议（SIP）地址。 | @@ -2222,7 +2222,7 @@ sipAddress.sipAddress = "sipAddress"; **系统能力**：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | -------- | ---- | ---- | ------------------ | | website | string | 是 | 是 | 联系人的网站信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md index d9ef320c4f251fdcb5ade3b66658dba4fdf66be1..9ddd395e2e3cd80eecefc9781f4295e291cc4524 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md @@ -560,15 +560,15 @@ save(deviceId: string, callback: AsyncCallback<SaveSuccessResponse>): void **示例：** -```js +FA模型示例 +```ts import distributedObject from '@ohos.data.distributedDataObject'; import featureAbility from '@ohos.ability.featureAbility'; // 获取context let context = featureAbility.getContext(); let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456"); -g_object.save("local", (status, result) => { - console.log("save status = " + status); +g_object.save("local", (result) => { console.log("save callback"); console.info("save sessionId: " + result.sessionId); console.info("save version: " + result.version); @@ -576,7 +576,8 @@ g_object.save("local", (status, result) => { }); ``` -```js +Stage模型示例 +```ts import distributedObject from '@ohos.data.distributedDataObject'; import Ability from '@ohos.application.Ability'; // 获取context @@ -588,8 +589,7 @@ class MainAbility extends Ability{ } let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456"); -g_object.save("local", (status, result) => { - console.log("save status = " + status); +g_object.save("local", (result) => { console.log("save callback"); console.info("save sessionId: " + result.sessionId); console.info("save version: " + result.version); @@ -694,13 +694,17 @@ import featureAbility from '@ohos.ability.featureAbility'; let context = featureAbility.getContext(); let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456"); -g_object.save("local").then((result) => { +// 持久化数据 +g_object.save("local", (result) => { console.log("save callback"); console.info("save sessionId " + result.sessionId); console.info("save version " + result.version); console.info("save deviceId " + result.deviceId); -}, () => { - console.error("save failed"); +}); +// 删除持久化保存的数据 +g_object.revokeSave((result) => { + console.log("revokeSave callback"); + console.log("revokeSave sessionId " + result.sessionId); }); ``` @@ -711,15 +715,24 @@ import distributedObject from '@ohos.data.distributedDataObject'; import Ability from '@ohos.application.Ability'; // 获取context let context; -class MainAbility extends Ability{ - onWindowStageCreate(windowStage){ +class MainAbility extends Ability { + onWindowStageCreate(windowStage) { context = this.context } } let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456"); -g_object.revokeSave((result, data) => { +// 持久化数据 +g_object.save("local", (result) => { + console.log("save callback"); + console.info("save sessionId " + result.sessionId); + console.info("save version " + result.version); + console.info("save deviceId " + result.deviceId); +}); +// 删除持久化保存的数据 +g_object.revokeSave((result) => { console.log("revokeSave callback"); + console.log("revokeSave sessionId " + result.sessionId); }); ``` @@ -744,13 +757,23 @@ revokeSave(): Promise<RevokeSaveSuccessResponse> FA模型示例 -```js +```ts import distributedObject from '@ohos.data.distributedDataObject'; import featureAbility from '@ohos.ability.featureAbility'; // 获取context let context = featureAbility.getContext(); let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456"); +// 持久化数据 +g_object.save("local").then((result) => { + console.log("save callback"); + console.info("save sessionId " + result.sessionId); + console.info("save version " + result.version); + console.info("save deviceId " + result.deviceId); +}, () => { + console.error("save failed"); +}); +// 删除持久化保存的数据 g_object.revokeSave().then((result) => { console.log("revokeSave callback"); console.log("sessionId" + result.sessionId); @@ -766,8 +789,8 @@ import distributedObject from '@ohos.data.distributedDataObject'; import Ability from '@ohos.application.Ability'; // 获取context let context; -class MainAbility extends Ability{ - onWindowStageCreate(windowStage){ +class MainAbility extends Ability { + onWindowStageCreate(windowStage) { context = this.context } } @@ -781,6 +804,14 @@ g_object.save("local").then((result) => { }, () => { console.error("save failed"); }); + +// 删除持久化保存的数据 +g_object.revokeSave().then((result) => { + console.log("revokeSave callback"); + console.log("sessionId" + result.sessionId); +}, () => { + console.error("revokeSave failed"); +}); ``` ## distributedObject.createDistributedObject(deprecated) @@ -985,4 +1016,4 @@ globalThis.statusCallback = (sessionId, networkId, status) => { g_object.off("status",globalThis.statusCallback); // 删除所有的上下线回调 g_object.off("status"); -``` \ No newline at end of file +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ValuesBucket.md b/zh-cn/application-dev/reference/apis/js-apis-data-valuesBucket.md similarity index 100% rename from zh-cn/application-dev/reference/apis/js-apis-data-ValuesBucket.md rename to zh-cn/application-dev/reference/apis/js-apis-data-valuesBucket.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md b/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md index bbf1cef8d5989f50ad0d89904dca14633e9f2983..42eb241afbb09f1a02f9f36f840d530ee9e0c336 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md @@ -18,7 +18,7 @@ import defaultAppMgr from '@ohos.bundle.defaultAppManager'; | --------------------------------------- | ----------- | ---------------- | | ohos.permission.GET_DEFAULT_APPLICATION | system_core | 默认应用相关权限。 | -权限等级参考[权限等级说明](../../security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E) +权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明) ## defaultAppMgr.ApplicationType @@ -29,14 +29,14 @@ import defaultAppMgr from '@ohos.bundle.defaultAppManager'; | 名称 | 值 | 说明 | | -------- | -------------------------------------- | -------------------------------------- | -| BROWSER | Web Browser | 默认浏览器。 | -| IMAGE | Image Gallery | 默认图片查看器。 | -| AUDIO | Audio Player | 默认音频播放器。 | -| VIDEO | Video Player | 默认视频播放器。 | -| PDF | PDF Viewer | 默认PDF文档查看器。 | -| WORD | Word Viewer | 默认WORD文档查看器。 | -| EXCEL | Excel Viewer | 默认EXCEL文档查看器。 | -| PPT | PPT Viewer | 默认PPT文档查看器。 | +| BROWSER | "Web Browser" | 默认浏览器。 | +| IMAGE | "Image Gallery" | 默认图片查看器。 | +| AUDIO | "Audio Player" | 默认音频播放器。 | +| VIDEO | "Video Player" | 默认视频播放器。 | +| PDF | "PDF Viewer" | 默认PDF文档查看器。 | +| WORD | "Word Viewer" | 默认WORD文档查看器。 | +| EXCEL | "Excel Viewer" | 默认EXCEL文档查看器。 | +| PPT | "PPT Viewer" | 默认PPT文档查看器。 | ## defaultAppMgr.isDefaultApplication diff --git a/zh-cn/application-dev/reference/apis/js-apis-http.md b/zh-cn/application-dev/reference/apis/js-apis-http.md index 5ca134c1a077318d9ef72fcd59df5f9a0085b526..5980a7ec6151fa70d9a00fe3a68ec25bc9f69455 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -176,7 +176,7 @@ request\(url: string, options? : HttpRequestOptions\): Promise | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------ | ---- | ----------------------------------------------- | | url | string | 是 | 发起网络请求的URL地址。 | -| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#httprequestoptions)。 | +| options | HttpRequestOptions | 否 | 参考[HttpRequestOptions](#httprequestoptions)。 | **返回值：** @@ -355,7 +355,7 @@ httpRequest.once('headersReceive', (header) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | method | [RequestMethod](#requestmethod) | 否 | 请求方式。 | | extraData | string \| Object \| ArrayBuffer6+ | 否 | 发送请求的额外数据。
- 当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content。
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求的参数补充，参数内容会拼接到URL中进行发送。6+
- 开发者传入string对象，开发者需要自行编码，将编码后的string传入。6+ | @@ -375,14 +375,14 @@ HTTP 请求方法。 | 名称 | 值 | 说明 | | :------ | ------- | :------------------ | -| OPTIONS | OPTIONS | HTTP 请求 OPTIONS。 | -| GET | GET | HTTP 请求 GET。 | -| HEAD | HEAD | HTTP 请求 HEAD。 | -| POST | POST | HTTP 请求 POST。 | -| PUT | PUT | HTTP 请求 PUT。 | -| DELETE | DELETE | HTTP 请求 DELETE。 | -| TRACE | TRACE | HTTP 请求 TRACE。 | -| CONNECT | CONNECT | HTTP 请求 CONNECT。 | +| OPTIONS | "OPTIONS" | HTTP 请求 OPTIONS。 | +| GET | "GET" | HTTP 请求 GET。 | +| HEAD | "HEAD" | HTTP 请求 HEAD。 | +| POST | "POST" | HTTP 请求 POST。 | +| PUT | "PUT" | HTTP 请求 PUT。 | +| DELETE | "DELETE" | HTTP 请求 DELETE。 | +| TRACE | "TRACE" | HTTP 请求 TRACE。 | +| CONNECT | "CONNECT" | HTTP 请求 CONNECT。 | ## ResponseCode @@ -434,7 +434,7 @@ request方法回调函数的返回值类型。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | result | string \| Object \| ArrayBuffer6+ | 是 | HTTP请求根据响应头中Content-type类型返回对应的响应格式内容：
- application/json：返回JSON格式的字符串，如需HTTP响应具体内容，需开发者自行解析
- application/octet-stream：ArrayBuffer
- 其他：string | | resultType9+ | [HttpDataType](#httpdatatype9) | 是 | 返回值类型。 | @@ -509,7 +509,7 @@ flush(): Promise\ **系统能力**：SystemCapability.Communication.NetStack -**参数：** +**返回值：** | 类型 | 说明 | | --------------------------------- | ------------------------------------- | @@ -562,7 +562,7 @@ delete(): Promise\ **系统能力**：SystemCapability.Communication.NetStack -**参数：** +**返回值：** | 类型 | 说明 | | --------------------------------- | ------------------------------------- | @@ -595,17 +595,17 @@ httpResponseCache.delete().then() => { http的数据类型。 -| **HttpDataType 的合法值** | 说明 | -| :------------------ | :----------- | -| STRING | 字符串类型。 | -| OBJECT | 对象类型。 | -| ARRAY_BUFFER | 二进制数组类型。| +| 名称 | 值 | 说明 | +| ------------------ | -- | ----------- | +| STRING | 0 | 字符串类型。 | +| OBJECT | 1 | 对象类型。 | +| ARRAY_BUFFER | 2 | 二进制数组类型。| ## HttpProtocol9+ http协议版本。 -| **HttpProtocol 的合法值** | 说明 | -| :----------------- | :----------- | -| HTTP1_1 | 协议http1.1 | -| HTTP2 | 协议http2 | +| 名称 | 说明 | +| :-------- | :----------- | +| HTTP1_1 | 协议http1.1 | +| HTTP2 | 协议http2 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md similarity index 82% rename from zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md index 1662bc3ee4ec30f315d68c2178b2974aca9d57a6..54542e2f77a567559e0db4dac829c5d1c4e5c5d8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md @@ -6,18 +6,12 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 - -```ts -import AbilityResult from '@ohos.ability.ability' -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | | resultCode | 是 | 否 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 | -| want | 是 | 否 | [Want](js-apis-ability-Want.md) | 否 | 表示ability销毁之后返回的数据。 | +| want | 是 | 否 | [Want](./js-apis-app-ability-want.md) | 否 | 表示ability销毁之后返回的数据。 | **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..5fdbf7bf0f5ca970c1eefd2c0a23d71832749b20 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md @@ -0,0 +1,45 @@ +# ConnectOptions + +ConnectOptions类型说明 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | -------- | ---- | ------------------------- | +| onConnect7+ | function | 是 | 连接成功时的回调函数。 | +| onDisconnect7+ | function | 是 | 连接失败时的回调函数。 | +| onFailed7+ | function | 是 | ConnectAbility调用失败时的回调函数。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | -------------------- | +| number | 连接的ServiceAbilityID。 | + +**示例：** + +```ts +import rpc from '@ohos.rpc'; +import featureAbility from '@ohos.ability.featureAbility'; +function onConnectCallback(element, remote){ + console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); +} +function onDisconnectCallback(element){ + console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) +} +function onFailedCallback(code){ + console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) +} +var connectId = featureAbility.connectAbility( + { + deviceId: "", + bundleName: "com.ix.ServiceAbility", + abilityName: "ServiceAbilityA", + }, + { + onConnect: onConnectCallback, + onDisconnect: onDisconnectCallback, + onFailed: onFailedCallback, + }, +); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md similarity index 90% rename from zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md index cf836bc1c035529c128cd80a5c745fe1c81a9bec..47c56032443af6ed7762698dea197363f52d764b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md @@ -1,1037 +1,1013 @@ -# DataAbilityHelper模块(JS端SDK接口) - -> **说明：** -> -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在FA模型下使用。 - -## 使用说明 - -使用前根据具体情况引入如下模块 -``` -import ohos_data_ability from '@ohos.data.dataAbility' -import ohos_data_rdb from '@ohos.data.rdb' -``` - -## DataAbilityHelper.openFile - -openFile(uri: string, mode: string, callback: AsyncCallback\): void - -在指定的远程路径中打开文件（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ---------------------------------- | -| uri | string | 是 | 指示要打开的文件的路径。 | -| mode | string | 是 | 指示文件打开模式‘rwt’。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法，返回文件说明符。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var mode = "rwt"; -DAHelper.openFile( - "dataability:///com.example.DataAbility", - mode, - (err) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.openFile - -openFile(uri: string, mode: string): Promise\ - -在指定的远程路径中打开文件（promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------------------------ | -| uri | string | 是 | 指示要打开的文件的路径。 | -| mode | string | 是 | 指示文件打开模式‘rwt’。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ---------------- | -| Promise\ | 返回文件说明符。 | - -**示例：** - -```javascript -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var mode = "rwt"; -DAHelper.openFile( - "dataability:///com.example.DataAbility", - mode).then((data) => { - console.info("==========================>openFileCallback=======================>"); -}); -``` - -## DataAbilityHelper.on - -on(type: 'dataChange', uri: string, callback: AsyncCallback\): void - -注册观察者以观察给定uri指定的数据callback通知。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------------ | -| type | string | 是 | 数据更改。 | -| uri | string | 是 | 指示要操作的数据的路径。 | -| callback | AsyncCallback\ | 是 | 指示数据更改时的回调。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var helper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -function onChangeNotify() { - console.info("==========================>onChangeNotify=======================>"); -}; -helper.on( - "dataChange", - "dataability:///com.example.DataAbility", - onChangeNotify -) -``` - -## DataAbilityHelper.off - -off(type: 'dataChange', uri: string, callback?: AsyncCallback\): void - -注消观察者以停止观察给定uri指定的数据callback通知。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------------ | -| type | string | 是 | 数据更改。 | -| uri | string | 是 | 指示要操作的数据的路径。 | -| callback | AsyncCallback\ | 否 | 指示已注册的回调。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var helper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -function onChangeNotify() { - console.info("==========================>onChangeNotify=======================>"); -}; -helper.off( - "dataChange", - "dataability:///com.example.DataAbility", -) -helper.off( - "dataChange", - "dataability:///com.example.DataAbility", - onChangeNotify -) -``` - -## DataAbilityHelper.getType - -getType(uri: string, callback: AsyncCallback\): void - -获取给定URI指定数据的MIME类型（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | --------------------------------------------- | -| uri | string | 是 | 指示要操作的数据的路径。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getType( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.getType - -getType(uri: string): Promise\ - -获取给定URI指定数据的MIME类型（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------------------------ | -| uri | string | 是 | 指示要操作的数据的路径。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ----------------------------------- | -| Promise\ | 返回与uri指定的数据匹配的MIME类型。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getType( - "dataability:///com.example.DataAbility" - ).then((data) => { - console.info("==========================>getTypeCallback=======================>"); -}); -``` - -## DataAbilityHelper.getFileTypes - -getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void - -获取支持的文件的MIME类型（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------------ | ---- | ---------------------------------- | -| uri | string | 是 | 指示要获取的文件的路径。 | -| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | -| callback | AsyncCallback\> | 是 | 回调方法，返回匹配的MIME类型数组。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getFileTypes( - "dataability:///com.example.DataAbility", - "image/*", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - - - -## DataAbilityHelper.getFileTypes - -getFileTypes(uri: string, mimeTypeFilter: string): Promise\> - -获取支持的文件的MIME类型（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------------------------- | -| uri | string | 是 | 指示要获取的文件的路径。 | -| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------ | ------------------------ | -| Promise\> | 返回匹配的MIME类型数组。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getFileTypes( - "dataability:///com.example.DataAbility", - "image/*" - ).then((data) => { - console.info("==========================>getFileTypesCallback=======================>"); -}); -``` - -## DataAbilityHelper.normalizeUri - -normalizeUri(uri: string, callback: AsyncCallback\): void - -将引用数据功能的给定uri转换为规范化uri（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ------------------------------------------------------------ | -| uri | string | 是 | 指示要规范化的uri对象。 | -| callback | AsyncCallback\ | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.normalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.normalizeUri - -normalizeUri(uri: string): Promise\ - -将引用数据功能的给定uri转换为规范化uri（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----------------------- | -| uri | string | 是 | 指示要规范化的uri对象。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ------------------------------------------------------ | -| Promise\ | 如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.normalizeUri( - "dataability:///com.example.DataAbility", - ).then((data) => { - console.info("==========================>normalizeUriCallback=======================>"); -}); -``` - -## DataAbilityHelper.denormalizeUri - -denormalizeUri(uri: string, callback: AsyncCallback\): void - -将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | --------------------------------------------------- | -| uri | string | 是 | 指示要规范化的uri对象。 | -| callback | AsyncCallback\ | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.denormalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - - - -## DataAbilityHelper.denormalizeUri - -denormalizeUri(uri: string): Promise\ - -将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----------------------- | -| uri | string | 是 | 指示要规范化的uri对象。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ----------------------------------------- | -| Promise\ | 如果反规范化成功，则返回反规范化uri对象。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.denormalizeUri( - "dataability:///com.example.DataAbility", - ).then((data) => { - console.info("==========================>denormalizeUriCallback=======================>"); -}); -``` - -## DataAbilityHelper.notifyChange - -notifyChange(uri: string, callback: AsyncCallback\): void - -通知已注册的观察者uri指定的数据资源的更改（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------------ | -| uri | string | 是 | 指示要操作的数据的路径。 | -| callback | AsyncCallback\ | 是 | 回调方法。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var helper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -helper.notifyChange( - "dataability:///com.example.DataAbility", - (err) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.notifyChange - -notifyChange(uri: string): Promise\ - -通知已注册的观察者uri指定的数据资源的更改（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------------------------ | -| uri | string | 是 | 指示要操作的数据的路径。 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | --------------------- | -| Promise\ | 返回值为Promise对象。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.notifyChange( - "dataability:///com.example.DataAbility", - ).then(() => { - console.info("==========================>notifyChangeCallback=======================>"); -}); -``` - -## DataAbilityHelper.insert - -insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\): void - -将单个数据记录插入数据库（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ---------------------- | ---- | ------------------------------------------------------ | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回插入数据记录的索引。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const valueBucket = { - "name": "rose", - "age": 22, - "salary": 200.5, - "blobType": "u8", -} -DAHelper.insert( - "dataability:///com.example.DataAbility", - valueBucket, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.insert - -insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\ - -将单个数据记录插入数据库（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ---------------- | ---- | ------------------------------------------------------ | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ------------------------ | -| Promise\ | 返回插入数据记录的索引。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const valueBucket = { - "name": "rose1", - "age": 221, - "salary": 20.5, - "blobType": "u8", -} -DAHelper.insert( - "dataability:///com.example.DataAbility", - valueBucket - ).then((data) => { - console.info("==========================>insertCallback=======================>"); -}); -``` - -## DataAbilityHelper.batchInsert - -batchInsert(uri: string, valuesBuckets: Array\, callback: AsyncCallback\): void - -插入数据库（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ----------------------- | ---- | -------------------------------- | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | Array\ | 是 | 指示要插入的数据记录。 | -| callback | AsyncCallback\ | 是 | 回调方法。返回插入的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, - {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, - {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) -DAHelper.batchInsert( - "dataability:///com.example.DataAbility", - cars, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.batchInsert - -batchInsert(uri: string, valuesBuckets: Array): Promise\ - -将多个数据记录插入数据库（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ----------------------- | ---- | ------------------------ | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | Array | 是 | 指示要插入的数据记录。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ---------------------- | -| Promise\ | 返回插入的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, - {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, - {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) -DAHelper.batchInsert( - "dataability:///com.example.DataAbility", - cars - ).then((data) => { - console.info("==========================>batchInsertCallback=======================>"); -}); -``` - -## DataAbilityHelper.delete - -delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -从数据库中删除一个或多个数据记录（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要删除的数据的路径。 | -| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法。返回已删除的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.delete( - "dataability:///com.example.DataAbility", - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.delete - -delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\; - -从数据库中删除一个或多个数据记录（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要删除的数据的路径。 | -| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ------------------------ | -| Promise\ | 返回已删除的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.delete( - "dataability:///com.example.DataAbility", - da - ).then((data) => { - console.info("==========================>deleteCallback=======================>"); -}); -``` - -## DataAbilityHelper.update - -update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -更新数据库中的数据记录（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要更新的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | -| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回更新的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const va = { - "name": "roe1", - "age": 21, - "salary": 20.5, - "blobType": "u8", -} -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.update( - "dataability:///com.example.DataAbility", - va, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataAbilityHelper.update - -update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.DataAbilityPredicates): Promise\; - -更新数据库中的数据记录（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要更新的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | -| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | -------------------------------------------- | -| Promise\ | Promise中包含更新的数据记录数。 。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const va = { - "name": "roe1", - "age": 21, - "salary": 20.5, - "blobType": "u8", -} -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.update( - "dataability:///com.example.DataAbility", - va, - da - ).then((data) => { - console.info("==========================>updateCallback=======================>"); -}); -``` - -## DataAbilityHelper.query - -query(uri: string, columns: Array\, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -查询数据库中的数据（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要查询的数据的路径。 | -| columns | Array\ | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | -| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回查询结果。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars=new Array("value1", "value2", "value3", "value4"); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.query( - "dataability:///com.example.DataAbility", - cars, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - - - -## DataAbilityHelper.query - -query(uri: string, columns?: Array\, predicates?: dataAbility.DataAbilityPredicates): Promise\; - -查询数据库中的数据（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要查询的数据的路径。 | -| columns | Array\ | 否 | 指示要查询的列。如果此参数为空，则查询所有列。 | -| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | -------------- | -| Promise\ | 返回查询结果。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars=new Array("value1", "value2", "value3", "value4"); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.query( - "dataability:///com.example.DataAbility", - cars, - da - ).then((data) => { - console.info("==========================>queryCallback=======================>"); -}); -``` - -## DataAbilityHelper.call - -call(uri: string, method: string, arg: string, extras: PacMap): Promise\ - -调用DataAbility的扩展接口，使用Promise方式作为异步方法。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | -| method | string | 是 | 被调用的方法名。 | -| arg | string | 是 |需传入的参数。 | -| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | - -**返回值：** - -| 类型 | 说明 | -|------ | ------- | -|Promise\<[PacMap](#pacmap)> | 调用的返回值。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility'; - -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); -dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) => { - console.info('Operation succeeded: ' + data); -}).catch((error) => { - console.error('Operation failed. Cause: ' + error); -}); -``` - -## DataAbilityHelper.call - -call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\): void - -调用DataAbility的扩展接口，使用callback方式作为异步方法。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | -| method | string | 是 | 被调用的方法名。 | -| arg | string | 是 |需传入的参数。 | -| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | -| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility'; - -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); -dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) => { - if (err) { - console.error('Operation failed. Cause: ' + err); - return; - } - console.info('Operation succeeded: ' + data); -}); -``` - -## DataAbilityHelper.executeBatch - -executeBatch(uri: string, operations: Array\, callback: AsyncCallback\>): void; - -查询数据库中的数据。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| -| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | -| callback | AsyncCallback\> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility'; - -// 根据DataAbilityOperation列表选择要对数据库做的操作 -let op=new Array(); -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); -dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => { - if (err) { - console.error('Operation failed. Cause: ' + err); - return; - } - console.info('Operation succeeded: ' + data); -}); -``` - -## DataAbilityHelper.executeBatch - -executeBatch(uri: string, operations: Array\): Promise\>; - -查询数据库中的数据。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | -------------------------------| ---- | ------------------------------------------------ | -| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| -| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | - -**返回值：** - -| 类型 | 说明 | -|------ | ------- | -|Promise\> | 在数组 DataAbilityResult中返回每个操作的结果。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility'; - -// 根据DataAbilityOperation列表选择要对数据库做的操作 -let op=new Array(); -let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); -dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",op ).then((data) => { - console.info('Operation succeeded: ' + data); -}).catch((error) => { - console.error('Operation failed. Cause: ' + error); -}); - -``` - -## PacMap - -[key: string]: number | string | boolean | Array\ | null; - -**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel - -| 参数名 | 参数类型 | 必填 | 说明 | -| ------ | ------ | ------ | ------ | -| [key: string] | number \| string \| boolean \| Array\ \| null | Yes| 数据存储在键值对中。| - -## DataAbilityOperation - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 类型 | 可读 | 可写 | 必填| 说明 | -| -------- | -------- | -------- | -------- | --------| -------- | -| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | -| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 | -| valuesBucket? | rdb.ValuesBucket | 是 | 否 | 否 | 指示要设置的数据值。 | -| valueBackReferences? | rdb.ValuesBucket | 是 | 否 | 否 | 指示包含一组键值对的valuesBucket对象。 | -| predicates? | dataAbility.DataAbilityPredicates | 是 | 否 | 否 | 指示要设置的筛选条件。如果此参数为空，则所有数据记录。 | -| predicatesBackReferences? | Map\ | 是 | 否 | 否 | 指示用作谓词中筛选条件的反向引用。 | -| interrupted? | boolean | 是 | 否 | 否 | 指定是否可以中断批处理操作。 | -| expectedCount? | number | 是 | 否 | 否 | 指示要更新或删除的预期行数。 | - -## DataAbilityResult - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel - -| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -------- | -| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | -| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 | \ No newline at end of file +# DataAbilityHelper模块(JS端SDK接口) + +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在FA模型下使用。 + +## 使用说明 + +使用前根据具体情况引入如下模块 +```ts +import ohos_data_ability from '@ohos.data.dataAbility' +import ohos_data_rdb from '@ohos.data.rdb' +``` + +## DataAbilityHelper.openFile + +openFile(uri: string, mode: string, callback: AsyncCallback\): void + +在指定的远程路径中打开文件（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---------------------------------- | +| uri | string | 是 | 指示要打开的文件的路径。 | +| mode | string | 是 | 指示文件打开模式‘rwt’。 | +| callback | AsyncCallback\ | 是 | 被指定的回调方法，返回文件说明符。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var mode = "rwt"; +DAHelper.openFile( + "dataability:///com.example.DataAbility", + mode, + (err) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.openFile + +openFile(uri: string, mode: string): Promise\ + +在指定的远程路径中打开文件（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------------------ | +| uri | string | 是 | 指示要打开的文件的路径。 | +| mode | string | 是 | 指示文件打开模式‘rwt’。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ---------------- | +| Promise\ | 返回文件说明符。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var mode = "rwt"; +DAHelper.openFile( + "dataability:///com.example.DataAbility", + mode).then((data) => { + console.info("==========================>openFileCallback=======================>"); +}); +``` + +## DataAbilityHelper.on + +on(type: 'dataChange', uri: string, callback: AsyncCallback\): void + +注册观察者以观察给定uri指定的数据callback通知。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| type | string | 是 | 数据更改。 | +| uri | string | 是 | 指示要操作的数据的路径。 | +| callback | AsyncCallback\ | 是 | 指示数据更改时的回调。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var helper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +function onChangeNotify() { + console.info("==========================>onChangeNotify=======================>"); +}; +helper.on( + "dataChange", + "dataability:///com.example.DataAbility", + onChangeNotify +) +``` + +## DataAbilityHelper.off + +off(type: 'dataChange', uri: string, callback?: AsyncCallback\): void + +注消观察者以停止观察给定uri指定的数据callback通知。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| type | string | 是 | 数据更改。 | +| uri | string | 是 | 指示要操作的数据的路径。 | +| callback | AsyncCallback\ | 否 | 指示已注册的回调。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var helper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +function onChangeNotify() { + console.info("==========================>onChangeNotify=======================>"); +}; +helper.off( + "dataChange", + "dataability:///com.example.DataAbility", +) +helper.off( + "dataChange", + "dataability:///com.example.DataAbility", + onChangeNotify +) +``` + +## DataAbilityHelper.getType + +getType(uri: string, callback: AsyncCallback\): void + +获取给定URI指定数据的MIME类型（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | --------------------------------------------- | +| uri | string | 是 | 指示要操作的数据的路径。 | +| callback | AsyncCallback\ | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.getType( + "dataability:///com.example.DataAbility", + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.getType + +getType(uri: string): Promise\ + +获取给定URI指定数据的MIME类型（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------------------ | +| uri | string | 是 | 指示要操作的数据的路径。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ----------------------------------- | +| Promise\ | 返回与uri指定的数据匹配的MIME类型。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.getType( + "dataability:///com.example.DataAbility" + ).then((data) => { + console.info("==========================>getTypeCallback=======================>"); +}); +``` + +## DataAbilityHelper.getFileTypes + +getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void + +获取支持的文件的MIME类型（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------------ | ---- | ---------------------------------- | +| uri | string | 是 | 指示要获取的文件的路径。 | +| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | +| callback | AsyncCallback\> | 是 | 回调方法，返回匹配的MIME类型数组。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.getFileTypes( + "dataability:///com.example.DataAbility", + "image/*", + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + + + +## DataAbilityHelper.getFileTypes + +getFileTypes(uri: string, mimeTypeFilter: string): Promise\> + +获取支持的文件的MIME类型（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------------------------- | +| uri | string | 是 | 指示要获取的文件的路径。 | +| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------ | ------------------------ | +| Promise\> | 返回匹配的MIME类型数组。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.getFileTypes( + "dataability:///com.example.DataAbility", + "image/*" + ).then((data) => { + console.info("==========================>getFileTypesCallback=======================>"); +}); +``` + +## DataAbilityHelper.normalizeUri + +normalizeUri(uri: string, callback: AsyncCallback\): void + +将引用数据功能的给定uri转换为规范化uri（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| uri | string | 是 | 指示要规范化的uri对象。 | +| callback | AsyncCallback\ | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.normalizeUri( + "dataability:///com.example.DataAbility", + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.normalizeUri + +normalizeUri(uri: string): Promise\ + +将引用数据功能的给定uri转换为规范化uri（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----------------------- | +| uri | string | 是 | 指示要规范化的uri对象。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ------------------------------------------------------ | +| Promise\ | 如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.normalizeUri( + "dataability:///com.example.DataAbility", + ).then((data) => { + console.info("==========================>normalizeUriCallback=======================>"); +}); +``` + +## DataAbilityHelper.denormalizeUri + +denormalizeUri(uri: string, callback: AsyncCallback\): void + +将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | --------------------------------------------------- | +| uri | string | 是 | 指示要规范化的uri对象。 | +| callback | AsyncCallback\ | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.denormalizeUri( + "dataability:///com.example.DataAbility", + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + + + +## DataAbilityHelper.denormalizeUri + +denormalizeUri(uri: string): Promise\ + +将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----------------------- | +| uri | string | 是 | 指示要规范化的uri对象。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ----------------------------------------- | +| Promise\ | 如果反规范化成功，则返回反规范化uri对象。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.denormalizeUri( + "dataability:///com.example.DataAbility", + ).then((data) => { + console.info("==========================>denormalizeUriCallback=======================>"); +}); +``` + +## DataAbilityHelper.notifyChange + +notifyChange(uri: string, callback: AsyncCallback\): void + +通知已注册的观察者uri指定的数据资源的更改（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| uri | string | 是 | 指示要操作的数据的路径。 | +| callback | AsyncCallback\ | 是 | 回调方法。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var helper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +helper.notifyChange( + "dataability:///com.example.DataAbility", + (err) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.notifyChange + +notifyChange(uri: string): Promise\ + +通知已注册的观察者uri指定的数据资源的更改（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------------------ | +| uri | string | 是 | 指示要操作的数据的路径。 | + +**返回值：** + +| 类型 | 说明 | +| -------------- | --------------------- | +| Promise\ | 返回值为Promise对象。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +DAHelper.notifyChange( + "dataability:///com.example.DataAbility", + ).then(() => { + console.info("==========================>notifyChangeCallback=======================>"); +}); +``` + +## DataAbilityHelper.insert + +insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\): void + +将单个数据记录插入数据库（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ---------------------- | ---- | ------------------------------------------------------ | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | +| callback | AsyncCallback\ | 是 | 回调方法，返回插入数据记录的索引。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +const valueBucket = { + "name": "rose", + "age": 22, + "salary": 200.5, + "blobType": "u8", +} +DAHelper.insert( + "dataability:///com.example.DataAbility", + valueBucket, + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.insert + +insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\ + +将单个数据记录插入数据库（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ---------------- | ---- | ------------------------------------------------------ | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ------------------------ | +| Promise\ | 返回插入数据记录的索引。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +const valueBucket = { + "name": "rose1", + "age": 221, + "salary": 20.5, + "blobType": "u8", +} +DAHelper.insert( + "dataability:///com.example.DataAbility", + valueBucket + ).then((data) => { + console.info("==========================>insertCallback=======================>"); +}); +``` + +## DataAbilityHelper.batchInsert + +batchInsert(uri: string, valuesBuckets: Array\, callback: AsyncCallback\): void + +插入数据库（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ----------------------- | ---- | -------------------------------- | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | Array\ | 是 | 指示要插入的数据记录。 | +| callback | AsyncCallback\ | 是 | 回调方法。返回插入的数据记录数。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, + {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, + {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) +DAHelper.batchInsert( + "dataability:///com.example.DataAbility", + cars, + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.batchInsert + +batchInsert(uri: string, valuesBuckets: Array): Promise\ + +将多个数据记录插入数据库（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ----------------------- | ---- | ------------------------ | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | Array | 是 | 指示要插入的数据记录。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ---------------------- | +| Promise\ | 返回插入的数据记录数。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, + {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, + {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) +DAHelper.batchInsert( + "dataability:///com.example.DataAbility", + cars + ).then((data) => { + console.info("==========================>batchInsertCallback=======================>"); +}); +``` + +## DataAbilityHelper.delete + +delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void + +从数据库中删除一个或多个数据记录（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要删除的数据的路径。 | +| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法。返回已删除的数据记录数。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.delete( + "dataability:///com.example.DataAbility", + da, + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.delete + +delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\; + +从数据库中删除一个或多个数据记录（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要删除的数据的路径。 | +| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ------------------------ | +| Promise\ | 返回已删除的数据记录数。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.delete( + "dataability:///com.example.DataAbility", + da + ).then((data) => { + console.info("==========================>deleteCallback=======================>"); +}); +``` + +## DataAbilityHelper.update + +update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void + +更新数据库中的数据记录（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要更新的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | +| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法，返回更新的数据记录数。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +const va = { + "name": "roe1", + "age": 21, + "salary": 20.5, + "blobType": "u8", +} +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.update( + "dataability:///com.example.DataAbility", + va, + da, + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + +## DataAbilityHelper.update + +update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.DataAbilityPredicates): Promise\; + +更新数据库中的数据记录（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要更新的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | +| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | -------------------------------------------- | +| Promise\ | Promise中包含更新的数据记录数。 。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +const va = { + "name": "roe1", + "age": 21, + "salary": 20.5, + "blobType": "u8", +} +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.update( + "dataability:///com.example.DataAbility", + va, + da + ).then((data) => { + console.info("==========================>updateCallback=======================>"); +}); +``` + +## DataAbilityHelper.query + +query(uri: string, columns: Array\, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void + +查询数据库中的数据（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要查询的数据的路径。 | +| columns | Array\ | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | +| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法，返回查询结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var cars=new Array("value1", "value2", "value3", "value4"); +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.query( + "dataability:///com.example.DataAbility", + cars, + da, + (err, data) => { + console.info("==========================>Called=======================>"); +}); +``` + + + +## DataAbilityHelper.query + +query(uri: string, columns?: Array\, predicates?: dataAbility.DataAbilityPredicates): Promise\; + +查询数据库中的数据（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要查询的数据的路径。 | +| columns | Array\ | 否 | 指示要查询的列。如果此参数为空，则查询所有列。 | +| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | -------------- | +| Promise\ | 返回查询结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility' +import ohos_data_ability from '@ohos.data.dataAbility' +var DAHelper = featureAbility.acquireDataAbilityHelper( + "dataability:///com.example.DataAbility" +); +var cars=new Array("value1", "value2", "value3", "value4"); +let da = new ohos_data_ability.DataAbilityPredicates() +DAHelper.query( + "dataability:///com.example.DataAbility", + cars, + da + ).then((data) => { + console.info("==========================>queryCallback=======================>"); +}); +``` + +## DataAbilityHelper.call + +call(uri: string, method: string, arg: string, extras: PacMap): Promise\ + +调用DataAbility的扩展接口，使用Promise方式作为异步方法。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | +| method | string | 是 | 被调用的方法名。 | +| arg | string | 是 |需传入的参数。 | +| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | + +**返回值：** + +| 类型 | 说明 | +|------ | ------- | +|Promise\<[PacMap](#pacmap)> | 调用的返回值。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) => { + console.info('Operation succeeded: ' + data); +}).catch((error) => { + console.error('Operation failed. Cause: ' + error); +}); +``` + +## DataAbilityHelper.call + +call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\): void + +调用DataAbility的扩展接口，使用callback方式作为异步方法。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | +| method | string | 是 | 被调用的方法名。 | +| arg | string | 是 |需传入的参数。 | +| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | +| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) => { + if (err) { + console.error('Operation failed. Cause: ' + err); + return; + } + console.info('Operation succeeded: ' + data); +}); +``` + +## DataAbilityHelper.executeBatch + +executeBatch(uri: string, operations: Array\, callback: AsyncCallback\>): void; + +查询数据库中的数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| +| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | +| callback | AsyncCallback\> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +// 根据DataAbilityOperation列表选择要对数据库做的操作 +let op=new Array(); +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => { + if (err) { + console.error('Operation failed. Cause: ' + err); + return; + } + console.info('Operation succeeded: ' + data); +}); +``` + +## DataAbilityHelper.executeBatch + +executeBatch(uri: string, operations: Array\): Promise\>; + +查询数据库中的数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | -------------------------------| ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| +| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | + +**返回值：** + +| 类型 | 说明 | +|------ | ------- | +|Promise\> | 在数组 DataAbilityResult中返回每个操作的结果。 | + +**示例：** + +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +// 根据DataAbilityOperation列表选择要对数据库做的操作 +let op=new Array(); +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",op ).then((data) => { + console.info('Operation succeeded: ' + data); +}).catch((error) => { + console.error('Operation failed. Cause: ' + error); +}); + +``` + +## PacMap + +[key: string]: number | string | boolean | Array\ | null; + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +| 参数名 | 参数类型 | 必填 | 说明 | +| ------ | ------ | ------ | ------ | +| [key: string] | number \| string \| boolean \| Array\ \| null | Yes| 数据存储在键值对中。| \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md new file mode 100644 index 0000000000000000000000000000000000000000..59849ff98a79762a7af0f620b857638c15fba284 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md @@ -0,0 +1,66 @@ +# DataAbilityOperation + +定义dataAbility数据操作方式。 + +> **说明：** +> +> 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本接口仅可在FA模型下使用 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 类型 | 必填| 说明 | +| -------- | -------- | --------| -------- | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | +| type | featureAbility.DataAbilityOperationType | 是 | 指示操作类型。 | +| valuesBucket? | rdb.ValuesBucket | 否 | 指示要设置的数据值。 | +| valueBackReferences? | rdb.ValuesBucket | 否 | 指示包含一组键值对的valuesBucket对象。 | +| predicates? | dataAbility.DataAbilityPredicates | 否 | 指示要设置的筛选条件。如果此参数为空，则所有数据记录。 | +| predicatesBackReferences? | Map\ | 否 | 指示用作谓词中筛选条件的反向引用。 | +| interrupted? | boolean | 否 | 指定是否可以中断批处理操作。 | +| expectedCount? | number | 否 | 指示要更新或删除的预期行数。 | + +**示例：** +```ts +import featureAbility from '@ohos.ability.featureAbility' + +let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility"); +let DAHelper; +try { + DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); + if(DAHelper == null){ + console.error('DAHelper is null'); + return; + } +} catch (err) { + console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err)); + return; +} + +let valueBucket = { + "name": "DataAbilityHelperTest", + "age": 24, + "salary": 2024.20, +}; +let dataAbilityOperation = { + uri: dataAbilityUri, + type: featureAbility.DataAbilityOperationType.TYPE_INSERT, + valuesBucket: valueBucket, + predicates: null, + expectedCount: 1, + PredicatesBackReferences: {}, + interrupted: true +} +let operations = [ + dataAbilityOperation +]; +try { + DAHelper.executeBatch(dataAbilityUri, operations, + (err, data) => { + console.log("executeBatch, data: " + JSON.stringify(data)); + } + ); +} catch (err) { + console.error('executeBatch fail: ' + JSON.stringify(err)); +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md new file mode 100644 index 0000000000000000000000000000000000000000..612b883d06029d37b14349c910f28dadbd3aa7e4 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md @@ -0,0 +1,73 @@ +## DataAbilityResult + +定义dataAbility数据操作结果。 + +> **说明：** +> +> 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本接口仅可在FA模型下使用 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uri? | string | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | +| count? | number | 否 | 指示受操作影响的行数。 | + +**示例：** +```ts +import featureAbility from '@ohos.ability.featureAbility' + +let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility"); +let DAHelper; +try { + DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); + if(DAHelper == null){ + console.error('DAHelper is null'); + return; + } +} catch (err) { + console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err)); + return; +} + +let valueBucket = { + "name": "DataAbilityHelperTest", + "age": 24, + "salary": 2024.20, +}; +let operations = [ +{ + uri: dataAbilityUri, + type: featureAbility.DataAbilityOperationType.TYPE_INSERT, + valuesBucket: valueBucket, + predicates: null, + expectedCount: 1, + PredicatesBackReferences: {}, + interrupted: true, +}, +{ + uri: dataAbilityUri, + type: featureAbility.DataAbilityOperationType.TYPE_INSERT, + valuesBucket: valueBucket, + predicates: null, + expectedCount: 1, + PredicatesBackReferences: {}, + interrupted: true, +} +]; + +try { + let promise = DAHelper.executeBatch(dataAbilityUri, operations).then((data) => { + for (let i = 0; i < data.length; i++) { + let dataAbilityResult = data[i]; + console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri); + console.log('dataAbilityResult.count: ' + dataAbilityResult.count); + } + }).catch(err => { + console.error('executeBatch error: ' + JSON.stringify(err)); + }); +} catch (err) { + console.error('executeBatch error: ' + JSON.stringify(err)); +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..166b220546ee4a2f4bfdecc298ff279e9ba17bc8 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md @@ -0,0 +1,44 @@ +# StartAbilityParameter + +定义启动Ability参数。 + +> **说明：** +> +> 本接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本接口仅可在FA模型下使用 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 类型 | 必填 | 说明 | +| ------------------- | -------- | ---- | -------------------------------------- | +| want | [Want](js-apis-application-want.md)| 是 | 表示需要包含有关目标启动能力的信息。 | +| abilityStartSetting | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 | + +**示例：** +```ts +import featureAbility from '@ohos.ability.featureAbility' + +let Want = { + bundleName: "com.example.abilityStartSettingApp2", + abilityName: "com.example.abilityStartSettingApp.MainAbility", +} + +let abilityStartSetting ={ + [featureAbility.AbilityStartSetting.BOUNDS_KEY] : [100,200,300,400], + [featureAbility.AbilityStartSetting.WINDOW_MODE_KEY] : + featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED, + [featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1, +} + +let startAbilityParameter = { + want:Want, + abilityStartSetting:abilityStartSetting +} + +featureAbility.startAbility(startAbilityParameter, (err,data)=>{ + console.log('errCode : ' + JSON.stringify(err)); + console.log('data : ' + JSON.stringify(data)); +} catch(error) { + console.log("startAbility error: " + JSON.stringify(error)); +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md new file mode 100644 index 0000000000000000000000000000000000000000..98eacbd321c20046adaac24b1181ba36f169b6a5 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md @@ -0,0 +1,65 @@ +# Want + +Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 + +> **说明：** +> +> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase + +| 名称 | 类型 | 必填 | 说明 | +| ----------- | -------------------- | ---- | ------------------------------------------------------------ | +| deviceId | string | 否 | 表示运行指定Ability的设备ID。 | +| bundleName | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | +| abilityName | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | +| uri | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | +| type | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | +| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | +| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | +| parameters | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | +| entities | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | +| moduleName9+ | string | 否 | 表示待启动的Ability所属的模块（module）。 | + +**示例：** + +- 基础用法 + + ```ts + var want = { + "deviceId": "", // deviceId为空表示本设备 + "bundleName": "com.extreme.test", + "abilityName": "MainAbility", + "moduleName": "entry" // moduleName非必选 + }; + this.context.startAbility(want, (error) => { + // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability + console.log("error.code = " + error.code) + }) + ``` + +- 传递FD数据，FD表示文件描述符(FileDescriptor) + + ```ts + import fileio from '@ohos.fileio'; + var fd; + try { + fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); + } catch(e) { + console.log("openSync fail:" + JSON.stringify(e)); + } + var want = { + "deviceId": "", // deviceId为空表示本设备 + "bundleName": "com.extreme.test", + "abilityName": "MainAbility", + "moduleName": "entry", // moduleName非必选 + "parameters": { + "keyFd":{"type":"FD", "value":fd} + } + }; + this.context.startAbility(want, (error) => { + // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability + console.log("error.code = " + error.code) + }) + ``` + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..39d0fbe8d3732ae200904c2b0c181734e53c265e --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md @@ -0,0 +1,24 @@ +# AppVersionInfo7+ + +定义应用版本信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------- | ------ | ---- | ---- | ------- | +| appName | string | 是 | 否 | 模块名称。 | +| versionCode | number | 是 | 否 | 模块描述信息。 | +| versionName | string | 是 | 否 | 描述信息ID。 | + +**示例：** +```ts +let appName; +let versionCode; +let versionName; +this.context.getAppVersionInfo((error, data) => { + console.info('getAppVersionInfo data is:' + JSON.stringify(data)); + appName = data.appName; + versionCode = data.versionCode; + versionName = data.versionName; +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md similarity index 88% rename from zh-cn/application-dev/reference/apis/js-apis-Context.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md index 9eb4bd06d2e25dfb16646ab33a135fe510e6b004..1cd3edb29b0bd612c7d140ff1d58a63d993d29b0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md @@ -11,7 +11,7 @@ Context模块提供了ability或application的上下文的能力，包括允许 Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下： -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getOrCreateLocalDir().then((data) => { @@ -31,13 +31,13 @@ getOrCreateLocalDir(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------- | | callback | AsyncCallback\ | 是 | 返回应用程序的本地根目录。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getOrCreateLocalDir((err, data)=>{ @@ -65,7 +65,7 @@ getOrCreateLocalDir(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getOrCreateLocalDir().then((data) => { @@ -73,8 +73,6 @@ context.getOrCreateLocalDir().then((data) => { }); ``` - - ## Context.verifyPermission7+ verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\): void @@ -85,7 +83,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ---------- | --------------------------------------- | ---- | -------------------- | | permission | string | 是 | 指定权限的名称。 | | options | [PermissionOptions](#permissionoptions7) | 是 | 权限选项。 | @@ -93,7 +91,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; import bundle from '@ohos.bundle'; var context = featureAbility.getContext(); @@ -116,14 +114,14 @@ verifyPermission(permission: string, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------- | ---- | -------------------- | | permission | string | 是 | 指定权限的名称。 | | callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.verifyPermission("com.example.permission", (err, data) =>{ @@ -141,7 +139,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\, requestCode: number, res **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------------- | ---------------------------------------- | ---- | ----------------------------------- | | permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | @@ -183,7 +181,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number, res **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.requestPermissionsFromUser( @@ -210,7 +208,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number): Pr **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------- | ----- | -------------------------------------------- | | permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | @@ -223,7 +221,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number): Pr **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.requestPermissionsFromUser( @@ -250,13 +248,13 @@ getApplicationInfo(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------ | -| callback | AsyncCallback\ | 是 | 返回当前应用程序的信息。 | +| callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 返回当前应用程序的信息。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getApplicationInfo((err, data) => { @@ -278,11 +276,11 @@ getApplicationInfo(): Promise\ | 类型 | 说明 | | ------------------------- | --------- | -| Promise\ | 当前应用程序的信息 | +| Promise\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 当前应用程序的信息 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getApplicationInfo().then((data) => { @@ -302,13 +300,13 @@ getBundleName(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------ | | callback | AsyncCallback\ | 是 | 返回当前ability的捆绑包名称。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getBundleName((err, data) => { @@ -334,7 +332,7 @@ getBundleName(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getBundleName().then((data) => { @@ -352,13 +350,13 @@ getDisplayOrientation(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------ | | callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getDisplayOrientation((err, data) => { @@ -382,7 +380,7 @@ getDisplayOrientation(): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getDisplayOrientation().then((data) => { @@ -400,13 +398,13 @@ getExternalCacheDir(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------ | | callback | AsyncCallback\ | 是 | 返回应用程序的缓存目录的绝对路径。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getExternalCacheDir((err, data) => { @@ -430,7 +428,7 @@ getExternalCacheDir(): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getExternalCacheDir().then((data) => { @@ -448,14 +446,14 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | ---------------------------------------- | ---- | ------------ | | orientation | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | | callback | AsyncCallback\ | 是 | 表示屏幕显示方向。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; import bundle from '@ohos.bundle'; var context = featureAbility.getContext(); @@ -482,7 +480,7 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; import bundle from '@ohos.bundle'; var context = featureAbility.getContext(); @@ -502,14 +500,14 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------------------- | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | callback | AsyncCallback\ | 是 | 返回回调结果。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); var show=true @@ -528,7 +526,7 @@ setShowOnLockScreen(show: boolean): Promise\; **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ---- | ------- | ---- | ---------------------------------------- | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | @@ -540,7 +538,7 @@ setShowOnLockScreen(show: boolean): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); var show=true @@ -559,14 +557,14 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | --------------------------------- | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | callback | AsyncCallback\ | 是 | 返回回调结果。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); var wakeUp=true @@ -585,7 +583,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\; **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ------- | ---- | --------------------------------- | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | @@ -597,7 +595,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); var wakeUp=true @@ -619,13 +617,13 @@ getProcessInfo(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | 是 | 返回当前进程的信息。 | +| callback | AsyncCallback\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 是 | 返回当前进程的信息。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getProcessInfo((err, data) => { @@ -647,11 +645,11 @@ getProcessInfo(): Promise\ | 类型 | 说明 | | --------------------- | ------- | -| Promise\ | 当前进程的信息 | +| Promise\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 当前进程的信息 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getProcessInfo().then((data) => { @@ -673,13 +671,13 @@ getElementName(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | -------------------------------------- | -| callback | AsyncCallback\ | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | +| callback | AsyncCallback\<[ElementName](js-apis-bundle-ElementName.md)> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getElementName((err, data) => { @@ -703,11 +701,11 @@ getElementName(): Promise\ | 类型 | 说明 | | --------------------- | ------------------------------------ | -| Promise\ | 当前ability的ohos.bundle.ElementName对象。 | +| Promise\<[ElementName](js-apis-bundle-ElementName.md)> | 当前ability的ohos.bundle.ElementName对象。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getElementName().then((data) => { @@ -725,13 +723,13 @@ getProcessName(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------- | | callback | AsyncCallback\ | 是 | 返回当前进程的名称。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getProcessName((err, data) => { @@ -757,7 +755,7 @@ getProcessName(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getProcessName().then((data) => { @@ -777,13 +775,13 @@ getCallingBundle(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------- | | callback | AsyncCallback\ | 是 | 返回调用ability的包名称。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getCallingBundle((err, data) => { @@ -809,7 +807,7 @@ getCallingBundle(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getCallingBundle().then((data) => { @@ -827,13 +825,13 @@ getCacheDir(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | --------------- | | callback | AsyncCallback\ | 是 | 返回该应用程序的内部存储目录。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getCacheDir((err, data) => { @@ -857,7 +855,7 @@ getCacheDir(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getCacheDir().then((data) => { @@ -875,13 +873,13 @@ getFilesDir(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------- | | callback | AsyncCallback\ | 是 | 返回内部存储器上此应用程序的文件目录。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getFilesDir((err, data) => { @@ -905,7 +903,7 @@ getFilesDir(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getFilesDir().then((data) => { @@ -925,13 +923,13 @@ getOrCreateDistributedDir(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getOrCreateDistributedDir((err, data) => { @@ -957,7 +955,7 @@ getOrCreateDistributedDir(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getOrCreateDistributedDir().then((data) => { @@ -975,13 +973,13 @@ getAppType(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAppType((err, data) => { @@ -1005,7 +1003,7 @@ getAppType(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAppType().then((data) => { @@ -1023,13 +1021,13 @@ getHapModuleInfo(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------------------- | | callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getHapModuleInfo((err, data) => { @@ -1053,7 +1051,7 @@ getHapModuleInfo(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getHapModuleInfo().then((data) => { @@ -1071,13 +1069,13 @@ getAppVersionInfo(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 | +| callback | AsyncCallback\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAppVersionInfo((err, data) => { @@ -1097,11 +1095,11 @@ getAppVersionInfo(): Promise\ | 类型 | 说明 | | ---------------------------------------- | --------- | -| Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 | +| Promise\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 返回应用版本信息。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAppVersionInfo().then((data) => { @@ -1119,13 +1117,13 @@ getAbilityInfo(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------------------- | | callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAbilityInfo((err, data) => { @@ -1149,7 +1147,7 @@ getAbilityInfo(): Promise\ **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getAbilityInfo().then((data) => { @@ -1173,7 +1171,7 @@ getApplicationContext(): Context **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext().getApplicationContext(); ``` @@ -1188,13 +1186,13 @@ isUpdatingConfigurations(callback: AsyncCallback\): void; **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ----------------------------- | | callback | AsyncCallback\ | 是 | 如果该能力的配置正在更改，则为true，否则为false。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.isUpdatingConfigurations((err, data) => { @@ -1218,7 +1216,7 @@ isUpdatingConfigurations(): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.isUpdatingConfigurations().then((data) => { @@ -1236,13 +1234,13 @@ printDrawnCompleted(callback: AsyncCallback\): void; **参数：** -| 参数名 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ----------- | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.printDrawnCompleted((err) => { @@ -1266,7 +1264,7 @@ printDrawnCompleted(): Promise\; **示例：** -```js +```ts import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.printDrawnCompleted().then((data) => { @@ -1279,20 +1277,20 @@ context.printDrawnCompleted().then((data) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | -| ---- | ---- |-------- | ------ | ---- | ----- | -| pid | 是 | 否 | number | 否 | 进程id。 | -| uid | 是 | 否 | number | 否 | 用户id。 | +| 名称 | 读写属性 | 类型 | 必填 | 说明 | +| ---- | ---- | ------ | ---- | ----- | +| pid | 只读 | number | 否 | 进程id。 | +| uid | 只读 | number | 否 | 用户id。 | ## PermissionRequestResult7+ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | -| ----------- | ---- |-------- | -------------- | ---- | ---------- | -| requestCode | 是 | 否 | number | 是 | 用户传入的请求代码。 | -| permissions | 是 | 否 | Array\ | 是 | 用户传入的权限。 | -| authResults | 是 | 否 | Array\ | 是 | 请求权限的结果。 | +| 名称 | 读写属性 | 类型 | 必填 | 说明 | +| ----------- | ---- | -------------- | ---- | ---------- | +| requestCode | 只读 | number | 是 | 用户传入的请求代码。 | +| permissions | 只读 | Array\ | 是 | 用户传入的权限。 | +| authResults | 只读 | Array\ | 是 | 请求权限的结果。 | ## AppVersionInfo7+ @@ -1302,4 +1300,4 @@ context.printDrawnCompleted().then((data) => { | ----------- | ------ | ---- | ---- | ------- | | appName | string | 是 | 否 | 模块名称。 | | versionCode | number | 是 | 否 | 模块描述信息。 | -| versionName | string | 是 | 否 | 描述信息ID。 | +| versionName | string | 是 | 否 | 描述信息ID。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..c1a5f7775001b63b698fc515934d03adb3281d4d --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md @@ -0,0 +1,22 @@ +# ProcessInfo7+ + +定义进程信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| pid | number | 是 | 否 | 进程ID。 | +| processName | string | 是 | 否 | 进程名称。 | + +**示例：** +```ts +import featureAbility from '@ohos.ability.featureAbility'; + +var context = featureAbility.getContext(); +context.getProcessInfo((err, data) => { + console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); + let pid = data.pid; + let processName = data.processName; +}); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md similarity index 84% rename from zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md index 1a31318d49db97a2daf8536c14c326e174616274..94fdd48abd006f2841c4e94c70c25ee8b0ec6e79 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md @@ -4,12 +4,12 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改 > **说明：** > -> 本模块首批接口从API version 8开始支持，从API version 9废弃，替换木块为[@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-app-ability-abilityDelegator.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 使用说明 通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。 -```js +```ts import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' var abilityDelegator; @@ -32,12 +32,12 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | | callback | AsyncCallback\ | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -67,7 +67,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | **返回值：** @@ -77,7 +77,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\; **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -109,12 +109,12 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | | callback | AsyncCallback\ | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -146,7 +146,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | **返回值：** @@ -156,7 +156,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\; - 示例 -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -188,12 +188,12 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\) | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | -| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | +| callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -223,13 +223,13 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 | | timeout | number | 否 | 最大等待时间，单位毫秒（ms） | -| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | +| callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var timeout = 100; @@ -262,18 +262,18 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\ | 以Promise形式返回Ability。 | +| Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 以Promise形式返回Ability。 | **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -305,11 +305,11 @@ getAppContext(): Context; | 类型 | 说明 | | ------------------------------------- | ------------------------------------------- | -| [Context](js-apis-Context.md#Context) | 应用[Context](js-apis-Context.md#Context)。 | +| [Context](js-apis-inner-application-context.md) | 应用[Context](js-apis-inner-application-context.md)。 | **示例：** -```js +```ts var abilityDelegator; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); @@ -330,17 +330,17 @@ getAbilityState(ability: UIAbility): number; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------- | ---- | --------------- | -| ability | [UIAbility](js-apis-application-ability.md#Ability) | 是 | 指定Ability对象 | +| ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 指定Ability对象 | **返回值：** | 类型 | 说明 | | ------ | ------------------------------------------------------------ | -| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-abilityDelegatorRegistry.md#AbilityLifecycleState)。 | +| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-application-abilityDelegatorRegistry.md#AbilityLifecycleState)。 | **示例：** -```js +```ts var abilityDelegator; var ability; @@ -367,11 +367,11 @@ getCurrentTopAbility(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------ | -| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | +| callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var ability; @@ -396,11 +396,11 @@ getCurrentTopAbility(): Promise\; | 类型 | 说明 | | ----------------------------------------------------------- | -------------------------------------- | -| Promise\<[UIAbility](js-apis-application-ability.md#Ability)> | 以Promise形式返回当前应用顶部ability。 | +| Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 以Promise形式返回当前应用顶部ability。 | **示例：** -```js +```ts var abilityDelegator; var ability; @@ -425,12 +425,12 @@ startAbility(want: Want, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability参数 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability参数 | | callback | AsyncCallback\ | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var want = { bundleName: "bundleName", @@ -457,7 +457,7 @@ startAbility(want: Want): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------------- | ---- | --------------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability参数 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability参数 | **返回值：** @@ -467,7 +467,7 @@ startAbility(want: Want): Promise\; **示例：** -```js +```ts var abilityDelegator; var want = { bundleName: "bundleName", @@ -499,7 +499,7 @@ doAbilityForeground(ability: UIAbility, callback: AsyncCallback\): void; **示例：** -```js +```ts var abilityDelegator; var ability; @@ -537,7 +537,7 @@ doAbilityForeground(ability: UIAbility): Promise\; **示例：** -```js +```ts var abilityDelegator; var ability; @@ -570,7 +570,7 @@ doAbilityBackground(ability: UIAbility, callback: AsyncCallback\): void; **示例：** -```js +```ts var abilityDelegator; var ability; @@ -608,7 +608,7 @@ doAbilityBackground(ability: UIAbility): Promise\; **示例：** -```js +```ts var abilityDelegator; var ability; @@ -640,7 +640,7 @@ printSync(msg: string): void; **示例：** -```js +```ts var abilityDelegator; var msg = "msg"; @@ -667,7 +667,7 @@ print(msg: string, callback: AsyncCallback\): void; **示例：** -```js +```ts var abilityDelegator; var msg = "msg"; @@ -701,7 +701,7 @@ print(msg: string): Promise\; **示例：** -```js +```ts var abilityDelegator; var msg = "msg"; @@ -726,11 +726,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------ | | cmd | string | 是 | shell命令字符串 | -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var cmd = "cmd"; @@ -756,11 +756,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\ | 是 | 表示指定的回调方法 | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var cmd = "cmd"; var timeout = 100; @@ -792,11 +792,11 @@ executeShellCommand(cmd: string, timeoutSecs?: number): Promise\ | 类型 | 说明 | | ------------------------------------------------------------ | ------------------------------------------------------------ | -| Promise\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)对象。 | +| Promise\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)对象。 | **示例：** -```js +```ts var abilityDelegator; var cmd = "cmd"; var timeout = 100; @@ -827,7 +827,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\): void; **示例：** -```js +```ts var abilityDelegator; var msg = "msg"; @@ -862,7 +862,7 @@ finishTest(msg: string, code: number): Promise\; **示例：** -```js +```ts var abilityDelegator; var msg = "msg"; @@ -884,12 +884,12 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var monitor = { @@ -917,7 +917,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | +| monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 | **返回值：** @@ -927,7 +927,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; **示例：** -```js +```ts var abilityDelegator; var monitor = { @@ -953,12 +953,12 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | +| monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 | | callback | AsyncCallback\ | 是 | 表示指定的回调方法 | **示例：** -```js +```ts var abilityDelegator; var monitor = { @@ -986,7 +986,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | +| monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 | **返回值：** @@ -996,7 +996,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; **示例：** -```js +```ts var abilityDelegator; var monitor = { @@ -1022,12 +1022,12 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ | 是 | 成功返回AbilityStage对象，失败返回空。 | **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -1057,7 +1057,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | +| monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 | | timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | **返回值：** @@ -1068,7 +1068,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise **示例：** -```js +```ts var abilityDelegator; function onAbilityCreateCallback(data) { @@ -1098,13 +1098,13 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | +| monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 | | timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | | callback | AsyncCallback\ | 是 | 成功返回AbilityStage对象，失败返回空。 | **示例：** -```js +```ts var abilityDelegator; var timeout = 100; @@ -1121,16 +1121,4 @@ abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => { console.info("waitAbilityStageMonitor callback"); }); -``` - -## AbilityStageMonitor - -提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 - -系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| moduleName9+ | string | 是 | 是 | 要监视的abilityStage的模块名。 | -| srcEntrance9+ | string | 是 | 是 | 要监视的abilityStage的源路径。 | - +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegatorArgs.md similarity index 97% rename from zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegatorArgs.md index 5cbff5c086b5f87807e9bc6ba66698da84dd6785..51524253b13b25df9a258c67a82d7d7bc3798300 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegatorArgs.md @@ -1,32 +1,34 @@ -# AbilityDelegatorArgs - -AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 使用说明 - -通过AbilityDelegatorRegistry中getArguments方法获取。 - -```js -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; - -var args = AbilityDelegatorRegistry.getArguments(); -``` - -## AbilityDelegatorArgs - -测试参数信息 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------- | ---------------------- | ---- | ---- | ------------------------------------------------------------ | -| bundleName | string | 是 | 是 | 当前被测试应用的包名 | -| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 | -| testCaseNames | string | 是 | 是 | 测试用例名称 | -| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称 | - - +# AbilityDelegatorArgs + +AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。 + +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 使用说明 + +通过AbilityDelegatorRegistry中getArguments方法获取。 + +## AbilityDelegatorArgs + +测试参数信息 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------- | ---------------------- | ---- | ---- | ------------------------------------------------------------ | +| bundleName | string | 是 | 是 | 当前被测试应用的包名 | +| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 | +| testCaseNames | string | 是 | 是 | 测试用例名称 | +| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称 | + +**示例：** + +```ts +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; + +var args = AbilityDelegatorRegistry.getArguments(); +``` + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md new file mode 100644 index 0000000000000000000000000000000000000000..9ced37e8f8c370454ac36b999987f4230622e6c8 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md @@ -0,0 +1,51 @@ +# AbilityMonitor + +AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力，最近匹配的ability对象将保存在AbilityMonitor对象中。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 使用说明 + +通过abilityDelegator中的addAbilityMonitor来设置。 + +## AbilityMonitor + +Ability监听器 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | +| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称 | +| onAbilityCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability被启动初始化时的回调函数
不设置该属性则不能收到该生命周期回调 | +| onAbilityForeground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability状态变成前台时的回调函数
不设置该属性则不能收到该生命周期回调 | +| onAbilityBackground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability状态变成后台时的回调函数
不设置该属性则不能收到该生命周期回调 | +| onAbilityDestroy?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| +| onWindowStageCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被创建时的回调函数
不设置该属性则不能收到该生命周期回调
| +| onWindowStageRestore?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被重载时的回调函数
不设置该属性则不能收到该生命周期回调
| +| onWindowStageDestroy?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| + +**示例：** + +```ts +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +var abilityDelegator; + +function onAbilityCreateCallback(data) { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityMonitor(monitor, (err : any) => { + console.info("addAbilityMonitor callback"); +}); +``` + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md similarity index 59% rename from zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md index f419bebbae38d348233b618902b28d18f9e0b779..e83303d843fa290ac7a1a8881e77735293b42636 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md @@ -10,13 +10,6 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态的定义 通过abilityManager中getAbilityRunningInfos方法获取。 -```js -import abilitymanager from '@ohos.application.abilityManager'; -abilitymanager.getAbilityRunningInfos((err,data) => { - console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); -}); -``` - ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -30,4 +23,22 @@ abilitymanager.getAbilityRunningInfos((err,data) => { | uid | number | 是 | 否 | 用户ID。 | | processName | string | 是 | 否 | 进程名称。 | | startTime | number | 是 | 否 | Ability启动时间。 | -| abilityState | [abilityManager.AbilityState](js-apis-application-abilityManager.md#abilitystate) | 是 | 否 | Ability状态。 | \ No newline at end of file +| abilityState | [abilityManager.AbilityState](js-apis-app-ability-abilityManager.md#abilitystate) | 是 | 否 | Ability状态。 | + +**示例：** + +```ts +import abilitymanager from '@ohos.application.abilityManager'; +abilitymanager.getAbilityRunningInfos((err,data) => { + console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); + for (let i = 0; i < data.length; i++) { + let abilityinfo = data[i]; + console.log("abilityinfo.ability: " + JSON.stringify(abilityinfo.ability)); + console.log("abilityinfo.pid: " + JSON.stringify(abilityinfo.pid)); + console.log("abilityinfo.uid: " + JSON.stringify(abilityinfo.uid)); + console.log("abilityinfo.processName: " + JSON.stringify(abilityinfo.processName)); + console.log("abilityinfo.startTime: " + JSON.stringify(abilityinfo.startTime)); + console.log("abilityinfo.abilityState: " + JSON.stringify(abilityinfo.abilityState)); + } +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md similarity index 99% rename from zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md index 39a672967e687ab26bc176030d4dbafb9c5dbbe8..4ee6a2ca5100870f613d93e165ec40e6d08ac2fa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md @@ -13,7 +13,7 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力， 通过AbilityStage实例来获取。 -```js +```ts import AbilityStage from '@ohos.application.AbilityStage'; class MyAbilityStage extends AbilityStage { onCreate() { diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md new file mode 100644 index 0000000000000000000000000000000000000000..840cc6da4dab10dd9bb3898dbdb2a4ce59422b74 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md @@ -0,0 +1,25 @@ +# AbilityStageMonitor + +提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | +| moduleName9+ | string | 是 | 是 | 要监视的abilityStage的模块名。 | +| srcEntrance9+ | string | 是 | 是 | 要监视的abilityStage的源路径。 | + +**示例：** +```ts +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' + +let monitor = { + moduleName: "feature_as1", + srcEntrance: "./ets/Application/MyAbilityStage.ts", +}; + +let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => { + console.info("stageMonitor waitAbilityStageMonitor, abilityStage = " + JSON.stringify(data)); +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md new file mode 100644 index 0000000000000000000000000000000000000000..d7db520eb01f75c2a42e0e84a2bb65ba037d8b48 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md @@ -0,0 +1,33 @@ +# AbilityStateData + +定义Ability状态信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------------------- | ---------| ---- | ---- | ------------------------- | +| pid8+ | number | 是 | 否 | 进程ID。 | +| bundleName8+ | string | 是 | 否 | 应用包名。 | +| abilityName8+ | string | 是 | 否 | Ability名称。 | +| uid8+ | number | 是 | 否 | 用户ID。 | +| state8+ | number | 是 | 否 | Ability状态。 | +| moduleName9+ | string | 是 | 否 | Ability所属的HAP包的名称。 | +| abilityType8+ | string | 是 | 否 | 能力类型、页面或服务等。 | + +**示例：** +```ts +import appManager from "@ohos.application.appManager" + +appManager.getForegroundApplications((error, data) => { + for(let i=0; i8+ | string | 否 | 包名。 | +| uid8+ | number | 否 | 用户ID。 | +| state8+ | number | 否 | 应用状态。 | + +**示例：** +```ts +import appManager from "@ohos.application.appManager" + +appManager.getForegroundApplications((error, data) => { + for(let i=0; i **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 使用说明 + +在使用ApplicationContext的功能前，需要通过context的实例获取。 + +```ts +let applicationContext = this.context.getApplicationContext(); +``` + +## ApplicationContext.registerAbilityLifecycleCallback + +registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**; + +注册监听应用内生命周期 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------ | -------- | ---- | ------------------------------ | +| callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------------ | +| number | 返回的此次注册监听生命周期的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| + +**示例：** + +```ts +import Ability from "@ohos.application.Ability"; + +var lifecycleId; + +export default class MyAbility extends Ability { + onCreate() { + console.log("MyAbility onCreate") + let AbilityLifecycleCallback = { + onAbilityCreate(ability) { + console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); + }, + onWindowStageCreate(ability, windowStage) { + console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); + }, + onWindowStageActive(ability, windowStage) { + console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); + }, + onWindowStageInactive(ability, windowStage) { + console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); + }, + onWindowStageDestroy(ability, windowStage) { + console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); + }, + onAbilityDestroy(ability) { + console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); + }, + onAbilityForeground(ability) { + console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); + }, + onAbilityBackground(ability) { + console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); + }, + onAbilityContinue(ability) { + console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); + } + } + // 1.通过context属性获取applicationContext + let applicationContext = this.context.getApplicationContext(); + // 2.通过applicationContext注册监听应用内生命周期 + lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); + console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); + } +} +``` + +## ApplicationContext.unregisterAbilityLifecycleCallback + +unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; + +取消监听应用内生命周期 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | -------- | ---- | -------------------------- | +| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | +| callback | AsyncCallback\ | 是 | 回调方法。 | + +**示例：** + +```ts +import Ability from "@ohos.application.Ability"; + +var lifecycleId; + +export default class MyAbility extends Ability { + onDestroy() { + let applicationContext = this.context.getApplicationContext(); + console.log("stage applicationContext: " + JSON.stringify(applicationContext)); + applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { + console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); + }); + } +} +``` + +## ApplicationContext.registerEnvironmentCallback + +registerEnvironmentCallback(callback: EnvironmentCallback): **number**; + +注册对系统环境变化的监听。使用callback异步回调。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------ | -------- | ---- | ------------------------------ | +| callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------------ | +| number | 返回的此次注册监听系统环境变化的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。| + +**示例：** + +```ts +import Ability from "@ohos.application.Ability"; + +var callbackId; + +export default class MyAbility extends Ability { + onCreate() { + console.log("MyAbility onCreate") + globalThis.applicationContext = this.context.getApplicationContext(); + let EnvironmentCallback = { + onConfigurationUpdated(config){ + console.log("onConfigurationUpdated config:" + JSON.stringify(config)); + }, + } + // 1.获取applicationContext + let applicationContext = globalThis.applicationContext; + // 2.通过applicationContext注册监听应用内生命周期 + callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); + console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); + } +} +``` + +## ApplicationContext.unregisterEnvironmentCallback + +unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; + +取消对系统环境变化的监听。使用callback异步回调。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | -------- | ---- | -------------------------- | +| callbackId | number | 是 | 注册监听系统环境变化的ID。 | +| callback | AsyncCallback\ | 是 | 回调方法。 | + +**示例：** + +```ts +import Ability from "@ohos.application.Ability"; + +var callbackId; + +export default class MyAbility extends Ability { + onDestroy() { + let applicationContext = this.context.getApplicationContext(); + applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { + console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); + }); + } +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md new file mode 100644 index 0000000000000000000000000000000000000000..dfed689e14b736eb35073438a848969654c5475b --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md @@ -0,0 +1,39 @@ +# ApplicationStateObserver + +定义应用状态监听。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------------------- | ---------| ---- | ---- | ------------------------- | +| onForegroundApplicationChanged8+ | AsyncCallback\ | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 | +| onAbilityStateChanged8+ | AsyncCallback\ | 是 | 否 | ability状态发生变化时执行的回调函数。 | +| onProcessCreated8+ | AsyncCallback\ | 是 | 否 | 进程创建时执行的回调函数。 | +| onProcessDied8+ | AsyncCallback\ | 是 | 否 | 进程销毁时执行的回调函数。 | +| onProcessStateChanged8+ | AsyncCallback\ | 是 | 否 | 进程状态更新时执行的回调函数。 | + +**示例：** +```ts +import appManager from "@ohos.application.appManager" + +let applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData)); + }, + onAbilityStateChanged(abilityStateData) { + console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData)); + }, + onProcessCreated(processData) { + console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData)); + }, + onProcessDied(processData) { + console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData)); + }, + onProcessStateChanged(processData) { + console.log('onProcessStateChanged onProcessStateChanged: ' + JSON.stringify(processData)); + } +} +let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md new file mode 100644 index 0000000000000000000000000000000000000000..6c6d4c3eeea213c8ce372ac4a9f59c0181d344ed --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md @@ -0,0 +1,23 @@ +# BaseContext + +BaseContext抽象类用于表示继承的子类Context是Stage模型还是FA模型。 + +> **说明：** +> +> 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | ------ | ---- | ---- | ------- | +| stageMode | boolean | 是 | 是 | 表示Stage模型还是FA模型。 | + +**示例：** + + ```ts + class MyContext extends BaseContext { + constructor(stageMode) { + this.stageMode = stageMode; + } + } + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md new file mode 100644 index 0000000000000000000000000000000000000000..a52eafe94507278864fc23467501e89213fc1fa5 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md @@ -0,0 +1,135 @@ +# Context模块 + +Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------- | ------ | ---- | ---- | ------- | +| resourceManager | resmgr.ResourceManager | 是 | 否 | 资源管理对象。 | +| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用程序的信息。 | +| cacheDir | string | 是 | 否 | 缓存目录。 | +| tempDir | string | 是 | 否 | 临时目录。 | +| filesDir | string | 是 | 否 | 文件目录。 | +| databaseDir | string | 是 | 否 | 数据库目录。 | +| preferencesDir | string | 是 | 否 | preferences目录。 | +| bundleCodeDir | string | 是 | 否 | 安装包目录。 | +| distributedFilesDir | string | 是 | 否 | 分布式文件目录。 | +| eventHub | string | 是 | 否 | 事件中心，提供订阅、取消订阅、触发事件对象。 | +| area | [AreaMode](#areamode) | 是 | 否 | 文件分区信息。 | + + +## Context.createBundleContext + +createBundleContext(bundleName: string): Context; + +根据包名创建安装包的上下文Context。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------- | +| bundleName | string | 是 | 包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Context | 安装包的上下文Context。 | + +**示例：** + +```ts +let bundleContext = this.context.createBundleContext("com.example.test"); +``` + +## Context.createModuleContext + +createModuleContext(moduleName: string): Context; + +根据模块名创建上下文Context。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------- | +| moduleName | string | 是 | 模块名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Context | 上下文Context。 | + +**示例：** + +```ts +let moduleContext = this.context.createModuleContext("entry"); +``` + +createModuleContext(bundleName: string, moduleName: string): Context; + +根据包名和模块名创建上下文Context。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------- | +| bundleName | string | 是 | 包名。 | +| moduleName | string | 是 | 模块名。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Context | 上下文Context。 | + +**示例：** + +```ts +let moduleContext = this.context.createModuleContext("com.example.test", "entry"); +``` + +## Context.getApplicationContext + +getApplicationContext(): ApplicationContext; + +获取应用上下文Context。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Context | 应用上下文Context。 | + +**示例：** + +```ts +let applicationContext = this.context.getApplicationContext(); +``` + +## AreaMode + +文件分区 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| -------- | -------- | -------- | +| EL1 | 0 | 设备级加密区。 | +| EL2 | 1 | 用户凭据加密区。 | 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 new file mode 100644 index 0000000000000000000000000000000000000000..a41fc3b426a8dfadaf1440a60e7f3590ec067b9e --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md @@ -0,0 +1,37 @@ +# ContinueCallback + +表示迁移完成后，返回迁移结果回调函数。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------- | -------- | ---- | ---- | ------------------ | +| onContinueDone | function | 是 | 否 | 通知迁移完成，返回迁移结果。 | + +**示例：** + + ```ts + import distributedMissionManager from '@ohos.distributedMissionManager'; + + let continueDeviceInfo = { + 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) => { + if (error.code != 0) { + console.error('continueMission failed, cause: ' + JSON.stringify(error)) + } + console.info('continueMission finished') + }) + ``` \ No newline at end of file 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 new file mode 100644 index 0000000000000000000000000000000000000000..0eaacb24b9a81bf6be47ef8482c383400d64fb57 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md @@ -0,0 +1,40 @@ +# ContinueDeviceInfo + +表示发起任务迁移时所需参数的枚举。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | ------ | ---- | ---- | ------- | +| srcDeviceId | string | 是 | 是 | 表示任务迁移源设备ID。 | +| dstDeviceId | string | 是 | 是 | 表示任务迁移目标设备ID。 | +| missionId | number | 是 | 是 | 表示任务ID。 | +| wantParam | {[key: string]: any} | 是 | 是 | 表示扩展参数。 | + +**示例：** + + ```ts + import distributedMissionManager from '@ohos.distributedMissionManager'; + + let continueDeviceInfo = { + 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) => { + if (error.code != 0) { + console.error('continueMission failed, cause: ' + JSON.stringify(error)) + } + console.info('continueMission finished') + }) + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md new file mode 100644 index 0000000000000000000000000000000000000000..2b5701a73bc3c06ddeb8c1b64430f4e57848373f --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md @@ -0,0 +1,30 @@ +# ErrorObserver + +定义异常监听。 + +## onUnhandledException + +onUnhandledException(errMsg: string): void; + +将在js运行时引发用户未捕获的异常时调用。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| errMsg | string | 否 | 有关异常的消息和错误堆栈跟踪。 | + +**示例：** + +```ts +import errorManager from '@ohos.application.errorManager'; + +let observer = { + onUnhandledException(errorMsg) { + console.log('onUnhandledException, errorMsg: ' + JSON.stringify(errorMsg)); + } +} +errorManager.registerErrorObserver(observer) +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md similarity index 99% rename from zh-cn/application-dev/reference/apis/js-apis-eventhub.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md index 181e7c03165c457c078437ba690af67eb6c799cb..e5c0502fed2c7e5271ebb4239ab14e383f533d98 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md @@ -11,7 +11,7 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件 在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。 -```js +```ts import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { func1(){ @@ -40,7 +40,7 @@ on(event: string, callback: Function): void; **示例：** - ```js + ```ts import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { @@ -78,7 +78,7 @@ off(event: string, callback?: Function): void; **示例：** - ```js + ```ts import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { @@ -116,7 +116,7 @@ emit(event: string, ...args: Object[]): void; **示例：** - ```js + ```ts import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md similarity index 90% rename from zh-cn/application-dev/reference/apis/js-apis-extension-context.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md index 2181cda4b1155534c6bbef35a4edab595af4855e..071b5563b7621ae381123b55bb09f90009106acb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md @@ -2,7 +2,7 @@ ExtensionContext是Extension的上下文环境，继承自Context。 -ExtensionContext模块提供访问特定Extension的资源的能力，对于拓展的Extension，可直接将ExtensionContext作为上下文环境，或者定义一个继承自ExtensionContext的类型作为上下文环境。如：ServiceExtension提供了ServiceExtensionContext，它在ExtensionContext的基础上扩展了启动、停止、绑定、解绑Ability的能力，详见[ServiceExtensionContext](js-apis-service-extension-context.md)。 +ExtensionContext模块提供访问特定Extension的资源的能力，对于拓展的Extension，可直接将ExtensionContext作为上下文环境，或者定义一个继承自ExtensionContext的类型作为上下文环境。如：ServiceExtension提供了ServiceExtensionContext，它在ExtensionContext的基础上扩展了启动、停止、绑定、解绑Ability的能力，详见[ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)。 > **说明：** > @@ -15,8 +15,8 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓 | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。
(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) | -| config | Configuration | 是 | 否 | 所属Module的配置信息。
(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) | +| currentHapModuleInfo | [HapModuleInfo](js-apis-bundle-HapModuleInfo.md) | 是 | 否 | 所属Hap包的信息。
(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) | +| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 所属Module的配置信息。
(详见SDK目录下的 `api\@ohos.app.ability.Configuration.d.ts`) | | extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。
(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) | ## 使用场景 @@ -30,7 +30,7 @@ ExtensionContext主要用于查询所属Extension的信息、Module的配置信 **示例：** 三个Module内都定义一个相同名称的ServiceExtension： -``` js +```ts import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility' import Want from '@ohos.application.Want' export default class TheServiceExtension extends ServiceExtension { @@ -60,7 +60,7 @@ export default class TheServiceExtension extends ServiceExtension { ``` 在entry的MainAbility的onCreate回调内启动ServiceExtension -``` js +```ts import Ability from '@ohos.app.ability.Ability' export default class MainAbility extends Ability { onCreate(want, launchParam) { @@ -76,7 +76,7 @@ export default class MainAbility extends Ability { ``` 在entry内新建一个ServiceModule.ts，专用于执行业务逻辑 -``` js +```ts export default class ServiceModel { moduleName: string; @@ -110,4 +110,4 @@ export default class ServiceModel { } } }; -``` +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md similarity index 56% rename from zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md index 1fc56d1fdfe746182190d8ff0037938496b3f5df..0b5a74b5cb8032c95f0871662dd0aaba3b37f488 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md @@ -11,14 +11,6 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行 通过abilityManager中方法获取。 -```js -import abilityManager from '@ohos.application.abilityManager'; -let upperLimit=1 -abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { - console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); -}); -``` - ## 属性 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -31,4 +23,23 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { | processName | string | 是 | 否 | 进程名称。 | | startTime | number | 是 | 否 | Extension启动时间。 | | clientPackage | Array<String> | 是 | 否 | 表示当期进程下的所有包名。 | -| type | [bundle.ExtensionAbilityType](js-apis-bundleManager.md#extensionabilitytype) | 是 | 否 | Extension类型。 | \ No newline at end of file +| type | [bundle.ExtensionAbilityType](js-apis-Bundle.md) | 是 | 否 | Extension类型。 | + +**示例：** +```ts +import abilityManager from '@ohos.application.abilityManager'; +let upperLimit=1; +abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { + console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); + for (let i=0; i { + console.info('getMissionInfo missionId is:' + JSON.stringify(data.missionId)); + console.info('getMissionInfo runningState is:' + JSON.stringify(data.runningState)); + console.info('getMissionInfo lockedState is:' + JSON.stringify(data.lockedState)); + console.info('getMissionInfo timestamp is:' + JSON.stringify(data.timestamp)); + console.info('getMissionInfo want is:' + JSON.stringify(data.want)); + console.info('getMissionInfo label is:' + JSON.stringify(data.label)); + console.info('getMissionInfo iconPath is:' + JSON.stringify(data.iconPath)); + console.info('getMissionInfo continuable is:' + JSON.stringify(data.continuable)); +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md new file mode 100644 index 0000000000000000000000000000000000000000..f3c934e8d2d2158cc89a5fed3a62b16438625e42 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md @@ -0,0 +1,42 @@ +# MissionListener + +定义系统任务状态监听。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 必填 | 说明 | +| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | +| onMissionCreated | function | 否 | 表示当系统创建任务时回调执行。 | +| onMissionDestroyed | function | 否 | 表示当系统销毁任务时回调执行。 | +| onMissionSnapshotChanged | function | 否 | 表示当系统更新任务缩略图时回调执行。 | +| onMissionMovedToFront | function | 否 | 表示当系统将任务移动到前台时回调执行。 | +| onMissionLabelUpdated | function | 否 | 表示当系统更新任务标签时回调执行。 | +| onMissionIconUpdated | function | 否 | 表示当系统更新任务图标时回调执行。 | +| onMissionClosed | function | 否 | 表示当系统关闭任务时回调执行。 | + +**示例：** +```ts +import missionManager from '@ohos.application.missionManager' + +let listener = { + onMissionCreated: function (mission) { + console.log("onMissionCreated mission: " + JSON.stringify(mission)); + }, + onMissionDestroyed: function (mission) { + console.log("onMissionDestroyed mission: " + JSON.stringify(mission)); + }, + onMissionSnapshotChanged: function (mission) { + console.log("onMissionSnapshotChanged mission: " + JSON.stringify(mission)); + }, + onMissionMovedToFront: function (mission) { + console.log("onMissionMovedToFront mission: " + JSON.stringify(mission)); + }, + onMissionIconUpdated: function (mission, icon) { + console.log("onMissionIconUpdated mission: " + JSON.stringify(mission)); + }, + onMissionClosed: function (mission) { + console.log("onMissionClosed mission: " + JSON.stringify(mission)); + } +}; +let listenerid = missionManager.registerMissionListener(listener); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..2c3fd769ab3b2e54388449f43c720539e813e3cf --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md @@ -0,0 +1,31 @@ +# MissionParameter + +表示同步时所需参数的枚举。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------- | ------- | ---- | ---- | ----------- | +| deviceId | string | 是 | 是 | 表示设备ID。 | +| fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 | +| tag | number | 是 | 是 | 表示特定的标签。 | + +**示例：** +```ts +import distributedMissionManager from '@ohos.distributedMissionManager'; + +let missionParameter = { + deviceId: "123456", + fixConflict: true, + tag: 123 +}; +try { + distributedMissionManager.startSyncRemoteMissions(missionParameter, + (err, data) => { + console.log("startSyncRemoteMissions, data: " + JSON.stringify(data)); + } + ); +} catch (err) { + console.error('startSyncRemoteMissions fail: ' + JSON.stringify(err)); +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md old mode 100755 new mode 100644 similarity index 94% rename from zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md index ab2a696d17bd5566c15064eeb29de692f460ae59..dd5120ea69778e2c17bcfd5e27680c8fa9a6f2e5 --- a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md @@ -7,11 +7,19 @@ MissionSnapshot模块提供设置与任务对应的任务快照的任务元素 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口均为系统接口，三方应用不支持调用 +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 | +| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 | + ## 使用说明 通过missionManager中的getMissionSnapShot来获取。 -```js +**示例：** +```ts import ElementName from '@ohos.bundle'; import image from '@ohos.multimedia.image'; import missionManager from '@ohos.application.missionManager'; @@ -27,14 +35,4 @@ missionManager.getMissionInfos("", 10, (error, missions) => { console.log("bundleName = " + snapshot.ability.bundleName); }) }) -``` -## MissionSnapshot - -表示任务对应的任务快照的枚举。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 | -| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 | +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md similarity index 98% rename from zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md index c0fec4fa95b8809c1e44b813adea9ef218798481..661c6d76178d7b835e2170ccf42bb122e56cfa19 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md @@ -7,11 +7,21 @@ PermissionRequestResult模块提供了权限请求结果的能力。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + + | 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| permissions | Array<string> | 是 | 否 | 用户传入的权限。| +| authResults | Array<number> | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 | + ## 使用说明 通过AbilityContext实例来获取。 -```js +**示例：** +```ts import Ability from '@ohos.application.Ability' export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -27,14 +37,4 @@ export default class MainAbility extends Ability { }); } } -``` - - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - - | 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| permissions | Array<string> | 是 | 否 | 用户传入的权限。| -| authResults | Array<number> | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 | +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md new file mode 100644 index 0000000000000000000000000000000000000000..7ba2d4efd55af6a2f53a66e21290de121ec556a4 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md @@ -0,0 +1,43 @@ +# ProcessData + +定义进程数据。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +**系统API**：该接口为系统接口，三方应用不支持调用。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------------------- | ---------| ---- | ---- | ------------------------- | +| pid8+ | number | 是 | 否 | 进程ID。 | +| bundleName8+ | string | 是 | 否 | 应用包名。 | +| uid8+ | number | 是 | 否 | 用户ID。 | +| isContinuousTask9+ | boolean | 是 | 否 | 判断过程是否为连续任务。 | +| isKeepAlive9+ | boolean | 是 | 否 | 判断该过程是否保持活跃。 | + +**示例：** +```ts +import appManager from '@ohos.application.appManager' + +let applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData)); + }, + onAbilityStateChanged(abilityStateData) { + console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData)); + }, + onProcessCreated(processData) { + console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData)); + }, + onProcessDied(processData) { + console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData)); + }, + onProcessStateChanged(processData) { + console.log('onProcessStateChanged processData.pid : ' + JSON.stringify(processData.pid)); + console.log('onProcessStateChanged processData.bundleName : ' + JSON.stringify(processData.bundleName)); + console.log('onProcessStateChanged processData.uid : ' + JSON.stringify(processData.uid)); + console.log('onProcessStateChanged processData.isContinuousTask : ' + JSON.stringify(processData.isContinuousTask)); + console.log('onProcessStateChanged processData.isKeepAlive : ' + JSON.stringify(processData.isKeepAlive)); + } +} +let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md similarity index 73% rename from zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md index ed34599c56076fe9e3477ccb66c528da3191219e..9be2b7cd87fc6a53e45a6077641a37f29a58b2e8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md @@ -3,14 +3,26 @@ 本模块提供对进程运行信息进行设置和查询的能力。 > **说明：** -> - 本模块接口从API version 9 开始废弃，建议使用[ProcessRunningInformation9+](js-apis-processrunninginformation.md)替代。 +> - 本模块接口从API version 9 开始废弃，建议使用[ProcessRunningInformation9+](js-apis-inner-application-processRunningInformation.md)替代。 > - 本模块首批接口从API version 8 开始支持。 +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| pid | number | 是 | 否 | 进程ID。 | +| uid | number | 是 | 否 | 用户ID。 | +| processName | string | 是 | 否 | 进程名称。 | +| bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。 | + ## 使用说明 -通过appManager中[getProcessRunningInfos](js-apis-appmanager.md#appmanagergetprocessrunninginfosdeprecated)方法来获取。 +通过appManager中[getProcessRunningInfos](js-apis-application-appManager.md##appManager.getProcessRunningInfos(deprecated))方法来获取。 -```js +**示例：** +```ts import appManager from '@ohos.application.appManager'; app.getProcessRunningInfos().then((data) => { console.log('success:' + JSON.stringify(data)); @@ -18,14 +30,3 @@ app.getProcessRunningInfos().then((data) => { console.log('failed:' + JSON.stringify(error)); }); ``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| pid | number | 是 | 否 | 进程ID。 | -| uid | number | 是 | 否 | 用户ID。 | -| processName | string | 是 | 否 | 进程名称。 | -| bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-processrunninginformation.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInformation.md old mode 100755 new mode 100644 similarity index 85% rename from zh-cn/application-dev/reference/apis/js-apis-processrunninginformation.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInformation.md index e417b0991cb672f9fdec69314b079e5de19d7aab..373f4aa4c8a60b9e9498372219ecf909b3602d43 --- a/zh-cn/application-dev/reference/apis/js-apis-processrunninginformation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInformation.md @@ -8,9 +8,9 @@ ProcessRunningInformation模块提供对进程运行信息进行设置和查询 ## 使用说明 -通过[appManager](js-apis-appmanager.md#appmanagergetprocessrunninginformation9)来获取。 +通过[appManager](js-apis-application-appManager.md#appmanagergetprocessrunninginformation9)来获取。 -```js +```ts import appManager from '@ohos.application.appManager'; appManager.getProcessRunningInformation((error,data) => { console.log("getProcessRunningInformation error: " + error.code + " data: " + JSON.stringify(data)); @@ -21,7 +21,7 @@ appManager.getProcessRunningInformation((error,data) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | pid | number | 是 | 否 | 进程ID。 | | uid | number | 是 | 否 | 用户ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md similarity index 68% rename from zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md index 43f4dca60d1eac4fd6ab768e6bad827cf600aacd..9c7cc4311ba346184c236f12ad3ea392918441ad 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md @@ -38,15 +38,32 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -88,8 +105,8 @@ startAbility(want: Want, options?: StartOptions): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 | **返回值：** @@ -101,8 +118,25 @@ startAbility(want: Want, options?: StartOptions): Promise\; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -147,16 +181,33 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -202,7 +253,7 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | @@ -210,8 +261,26 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -255,17 +324,35 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -313,9 +400,9 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | **返回值：** @@ -327,8 +414,26 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -375,15 +480,25 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -426,7 +541,7 @@ startServiceExtensionAbility(want: Want): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | **返回值：** @@ -438,8 +553,18 @@ startServiceExtensionAbility(want: Want): Promise\; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -484,7 +609,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | @@ -492,8 +617,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -540,7 +676,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | **返回值：** @@ -553,8 +689,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -598,15 +745,22 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 停止Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 停止Ability的want信息。 | | callback | AsyncCallback\ | 是 | 停止Ability的回调函数。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -649,7 +803,7 @@ stopServiceExtensionAbility(want: Want): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 停止Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 停止Ability的want信息。 | **返回值：** @@ -661,8 +815,15 @@ stopServiceExtensionAbility(want: Want): Promise\; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -707,7 +868,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 停止Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 停止Ability的want信息。 | | accountId | number | 是 | 需要停止的系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | | callback | AsyncCallback\ | 是 | 停止Ability的回调函数。 | @@ -715,8 +876,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -762,7 +931,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 停止Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 停止Ability的want信息。 | | accountId | number | 是 | 需要停止的系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | **返回值：** @@ -775,8 +944,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | **示例：** @@ -820,14 +997,18 @@ terminateSelf(callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -864,8 +1045,12 @@ terminateSelf(): Promise<void>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -894,8 +1079,8 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | + | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | **返回值：** @@ -907,8 +1092,13 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -947,9 +1137,9 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| options | ConnectOptions | 是 | 远端对象实例。 | +| options | ConnectOptions | 否 | 远端对象实例。 | **返回值：** @@ -961,8 +1151,14 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -1004,14 +1200,18 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | connection | number | 是 | 在connectAbility中返回的number。 | - | callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | **错误码：** | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000003 | Input error. The specified id does not exist. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -1063,8 +1263,12 @@ disconnectServiceExtensionAbility(connection: number): Promise<void>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000003 | Input error. The specified id does not exist. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | **示例：** @@ -1104,7 +1308,7 @@ startAbilityByCall(want: Want): Promise<Caller>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 | +| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 | **返回值：** @@ -1116,8 +1320,15 @@ startAbilityByCall(want: Want): Promise<Caller>; | 错误码ID | 错误信息 | | ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | | 401 | Invalid input parameter. | -| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000050 | Internal Error. | **示例：** @@ -1184,5 +1395,4 @@ startAbilityByCall(want: Want): Promise<Caller>; console.log('error.code: ' + JSON.stringify(paramError.code) + ' error.message: ' + JSON.stringify(paramError.message)); } - ``` - \ No newline at end of file + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md similarity index 83% rename from zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md rename to zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md index 978d61fb22593e3bd13d26f1cec086de57720e5d..986aaca7944a212ac2e57e9460e9e50a1157ed9e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md @@ -1,34 +1,31 @@ -# ShellCmdResult - -本模块提供Shell命令执行结果的能力。 - -> **说明：** -> -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 使用说明 - -通过abilityDelegator中的[executeShellCommand](js-apis-application-abilityDelegator.md#executeshellcommand)方法来获取。 - -```js -import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry"; -let abilityDelegator; -let cmd = "cmd"; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => { - console.info("executeShellCommand callback, failed: ", err); - console.info("executeShellCommand callback, success: ", data); -}); -``` - -## ShellCmdResult - -Shell命令执行结果 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------- | ------ | ---- | ---- | ------------------------------------------------------------ | -| stdResult | string | 是 | 是 | 标准输出内容。 | -| exitCode | number | 是 | 是 | 结果码。 | +# ShellCmdResult + +本模块提供Shell命令执行结果的能力。 + +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------- | ------ | ---- | ---- | ------------------------------------------------------------ | +| stdResult | string | 是 | 是 | 标准输出内容。 | +| exitCode | number | 是 | 是 | 结果码。 | + +## 使用说明 + +通过abilityDelegator中的[executeShellCommand](js-apis-inner-application-abilityDelegator.md#executeshellcommand)方法来获取。 + +**示例：** +```ts +import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry"; +let abilityDelegator; +let cmd = "cmd"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => { + console.info("executeShellCommand callback, failed: ", err); + console.info("executeShellCommand callback, success: ", data); +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md new file mode 100644 index 0000000000000000000000000000000000000000..bd3cb09328549807c191f13d586b06241b057358 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md @@ -0,0 +1,2164 @@ +# UIAbilityContext + +UIAbilityContext是Ability的上下文环境，继承自Context。 + +UIAbilityContext模块提供允许访问特定Ability的资源的能力，包括对Ability的启动、停止的设置、获取caller通信接口、拉起弹窗请求用户授权等。 + +> **说明：** +> +> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 本模块接口仅可在Stage模型下使用。 + +## 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| abilityInfo | [AbilityInfo](js-apis-bundleManager-abilityInfo.md) | 是 | 否 | Abilityinfo相关信息 | +| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | 当前hap包的信息 | +| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 表示配置信息。 | + +## AbilityContext.startAbility + +startAbility(want: Want, callback: AsyncCallback<void>): void; + +启动Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + bundleName: "com.example.myapp", + abilityName: "MyAbility" + }; + + try { + this.context.startAbility(want, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startAbility succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbility + +startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void; + +启动Ability（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | + +**错误码：** + +| 错误码ID | 错误信息 +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var options = { + windowMode: 0 + }; + + try { + this.context.startAbility(want, options, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startAbility succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startAbility + +startAbility(want: Want, options?: StartOptions): Promise<void>; + +启动Ability（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | Promise形式返回启动结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + bundleName: "com.example.myapp", + abilityName: "MyAbility" + }; + var options = { + windowMode: 0, + }; + + try { + this.context.startAbility(want, options) + .then((data) => { + // 执行正常业务 + console.log('startAbility succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityForResult + +startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void; + +启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + + try { + this.context.startAbilityForResult(want, (error, result) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log("startAbilityForResult succeed, result.resultCode = " + + result.resultCode) + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startAbilityForResult + +startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void; + +启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var options = { + windowMode: 0, + }; + + try { + this.context.startAbilityForResult(want, options, (error, result) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log("startAbilityForResult succeed, result.resultCode = " + + result.resultCode) + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityForResult + +startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>; + +启动Ability并在该Ability退出的时候返回执行结果（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | + + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回执行结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + bundleName: "com.example.myapp", + abilityName: "MyAbility" + }; + var options = { + windowMode: 0, + }; + + try { + this.context.startAbilityForResult(want, options) + .then((result) => { + // 执行正常业务 + console.log("startAbilityForResult succeed, result.resultCode = " + result.resultCode); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数，返回Ability结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log("startAbilityForResultWithAccount succeed, result.resultCode = " + + result.resultCode) + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\): void; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0 + }; + + try { + this.context.startAbilityForResultWithAccount(want, accountId, options, (error, result) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log("startAbilityForResultWithAccount succeed, result.resultCode = " + + result.resultCode) + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityForResultWithAccount + +startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\; + +启动一个Ability并在该Ability帐号销毁时返回执行结果（promise形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<AbilityResult> | 返回一个Promise，包含Ability结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0 + }; + + try { + this.context.startAbilityForResultWithAccount(want, accountId, options) + .then((result) => { + // 执行正常业务 + console.log("startAbilityForResultWithAccount succeed, result.resultCode = " + + result.resultCode) + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` +## AbilityContext.startServiceExtensionAbility + +startServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; + +启动一个新的ServiceExtensionAbility（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + + try { + this.context.startServiceExtensionAbility(want, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startServiceExtensionAbility succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startServiceExtensionAbility + +startServiceExtensionAbility(want: Want): Promise\; + +启动一个新的ServiceExtensionAbility（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + + try { + this.context.startServiceExtensionAbility(want) + .then((data) => { + // 执行正常业务 + console.log('startServiceExtensionAbility succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startServiceExtensionAbilityWithAccount + +startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +启动一个新的ServiceExtensionAbility（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startServiceExtensionAbilityWithAccount succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startServiceExtensionAbilityWithAccount + +startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\; + +启动一个新的ServiceExtensionAbility（Promise形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.startServiceExtensionAbilityWithAccount(want, accountId) + .then((data) => { + // 执行正常业务 + console.log('startServiceExtensionAbilityWithAccount succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` +## AbilityContext.stopServiceExtensionAbility + +stopServiceExtensionAbility(want: Want, callback: AsyncCallback\): void; + +停止同一应用程序内的服务（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + + try { + this.context.stopServiceExtensionAbility(want, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('stopServiceExtensionAbility succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.stopServiceExtensionAbility + +stopServiceExtensionAbility(want: Want): Promise\; + +停止同一应用程序内的服务（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + + try { + this.context.stopServiceExtensionAbility(want) + .then((data) => { + // 执行正常业务 + console.log('stopServiceExtensionAbility succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.stopServiceExtensionAbilityWithAccount + +stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +使用帐户停止同一应用程序内的服务（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('stopServiceExtensionAbilityWithAccount succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.stopServiceExtensionAbilityWithAccount + +stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\; + +使用帐户停止同一应用程序内的服务（Promise形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.stopServiceExtensionAbilityWithAccount(want, accountId) + .then((data) => { + // 执行正常业务 + console.log('stopServiceExtensionAbilityWithAccount succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.terminateSelf + +terminateSelf(callback: AsyncCallback<void>): void; + +停止Ability自身（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + this.context.terminateSelf((error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('terminateSelf succeed'); + }); + ``` + + +## AbilityContext.terminateSelf + +terminateSelf(): Promise<void>; + +停止Ability自身（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + this.context.terminateSelf().then((data) => { + // 执行正常业务 + console.log('terminateSelf succeed'); + }).catch((error) => { + // 处理业务逻辑错误 + console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + ``` + + +## AbilityContext.terminateSelfWithResult + +terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void; + +停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | +| callback | AsyncCallback<void> | 是 | callback形式返回停止结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + bundleName: "com.extreme.myapplication", + abilityName: "SecondAbility" + } + var resultCode = 100; + // 返回给接口调用方AbilityResult信息 + var abilityResult = { + want, + resultCode + } + + try { + this.context.terminateSelfWithResult(abilityResult, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('terminateSelfWithResult succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.terminateSelfWithResult + +terminateSelfWithResult(parameter: AbilityResult): Promise<void>; + +停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult 调用方的信息。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | promise形式返回停止结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + + +**示例：** + + ```ts + var want = { + bundleName: "com.extreme.myapplication", + abilityName: "SecondAbility" + } + var resultCode = 100; + // 返回给接口调用方AbilityResult信息 + var abilityResult = { + want, + resultCode + } + + try { + this.context.terminateSelfWithResult(abilityResult) + .then((data) => { + // 执行正常业务 + console.log('terminateSelfWithResult succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.connectServiceExtensionAbility + +connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; + +使用AbilityInfo.AbilityType.SERVICE模板将当前Ability连接到一个Ability。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回Ability连接的结果code。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var options = { + onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.log('----------- onFailed -----------') } + } + + var connection = null; + try { + connection = this.context.connectServiceExtensionAbility(want, options); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.connectServiceExtensionAbilityWithAccount + +connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; + +使用AbilityInfo.AbilityType.SERVICE模板和account将当前Ability连接到一个Ability。 + +**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回Ability连接的结果code。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000002 | Ability type error. The specified ability type is wrong. | +| 16000004 | Visibility verification failed. | +| 16000006 | Can not cross user operations. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + var options = { + onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, + onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, + onFailed(code) { console.log('----------- onFailed -----------') } + } + + var connection = null; + try { + connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.disconnectServiceExtensionAbility + +disconnectServiceExtensionAbility(connection: number): Promise\; + +断开连接（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| connection | number | 是 | 连接的Ability的数字代码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 返回执行结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000003 | Input error. The specified id does not exist. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + // connection为connectServiceExtensionAbility中的返回值 + var connection = 1; + + try { + this.context.disconnectServiceExtensionAbility(connection) + .then((data) => { + // 执行正常业务 + console.log('disconnectServiceExtensionAbility succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.disconnectServiceExtensionAbility + +disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\): void; + +断开连接（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| connection | number | 是 | 连接的Ability的数字代码。 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000003 | Input error. The specified id does not exist. | +| 16000011 | Context does not exist. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + // connection为connectServiceExtensionAbility中的返回值 + var connection = 1; + + try { + this.context.disconnectServiceExtensionAbility(connection, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('disconnectServiceExtensionAbility succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startAbilityByCall + +startAbilityByCall(want: Want): Promise<Caller>; + +启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<Caller> | 获取要通讯的caller对象。 | + +**示例：** + + 后台启动： + + ```ts + var caller = undefined; + + // 后台启动Ability，不配置parameters + var wantBackground = { + bundleName: "com.example.myservice", + moduleName: "entry", + abilityName: "MainAbility", + deviceId: "" + }; + + try { + this.context.startAbilityByCall(wantBackground) + .then((obj) => { + // 执行正常业务 + caller = obj; + console.log('startAbilityByCall succeed'); + }).catch((error) => { + // 处理业务逻辑错误 + console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + 前台启动： + + ```ts + var caller = undefined; + + // 前台启动Ability，将parameters中的"ohos.aafwk.param.callAbilityToForeground"配置为true + var wantForeground = { + bundleName: "com.example.myservice", + moduleName: "entry", + abilityName: "MainAbility", + deviceId: "", + parameters: { + "ohos.aafwk.param.callAbilityToForeground": true + } + }; + + try { + this.context.startAbilityByCall(wantForeground) + .then((obj) => { + // 执行正常业务 + caller = obj; + console.log('startAbilityByCall succeed'); + }).catch((error) => { + // 处理业务逻辑错误 + console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + + try { + this.context.startAbilityWithAccount(want, accountId, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startAbilityWithAccount succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\): void; + +根据account启动Ability（callback形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。| +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | +| callback | AsyncCallback\ | 是 | 启动Ability的回调函数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0 + }; + + try { + this.context.startAbilityWithAccount(want, accountId, options, (error) => { + if (error.code) { + // 处理业务逻辑错误 + console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + return; + } + // 执行正常业务 + console.log('startAbilityWithAccount succeed'); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + + +## AbilityContext.startAbilityWithAccount + +startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\; + +根据account启动Ability（Promise形式）。 + +**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | +| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | +| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 201 | The application does not have permission to call the interface. | +| 401 | Invalid input parameter. | +| 16000001 | Input error. The specified ability name does not exist. | +| 16000004 | Visibility verification failed. | +| 16000005 | Static permission denied. The specified process does not have the permission. | +| 16000006 | Can not cross user operations. | +| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. | +| 16000008 | Crowdtest App Expiration. | +| 16000009 | Can not start ability in wukong mode. | +| 16000010 | Can not operation with continue flag. | +| 16000011 | Context does not exist. | +| 16000051 | Network error. The network is abnormal. | +| 16000052 | Free install not support. The application does not support freeinstall | +| 16000053 | Not top ability. The application is not top ability. | +| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. | +| 16000055 | Free install timeout. | +| 16000056 | Can not free install other ability. | +| 16000057 | Not support cross device free install. | +| 16200001 | Caller released. The caller has been released. | +| 16000050 | Internal Error. | + +**示例：** + + ```ts + var want = { + deviceId: "", + bundleName: "com.extreme.test", + abilityName: "MainAbility" + }; + var accountId = 100; + var options = { + windowMode: 0 + }; + + try { + this.context.startAbilityWithAccount(want, accountId, options) + .then((data) => { + // 执行正常业务 + console.log('startAbilityWithAccount succeed'); + }) + .catch((error) => { + // 处理业务逻辑错误 + console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + }); + } catch (paramError) { + // 处理入参错误异常 + console.log('error.code: ' + JSON.stringify(paramError.code) + + ' error.message: ' + JSON.stringify(paramError.message)); + } + ``` + +## AbilityContext.requestPermissionsFromUser + +requestPermissionsFromUser(permissions: Array<string>, requestCallback: AsyncCallback<PermissionRequestResult>) : void; + +拉起弹窗请求用户授权（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| permissions | Array<string> | 是 | 权限列表。 | +| callback | AsyncCallback<[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | + +**示例：** + + ```ts + var permissions=['com.example.permission'] + this.context.requestPermissionsFromUser(permissions,(result) => { + console.log('requestPermissionsFromUserresult:' + JSON.stringify(result)); + }); + + ``` + + +## AbilityContext.requestPermissionsFromUser + +requestPermissionsFromUser(permissions: Array<string>) : Promise<PermissionRequestResult>; + +拉起弹窗请求用户授权（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| permissions | Array<string> | 是 | 权限列表。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```ts + var permissions=['com.example.permission'] + this.context.requestPermissionsFromUser(permissions).then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + + ``` + + +## AbilityContext.setMissionLabel + +setMissionLabel(label: string, callback:AsyncCallback<void>): void; + +设置ability在任务中显示的名称（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| label | string | 是 | 显示名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | + +**示例：** + + ```ts + this.context.setMissionLabel("test",(result) => { + console.log('requestPermissionsFromUserresult:' + JSON.stringify(result)); + }); + ``` + + +## AbilityContext.setMissionLabel + +setMissionLabel(label: string): Promise<void>; + +设置ability在任务中显示的名称（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| label | string | 是 | 显示名称。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```ts + this.context.setMissionLabel("test").then(() => { + console.log('success'); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` +## AbilityContext.setMissionIcon + +setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\): void; + +设置当前ability在任务中显示的图标（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 | +| callback | AsyncCallback\ | 是 | 指定的回调函数的结果。 | + +**示例：** + + ```ts + import image from '@ohos.multimedia.image'; + var imagePixelMap; + var color = new ArrayBuffer(0); + var initializationOptions = { + size: { + height: 100, + width: 100 + } + }; + image.createPixelMap(color, initializationOptions) + .then((data) => { + imagePixelMap = data; + }) + .catch((err) => { + console.log('--------- createPixelMap fail, err: ---------', err) + }); + this.context.setMissionIcon(imagePixelMap, (err) => { + console.log('---------- setMissionIcon fail, err: -----------', err); + }) + ``` + + +## AbilityContext.setMissionIcon + +setMissionIcon(icon: image.PixelMap): Promise\; + +设置当前ability在任务中显示的图标（promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```ts + import image from '@ohos.multimedia.image'; + var imagePixelMap; + var color = new ArrayBuffer(0); + var initializationOptions = { + size: { + height: 100, + width: 100 + } + }; + image.createPixelMap(color, initializationOptions) + .then((data) => { + imagePixelMap = data; + }) + .catch((err) => { + console.log('--------- createPixelMap fail, err: ---------', err) + }); + this.context.setMissionIcon(imagePixelMap) + .then(() => { + console.log('-------------- setMissionIcon success -------------'); + }) + .catch((err) => { + console.log('-------------- setMissionIcon fail, err: -------------', err); + }); + ``` +## AbilityContext.restoreWindowStage + +restoreWindowStage(localStorage: LocalStorage) : void; + +恢复ability中的window stage数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 | + +**示例：** + + ```ts + var storage = new LocalStorage(); + this.context.restoreWindowStage(storage); + ``` + +## AbilityContext.isTerminating + +isTerminating(): boolean; + +查询ability是否在terminating状态。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| bool | true：ability当前处于terminating状态；false：不处于terminating状态。 | + +**示例：** + + ```ts + var isTerminating = this.context.isTerminating(); + console.log('ability state :' + isTerminating); + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..1574a001f9afd5c6154b01a49383c037f6b19e53 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md @@ -0,0 +1,66 @@ +# TriggerInfo + +定义触发WantAgent所需要的的信息 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 必填 | 说明 | +| ---------- | --- | ---- | -------------------- | ---- | ----------- | +| code | number | 是 | result code。 | +| want | Want | 否 | Want。 | +| permission | string | 否 | 权限定义。 | +| extraInfo | {[key: string]: any} | 否 | 额外数据。 | + +**示例：** +```ts +import wantAgent from '@ohos.wantAgent'; + +let wantAgentInfo = { + wants: [ + { + deviceId: "", + bundleName: "com.example.apicoverhaptest", + abilityName: "com.example.apicoverhaptest.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true.true,false}", + parameters: { + myKey0: 2222 + } + } + ], + operationType: wantAgent.OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG], + extraInfo:{ + "key": "value" + } +} + +let triggerInfo = { + code: 0, + want: { + deviceId: "", + bundleName: "com.example.apicoverhaptest", + abilityName: "com.example.apicoverhaptest.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true.true,false}", + parameters: { + myKey0: 2222 + } + }, + permission: "" + extraInfo:{ + "key": "value" + } +} + +wantAgent.trigger(wantAgentInfo, triggerInfo).then((data) =>{ + console.info("trigger data: " + JSON.stringify(data)); +}).catch((err) => { + console.error("trigger err: " + JSON.stringify(err)); +}) +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..aaf328c337c9c927d699ab8d9c70828a950db2c4 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md @@ -0,0 +1,46 @@ +# WantAgentInfo + +定义触发WantAgent所需要的的信息 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 必填 | 说明 | +| -------------- | ------------------------------- | ---- | ---------------------- | +| wants | Array\ | 是 | 将被执行的动作列表。 | +| operationType | wantAgent.OperationType | 是 | 动作类型。 | +| requestCode | number | 是 | 使用者定义的一个私有值。 | +| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-wantAgent.md#WantAgentFlags)> | 否 | 动作执行属性。 | +| extraInfo | {[key: string]: any} | 否 | 额外数据。 | + +**示例：** +```ts +import wantAgent from '@ohos.wantAgent'; + +let wantAgentInfo = { + wants: [ + { + deviceId: "", + bundleName: "com.example.apicoverhaptest", + abilityName: "com.example.apicoverhaptest.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true.true,false}", + parameters: { + myKey0: 2222 + } + } + ], + operationType: wantAgent.OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG], + extraInfo:{ + "key": "value" + } +} +wantAgent.getWantAgent(wantAgentInfo).then((data) =>{ + console.info("getWantAgent data: " + JSON.stringify(data)); +}).catch((err) => { + console.error("getWantAgent err: " + JSON.stringify(err)); +}) +``` \ No newline at end of file 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 770df3a02abc270226029a54f5a6dcc0b112221f..b486bb48022331247594757cc873a8167dc381e1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-installer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-installer.md @@ -17,7 +17,7 @@ import installer from '@ohos.bundle.installer'; | ------------------------------ | ----------- | ---------------- | | ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用。 | -权限等级参考[权限等级说明](../../security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E) +权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明) ## BundleInstaller.getBundleInstaller diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-connection.md b/zh-cn/application-dev/reference/apis/js-apis-net-connection.md index 82d07447fc766815a638cc427393153b3d5c4518..64856eec56fd372f4e04dc535bcab402805de742 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-connection.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-connection.md @@ -61,7 +61,7 @@ connection.getDefaultNet().then(function (netHandle) { }) ``` -## connection.getDefaultNetSync +## connection.getDefaultNetSync9+ getDefaultNetSync(): NetHandle; @@ -302,6 +302,55 @@ connection.getDefaultNet().then(function (netHandle) { }) ``` +## connection.isDefaultNetMetered9+ + +isDefaultNetMetered(callback: AsyncCallback\): void + +检查当前网络上的数据流量使用是否被计量，使用callback方式作为异步方法。 + +**需要权限**：ohos.permission.GET_NETWORK_INFO + +**系统能力**：SystemCapability.Communication.NetManager.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | -------------------------------------- | +| callback | AsyncCallback\ | 是 | 回调函数，当前网络上的数据流量使用被计量返回true。 | + +**示例：** + +```js +connection.isDefaultNetMetered(function (error, has) { + console.log(JSON.stringify(error)) + console.log('has: ' + has) +}) +``` + +## connection.isDefaultNetMetered9+ + +isDefaultNetMetered(): Promise\ + +检查当前网络上的数据流量使用是否被计量，使用Promise方式作为异步方法。 + +**需要权限**：ohos.permission.GET_NETWORK_INFO + +**系统能力**：SystemCapability.Communication.NetManager.Core + +**返回值：** + +| 类型 | 说明 | +| ----------------- | ----------------------------------------------- | +| Promise\ | 以Promise形式返回，当前网络上的数据流量使用被计量true。 | + +**示例：** + +```js +connection.isDefaultNetMetered().then(function (has) { + console.log('has: ' + has) +}) +``` + ## connection.reportNetConnected reportNetConnected(netHandle: NetHandle, callback: AsyncCallback<void>): void @@ -490,7 +539,7 @@ enableAirplaneMode(callback: AsyncCallback\): void 开启飞行模式，使用callback方式作为异步方法。 -该接口为系统接口。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -514,7 +563,7 @@ enableAirplaneMode(): Promise\ 开启飞行模式，使用Promise方式作为异步方法。 -该接口为系统接口。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -539,7 +588,7 @@ disableAirplaneMode(callback: AsyncCallback\): void 关闭飞行模式，使用callback方式作为异步方法。 -该接口为系统接口。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -563,7 +612,7 @@ disableAirplaneMode(): Promise\ 关闭飞行模式，使用Promise方式作为异步方法。 -该接口为系统接口。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -816,19 +865,16 @@ netConnection.unregister(function (error) { ### 属性 -| 参数名 | 类型 | 说明 | -| ------ | ------ | ------------------------- | -| netId | number | 网络ID，取值为0代表没有默认网络，其余取值必须大于等于100。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | --- |------------------------- | +| netId | number | 是 | 网络ID，取值为0代表没有默认网络，其余取值必须大于等于100。 | - -### bindSocket +### bindSocket9+ bindSocket(socketParam: TCPSocket \| UDPSocket, callback: AsyncCallback\): void; 将TCPSocket或UDPSocket绑定到当前网络，使用callback方式作为异步方法。 -**需要权限**：ohos.permission.GET_NETWORK_INFO - **系统能力**：SystemCapability.Communication.NetManager.Core **参数：** @@ -870,14 +916,12 @@ connection.getDefaultNet().then(function (netHandle) { } ``` -### bindSocket +### bindSocket9+ bindSocket(socketParam: TCPSocket \| UDPSocket): Promise\; 将TCPSocket或UDPSockett绑定到当前网络，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.GET_NETWORK_INFO - **系统能力**：SystemCapability.Communication.NetManager.Core **参数：** @@ -1052,10 +1096,10 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| ----------------------- | ----------------------------------- | ------------------------------------------------------------ | -| netCapabilities | [NetCapabilities](#netcapabilities) | 存储数据网络的传输能力和承载类型。 | -| bearerPrivateIdentifier | string | 网络标识符，Wi-Fi网络的标识符是"wifi"，蜂窝网络的标识符是"slot0"（对应SIM卡1）。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------------------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| netCapabilities | [NetCapabilities](#netcapabilities) | 是 | 存储数据网络的传输能力和承载类型。 | +| bearerPrivateIdentifier | string | 否 | 网络标识符，Wi-Fi网络的标识符是"wifi"，蜂窝网络的标识符是"slot0"（对应SIM卡1）。 | ## NetCapabilities @@ -1063,12 +1107,12 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| --------------------- | ---------------------------------- | ------------------------ | -| linkUpBandwidthKbps | number | 上行（设备到网络）带宽。 | -| linkDownBandwidthKbps | number | 下行（网络到设备）带宽。 | -| networkCap | Array<[NetCap](#netcap)> | 网络具体能力。 | -| bearerTypes | Array<[NetBearType](#netbeartype)> | 网络类型。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------------- | ---------------------------------- | --- | ------------------------ | +| linkUpBandwidthKbps | number | 否 | 上行（设备到网络）带宽。 | +| linkDownBandwidthKbps | number | 否 | 下行（网络到设备）带宽。 | +| networkCap | Array\<[NetCap](#netcap)> | 否 | 网络具体能力。 | +| bearerTypes | Array\<[NetBearType](#netbeartype)> | 是 | 网络类型。 | ## NetCap @@ -1076,7 +1120,7 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------ | ---- | ---------------------- | | NET_CAPABILITY_MMS | 0 | 表示网络可以访问运营商的MMSC（Multimedia Message Service，多媒体短信服务）发送和接收彩信。 | | NET_CAPABILITY_NOT_METERED | 11 | 表示网络流量未被计费。 | @@ -1102,14 +1146,14 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| ------------- | ---------------------------------- | ---------------- | -| interfaceName | string | 网卡名称。 | -| domains | string | 所属域，默认""。 | -| linkAddresses | Array<[LinkAddress](#linkaddress)> | 链路信息。 | -| routes | Array<[RouteInfo](#routeinfo)> | 路由信息。 | -| dnses | Array<[NetAddress](#netaddress)> | 网络地址，参考[NetAddress](#netaddress)。 | -| mtu | number | 最大传输单元。 | +| 名称 | 类型 | 必填 | 说明 | +| ------------- | ---------------------------------- | ----|---------------- | +| interfaceName | string | 是 |网卡名称。 | +| domains | string | 是 |所属域，默认""。 | +| linkAddresses | Array\<[LinkAddress](#linkaddress)> | 是 |链路信息。 | +| routes | Array\<[RouteInfo](#routeinfo)> | 是 |路由信息。 | +| dnses | Array\<[NetAddress](#netaddress)>; | 是 |网络地址，参考[NetAddress](#netaddress)。 | +| mtu | number | 是 |最大传输单元。 | ## LinkAddress @@ -1117,10 +1161,10 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| ------------ | ------------------------- | -------------------- | -| address | [NetAddress](#netaddress) | 链路地址。 | -| prefixLength | number | 链路地址前缀的长度。 | +| 名称 | 类型 | 必填 |说明 | +| ------------ | ----------------------- |---- |-------------------- | +| address | [NetAddress](#netaddress) | 是 | 链路地址。 | +| prefixLength | number | 是 |链路地址前缀的长度。 | ## RouteInfo @@ -1128,13 +1172,13 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| -------------- | --------------------------- | ---------------- | -| interface | string | 网卡名称。 | -| destination | [LinkAddress](#linkaddress) | 目的地址。 | -| gateway | [NetAddress](#netaddress) | 网关地址。 | -| hasGateway | boolean | 是否有网关。 | -| isDefaultRoute | boolean | 是否为默认路由。 | +| 名称 | 类型 | 必填 |说明 | +| -------------- | --------------------------- | --- |---------------- | +| interface | string | 是 |网卡名称。 | +| destination | [LinkAddress](#linkaddress) | 是 |目的地址。 | +| gateway | [NetAddress](#netaddress) | 是 |网关地址。 | +| hasGateway | boolean | 是 |是否有网关。 | +| isDefaultRoute | boolean | 是 |是否为默认路由。 | ## NetAddress @@ -1142,8 +1186,8 @@ connection.getDefaultNet().then(function (netHandle) { **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 -| 参数名 | 类型 | 说明 | -| ------- | ------ | ------------------------------ | -| address | string | 地址。 | -| family | number | IPv4 = 1，IPv6 = 2，默认IPv4。 | -| port | number | 端口，取值范围\[0, 65535]。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------ | -- |------------------------------ | +| address | string | 是 |地址。 | +| family | number | 否 |IPv4 = 1，IPv6 = 2，默认IPv4。 | +| port | number | 否 |端口，取值范围\[0, 65535]。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md b/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md index 2c644dccc3e07b9cbbeb2cee34b52a66dc94df84..147158c9b8315816ff78561fa635072ccb35fc90 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md @@ -18,9 +18,11 @@ setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallbac 设置网络接口配置信息，使用callback方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.CONNECTIVITY_INTERNAL -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -50,9 +52,11 @@ setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise\; 设置网络接口配置信息，使用Promise方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.CONNECTIVITY_INTERNAL -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -84,9 +88,11 @@ getIfaceConfig(iface: string, callback: AsyncCallback\): 获取指定网络接口信息，使用callback方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -119,9 +125,11 @@ getIfaceConfig(iface: string): Promise\; 获取指定网络接口信息，使用Promise方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -157,9 +165,11 @@ isIfaceActive(iface?: string, callback: AsyncCallback\): void; 判断接口是否已激活，使用callback方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -186,9 +196,11 @@ isIfaceActive(iface?: string): Promise\; 判断接口是否已激活，使用Promise方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -218,9 +230,11 @@ getAllActiveIfaces(callback: AsyncCallback\>): void; 获取活动的网络接口，使用callback方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -249,9 +263,11 @@ getAllActiveIfaces(): Promise\>; 获取活动的网络接口，使用Promise方式作为异步方法。 +**系统接口**：此接口为系统接口。 + **需要权限**：ohos.permission.GET_NETWORK_INFO -**系统能力**：SystemCapability.Communication.NetManager.Core +**系统能力**：SystemCapability.Communication.NetManager.Ethernet **参数：** @@ -278,7 +294,9 @@ ethernet.getAllActiveIfaces().then((data) => { 以太网连接配置网络信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 +**系统接口**：此接口为系统接口。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Ethernet。 | 参数名 | 类型 | 说明 | | ----------------------- | ----------------------------------- | ------------------------------------------------------------ | @@ -293,9 +311,11 @@ ethernet.getAllActiveIfaces().then((data) => { 以太网连接模式。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。 +**系统接口**：此接口为系统接口。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Ethernet。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------ | ---- | ---------------------- | | STATIC | 0 | 以太网连接静态配置网络信息。 | | DHCP | 1 | 以太网连接动态配置网络信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-nfcController.md b/zh-cn/application-dev/reference/apis/js-apis-nfcController.md index dd7b4d23c0cce73e1191bb8c0817328d711932e9..a92b7985ca68352e76d54977c376c27f30a109d9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-nfcController.md +++ b/zh-cn/application-dev/reference/apis/js-apis-nfcController.md @@ -15,7 +15,7 @@ import controller from '@ohos.nfc.controller'; 定义不同的NFC状态值。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -30,7 +30,7 @@ isNfcAvailable(): boolean 查询设备是否有NFC能力。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -45,9 +45,9 @@ openNfc(): boolean 打开NFC开关。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限：** ohos.permission.MANAGE_SECURE_SETTINGS -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -61,9 +61,9 @@ closeNfc(): boolean 关闭NFC开关。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限：** ohos.permission.MANAGE_SECURE_SETTINGS -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -77,7 +77,7 @@ isNfcOpen(): boolean 查询NFC是否打开。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -91,7 +91,7 @@ getNfcState(): [NfcState](#nfcstate) 查询NFC状态。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -105,7 +105,7 @@ on(type: "nfcStateChange", callback: Callback<[NfcState](#nfcstate)>): voi 注册NFC开关状态事件，通过Callback方式获取NFC状态的变化通知。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数** @@ -120,7 +120,7 @@ off(type: "nfcStateChange", callback?: Callback<[NfcState](#nfcstate)>): v 取消NFC开关状态事件的注册，取消后NFC状态变化时，就不会再收到Callback的通知。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数** diff --git a/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md b/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md index 117d25a87de32ef4ecd2ec74e57efce255e5e240..151a7f8e13bcabef1c3245e0331506a6148dbf76 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md +++ b/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md @@ -125,9 +125,9 @@ getNfcATag(tagInfo: [TagInfo](#taginfo)): [NfcATag](js-apis-nfctech.md#nfcatag) 获取NFC A类型Tag对象，通过该对象可访问NfcA技术类型的Tag。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -141,9 +141,9 @@ getNfcBTag(tagInfo: [TagInfo](#taginfo)): [NfcBTag](js-apis-nfctech.md#nfcbtag) 获取NFC B类型Tag对象，通过该对象可访问NfcB技术类型的Tag。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -157,9 +157,9 @@ getNfcFTag(tagInfo: [TagInfo](#taginfo)): [NfcFTag](js-apis-nfctech.md#nfcftag) 获取NFC F类型Tag对象，通过该对象可访问NfcF技术类型的Tag。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -173,9 +173,9 @@ getNfcVTag(tagInfo: [TagInfo](#taginfo)): [NfcVTag](js-apis-nfctech.md#nfcvtag) 获取NFC V类型Tag对象，通过该对象可访问NfcV技术类型的Tag。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -189,7 +189,7 @@ getIsoDep(tagInfo: [TagInfo](#taginfo)): [IsoDepTag](js-apis-nfctech.md#isoDepTa 获取IsoDep类型Tag对象，通过该对象可访问支持IsoDep技术类型的Tag。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -209,7 +209,7 @@ getIsoDep(tagInfo: [TagInfo](#taginfo)): [IsoDepTag](js-apis-nfctech.md#isoDepTa | 错误码ID | 错误信息| | ------- | -------| -| 3100201 | Tag running state of service is abnormal. | +| 3100201 | Tag running state is abnormal in service. | ## tag.getNdef9+ @@ -217,7 +217,7 @@ getNdef(tagInfo: [TagInfo](#taginfo)): [NdefTag](js-apis-nfctech.md#ndeftag9) 获取NDEF类型Tag对象，通过该对象可访问支持NDEF技术类型的Tag。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -237,7 +237,7 @@ getNdef(tagInfo: [TagInfo](#taginfo)): [NdefTag](js-apis-nfctech.md#ndeftag9) | 错误码ID | 错误信息| | ------- | -------| -| 3100201 | Tag running state of service is abnormal. | +| 3100201 | Tag running state is abnormal in service. | ## tag.getMifareClassic9+ @@ -245,7 +245,7 @@ getMifareClassic(tagInfo: [TagInfo](#taginfo)): [MifareClassicTag](js-apis-nfcte 获取MIFARE Classic类型Tag对象，通过该对象访问支持MIFARE Classic技术类型的Tag。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -265,7 +265,7 @@ getMifareClassic(tagInfo: [TagInfo](#taginfo)): [MifareClassicTag](js-apis-nfcte | 错误码ID | 错误信息| | ------- | -------| -| 3100201 | Tag running state of service is abnormal. | +| 3100201 | Tag running state is abnormal in service. | ## tag.getMifareUltralight9+ @@ -273,7 +273,7 @@ getMifareUltralight(tagInfo: [TagInfo](#taginfo)): [MifareUltralightTag](js-apis 获取MIFARE Ultralight类型Tag对象，通过该对象可访问支持MIFARE Ultralight技术类型的Tag。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -292,7 +292,7 @@ getMifareUltralight(tagInfo: [TagInfo](#taginfo)): [MifareUltralightTag](js-apis | 错误码ID | 错误信息| | ------- | -------| -| 3100201 | Tag running state of service is abnormal. | +| 3100201 | Tag running state is abnormal in service. | ## tag.getNdefFormatable9+ @@ -300,7 +300,7 @@ getNdefFormatable(tagInfo: [TagInfo](#taginfo)): [NdefFormatableTag](js-apis-nfc 获取NDEF Formatable类型Tag对象，通过该对象可访问支持NDEF Formatable技术类型的Tag。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -314,7 +314,7 @@ getNdefFormatable(tagInfo: [TagInfo](#taginfo)): [NdefFormatableTag](js-apis-nfc | 错误码ID | 错误信息| | ------- | -------| -| 3100201 | Tag running state of service is abnormal. | +| 3100201 | Tag running state is abnormal in service. | ## tag.getTagInfo9+ @@ -322,7 +322,7 @@ getTagInfo(want: [Want](js-apis-application-Want.md#Want)): [TagInfo](#taginfo) 从Want中获取TagInfo，Want是被NFC服务初始化，包含了TagInfo所需的属性值。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -343,7 +343,7 @@ makeUriRecord(uri: string): [NdefRecord](#ndefrecord9); 根据输入的URI，构建NDEF标签的Record数据对象。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -382,7 +382,7 @@ makeTextRecord(text: string, locale: string): [NdefRecord](#ndefrecord9); 根据输入的文本数据和编码类型，构建NDEF标签的Record。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -424,7 +424,7 @@ makeMimeRecord(mimeType: string, mimeData: number[]): [NdefRecord](#ndefrecord9) 根据输入的MIME数据和类型，构建NDEF标签的Record。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -464,7 +464,7 @@ makeExternalRecord(domainName: string, type: string, externalData: number[]): [N 根据应用程序特定的外部数据，构建NDEF标签的Record。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -507,7 +507,7 @@ messageToBytes(ndefMessage: [NdefMessage](js-apis-nfctech.md#ndefmessage9)): num 把输入的NDEF消息数据对象，转换为字节格式的数据。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -548,7 +548,7 @@ createNdefMessage(data: number[]): [NdefMessage](js-apis-nfctech.md#ndefmessage9 使用原始字节数据创建NDEF标签的Message。该数据必须符合NDEF Record数据格式，如果不符合格式，则返回的NdeMessage数据对象，所包含的NDE Record列表会为空。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -582,7 +582,7 @@ createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](js-apis-nfctech.md#n 使用NDEF Records列表，创建NDEF Message。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -617,22 +617,22 @@ try { NFC服务在读取到标签时给出的对象，通过改对象属性，应用知道该标签支持哪些技术类型，并使用匹配的技术类型来调用相关接口。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG | **名称** | **类型** | **可读** | **可写** | **说明** | | -------- | -------- | -------- | -------- | -------- | | uid9+ | number[] | 是 | 否 | 标签的uid，每个number值是十六进制表示，范围是0x00~0xFF。| | technology9+ | number[] | 是 | 否 | 支持的技术类型，每个number值表示所支持技术类型的常量值。 | | supportedProfiles | number[] | 是 | 否 | 支持的技术类型，从API9开始不支持，使用[tag.TagInfo#technology](#taginfo)替代。| -| extrasData | [PacMap](js-apis-dataAbilityHelper.md#pacmap)[] | 是 | 否 | 此属性为系统属性，仅限内部使用。标签所支持技术的扩展属性值。| -| tagRfDiscId | number | 是 | 否 | 此属性为系统属性，仅限内部使用。标签发现时分配的ID值。| -| remoteTagService | [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | 是 | 否 | 此属性为系统属性，仅限内部使用。NFC服务进程的远端对象，用于客户端和服务之间的接口通信。| +| extrasData9+ | [PacMap](js-apis-dataAbilityHelper.md#pacmap)[] | 是 | 否 | 标签所支持技术的扩展属性值。
**系统接口：** 此接口为系统接口。| +| tagRfDiscId9+ | number | 是 | 否 | 标签发现时分配的ID值。
**系统接口：** 此接口为系统接口。| +| remoteTagService9+ | [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | 是 | 否 | NFC服务进程的远端对象，用于客户端和服务之间的接口通信。
**系统接口：** 此接口为系统接口。| ## NdefRecord9+ NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **类型** | **可读** | **可写** | **说明** | | -------- | -------- | -------- | -------- | -------- | @@ -644,7 +644,7 @@ NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDE ## 技术类型定义 NFC Tag有多种不同的技术类型，定义常量描述不同的技术类型。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -661,7 +661,7 @@ NFC Tag有多种不同的技术类型，定义常量描述不同的技术类型 ## TnfType9+ NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -676,7 +676,7 @@ NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFC ## NDEF Record RTD类型定义 NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -686,7 +686,7 @@ NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规 ## NfcForumType9+ NFC Forum标准里面Tag类型的定义。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -699,7 +699,7 @@ NFC Forum标准里面Tag类型的定义。 ## MifareClassicType9+ MIFARE Classic标签类型的定义。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -711,7 +711,7 @@ MIFARE Classic标签类型的定义。 ## MifareClassicSize9+ MIFARE Classic标签存储大小的定义。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | @@ -723,7 +723,7 @@ MIFARE Classic标签存储大小的定义。 ## MifareUltralightType9+ MIFARE Ultralight标签类型的定义。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core | **名称** | **值** | **说明** | | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-nfctech.md b/zh-cn/application-dev/reference/apis/js-apis-nfctech.md index dc86cae8733d78bc2e0110ebe82b66c5746f2e0e..edef70f1fa42b27b4b32ebfa4c43385ac886afff 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-nfctech.md +++ b/zh-cn/application-dev/reference/apis/js-apis-nfctech.md @@ -25,9 +25,9 @@ getSak(): number 获取NFC-A标签的SAK值。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -51,9 +51,9 @@ getAtqa(): number[] 获取NFC-A标签的Atqa值。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -85,9 +85,9 @@ getRespAppData(): number[] 获取标签的应用程序数据。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -111,9 +111,9 @@ getRespProtocol(): number[] 获取标签的协议信息。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -145,9 +145,9 @@ getSystemCode(): number[] 从标签实例获取系统代码。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -171,9 +171,9 @@ getPmm(): number[] 从标签实例获取PMm（由IC代码和制造商参数组成）。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -205,9 +205,9 @@ getResponseFlags(): number 从标签实例实例获取响应标志。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -231,9 +231,9 @@ getDsfId(): number 从标签实例实例获取数据存储格式标识符（DSFID）。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -265,7 +265,7 @@ getHistoricalBytes(): number[] 获取标签的历史字节，针对基于NfcA通信技术的IsoDep卡片。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -289,7 +289,7 @@ getHiLayerResponse(): number[] 获取标签的更高层响应字节，针对基于NfcB通信技术的IsoDep卡片。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -313,9 +313,9 @@ isExtendedApduSupported(): Promise<boolean> 检查是否支持扩展的APDU，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -364,9 +364,9 @@ isExtendedApduSupported(callback: AsyncCallback\): void 检查是否支持扩展的APDU，使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -418,7 +418,7 @@ getNdefRecords(): [tag.NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] 获取NDEF消息中的所有记录。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -453,7 +453,7 @@ getNdefTagType(): [tag.NfcForumType](js-apis-nfcTag.md#nfcforumtype9) 获取NDEF标签的类型。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -477,7 +477,7 @@ getNdefMessage(): [NdefMessage](#ndefmessage9) 获取发现NDEF标签时，从标签读取的Message。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -500,7 +500,7 @@ isNdefWritable(): boolean; 检查NDEF标签是否可写。在调用写数据接口前，需要先判断是否支持写操作。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -524,9 +524,9 @@ readNdef(): Promise\<[NdefMessage](#ndefmessage9)> 读取标签上的NDEF消息，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -574,9 +574,9 @@ readNdef(callback: AsyncCallback\<[NdefMessage](#ndefmessage9)>): void 读取标签上的NDEF消息，使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -626,9 +626,9 @@ writeNdef(msg: NdefMessage): Promise\; 将NDEF Messsage数据对象写入标签，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -679,9 +679,9 @@ writeNdef(msg: [NdefMessage](#ndefmessage9), callback: AsyncCallback\): vo 将NDEF Message数据对象写入此标签，使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -735,9 +735,9 @@ canSetReadOnly(): boolean 检查NDEF标签是否可以设置为只读。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -769,9 +769,9 @@ setReadOnly(): Promise\ 将NDEF标签设置为只读，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **错误码：** @@ -813,9 +813,9 @@ setReadOnly(callback: AsyncCallback\): void 将NDEF标签设置为只读，使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -865,7 +865,7 @@ getNdefTagTypeString(type: [tag.NfcForumType](js-apis-nfcTag.md#nfcforumtype9)): 将NFC论坛类型，转换为NFC论坛中定义的字符串描述。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -908,9 +908,9 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise 使用密钥对扇区进行身份验证，只有身份验证成功的扇区可以进行操作。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -962,9 +962,9 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback 使用密钥对扇区进行身份验证，只有身份验证成功的扇区可以进行操作。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1018,9 +1018,9 @@ readSingleBlock(blockIndex: number): Promise\ 读取标签中一个块存储的内容，一个块大小为16字节。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1075,9 +1075,9 @@ readSingleBlock(blockIndex: number, callback: AsyncCallback\): void 读取标签中一个块存储的内容，一个块大小为16字节。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1129,9 +1129,9 @@ writeSingleBlock(blockIndex: number, data: number[]): Promise\ 向标签中一个块存储写入内容，一个块大小为16字节。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1183,9 +1183,9 @@ writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback\ 对指定块的内容，增加指定的数值。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1293,9 +1293,9 @@ incrementBlock(blockIndex: number, value: number, callback: AsyncCallback\ 对指定块的内容，增加指定的数值。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1349,9 +1349,9 @@ decrementBlock(blockIndex: number, value: number): Promise\ 对指定块的内容，减少指定的数值。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1402,9 +1402,9 @@ decrementBlock(blockIndex: number, value: number, callback: AsyncCallback\ 对指定块的内容，减少指定的数值。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1458,9 +1458,9 @@ transferToBlock(blockIndex: number): Promise\ 将临时寄存器的值转移到指定的块。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1509,9 +1509,9 @@ transferToBlock(blockIndex: number, callback: AsyncCallback\): void 将临时寄存器的值转移到指定的块。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1563,9 +1563,9 @@ restoreFromBlock(blockIndex: number): Promise\ 将指定块的值复制到临时寄存器。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1614,9 +1614,9 @@ restoreFromBlock(blockIndex: number, callback: AsyncCallback\): void 将指定块的值复制到临时寄存器。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1668,7 +1668,7 @@ getSectorCount(): number 获取MIFARE Classic标签中的扇区数。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -1692,7 +1692,7 @@ getBlockCountInSector(sectorIndex: number): number 获取指定扇区中的块数。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1728,7 +1728,7 @@ getType(): [tag.MifareClassicType](js-apis-nfcTag.md#mifareclassictype9) 获取MIFARE Classic标签的类型。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -1752,7 +1752,7 @@ getTagSize(): number 获取标签的存储空间大小，具体请参见[MifareClassicSize](js-apis-nfcTag.md#mifareclassicsize9)。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -1776,7 +1776,7 @@ isEmulatedTag(): boolean 检查标签是不是被模拟的。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -1800,7 +1800,7 @@ getBlockIndex(sectorIndex: number): number 获取特定扇区的第一个块的序号。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1836,7 +1836,7 @@ getSectorIndex(blockIndex: number): number 获取包含指定块号的扇区序号。 -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1880,9 +1880,9 @@ readMultiplePages(pageIndex: number): Promise\ 读取标签的4页数据，共16字节的数据。每个页面数据大小为4字节。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1938,9 +1938,9 @@ readMultiplePages(pageIndex: number, callback: AsyncCallback\): void 读取标签的4页数据，共16字节的数据。每个页面数据大小为4字节。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -1992,9 +1992,9 @@ writeSinglePage(pageIndex: number, data: number[]): Promise\ 写入一页数据，数据大小为4字节。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -2045,9 +2045,9 @@ writeSinglePage(pageIndex: number, data: number[], callback: AsyncCallback\ 将标签格式化为NDEF标签，将NDEF消息写入NDEF标签。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -2187,9 +2187,9 @@ format(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\): v 将标签格式化为NDEF标签，然后将NDEF消息写入NDEF标签。使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -2242,9 +2242,9 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9)): Promise\ 将标签格式化为NDEF标签，将NDEF消息写入NDEF标签，之后将标签设置为只读。使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -2296,9 +2296,9 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\8+ | [LockReason](#lockreason8) | SIM卡锁类型。 | +| 名称 | 类型 | 必填 | 说明 | +| ------------------- | ----------------------------------- | ---- | -------------------------------------------------------- | +| type | [CardType](js-apis-sim.md#cardtype) | 是 | SIM卡类型，参考sim的[CardType](js-apis-sim.md#cardtype)。 | +| state | [SimState](js-apis-sim.md#simstate) | 是 | SIM卡状态，参考sim的[SimState](js-apis-sim.md#simstate)。 | +| reason8+ | [LockReason](#lockreason8) | 是 | SIM卡锁类型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-power.md b/zh-cn/application-dev/reference/apis/js-apis-power.md index 0852f0cc5df45e917f640247fb98e5f35def79f1..a81b2441e8f86dbcea710028c0b48fe3a856b76a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-power.md +++ b/zh-cn/application-dev/reference/apis/js-apis-power.md @@ -373,9 +373,9 @@ power.isScreenOn() **系统能力：** SystemCapability.PowerManager.PowerManager.Core -| 名称 | 默认值 | 描述 | -| ----------------------- | ------ | ---------------------- | -| MODE_NORMAL | 600 | 表示标准模式，默认值。 | -| MODE_POWER_SAVE | 601 | 表示省电模式。 | -| MODE_PERFORMANCE | 602 | 表示性能模式。 | -| MODE_EXTREME_POWER_SAVE | 603 | 表示超级省电模式。 | +| 名称 | 值 | 说明 | +| ----------------------- | ---- | ---------------------- | +| MODE_NORMAL | 600 | 表示标准模式，默认值。 | +| MODE_POWER_SAVE | 601 | 表示省电模式。 | +| MODE_PERFORMANCE | 602 | 表示性能模式。 | +| MODE_EXTREME_POWER_SAVE | 603 | 表示超级省电模式。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-radio.md b/zh-cn/application-dev/reference/apis/js-apis-radio.md index 2617fad825459a762919f19007579173afe5cb98..6edc4bed7a46313869124bb2de991f9121e9d2f2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-radio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-radio.md @@ -1796,10 +1796,10 @@ radio.off('imsRegStateChange', 0, radio.ImsServiceType.TYPE_VIDEO, (err, data) = **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 参数名 | 类型 | 说明 | -| ----------- | --------------------------- | ------------------ | -| signalType | [NetworkType](#networktype) | 网络信号强度类型。 | -| signalLevel | number | 网络信号强度等级。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------- | --------------------------- | ---- | --------------- -- | +| signalType | [NetworkType](#networktype) | 是 | 网络信号强度类型。 | +| signalLevel | number | 是 | 网络信号强度等级。 | ## NetworkType @@ -1824,17 +1824,17 @@ radio.off('imsRegStateChange', 0, radio.ImsServiceType.TYPE_VIDEO, (err, data) = **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ----------------- | --------------------- | ------------------------------------------------------------ | -| longOperatorName | string | 注册网络的长运营商名称。 | -| shortOperatorName | string | 注册网络的短运营商名称。 | -| plmnNumeric | string | 注册网络的PLMN码。 | -| isRoaming | boolean | 是否处于漫游状态。 | -| regState | [RegState](#regstate) | 设备的网络注册状态。 | -| cfgTech8+ | [RadioTechnology](#radiotechnology) | 设备的无线接入技术。 | -| nsaState | [NsaState](#nsastate) | 设备的NSA网络注册状态。 | -| isCaActive | boolean | CA的状态。 | -| isEmergency | boolean | 此设备是否只允许拨打紧急呼叫。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| longOperatorName | string | 是 | 注册网络的长运营商名称。 | +| shortOperatorName | string | 是 | 注册网络的短运营商名称。 | +| plmnNumeric | string | 是 | 注册网络的PLMN码。 | +| isRoaming | boolean | 是 | 是否处于漫游状态。 | +| regState | [RegState](#regstate) | 是 | 设备的网络注册状态。 | +| cfgTech8+ | [RadioTechnology](#radiotechnology) | 是 | 设备的无线接入技术。 | +| nsaState | [NsaState](#nsastate) | 是 | 设备的NSA网络注册状态。 | +| isCaActive | boolean | 是 | CA的状态。 | +| isEmergency | boolean | 是 | 此设备是否只允许拨打紧急呼叫。 | ## RegState @@ -1932,13 +1932,13 @@ radio.off('imsRegStateChange', 0, radio.ImsServiceType.TYPE_VIDEO, (err, data) = **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| networkType | [NetworkType](#networktype) | 获取服务单元的网络类型。 | -| isCamped | boolean | 获取服务单元的状态。 | -| timeStamp | number | 获取单元格信息时获取时间戳。 | -| signalInformation | [SignalInformation](#signalinformation) | 信号信息。 | -| data | [CdmaCellInformation](#cdmacellinformation8) \| [GsmCellInformation](#gsmcellinformation8) \| [LteCellInformation](#ltecellinformation8) \| [NrCellInformation](#nrcellinformation8) \| [TdscdmaCellInformation](#tdscdmacellinformation8) | Cdma小区信息 \|Gsm小区信息\|Lte小区信息\|Nr小区信息\|Tdscdma小区信息 | +| 名称 | 类型 | 必填 | 说明 | +| ----------------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| networkType | [NetworkType](#networktype) | 是 | 获取服务单元的网络类型。 | +| isCamped | boolean | 是 | 获取服务单元的状态。 | +| timeStamp | number | 是 | 获取单元格信息时获取时间戳。 | +| signalInformation | [SignalInformation](#signalinformation) | 是 | 信号信息。 | +| data | [CdmaCellInformation](#cdmacellinformation8) \| [GsmCellInformation](#gsmcellinformation8) \| [LteCellInformation](#ltecellinformation8) \| [NrCellInformation](#nrcellinformation8) \| [TdscdmaCellInformation](#tdscdmacellinformation8) | 是 | Cdma小区信息 \|Gsm小区信息\|Lte小区信息\|Nr小区信息\|Tdscdma小区信息 | ## CdmaCellInformation8+ @@ -1948,13 +1948,13 @@ CDMA小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| --------- | ------ | ------------ | -| baseId | number | 基站Id。 | -| latitude | number | 经度。 | -| longitude | number | 纬度。 | -| nid | number | 网络识别码。 | -| sid | number | 系统识别码。 | +| 名称 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ------------ | +| baseId | number | 是 | 基站Id。 | +| latitude | number | 是 | 经度。 | +| longitude | number | 是 | 纬度。 | +| nid | number | 是 | 网络识别码。 | +| sid | number | 是 | 系统识别码。 | ## GsmCellInformation8+ @@ -1964,14 +1964,14 @@ GSM小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------ | ------ | -------------------- | -| lac | number | 位置区编号。 | -| cellId | number | 小区号。 | -| arfcn | number | 绝对无线频率信道号。 | -| bsic | number | 基站识别号。 | -| mcc | string | 移动国家码。 | -| mnc | string | 移动网号。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| lac | number | 是 | 位置区编号。 | +| cellId | number | 是 | 小区号。 | +| arfcn | number | 是 | 绝对无线频率信道号。 | +| bsic | number | 是 | 基站识别号。 | +| mcc | string | 是 | 移动国家码。 | +| mnc | string | 是 | 移动网号。 | ## LteCellInformation8+ @@ -1981,16 +1981,16 @@ LTE小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------------- | ------- | ----------------------- | -| cgi | number | 小区全球标识。 | -| pci | number | 物理小区识别。 | -| tac | number | 跟踪区域代码。 | -| earfcn | number | 绝对无线频率信道号。 | -| bandwidth | number | 带宽。 | -| mcc | string | 移动国家码。 | -| mnc | string | 移动网号。 | -| isSupportEndc | boolean | 是否支持新无线电_双连接 | +| 名称 | 类型 | 必填 | 说明 | +| ------------- | ------- | ---- | ----------------------- | +| cgi | number | 是 | 小区全球标识。 | +| pci | number | 是 | 物理小区识别。 | +| tac | number | 是 | 跟踪区域代码。 | +| earfcn | number | 是 | 绝对无线频率信道号。 | +| bandwidth | number | 是 | 带宽。 | +| mcc | string | 是 | 移动国家码。 | +| mnc | string | 是 | 移动网号。 | +| isSupportEndc | boolean | 是 | 是否支持新无线电_双连接 | ## NrCellInformation8+ @@ -2000,14 +2000,14 @@ NR小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------- | ------ | ---------------- | -| nrArfcn | number | 5G频点号。 | -| pci | number | 物理小区识别。 | -| tac | number | 跟踪区域代码。 | -| nci | number | 5G网络小区标识。 | -| mcc | string | 移动国家码。 | -| mnc | string | 移动网号。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------- | +| nrArfcn | number | 是 | 5G频点号。 | +| pci | number | 是 | 物理小区识别。 | +| tac | number | 是 | 跟踪区域代码。 | +| nci | number | 是 | 5G网络小区标识。 | +| mcc | string | 是 | 移动国家码。 | +| mnc | string | 是 | 移动网号。 | ## TdscdmaCellInformation8+ @@ -2017,14 +2017,14 @@ TD-SCDMA小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------ | ------ | ------------ | -| lac | number | 位置区编号。 | -| cellId | number | 小区号。 | -| cpid | number | 小区参数Id。 | -| uarfcn | number | 绝对射频号。 | -| mcc | string | 移动国家码。 | -| mnc | string | 移动网号。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------ | +| lac | number | 是 | 位置区编号。 | +| cellId | number | 是 | 小区号。 | +| cpid | number | 是 | 小区参数Id。 | +| uarfcn | number | 是 | 绝对射频号。 | +| mcc | string | 是 | 移动国家码。 | +| mnc | string | 是 | 移动网号。 | ## WcdmaCellInformation8+ @@ -2034,14 +2034,14 @@ WCDMA小区信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------ | ------ | ------------ | -| lac | number | 位置区编号。 | -| cellId | number | 小区号。 | -| psc | number | 主扰码。 | -| uarfcn | number | 绝对射频号。 | -| mcc | string | 移动国家码。 | -| mnc | string | 移动网号。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------ | +| lac | number | 是 | 位置区编号。 | +| cellId | number | 是 | 小区号。 | +| psc | number | 是 | 主扰码。 | +| uarfcn | number | 是 | 绝对射频号。 | +| mcc | string | 是 | 移动国家码。 | +| mnc | string | 是 | 移动网号。 | ## NrOptionMode8+ @@ -2066,10 +2066,10 @@ NR的选择模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ---------------------- | ------------------------------------------------- | -------------- | -| isNetworkSearchSuccess | boolean | 网络搜索成功。 | -| networkSearchResult | Array<[NetworkInformation](#networkinformation)\> | 网络搜索结果。 | +| 名称 | 类型 | 必填 | 说明 | +| ---------------------- | ------------------------------------------------- | ---- | -------------- | +| isNetworkSearchSuccess | boolean | 是 | 网络搜索成功。 | +| networkSearchResult | Array<[NetworkInformation](#networkinformation)\> | 是 | 网络搜索结果。 | ## NetworkInformation @@ -2079,12 +2079,12 @@ NR的选择模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| --------------- | ----------------------------------------- | -------------- | -| operatorName | string | 运营商的名称。 | -| operatorNumeric | string | 运营商数字。 | -| state | [NetworkInformationState](#networkinformationstate) | 网络信息状态。 | -| radioTech | string | 无线电技术。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------- | --------------------------------------------------- | ---- | -------------- | +| operatorName | string | 是 | 运营商的名称。 | +| operatorNumeric | string | 是 | 运营商数字。 | +| state | [NetworkInformationState](#networkinformationstate) | 是 | 网络信息状态。 | +| radioTech | string | 是 | 无线电技术。 | ## NetworkInformationState @@ -2109,12 +2109,12 @@ NR的选择模式。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------------------ | --------------------------------------------- | -------------------------------------- | -| slotId | number | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | -| selectMode | [NetworkSelectionMode](#networkselectionmode) | 网络选择模式。 | -| networkInformation | [NetworkInformation](#networkinformation) | 网络信息。 | -| resumeSelection | boolean | 继续选择。 | +| 名称 | 类型 | 必填 | 说明 | +| ------------------ | --------------------------------------------- | ---- | -------------------------------------- | +| slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | +| selectMode | [NetworkSelectionMode](#networkselectionmode) | 是 | 网络选择模式。 | +| networkInformation | [NetworkInformation](#networkinformation) | 是 | 网络信息。 | +| resumeSelection | boolean | 是 | 继续选择。 | ## ImsRegState9+ @@ -2152,10 +2152,10 @@ IMS注册信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ----------- | ---------------------------- | ------------- | -| imsRegState | [ImsRegState](#imsregstate9) | IMS注册状态。 | -| imsRegTech | [ImsRegTech](#imsregtech9) | IMS注册技术。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------- | ---------------------------- | ---- | ------------- | +| imsRegState | [ImsRegState](#imsregstate9) | 是 | IMS注册状态。 | +| imsRegTech | [ImsRegTech](#imsregtech9) | 是 | IMS注册技术。 | ## ImsServiceType9+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index 54946b12a40c52ff397a7eeda063a642923193cb..a06f77611b3ec1de535abb36b1ae8a4bb5a4cafa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -68,16 +68,12 @@ var config = { | SESSION_SUCCESSFUL7+ | number | 是 | 否 | 下载会话已完成。 | -## request.upload +## request.uploadFile9+ -upload(config: UploadConfig): Promise<UploadTask> +uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask> 上传，异步方法，使用promise形式返回结果。 -此接口仅可在FA模型下使用 - -> **说明：** 从API Version 9开始废弃，建议使用[request.uploadFile9+](#requestuploadfile9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -86,16 +82,25 @@ upload(config: UploadConfig): Promise<UploadTask> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<[UploadTask](#uploadtask)> | 返回上传任务。 | +**错误码：** +以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 + + | 错误码ID | 错误信息 | + | -------- | -------- | + | 13400002 | Bad file path. | + **示例：** - + ```js let uploadTask; let uploadConfig = { @@ -105,24 +110,20 @@ upload(config: UploadConfig): Promise<UploadTask> files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.upload(uploadConfig).then((data) => { + request.uploadFile(globalThis.abilityContext, uploadConfig).then((data) => { uploadTask = data; }).catch((err) => { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); - }) + }); ``` -## request.upload +## request.uploadFile9+ -upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void +uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void 上传，异步方法，使用callback形式返回结果。 -此接口仅可在FA模型下使用 - -> **说明：** 从API Version 9开始废弃，建议使用[request.uploadFile9+](#requestuploadfile9-1)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -131,11 +132,19 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | +**错误码：** +以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 + + | 错误码ID | 错误信息 | + | -------- | -------- | + | 13400002 | Bad file path. | + **示例：** - + ```js let uploadTask; let uploadConfig = { @@ -145,7 +154,7 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.upload(uploadConfig, (err, data) => { + request.uploadFile(globalThis.abilityContext, uploadConfig, (err, data) => { if (err) { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); return; @@ -153,13 +162,16 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void uploadTask = data; }); ``` -## request.upload9+ -upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> +## request.upload(deprecated) + +upload(config: UploadConfig): Promise<UploadTask> 上传，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.uploadFile9+](#requestuploadfile9)替代。 +**模型约束**：此接口仅可在FA模型下使用 + +> **说明：** 从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9)替代。 **需要权限**：ohos.permission.INTERNET @@ -169,9 +181,7 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - **返回值：** @@ -180,7 +190,7 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> | Promise<[UploadTask](#uploadtask)> | 返回上传任务。 | **示例：** - + ```js let uploadTask; let uploadConfig = { @@ -190,21 +200,23 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.upload(globalThis.abilityContext, uploadConfig).then((data) => { + request.upload(uploadConfig).then((data) => { uploadTask = data; }).catch((err) => { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); - }); + }) ``` -## request.upload9+ +## request.upload(deprecated) -upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void +upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void 上传，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.uploadFile9+](#requestuploadfile9-1)替代。 +**模型约束**：此接口仅可在FA模型下使用 + +> **说明：** 从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9-1)替代。 **需要权限**：ohos.permission.INTERNET @@ -214,12 +226,11 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | **示例：** - + ```js let uploadTask; let uploadConfig = { @@ -229,7 +240,7 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.upload(globalThis.abilityContext, uploadConfig, (err, data) => { + request.upload(uploadConfig, (err, data) => { if (err) { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); return; @@ -238,37 +249,31 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up }); ``` +## request.upload(deprecated) -## request.uploadFile9+ - -uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask> +upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> 上传，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context | BaseContext | 是 | 基于应用程序的上下文。 | -| config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - + | context | BaseContext | 是 | 基于应用程序的上下文。 | + | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | + **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<[UploadTask](#uploadtask)> | 返回上传任务。 | - -**错误码：** -以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------- | -| 13400002 | Bad file path. | + | Promise<[UploadTask](#uploadtask)> | 返回上传任务。 | **示例：** @@ -281,7 +286,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask> files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.uploadFile(globalThis.abilityContext, uploadConfig).then((data) => { + request.upload(globalThis.abilityContext, uploadConfig).then((data) => { uploadTask = data; }).catch((err) => { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); @@ -289,30 +294,25 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask> ``` -## request.uploadFile9+ +## request.upload(deprecated) -uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void +upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void 上传，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9-1)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context | BaseContext | 是 | 基于应用程序的上下文。 | -| config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | -| callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | - -**错误码：** -以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------- | -| 13400002 | Bad file path. | + | context | BaseContext | 是 | 基于应用程序的上下文。 | + | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | + | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | **示例：** @@ -325,7 +325,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], data: [{ name: "name123", value: "123" }], }; - request.uploadFile(globalThis.abilityContext, uploadConfig, (err, data) => { + request.upload(globalThis.abilityContext, uploadConfig, (err, data) => { if (err) { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); return; @@ -334,7 +334,6 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l }); ``` - ## UploadTask 上传任务，使用下列方法前，需要先获取UploadTask对象。 @@ -365,7 +364,7 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => vo | totalSize | number | 是 | 上传文件的总大小，单位为KB。 | **示例：** - + ```js let uploadTask; uploadTask.on('progress', function callback(uploadedSize, totalSize) { @@ -399,7 +398,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void | header | object | 是 | HTTP Response Header。 | **示例：** - + ```js let uploadTask; uploadTask.on('headerReceive', function callback(headers){ @@ -433,7 +432,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void | taskstates | Array<[TaskState](#taskstate9)> | 是 | 上传任务返回结果 | **示例：** - + ```js let uploadTask; uploadTask.on('complete', function callback(taskStates) { @@ -477,7 +476,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g | totalSize | number | 是 | 上传文件的总大小，单位为KB。 | **示例：** - + ```js let uploadTask; uploadTask.off('progress', function callback(uploadedSize, totalSize) { @@ -511,7 +510,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void | header | object | 是 | HTTP Response Header。 | **示例：** - + ```js let uploadTask; uploadTask.off('headerReceive', function callback(headers) { @@ -544,7 +543,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void | taskstates | Array<[TaskState](#taskstate9)> | 是 | 上传任务返回结果 | **示例：** - + ```js let uploadTask; uploadTask.off('complete', function callback(taskStates) { @@ -562,15 +561,11 @@ off(type: 'headerReceive', callback?: (header: object) => void): void ); ``` - -### remove - -remove(): Promise<boolean> +### delete9+ +delete(): Promise<boolean> 移除上传的任务，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[delete9+](#delete9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -582,10 +577,10 @@ remove(): Promise<boolean> | Promise<boolean> | 移除任务是否成功。true：成功，false：不成功。 | **示例：** - + ```js let uploadTask; - uploadTask.remove().then((result) => { + uploadTask.delete().then((result) => { if (result) { console.info('Upload task removed successfully. '); } else { @@ -597,14 +592,12 @@ remove(): Promise<boolean> ``` -### remove +### delete9+ -remove(callback: AsyncCallback<boolean>): void +delete(callback: AsyncCallback<boolean>): void 移除上传的任务，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[delete9+](#delete9-1)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -616,10 +609,10 @@ remove(callback: AsyncCallback<boolean>): void | callback | AsyncCallback<boolean> | 是 | 移除任务的回调函数。 | **示例：** - + ```js let uploadTask; - uploadTask.remove((err, result) => { + uploadTask.delete((err, result) => { if (err) { console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); return; @@ -633,27 +626,29 @@ remove(callback: AsyncCallback<boolean>): void ``` -### delete9+ +### remove(deprecated) -delete(): Promise<boolean> +remove(): Promise<boolean> 移除上传的任务，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 9开始不再维护，建议使用[delete9+](#delete9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | 移除任务是否成功。true：成功，false：不成功。 | + | Promise<boolean> | 移除任务是否成功。true：成功，false：不成功。 | **示例：** ```js let uploadTask; - uploadTask.delete().then((result) => { + uploadTask.remove().then((result) => { if (result) { console.info('Upload task removed successfully. '); } else { @@ -665,27 +660,29 @@ delete(): Promise<boolean> ``` -### delete9+ +### remove(deprecated) -delete(callback: AsyncCallback<boolean>): void +remove(callback: AsyncCallback<boolean>): void 移除上传的任务，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 9开始不再维护，建议使用[delete9+](#delete9-1)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | 是 | 移除任务的回调函数。 | + | callback | AsyncCallback<boolean> | 是 | 移除任务的回调函数。 | **示例：** ```js let uploadTask; - uploadTask.delete((err, result) => { + uploadTask.remove((err, result) => { if (err) { console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); return; @@ -698,7 +695,6 @@ delete(callback: AsyncCallback<boolean>): void }); ``` - ## UploadConfig **需要权限**：ohos.permission.INTERNET @@ -750,17 +746,12 @@ delete(callback: AsyncCallback<boolean>): void | name | string | 是 | 表示表单元素的名称。 | | value | string | 是 | 表示表单元素的值。 | +## request.downloadFile9+ -## request.download - -download(config: DownloadConfig): Promise<DownloadTask> +downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> 下载，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.downloadFile9+](#requestdownloadfile9)替代。 - -此接口仅可在FA模型下使用 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -769,6 +760,7 @@ download(config: DownloadConfig): Promise<DownloadTask> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | **返回值：** @@ -777,11 +769,20 @@ download(config: DownloadConfig): Promise<DownloadTask> | -------- | -------- | | Promise<[DownloadTask](#downloadtask)> | 返回下载任务。 | +**错误码：** +以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 + + | 错误码ID | 错误信息 | + | -------- | -------- | + | 13400001 | File operation error. | + | 13400002 | Bad file path. | + | 13400003 | Task manager service error. | + **示例：** - + ```js let downloadTask; - request.download({ url: 'https://xxxx/xxxx.hap' }).then((data) => { + request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { downloadTask = data; }).catch((err) => { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -789,16 +790,12 @@ download(config: DownloadConfig): Promise<DownloadTask> ``` -## request.download +## request.downloadFile9+ -download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void +downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; 下载，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.downloadFile9+](#requestdownloadfile9-1)替代。 - -此接口仅可在FA模型下使用 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -807,14 +804,24 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | +**错误码：** +以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 + + | 错误码ID | 错误信息 | + | -------- | -------- | + | 13400001 | File operation error. | + | 13400002 | Bad file path. | + | 13400003 | Task manager service error. | + **示例：** - + ```js let downloadTask; - request.download({ url: 'https://xxxx/xxxxx.hap', + request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', filePath: 'xxx/xxxxx.hap'}, (err, data) => { if (err) { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -824,13 +831,15 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v }); ``` -## request.download9+ +## request.download(deprecated) -download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> +download(config: DownloadConfig): Promise<DownloadTask> 下载，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.downloadFile9+](#requestdownloadfile9)替代。 +> **说明：** 从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9)替代。 + +**模型约束**：此接口仅可在FA模型下使用 **需要权限**：ohos.permission.INTERNET @@ -840,7 +849,6 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask& | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | **返回值：** @@ -850,10 +858,10 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask& | Promise<[DownloadTask](#downloadtask)> | 返回下载任务。 | **示例：** - + ```js let downloadTask; - request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { + request.download({ url: 'https://xxxx/xxxx.hap' }).then((data) => { downloadTask = data; }).catch((err) => { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -861,13 +869,15 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask& ``` -## request.download9+ +## request.download(deprecated) -download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; +download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void 下载，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[request.downloadFile9+](#requestdownloadfile9-1)替代。 +> **说明：** 从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9-1)替代。 + +**模型约束**：此接口仅可在FA模型下使用 **需要权限**：ohos.permission.INTERNET @@ -877,15 +887,14 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | **示例：** - + ```js let downloadTask; - request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', + request.download({ url: 'https://xxxx/xxxxx.hap', filePath: 'xxx/xxxxx.hap'}, (err, data) => { if (err) { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -895,44 +904,36 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l }); ``` +## request.download(deprecated) -## request.downloadFile9+ - -downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> +download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> 下载，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context | BaseContext | 是 | 基于应用程序的上下文。 | -| config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | + | context | BaseContext | 是 | 基于应用程序的上下文。 | + | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<[DownloadTask](#downloadtask)> | 返回下载任务。 | - -**错误码：** -以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------- | -| 13400001 | File operation error. | -| 13400002 | Bad file path. | -| 13400003 | Task manager service error. | + | Promise<[DownloadTask](#downloadtask)> | 返回下载任务。 | **示例：** ```js let downloadTask; - request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { + request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { downloadTask = data; }).catch((err) => { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -940,38 +941,31 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadT ``` -## request.downloadFile9+ +## request.download(deprecated) -downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; +download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; 下载，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9-1)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context | BaseContext | 是 | 基于应用程序的上下文。 | -| config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | -| callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | - -**错误码：** -以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------- | -| 13400001 | File operation error. | -| 13400002 | Bad file path. | -| 13400003 | Task manager service error. | + | context | BaseContext | 是 | 基于应用程序的上下文。 | + | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | + | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | **示例：** ```js let downloadTask; - request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', + request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', filePath: 'xxx/xxxxx.hap'}, (err, data) => { if (err) { console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); @@ -1012,7 +1006,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo | totalSize | number | 是 | 下载文件的总大小，单位为KB。 | **示例：** - + ```js let downloadTask; downloadTask.on('progress', function download_callback(receivedSize, totalSize) { @@ -1047,7 +1041,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => | totalSize | number | 是 | 下载文件的总大小。 | **示例：** - + ```js downloadTask .off('progress', function download_callback(receivedSize, totalSize) { console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize); @@ -1074,7 +1068,7 @@ on(type: 'complete'|'pause'|'remove', callback:() => void): void | callback | function | 是 | 回调函数。 | **示例：** - + ```js let downloadTask; downloadTask.on('complete', function callback() { @@ -1102,7 +1096,7 @@ off(type: 'complete'|'pause'|'remove', callback?:() => void): void | callback | function | 否 | 回调函数。 | **示例：** - + ```js let downloadTask; downloadTask.off('complete', function callback() { @@ -1136,7 +1130,7 @@ on(type: 'fail', callback: (err: number) => void): void | err | number | 是 | 下载失败的错误码，错误原因见[ERROR.*](#常量)。 | **示例：** - + ```js let downloadTask; downloadTask.on('fail', function callBack(err) { @@ -1170,7 +1164,7 @@ off(type: 'fail', callback?: (err: number) => void): void | err | number | 是 | 下载失败的错误码。错误原因见[ERROR_*](#常量)。 | **示例：** - + ```js let downloadTask; downloadTask.off('fail', function callBack(err) { @@ -1179,15 +1173,12 @@ off(type: 'fail', callback?: (err: number) => void): void ); ``` + ### delete9+ -### remove - -remove(): Promise<boolean> +delete(): Promise<boolean> 移除下载的任务，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[delete9+](#delete9-2)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1199,10 +1190,10 @@ remove(): Promise<boolean> | Promise<boolean> | 移除任务是否成功。 | **示例：** - + ```js let downloadTask; - downloadTask.remove().then((result) => { + downloadTask.delete().then((result) => { if (result) { console.info('Download task removed.'); } else { @@ -1214,14 +1205,12 @@ remove(): Promise<boolean> ``` -### remove +### delete9+ -remove(callback: AsyncCallback<boolean>): void +delete(callback: AsyncCallback<boolean>): void 移除下载的任务，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[delete9+](#delete9-3)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1233,10 +1222,10 @@ remove(callback: AsyncCallback<boolean>): void | callback | AsyncCallback<boolean> | 是 | 移除任务是否成功。 | **示例：** - + ```js let downloadTask; - downloadTask.remove((err, result)=>{ + downloadTask.delete((err, result)=>{ if(err) { console.error('Failed to remove the download task.'); return; @@ -1250,14 +1239,12 @@ remove(callback: AsyncCallback<boolean>): void ``` -### query7+ +### getTaskInfo9+ -query(): Promise<DownloadInfo> +getTaskInfo(): Promise<DownloadInfo> 查询下载任务，异步方法，使用promise形式返回DownloadInfo里的信息。 -> **说明：** 从API Version 9开始废弃，建议使用[getTaskInfo9+](#gettaskinfo9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1269,10 +1256,10 @@ query(): Promise<DownloadInfo> | Promise<[DownloadInfo](#downloadinfo7)> | 查询下载任务信息。 | **示例：** - + ```js let downloadTask; - downloadTask.query().then((downloadInfo) => { + downloadTask.getTaskInfo().then((downloadInfo) => { console.info('Download task queried. Data:' + JSON.stringify(downloadInfo)) }) .catch((err) => { console.error('Failed to query the download task. Cause:' + err) @@ -1280,14 +1267,12 @@ query(): Promise<DownloadInfo> ``` -### query7+ +### getTaskInfo9+ -query(callback: AsyncCallback<DownloadInfo>): void +getTaskInfo(callback: AsyncCallback<DownloadInfo>): void 查询下载的任务，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[getTaskInfo9+](#gettaskinfo9-1)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1299,10 +1284,10 @@ query(callback: AsyncCallback<DownloadInfo>): void | callback | AsyncCallback<[DownloadInfo](#downloadinfo7)> | 是 | 查询下载任务的回调函数。 | **示例：** - + ```js let downloadTask; - downloadTask.query((err, downloadInfo)=>{ + downloadTask.getTaskInfo((err, downloadInfo)=>{ if(err) { console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); } else { @@ -1312,14 +1297,12 @@ query(callback: AsyncCallback<DownloadInfo>): void ``` -### queryMimeType7+ +### getTaskMimeType9+ -queryMimeType(): Promise<string> +getTaskMimeType(): Promise<string> 查询下载的任务的 MimeType，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[getTaskMimeType9+](#gettaskmimetype9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1331,10 +1314,10 @@ queryMimeType(): Promise<string> | Promise<string> | 查询下载任务的MimeType。 | **示例：** - + ```js let downloadTask; - downloadTask.queryMimeType().then((data) => { + downloadTask.getTaskMimeType().then((data) => { console.info('Download task queried. Data:' + JSON.stringify(data)); }).catch((err) => { console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err)) @@ -1342,14 +1325,12 @@ queryMimeType(): Promise<string> ``` -### queryMimeType7+ +### getTaskMimeType9+ -queryMimeType(callback: AsyncCallback<string>): void; +getTaskMimeType(callback: AsyncCallback<string>): void; 查询下载的任务的 MimeType，异步方法，使用callback形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[getTaskMimeType9+](#gettaskmimetype9-1)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1361,10 +1342,10 @@ queryMimeType(callback: AsyncCallback<string>): void; | callback | AsyncCallback<string> | 是 | 查询下载任务的MimeType的回调函数。 | **示例：** - + ```js let downloadTask; - downloadTask.queryMimeType((err, data)=>{ + downloadTask.getTaskMimeType((err, data)=>{ if(err) { console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); } else { @@ -1374,14 +1355,12 @@ queryMimeType(callback: AsyncCallback<string>): void; ``` -### pause7+ +### suspend9+ -pause(): Promise<void> +suspend(): Promise<boolean> 暂停下载任务，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[suspend9+](#suspend9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1390,13 +1369,13 @@ pause(): Promise<void> | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 暂停下载任务是否成功。 | + | Promise<boolean> | 暂停下载任务是否成功。 | **示例：** - + ```js let downloadTask; - downloadTask.pause().then((result) => { + downloadTask.suspend().then((result) => { if (result) { console.info('Download task paused. '); } else { @@ -1408,11 +1387,9 @@ pause(): Promise<void> ``` -### pause7+ - -pause(callback: AsyncCallback<void>): void +### suspend9+ -> **说明：** 从API Version 9开始废弃，建议使用[suspend9+](#suspend9-1)替代。 +suspend(callback: AsyncCallback<boolean>): void 暂停下载任务，异步方法，使用callback形式返回结果。 @@ -1424,13 +1401,13 @@ pause(callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 暂停下载任务的回调函数。 | + | callback | AsyncCallback<boolean> | 是 | 暂停下载任务的回调函数。 | **示例：** - + ```js let downloadTask; - downloadTask.pause((err, result)=>{ + downloadTask.suspend((err, result)=>{ if(err) { console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); return; @@ -1444,14 +1421,12 @@ pause(callback: AsyncCallback<void>): void ``` -### resume7+ +### restore9+ -resume(): Promise<void> +restore(): Promise<boolean> 重新启动暂停的下载任务，异步方法，使用promise形式返回结果。 -> **说明：** 从API Version 9开始废弃，建议使用[restore9+](#restore9)替代。 - **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -1460,13 +1435,13 @@ resume(): Promise<void> | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 重新启动暂停的下载任务是否成功。 | + | Promise<boolean> | 重新启动暂停的下载任务是否成功。 | **示例：** - + ```js let downloadTask; - downloadTask.resume().then((result) => { + downloadTask.restore().then((result) => { if (result) { console.info('Download task resumed.') } else { @@ -1479,11 +1454,9 @@ resume(): Promise<void> ``` -### resume7+ - -resume(callback: AsyncCallback<void>): void +### restore9+ -> **说明：** 从API Version 9开始废弃，建议使用[restore9+](#restore9-1)替代。 +restore(callback: AsyncCallback<boolean>): void 重新启动暂停的下载任务，异步方法，使用callback形式返回结果。 @@ -1495,13 +1468,13 @@ resume(callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 重新启动暂停的下载任务的回调函数。 | + | callback | AsyncCallback<boolean> | 是 | 重新启动暂停的下载任务的回调函数。 | **示例：** - + ```js let downloadTask; - downloadTask.resume((err, result)=>{ + downloadTask.restore((err, result)=>{ if (err) { console.error('Failed to resume the download task. Cause:' + err); return; @@ -1515,27 +1488,30 @@ resume(callback: AsyncCallback<void>): void ``` -### delete9+ -delete(): Promise<boolean> +### remove(deprecated) + +remove(): Promise<boolean> 移除下载的任务，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 9开始不再维护，建议使用[delete9+](#delete9-2)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | 移除任务是否成功。 | + | Promise<boolean> | 移除任务是否成功。 | **示例：** ```js let downloadTask; - downloadTask.delete().then((result) => { + downloadTask.remove().then((result) => { if (result) { console.info('Download task removed.'); } else { @@ -1547,27 +1523,29 @@ delete(): Promise<boolean> ``` -### delete9+ +### remove(deprecated) -delete(callback: AsyncCallback<boolean>): void +remove(callback: AsyncCallback<boolean>): void 移除下载的任务，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 9开始不再维护，建议使用[delete9+](#delete9-3)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | 是 | 移除任务是否成功。 | + | callback | AsyncCallback<boolean> | 是 | 移除任务是否成功。 | **示例：** ```js let downloadTask; - downloadTask.delete((err, result)=>{ + downloadTask.remove((err, result)=>{ if(err) { console.error('Failed to remove the download task.'); return; @@ -1581,27 +1559,29 @@ delete(callback: AsyncCallback<boolean>): void ``` -### getTaskInfo9+ +### query(deprecated) -getTaskInfo(): Promise<DownloadInfo> +query(): Promise<DownloadInfo> 查询下载任务，异步方法，使用promise形式返回DownloadInfo里的信息。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[getTaskInfo9+](#gettaskinfo9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| Promise<[DownloadInfo](#downloadinfo7)> | 查询下载任务信息。 | + | 类型 | 说明 | + | -------- | -------- | + | Promise<[DownloadInfo](#downloadinfo7)> | 查询下载任务信息。 | **示例：** ```js let downloadTask; - downloadTask.getTaskInfo().then((downloadInfo) => { + downloadTask.query().then((downloadInfo) => { console.info('Download task queried. Data:' + JSON.stringify(downloadInfo)) }) .catch((err) => { console.error('Failed to query the download task. Cause:' + err) @@ -1609,27 +1589,29 @@ getTaskInfo(): Promise<DownloadInfo> ``` -### getTaskInfo9+ +### query(deprecated) -getTaskInfo(callback: AsyncCallback<DownloadInfo>): void +query(callback: AsyncCallback<DownloadInfo>): void 查询下载的任务，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[getTaskInfo9+](#gettaskinfo9-1)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<[DownloadInfo](#downloadinfo7)> | 是 | 查询下载任务的回调函数。 | + | callback | AsyncCallback<[DownloadInfo](#downloadinfo7)> | 是 | 查询下载任务的回调函数。 | **示例：** ```js let downloadTask; - downloadTask.getTaskInfo((err, downloadInfo)=>{ + downloadTask.query((err, downloadInfo)=>{ if(err) { console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); } else { @@ -1639,27 +1621,29 @@ getTaskInfo(callback: AsyncCallback<DownloadInfo>): void ``` -### getTaskMimeType9+ +### queryMimeType(deprecated) -getTaskMimeType(): Promise<string> +queryMimeType(): Promise<string> 查询下载的任务的 MimeType，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[getTaskMimeType9+](#gettaskmimetype9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<string> | 查询下载任务的MimeType。 | + | Promise<string> | 查询下载任务的MimeType。 | **示例：** ```js let downloadTask; - downloadTask.getTaskMimeType().then((data) => { + downloadTask.queryMimeType().then((data) => { console.info('Download task queried. Data:' + JSON.stringify(data)); }).catch((err) => { console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err)) @@ -1667,27 +1651,29 @@ getTaskMimeType(): Promise<string> ``` -### getTaskMimeType9+ +### queryMimeType(deprecated) -getTaskMimeType(callback: AsyncCallback<string>): void; +queryMimeType(callback: AsyncCallback<string>): void; 查询下载的任务的 MimeType，异步方法，使用callback形式返回结果。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[getTaskMimeType9+](#gettaskmimetype9-1)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<string> | 是 | 查询下载任务的MimeType的回调函数。 | + | callback | AsyncCallback<string> | 是 | 查询下载任务的MimeType的回调函数。 | **示例：** ```js let downloadTask; - downloadTask.getTaskMimeType((err, data)=>{ + downloadTask.queryMimeType((err, data)=>{ if(err) { console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); } else { @@ -1697,27 +1683,29 @@ getTaskMimeType(callback: AsyncCallback<string>): void; ``` -### suspend9+ +### pause(deprecated) -suspend(): Promise<boolean> +pause(): Promise<void> 暂停下载任务，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[suspend9+](#suspend9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | 暂停下载任务是否成功。 | + | Promise<void> | 暂停下载任务是否成功。 | **示例：** ```js let downloadTask; - downloadTask.suspend().then((result) => { + downloadTask.pause().then((result) => { if (result) { console.info('Download task paused. '); } else { @@ -1729,9 +1717,11 @@ suspend(): Promise<boolean> ``` -### suspend9+ +### pause(deprecated) -suspend(callback: AsyncCallback<boolean>): void +pause(callback: AsyncCallback<void>): void + +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[suspend9+](#suspend9-1)替代。 暂停下载任务，异步方法，使用callback形式返回结果。 @@ -1741,15 +1731,15 @@ suspend(callback: AsyncCallback<boolean>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | 是 | 暂停下载任务的回调函数。 | + | callback | AsyncCallback<void> | 是 | 暂停下载任务的回调函数。 | **示例：** ```js let downloadTask; - downloadTask.suspend((err, result)=>{ + downloadTask.pause((err, result)=>{ if(err) { console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); return; @@ -1763,27 +1753,29 @@ suspend(callback: AsyncCallback<boolean>): void ``` -### restore9+ +### resume(deprecated) -restore(): Promise<boolean> +resume(): Promise<void> 重新启动暂停的下载任务，异步方法，使用promise形式返回结果。 +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[restore9+](#restore9)替代。 + **需要权限**：ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download **返回值：** -| 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | 重新启动暂停的下载任务是否成功。 | + | Promise<void> | 重新启动暂停的下载任务是否成功。 | **示例：** ```js let downloadTask; - downloadTask.restore().then((result) => { + downloadTask.resume().then((result) => { if (result) { console.info('Download task resumed.') } else { @@ -1796,9 +1788,11 @@ restore(): Promise<boolean> ``` -### restore9+ +### resume(deprecated) -restore(callback: AsyncCallback<boolean>): void +resume(callback: AsyncCallback<void>): void + +> **说明：** 从API Version 7开始支持，从API Version 9开始不再维护，建议使用[restore9+](#restore9-1)替代。 重新启动暂停的下载任务，异步方法，使用callback形式返回结果。 @@ -1808,15 +1802,15 @@ restore(callback: AsyncCallback<boolean>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | 是 | 重新启动暂停的下载任务的回调函数。 | + | callback | AsyncCallback<void> | 是 | 重新启动暂停的下载任务的回调函数。 | **示例：** ```js let downloadTask; - downloadTask.restore((err, result)=>{ + downloadTask.resume((err, result)=>{ if (err) { console.error('Failed to resume the download task. Cause:' + err); return; diff --git a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md index a0bde36e929a11bbbedd7cd63e640bf795a45424..e09d33cb12f728983f456c9d09383d590a8bd756 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md @@ -52,7 +52,7 @@ try { ## runningLock.create9+ -createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void +create(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void 创建RunningLock锁。 @@ -90,7 +90,7 @@ runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, ## runningLock.create9+ -createRunningLock(name: string, type: RunningLockType): Promise<RunningLock> +create(name: string, type: RunningLockType): Promise<RunningLock> 创建RunningLock锁。 @@ -281,7 +281,7 @@ hold(timeout: number): void | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ----------------------------------------- | -| timeout | number | 否 | 锁定和持有RunningLock的时长，单位：毫秒。 | +| timeout | number | 是 | 锁定和持有RunningLock的时长，单位：毫秒。 | **错误码：** @@ -399,9 +399,9 @@ lock(timeout: number): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------ | ---- | -------------------------- | -| timeout | number | 否 | 锁定和持有RunningLock的时长，单位：毫秒。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----------------------------------------- | +| timeout | number | 是 | 锁定和持有RunningLock的时长，单位：毫秒。 | **示例：** @@ -475,7 +475,7 @@ RunningLock锁的类型。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core -| 名称 | 默认值 | 描述 | -| ------------------------ | ------ | -------------------------------------- | -| BACKGROUND | 1 | 阻止系统休眠的锁。 | -| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | +| 名称 | 值 | 说明 | +| ------------------------ | ---- | -------------------------------------- | +| BACKGROUND | 1 | 阻止系统休眠的锁。 | +| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-sim.md b/zh-cn/application-dev/reference/apis/js-apis-sim.md index d523096d88ce741a3aaa2a4dcbbf43658e5020ef..3ed9abeb029dfc2786751d02efd2dcde4814c4c4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sim.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sim.md @@ -2848,10 +2848,10 @@ SIM卡状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| --------------- | ------ | ------------------ | -| result | number | 当前操作的结果。 | -| remain?: number | number | 剩余次数（可以为空）。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------- | ------ | ---- | --------------------- | +| result | number | 是 | 当前操作的结果。 | +| remain?: number | number | 否 | 剩余次数（可以为空）。| ## LockInfo8+ @@ -2861,11 +2861,11 @@ SIM卡状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| -------- | ------------------------ | ------ | -| lockType | [LockType](#locktype8) | 锁类型。 | -| password | string | 密码。 | -| state | [LockState](#lockstate8) | 锁状态。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | -------- | +| lockType | [LockType](#locktype8) | 是 | 锁类型。 | +| password | string | 是 | 密码。 | +| state | [LockState](#lockstate8) | 是 | 锁状态。 | ## PersoLockInfo8+ @@ -2875,10 +2875,10 @@ SIM卡状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| -------- | -------------------------------- | ------------ | -| lockType | [PersoLockType](#persolocktype8) | 定制锁的类型。 | -| password | string | 密码。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------- | +| lockType | [PersoLockType](#persolocktype8) | 是 | 定制锁的类型。| +| password | string | 是 | 密码。 | ## IccAccountInfo7+ @@ -2888,15 +2888,15 @@ Icc账户信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ---------- | ------- | ---------------- | -| simId | number | SIM卡ID。 | -| slotIndex | number | 卡槽ID。 | -| isEsim | boolean | 标记卡是否是eSim。 | -| isActive | boolean | 卡是否被激活。 | -| iccId | string | ICCID号码。 | -| showName | string | SIM卡显示名称。 | -| showNumber | string | SIM卡显示号码。 | +| 名称 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | ---------------- | +| simId | number | 是 | SIM卡ID。 | +| slotIndex | number | 是 | 卡槽ID。 | +| isEsim | boolean | 是 | 标记卡是否是eSim。 | +| isActive | boolean | 是 | 卡是否被激活。 | +| iccId | string | 是 | ICCID号码。 | +| showName | string | 是 | SIM卡显示名称。 | +| showNumber | string | 是 | SIM卡显示号码。 | ## OperatorConfig8+ @@ -2906,10 +2906,10 @@ Icc账户信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ----- | ------ | ---- | -| field | string | 字段 | -| value | string | 值 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ---- | +| field | string | 是 | 字段 | +| value | string | 是 | 值 | ## DiallingNumbersInfo8+ @@ -2919,12 +2919,12 @@ Icc账户信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。 -| 名称 | 类型 | 说明 | -| ------------ | ------ | -------- | -| alphaTag | string | 标签。 | -| number | string | 号码。 | -| recordNumber | number | 记录编号。 | -| pin2 | string | pin2密码。 | +| 名称 | 类型 | 必填 | 说明 | +| ------------ | ------ | ---- | ---------- | +| alphaTag | string | 是 | 标签。 | +| number | string | 是 | 号码。 | +| recordNumber | number | 是 | 记录编号。 | +| pin2 | string | 是 | pin2密码。 | ## ContactType8+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-sms.md b/zh-cn/application-dev/reference/apis/js-apis-sms.md index f042a4468f2e813026a7a24a73468531b36713fb..600ba6eb94e6ed04e7f818885d10812c4b5d04c9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sms.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sms.md @@ -1116,19 +1116,19 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 说明 | -| ------------------------ | --------------------------------------- | ------------------------------------------------------------ | -| hasReplyPath | boolean | 收到的短信是否包含“TP-Reply-Path”，默认为false。
“TP-Reply-Path”：设备根据发送SMS消息的短消息中心进行回复。 | -| isReplaceMessage | boolean | 收到的短信是否为“替换短信”，默认为false。
“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 | -| isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。
“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 | -| messageClass | [ShortMessageClass](#shortmessageclass) | 短信类型。 | -| pdu | Array<number> | SMS消息中的协议数据单元 （PDU）。 | -| protocolId | number | 发送短信时使用的协议标识。 | -| scAddress | string | 短消息服务中心（SMSC）地址。 | -| scTimestamp | number | SMSC时间戳。 | -| status | number | SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。 | -| visibleMessageBody | string | 短信正文。 | -| visibleRawAddress | string | 发送者地址。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | +| hasReplyPath | boolean | 是 | 收到的短信是否包含“TP-Reply-Path”，默认为false。
“TP-Reply-Path”：设备根据发送SMS消息的短消息中心进行回复。 | +| isReplaceMessage | boolean | 是 | 收到的短信是否为“替换短信”，默认为false。
“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 | +| isSmsStatusReportMessage | boolean | 是 | 当前消息是否为“短信状态报告”，默认为false。
“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。| +| messageClass | [ShortMessageClass](#shortmessageclass) | 是 | 短信类型。 | +| pdu | Array<number> | 是 | SMS消息中的协议数据单元 （PDU）。 | +| protocolId | number | 是 | 发送短信时使用的协议标识。 | +| scAddress | string | 是 | 短消息服务中心（SMSC）地址。 | +| scTimestamp | number | 是 | SMSC时间戳。 | +| status | number | 是 | SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。 | +| visibleMessageBody | string | 是 | 短信正文。 | +| visibleRawAddress | string | 是 | 发送者地址。 | ## ShortMessageClass @@ -1152,7 +1152,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | slotId | number | 是 | 用于发送短信的SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | | destinationHost | string | 是 | 短信的发送地址。 | @@ -1169,11 +1169,11 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------------- | ---- | ------------------------------------------------------------ | +| 名称 | 类型 | 必填 | 说明 | +| ---------- | ------------------------------- | ---- | ----------------------------------------------------------------------------------------- | | isLastPart | boolean | 否 | 指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。 | -| result | [SendSmsResult](#sendsmsresult) | 是 | 短信发送结果。 | -| url | string | 是 | 存储发送短信的URI。 | +| result | [SendSmsResult](#sendsmsresult) | 是 | 短信发送结果。 | +| url | string | 是 | 存储发送短信的URI。 | ## IDeliveryShortMessageCallback @@ -1182,9 +1182,9 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------- | ---- | -------------- | -| pdu | Array<number> | 是 | 短信送达报告。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------- | ---- | -------------- | +| pdu | Array<number> | 是 | 短信送达报告。 | ## SendSmsResult @@ -1208,9 +1208,9 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------------------------------------------------------ | ---- | --------- | -| messageType | [MessageType](#messagetype8) | 是 | 消息类型。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------- | ------------------------------------------------------------ | ---- | ---------- | +| messageType | [MessageType](#messagetype8) | 是 | 消息类型。 | | mmsType | [MmsSendReq](#mmssendreq8) \|[MmsSendConf](#mmssendconf8) \|[MmsNotificationInd](#mmsnotificationind8) \|[MmsRespInd](#mmsrespind8) \|[MmsRetrieveConf](#mmsretrieveconf8)\|[MmsAcknowledgeInd](#mmsacknowledgeind8)\|[MmsDeliveryInd](#mmsdeliveryind8)\|[MmsReadOrigInd](#mmsreadorigind8)\|[MmsReadRecInd](#mmsreadrecind8) | 是 | PDU头类型 | | attachment | Array<[MmsAttachment](#mmsattachment8)\> | 否 | 附件 | @@ -1222,7 +1222,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------------- | ------------------------------------ | ---- | ------------ | | from | [MmsAddress](#mmsaddress8) | 是 | 彩信来源 | | transactionId | string | 是 | 事务ID | @@ -1248,7 +1248,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------------- | ---------------------------------- | ---- | -------- | | responseState | number | 是 | 响应状态 | | transactionId | string | 是 | 事务ID | @@ -1263,7 +1263,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | ---------------------------------- | ---- | -------- | | transactionId | string | 是 | 事务ID | | messageClass | number | 是 | 消息类 | @@ -1284,7 +1284,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------------- | ---------------------------------- | ---- | -------- | | transactionId | string | 是 | 事务ID | | version | [MmsVersionType](#mmsversiontype8) | 是 | 版本 | @@ -1298,7 +1298,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------- | ------------------------------------ | ---- | -------- | | transactionId | string | 是 | 事务ID | | messageId | string | 是 | 消息ID | @@ -1323,7 +1323,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------- | ---------------------------------- | ---- | -------- | | version | [MmsVersionType](#mmsversiontype8) | 是 | 版本 | | messageId | string | 是 | 消息ID | @@ -1340,7 +1340,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------- | ---------------------------------- | ---- | -------- | | version | [MmsVersionType](#mmsversiontype8) | 是 | 版本 | | messageId | string | 是 | 消息ID | @@ -1357,7 +1357,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------------------- | ------------------------------------ | ---- | ------------------ | | contentId | string | 是 | 内容ID | | contentLocation | string | 是 | 内容位置 | @@ -1378,7 +1378,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------- | ---- | ------ | | address | string | 是 | 地址 | | charset | [MmsCharSets](#mmscharsets8) | 是 | 字符集 | @@ -1391,7 +1391,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------- | ---- | -------------------- | | TYPE_MMS_SEND_REQ | 128 | 彩信发送请求类型 | | TYPE_MMS_SEND_CONF | 129 | 彩信发送配置类型 | @@ -1411,7 +1411,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ---------- | ---- | -------------- | | MMS_LOW | 128 | 彩信优先级低 | | MMS_NORMAL | 129 | 彩信优先级正常 | @@ -1425,7 +1425,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | --------------- | ---- | ----------- | | MMS_VERSION_1_0 | 0x10 | 彩信版本1_0 | | MMS_VERSION_1_1 | 0x11 | 彩信版本1_1 | @@ -1440,7 +1440,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | --------------- | ------ | ------------------- | | BIG5 | 0X07EA | BIG5格式 | | ISO_10646_UCS_2 | 0X03E8 | ISO_10646_UCS_2格式 | @@ -1465,7 +1465,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ---------- | ---- | -------- | | FROM_DATA | 0 | 数据来源 | | ATTACHMENT | 1 | 附件 | @@ -1479,7 +1479,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------- | ---- | ---- | | MMS_YES | 128 | YES | | MMS_NO | 129 | NO | @@ -1492,7 +1492,7 @@ promise.then(data => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------- | -------------------- | ---- | ------------ | | slotId | number | 是 | 卡槽ID | | enable | boolean | 是 | 可行 | @@ -1508,7 +1508,7 @@ SIM卡消息状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------- | ---- | --------------------------- | | SIM_MESSAGE_STATUS_FREE | 0 | SIM卡上的状态可用空间 | | SIM_MESSAGE_STATUS_READ | 1 | 消息已读状态 | @@ -1524,7 +1524,7 @@ SIM卡消息状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | --------- | ---- | ---- | | TYPE_GSM | 1 | GSM | | TYPE_CDMA | 2 | CMDA | @@ -1537,7 +1537,7 @@ SIM卡消息状态。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 值 | 说明 | +| 名称 | 值 | 说明 | | -------------------- | ---- | ------------ | | SMS_ENCODING_UNKNOWN | 0 | 未知短信编码 | | SMS_ENCODING_7BIT | 1 | 7位短信编码 | @@ -1552,7 +1552,7 @@ SIM卡消息选项。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | -------------------------------------- | ---- | -------------- | | slotId | number | 是 | 卡槽ID | | smsc | string | 是 | 短消息业务中心 | @@ -1567,7 +1567,7 @@ SIM卡消息选项。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | -------------------------------------- | ---- | -------------- | | slotId | number | 是 | 卡槽ID | | msgIndex | number | 是 | 消息索引 | @@ -1583,7 +1583,7 @@ SIM卡短消息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------------- | -------------------------------------- | ---- | ------------- | | shortMessage | [ShortMessage](#shortmessage) | 是 | 短消息 | | simMessageStatus | [SimMessageStatus](#simmessagestatus7) | 是 | SIM卡消息状态 | @@ -1597,7 +1597,7 @@ SIM卡短消息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------- | ---- | ------ | | messageId | string | 是 | 消息ID | | date | number | 是 | 日期 | @@ -1613,7 +1613,7 @@ SIM卡短消息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------------- | ---------------------------------- | ---- | -------- | | transactionId | string | 是 | 事件ID | | status | number | 是 | 状态 | @@ -1628,7 +1628,7 @@ SIM卡短消息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------------- | ---------------------------------------- | ---- | ------------ | | splitCount | number | 是 | 拆分计数 | | encodeCount | number | 是 | 编码计数 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-socket.md b/zh-cn/application-dev/reference/apis/js-apis-socket.md index 4f44634d66d940abbbd332666118be42b0f20529..4261ccaca05404e1c60e7a368d47ff079813cf89 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -612,7 +612,7 @@ udp.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | port | number | 否 | 端口号 ，范围0~65535。如果不指定系统随机分配端口。 | @@ -624,7 +624,7 @@ UDPSocket发送参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | -------------- | | data | string \| ArrayBuffer7+ | 是 | 发送的数据。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息。 | @@ -635,7 +635,7 @@ UDPSocket连接的其他属性。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------------- | ------- | ---- | -------------------------------- | | broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | | receiveBufferSize | number | 否 | 接收缓冲区大小（单位：Byte）。 | @@ -649,7 +649,7 @@ Socket的状态信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------- | ------- | ---- | ---------- | | isBound | boolean | 是 | 是否绑定。 | | isClose | boolean | 是 | 是否关闭。 | @@ -661,7 +661,7 @@ Socket的连接信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | family | string | 是 | 网络协议类型，可选类型：
- IPv4
- IPv6
默认为IPv4。 | @@ -1421,7 +1421,7 @@ TCPSocket连接的参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | -------------------------- | | address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 | | timeout | number | 否 | 超时时间，单位毫秒（ms）。 | @@ -1432,7 +1432,7 @@ TCPSocket发送请求的参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | | data | string\| ArrayBuffer7+ | 是 | 发送的数据。 | | encoding | string | 否 | 字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。 | @@ -1443,7 +1443,7 @@ TCPSocket连接的其他属性。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------------- | ------- | ---- | ------------------------------------------------------------ | | keepAlive | boolean | 否 | 是否保持连接。默认为false。 | | OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 | @@ -1460,8 +1460,6 @@ constructTLSSocketInstance(): TLSSocket 创建并返回一个TLSSocket对象。 -**需要权限**：ohos.permission.INTERNET - **系统能力**：SystemCapability.Communication.NetStack **返回值:** @@ -1500,6 +1498,7 @@ bind\(address: NetAddress, callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | ----------------------- | | 401 | Parameter error. | | 201 | Permission denied. | | 2303198 | Address already in use. | @@ -1532,7 +1531,7 @@ bind\(address: NetAddress\): Promise | 参数名 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | ------------------------------------------------------ | -| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | +| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | **返回值：** @@ -1543,6 +1542,7 @@ bind\(address: NetAddress\): Promise **错误码：** | 错误码ID | 错误信息 | +| ------- | ----------------------- | | 401 | Parameter error. | | 201 | Permission denied. | | 2303198 | Address already in use. | @@ -1577,6 +1577,7 @@ getState\(callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303188 | Socket operation on non-socket.| | 2300002 | System internal error. | @@ -1617,6 +1618,7 @@ getState\(\): Promise **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303188 | Socket operation on non-socket.| | 2300002 | System internal error. | @@ -1657,6 +1659,7 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback\): voi **错误码：** | 错误码ID | 错误信息 | +| ------- | ----------------------------- | | 401 | Parameter error. | | 2303188 | Socket operation on non-socket.| | 2300002 | System internal error. | @@ -1714,6 +1717,7 @@ setExtraOptions\(options: TCPExtraOptions\): Promise **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 401 | Parameter error. | | 2303188 | Socket operation on non-socket.| | 2300002 | System internal error. | @@ -1764,6 +1768,7 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 401 | Parameter error. | | 2303104 | Interrupted system call. | | 2303109 | Bad file number. | @@ -1864,6 +1869,7 @@ connect(options: TLSConnectOptions): Promise\ **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 401 | Parameter error. | | 2303104 | Interrupted system call. | | 2303109 | Bad file number. | @@ -2087,6 +2093,7 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2300002 | System internal error. | @@ -2119,6 +2126,7 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)> **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2300002 | System internal error. | @@ -2149,6 +2157,7 @@ getProtocol(callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | ----------------------------- | | 2303501 | SSL is null. | | 2303505 | Error occurred in the tls system call. | | 2300002 | System internal error. | @@ -2182,6 +2191,7 @@ getProtocol():Promise\ **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2303505 | Error occurred in the tls system call. | | 2300002 | System internal error. | @@ -2213,6 +2223,7 @@ getCipherSuite(callback: AsyncCallback\>): void **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2303502 | Error in tls reading. | | 2303505 | Error occurred in the tls system call. | @@ -2247,6 +2258,7 @@ getCipherSuite(): Promise\> **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2303502 | Error in tls reading. | | 2303505 | Error occurred in the tls system call. | @@ -2279,6 +2291,7 @@ getSignatureAlgorithms(callback: AsyncCallback\>): void **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2300002 | System internal error. | @@ -2311,6 +2324,7 @@ getSignatureAlgorithms(): Promise\> **错误码：** | 错误码ID | 错误信息 | +| ------- | ------------------------------ | | 2303501 | SSL is null. | | 2300002 | System internal error. | @@ -2342,6 +2356,7 @@ send(data: string, callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 401 | Parameter error. | | 2303501 | SSL is null. | | 2303503 | Error in tls writing | @@ -2378,6 +2393,7 @@ send(data: string): Promise\ **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 401 | Parameter error. | | 2303501 | SSL is null. | | 2303503 | Error in tls writing | @@ -2418,6 +2434,7 @@ close(callback: AsyncCallback\): void **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 2303501 | SSL is null. | | 2303505 | Error occurred in the tls system call. | | 2303506 | Error clearing tls connection. | @@ -2452,6 +2469,7 @@ close(): Promise\ **错误码：** | 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | | 2303501 | SSL is null. | | 2303505 | Error occurred in the tls system call. | | 2303506 | Error clearing tls connection. | @@ -2473,11 +2491,11 @@ TLS连接的操作。 **系统能力**：SystemCapability.Communication.NetStack -| 参数名 | 类型 | 说明 | -| -------------- | ------------------------------------- | -------------- | -| address | [NetAddress](#netaddress) | 网关地址。 | -| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | TLS安全相关操作。| -| ALPNProtocols | Array\ | ALPN协议。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------- | ------------------------------------- | --- |-------------- | +| address | [NetAddress](#netaddress) | 是 | 网关地址。 | +| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。| +| ALPNProtocols | Array\ | 是 | ALPN协议。 | ## TLSSecureOptions9+ @@ -2485,16 +2503,16 @@ TLS安全相关操作，其中ca证书为必选参数，其他参数为可选参 **系统能力**：SystemCapability.Communication.NetStack -| 参数名 | 类型 | 说明 | -| --------------------- | ---------------------- | ----------------------------------- | -| ca | string \| Array\ | 服务端的ca证书，用于认证校验服务端的数字证书。| -| cert | string | 本地客户端的数字证书。 | -| key | string | 本地数字证书的私钥。 | -| passwd | string | 读取私钥的密码。 | -| protocols | [Protocol](#protocol9) \| Array\<[Protocol](#protocol9)> | TLS的协议版本。 | -| useRemoteCipherPrefer | boolean | 优先使用对等方的密码套件。 | -| signatureAlgorithms | string | 通信过程中的签名算法。 | -| cipherSuite | string | 通信过程中的加密套件。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------------- | ------------------------------------------------------ | --- |----------------------------------- | +| ca | string \| Array\ | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。| +| cert | string | 否 | 本地客户端的数字证书。 | +| key | string | 否 | 本地数字证书的私钥。 | +| passwd | string | 否 | 读取私钥的密码。 | +| protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)> | 否 | TLS的协议版本。 | +| useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 | +| signatureAlgorithms | string | 否 | 通信过程中的签名算法。 | +| cipherSuite | string | 否 | 通信过程中的加密套件。 | ## Protocol9+ @@ -2502,10 +2520,10 @@ TLS通信的协议版本。 **系统能力**：SystemCapability.Communication.NetStack -| **protocol 的合法值** | 说明 | -| :------------------ | :------------------ | -| TLSv12 | 使用TLSv1.2协议通信。 | -| TLSv13 | 使用TLSv1.3协议通信。 | +| 名称 | 值 | 说明 | +| --------- | --------- |------------------ | +| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 | +| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 | ## X509CertRawData9+ @@ -2513,7 +2531,6 @@ TLS通信的协议版本。 **系统能力**：SystemCapability.Communication.NetStack -| 参数名 | 类型 | 说明 | -| -------------- | ----------------------------- | -------------- | -| data | Uint8Array | 证书内容。 | -| encodingFormat | number | 编码格式der。 | \ No newline at end of file +| 类型 | 说明 | +| --------------------------------------------------------------------- | --------------------- | +|[cryptoFramework.EncodingBlob](js-apis-cryptoFramework.md#EncodingBlob) | 存储证书的数据和编码格式 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-tagSession.md b/zh-cn/application-dev/reference/apis/js-apis-tagSession.md index 57b6709752bd6205ce94483c536522b481f4d095..b122b896efdf53c3a455c9cc3d38fe951c87ebd3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-tagSession.md +++ b/zh-cn/application-dev/reference/apis/js-apis-tagSession.md @@ -25,9 +25,9 @@ getTagInfo(): tag.TagInfo 获取该Tag被分发时，NFC服务所提供的Tag数据对象。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -53,9 +53,9 @@ connectTag(): boolean; 和标签建立连接。在从标签读取数据或将数据写入标签之前，必须调用此方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -81,9 +81,9 @@ reset(): void 重置与标签的连接。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **示例：** @@ -102,9 +102,9 @@ isTagConnected(): boolean 检查是否已与标签建立连接。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -130,9 +130,9 @@ getMaxSendLength(): number 查询可以发送到标签的最大数据长度。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -157,9 +157,9 @@ getSendDataTimeout(): number 查询发送数据到Tag的等待超时时间，单位是毫秒。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **返回值：** @@ -185,9 +185,9 @@ setSendDataTimeout(timeout: number): boolean 查询发送数据到Tag的等待超时时间，单位是毫秒。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -220,9 +220,9 @@ sendData(data: number[]): Promise 发送指令到Tag上，使用Promise方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** @@ -266,9 +266,9 @@ sendData(data: number[], callback: AsyncCallback): void 发送指令到Tag上，使用AsyncCallback方式作为异步方法。 -**需要权限**：ohos.permission.NFC_TAG +**需要权限：** ohos.permission.NFC_TAG -**系统能力**：SystemCapability.Communication.NFC.Core +**系统能力：** SystemCapability.Communication.NFC.Core **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-telephony-data.md b/zh-cn/application-dev/reference/apis/js-apis-telephony-data.md index 80b6554c1e751b312787af056a834af357aa6b96..a8127e46ce62bf407f00ba1e15301bceed881d4a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-telephony-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-telephony-data.md @@ -59,7 +59,7 @@ promise.then((data) => { }); ``` -## data.getDefaultCellularDataSlotIdSync +## data.getDefaultCellularDataSlotIdSync9+ getDefaultCellularDataSlotIdSync(): number diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 8ba540f98137c7ae9990fa53bb1f8e9c605e0567..8b5964bf378cd6c4af086a6e687753139c3479cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -58,7 +58,7 @@ unregisterThermalLevelCallback(callback?: Callback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------------------------- | -| callback | Callback<void> | 可选 | 回调函数，无返回值。不填该参数则取消所有回调。 | +| callback | Callback<void> | 否 | 回调函数，无返回值。不填该参数则取消所有回调。 | **错误码：** @@ -191,12 +191,12 @@ console.info('thermal level is: ' + level); **系统能力：** SystemCapability.PowerManager.ThermalManager -| 名称 | 默认值 | 描述 | -| ---------- | ------ | ------------------------------------------------------------ | -| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 | -| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态 | -| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | -| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | -| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | -| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 | -| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 | +| 名称 | 值 | 说明 | +| ---------- | ---- | ------------------------------------------------------------ | +| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 | +| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态 | +| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | +| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | +| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | +| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 | +| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-url.md b/zh-cn/application-dev/reference/apis/js-apis-url.md index 4f5e36faa1e8c56f40640f083f814dd1ad76de4a..1631975c83e59f66b58b748b0d2327d3e9a7170d 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-url.md +++ b/zh-cn/application-dev/reference/apis/js-apis-url.md @@ -713,9 +713,10 @@ for (var value of searchParams.values()) { ### [Symbol.iterator](deprecated) + > **说明：** > -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.[Symbol.iterator]9+](#symbol.iterator9)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]9+](#symboliterator9)替代。 [Symbol.iterator]\(): IterableIterator<[string, string]> @@ -741,7 +742,7 @@ for (const [name, value] of paramsObject) { ### tostring(deprecated) > **说明：** > -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.tostring9+](#tostring9)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring9+](#tostring9)替代。 toString(): string @@ -790,7 +791,7 @@ console.log(params.toString()); > **说明：** > -> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL9+](#parseURL9)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL9+](#parseurl9)替代。 constructor(url: string, base?: string | URL) diff --git a/zh-cn/application-dev/reference/apis/js-apis-util.md b/zh-cn/application-dev/reference/apis/js-apis-util.md index 9dbb48cbf806bf1508c9b799cef69efded3a5fba..e8ee8bfedaebf88276df4d51be71b3d32153a8ce 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-util.md +++ b/zh-cn/application-dev/reference/apis/js-apis-util.md @@ -2644,13 +2644,13 @@ intersect(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | 是 | 传入一个给定范围。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scope8) | 返回给定范围和当前范围的交集。 | +| [Scope](#scopedeprecated) | 返回给定范围和当前范围的交集。 | **示例：** @@ -2687,7 +2687,7 @@ intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope | 类型 | 说明 | | -------- | -------- | -| [Scope](#scope8) | 返回当前范围与给定下限和上限范围的交集。 | +| [Scope](#scopedeprecated) | 返回当前范围与给定下限和上限范围的交集。 | **示例：** @@ -2777,7 +2777,7 @@ expand(lowerObj: ScopeType,upperObj: ScopeType): Scope | 类型 | 说明 | | -------- | -------- | -| [Scope](#scope8) | 返回当前范围和给定下限和上限的并集。 | +| [Scope](#scopedeprecated) | 返回当前范围和给定下限和上限的并集。 | **示例：** @@ -2806,13 +2806,13 @@ expand(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | 是 | 传入一个给定范围。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scope8) | 返回包括当前范围和给定范围的并集。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定范围的并集。 | **示例：** @@ -2848,7 +2848,7 @@ expand(value: ScopeType): Scope | 类型 | 说明 | | -------- | -------- | -| [Scope](#scope8) | 返回包括当前范围和给定值的并集。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定值的并集。 | **示例：** @@ -2910,7 +2910,7 @@ contains(range: Scope): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | 是 | 传入一个给定范围。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md index 9855276e48fca5a322ae75eda5105f1a3b8534da..d40853b5e03c7328c71b0ecc444f3fc022fa82dd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -1101,14 +1101,3 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => { | finalCode | number | 是 | 触发wantAgent的请求代码。| | finalData | string | 否 | 公共事件收集的最终数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 | - -## TriggerInfo - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 必填 | 说明 | -| ---------- | -------------------- | ---- | ----------- | -| code | number | 是 | result code。 | -| want | Want | 否 | Want。 | -| permission | string | 否 | 权限定义。 | -| extraInfo | {[key: string]: any} | 否 | 额外数据。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md index b9da91e72f104d69d543d278c6c3883b24f1f625..ebbd7466389a9d7cecd59b99f35deac8c565e0de 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md @@ -595,7 +595,7 @@ ws.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | | header | Object | 否 | 建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。 | @@ -606,7 +606,7 @@ ws.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | | code | number | 否 | 错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。 | | reason | string | 否 | 原因值，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为空字符串（""）。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md index c7b1564625c586cff13822fc2eedfc85f6745ad7..7dc1e4826365a6abac32d43ed79cf42b991b168e 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md @@ -41,7 +41,7 @@ | backdrop-filter5+ | string | - | 语法：backdrop-filter: blur(px)
通过这个样式可以设置当前组件布局范围的背景模糊，参数用于指定模糊半径，如果没有设置值，则默认是0(不模糊)，不支持百分比。
示例：
- backdrop-filter: blur(10px) | | window-filter5+ | string | - | 语法：window-filter: blur(percent), style5+
通过这个样式可以设置当前组件布局范围的窗口模糊程度和模糊样式，如果没有设置值，则默认是0%(不模糊)，多块模糊区域时不支持设置不同的模糊值和模糊样式。style可选值：small_light(默认值), medium_light, large_light, xlarge_light, small_dark, medium_dark, large_dark, xlarge_dark。
示例：
- window-filter: blur(50%)
- window-filter: blur(10%), large_light | | opacity | number | 1 | 元素的透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。 | -| display | string | flex | 确定一个元素所产生的框的类型，可选值为：
- flex：弹性布局。
- none：不渲染此元素。
-inline9+：元素会被显示为内联元素，元素前后没有换行符。
-block9+：元素将显示为块级元素，元素前后会带有换行符，容器组件默认为block。
-inline-block9+：设置为行内盒子，在同一行展示，可以设置宽高，基础组件默认为inline-block。 | +| display | string | flex | 确定一个元素所产生的框的类型，可选值为：
- flex：弹性布局。
- none：不渲染此元素。
- grid：网格布局（仅div支持display样式设置为grid）。 | | visibility | string | visible | 是否显示元素所产生的框。不可见的框会占用布局（将'display'属性设置为'none'来完全去除框），可选值为：
- visible：元素正常显示。
- hidden：隐藏元素，但是其他元素的布局不改变，相当于此元素变成透明。
visibility和display样式都设置时，仅display生效。 | | flex | number \| string | - | 规定当前组件如何适应父组件中的可用空间。
flex可以指定1个、2个5+或3个5+值。
单值语法：
- 一个无单位数：用来设置组件的flex-grow。
- 一个有效的宽度值5+：用来设置组件的flex-basis。
双值语法5+：
第一个值必须是无单位数，用来设置组件的flex-grow。第二个值是以下之一：
- 一个无单位数：用来设置组件的flex-shrink。
- 一个有效的宽度值：用来设置组件的flex-basis。
三值语法5+：
第一个值必须是无单位数，用来设置组件的flex-grow；第二个值必须是无单位数，用来设置组件的flex-shrink；第三个值必须是一个有效的宽度值，用来设置组件的flex-basis。
仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | | flex-grow | number | 0 | 设置组件的拉伸样式，指定父组件容器主轴方向上剩余空间（容器本身大小减去所有flex子元素占用的大小）的分配权重。0为不伸展。
仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md b/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md index 8f81b0178ddf9d7d0d2c3a6bc1137c14e1dc74dc..47802a8d39e69e77179d7e22df1ea5a2d67a158d 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md @@ -31,7 +31,6 @@ | justify-content | string | flex-start | 否 | flex容器当前行的主轴对齐格式。可选项有：
- flex-start：项目位于容器的开头。
- flex-end：项目位于容器的结尾。
- center：项目位于容器的中心。
- space-between：项目位于各行之间留有空白的容器内。
- space-around：项目位于各行之前、之间、之后都留有空白的容器内。
- space-evenly5+:  均匀排列每个元素，每个元素之间的间隔相等。 | | align-items | string | stretch
| 否 | flex容器当前行的交叉轴对齐格式，可选值为：
- stretch：弹性元素在交叉轴方向被拉伸到与容器相同的高度或宽度。
- flex-start：元素向交叉轴起点对齐。
- flex-end：元素向交叉轴终点对齐。
- center：元素在交叉轴居中。
- baseline：如Flex布局纵向排列，则该值与’flex-start‘等效。横向布局时，内容元素存在文本时按照文本基线对齐，否则底部对齐。 | | align-content | string | flex-start | 否 | 交叉轴中有额外的空间时，多行内容对齐格式，可选值为：
- flex-start：所有行从交叉轴起点开始填充。第一行的交叉轴起点边和容器的交叉轴起点边对齐。接下来的每一行紧跟前一行。
- flex-end：所有行从交叉轴末尾开始填充。最后一行的交叉轴终点和容器的交叉轴终点对齐。同时所有后续行与前一个对齐。
- center：所有行朝向容器的中心填充。每行互相紧挨，相对于容器居中对齐。容器的交叉轴起点边和第一行的距离相等于容器的交叉轴终点边和最后一行的距离。
- space-between：所有行在容器中平均分布。相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的边对齐。
- space-around：所有行在容器中平均分布，相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的距离是相邻两行间距的一半。 | -| display | string | flex | 否 | 确定该元素视图框的类型，该值暂不支持动态修改。可选值为：
- flex：弹性布局
- grid：网格布局
- none：不渲染此元素
-inline-flex9+：当设置为inline-flex 时，同时具备flex样式和inline-block的效果 | | grid-template-[columns\|rows] | string | 1行1列 | 否 | 用于设置当前网格布局行和列的数量，不设置时默认1行1列，仅当display为grid时生效。
示例：如设置grid-template-columns为：
- 50px 100px 60px：分三列，第一列50px，第二列100px，第三列60px；
- 1fr 1fr 2fr：分三列，将父组件允许的宽分为4等份，第一列占1份，第二列占一份，第三列占2份；
- 30% 20% 50%：分三列，将父组件允许的宽为基准，第一列占30%，第二列占20%，第三列占50%；
- repeat(2,100px)：分两列，第一列100px，第二列100px；
- repeat(auto-fill,100px)5+：按照每列100px的大小和交叉轴大小计算最大正整数重复次数，按照该重复次数布满交叉轴；
- auto 1fr 1fr：分三列，第一列自适应内部子组件所需宽度，剩余空间分为两等份，第二列占一份，第三列占一份。 | | grid-[columns\|rows]-gap | <length> | 0 | 否 | 用于设置行与行的间距或者列与列的间距，也可以支持通过grid-gap设置相同的行列间距，仅当display为grid时生效。 | | grid-row-[start\|end] | number | - | 否 | 用于设置当前元素在网格布局中的起止行号，仅当父组件display样式为grid时生效（仅div支持display样式设置为grid）。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg.md index a44fed0e5caee70217c41e0f045ff4a1d0074a78..76c3037ed5e446291163467d1e37937a6d78ae1e 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg.md @@ -4,9 +4,9 @@ > **说明：** -> - 该组件从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -> -> - svg父组件或者svg组件需要定义宽高值，否则不进行绘制。 +> - 该组件从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 +> +> - svg父组件或者svg组件需要定义宽高值，否则不进行绘制。 ## 权限列表 @@ -15,21 +15,21 @@ ## 子组件 -支持[svg](js-components-svg.md)、[rect](js-components-svg-rect.md)、[circle](js-components-svg-circle.md)、[ellipse](../arkui-js/js-components-svg-ellipse.md)、[path](js-components-svg-path.md)、[line](../arkui-js/js-components-svg-line.md)、[polygon](../arkui-js/js-components-svg-polygon.md)、[polyline](js-components-svg-polyline.md)、[text](js-components-svg-text.md)、[animate](js-components-svg-animate.md)、[animateTransform](js-components-svg-animateTransform.md)。 +支持[svg](js-components-svg.md)、[rect](js-components-svg-rect.md)、[circle](js-components-svg-circle.md)、[ellipse](../arkui-js/js-components-svg-ellipse.md)、[path](js-components-svg-path.md)、[line](../arkui-js/js-components-svg-line.md)、[polygon](../arkui-js/js-components-svg-polygon.md)、[polyline](js-components-svg-polyline.md)、[text](js-components-svg-text.md)、[animate](js-components-svg-animate.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性，设置的通用属性会传递给子组件。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| id | string | - | 否 | 组件的唯一标识。 | -| width | <length>\|<percentage> | - | 否 | 设置组件的宽度。 | -| height | <length>\|<percentage> | - | 否 | 设置组件的高度。 | -| x | <length>\|<percentage> | - | 否 | 设置当前svg的x轴坐标，根svg节点无效。 | -| y | <length>\|<percentage> | | 否 | 设置当前svg的y轴坐标，根svg节点无效。 | -| viewBox | string | - | 否 | 设置当前svg的视口。支持的格式为<number number number number>，4个参数分别表示min-x, min-y, width and height，viewBox的宽高和svg的宽高不一致，会以中心对齐进行缩放。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------- | ---------------------------------- | ---- | ---- | ---------------------------------------- | +| id | string | - | 否 | 组件的唯一标识。 | +| width | <length>\|<percentage> | - | 否 | 设置组件的宽度。 | +| height | <length>\|<percentage> | - | 否 | 设置组件的高度。 | +| x | <length>\|<percentage> | - | 否 | 设置当前svg的x轴坐标，根svg节点无效。 | +| y | <length>\|<percentage> | | 否 | 设置当前svg的y轴坐标，根svg节点无效。 | +| viewBox | string | - | 否 | 设置当前svg的视口。支持的格式为<number number number number>，4个参数分别表示min-x, min-y, width and height，viewBox的宽高和svg的宽高不一致，会以中心对齐进行缩放。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/flex.PNG b/zh-cn/application-dev/reference/arkui-ts/figures/flex.PNG index ccfb5020729aa765d259afd74fc93822c5752f4d..9975e8261fd548d2b11607ed3603410dd4a1577e 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/flex.PNG and b/zh-cn/application-dev/reference/arkui-ts/figures/flex.PNG differ diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/touchtarget.gif b/zh-cn/application-dev/reference/arkui-ts/figures/touchtarget.gif index 550dfe998ac31230b52ff3972974cdd4a7431b28..c1ded83ee8eb7d8f7a80c516f205c695570a86ef 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/touchtarget.gif and b/zh-cn/application-dev/reference/arkui-ts/figures/touchtarget.gif differ diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001189634870.gif b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001189634870.gif index c7532ed87726ac7591901514a7396b617daa10f0..cba972ca736015ad30288b21bb8069cb540414c2 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001189634870.gif and b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001189634870.gif differ diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001209874754.gif b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001209874754.gif index e83d5b33f9b10e586aa2288f6271c51fd79fab47..69f9763394cc6406b29ba8710b73c6441df29048 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001209874754.gif and b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001209874754.gif differ diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md index 58125935b9114b90b4bc23b1e5e37eaadf55de79..6e28c15b09dd53348449554f9ed8352621b1ea1d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md @@ -77,6 +77,7 @@ push(param: PushParameters, callback: AsyncCallback<void>): void | name | string | 是 | 组件名称。 | | data | KVObject | 否 | 组件数据值。 | | extraData | KVObject | 否 | 附加数据值。 | +| jsonPath | string | 否 | 存放模板路径的external.json文件的路径。 | **示例** @@ -103,6 +104,7 @@ request(param: RequestParameters, callback: AsyncCallback<RequestCallbackPara | want | Want | 是 | 组件提供者Ability信息。 | | name | string | 是 | 请求组件名称。 | | data | KVObject | 是 | 附加数据。 | +| jsonPath | string | 否 | 存放模板路径的external.json文件的路径。jsonPath字段不为空或者未设置的时候不触发Request通信。 | **RequestCallbackParameters说明** @@ -112,12 +114,6 @@ request(param: RequestParameters, callback: AsyncCallback<RequestCallbackPara | data | KVObject | 组件数据。 | | extraData | KVObject | 附加数据。 | -**KVObject类型说明** - -| 参数 | 类型 | 说明 | -| ---- | ---------------------------------------- | ---------------------------------------- | -| key | number \| string \| boolean \| Array \| KVObject | KVObject用[key，value]来存储数据，key是string类型的，value可以是number，string，boolean，数组或者另外的一个KVObject。 | - **示例** 见[Plugin组件使用方](#组件使用方)示例。 @@ -155,6 +151,20 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback): v 见[Plugin组件工具](#plugin组件工具)示例。 +**KVObject类型说明** + +| 参数 | 类型 | 说明 | +| ---- | ---------------------------------------- | ---------------------------------------- | +| key | number \| string \| boolean \| Array \| KVObject | KVObject用[key，value]来存储数据，key是string类型的，value可以是number，string，boolean，数组或者另外的一个KVObject。 | + + +**external.json文件说明** + +external.json文件由开发者创建。external.json中以键值对形式存放组件名称以及对应模板路径。以组件名称name作为关键字，对应模板路径作为值。 + +**示例** + +见[external.json](#externaljson)示例。 ## 示例 @@ -347,3 +357,11 @@ export default { } } ``` + + +### external.json +```json +{ + "plugintemplate": "ets/pages/plugintemplate.js", + "plugintemplate2": "ets/pages/plugintemplate2.js" +} diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md index d1c026f7074546c14b41cff054ef2b99d7d43972..323fc72b1e63787f0be933224e4406c47a33e984 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md @@ -10,8 +10,8 @@ ## 子组件 - - 不支持。 + 构造参数type为"surface"时不支持。\ + 从API version 9开始，构造参数type为"component"时可以包含子组件。 ## 接口 @@ -22,12 +22,32 @@ | 参数名 | 参数类型 | 必填 | 描述 | | --------- | ------ | ---- | ----- | | id | string | 是 | 组件的唯一标识，支持最大的字符串长度128。 | -| type | string | 是 | 用于指定XComponent组件类型，可选值为：
-surface：组件内容单独送显，直接合成到屏幕。
-component：组件内容与其他组件合成后统一送显。 | -| libraryname | string | 否 | 应用Native层编译输出动态库名称。 | -| controller | [XComponentcontroller](#xcomponentcontroller) | 否 | 给组件绑定一个控制器，通过控制器调用组件方法。 | +| type | string | 是 | 用于指定XComponent组件类型，可选值为：
-"surface"：用于EGL/OpenGLES和媒体数据写入，组件内容单独送显，直接合成到屏幕。
-"component"9+ ：XComponent将变成一个容器组件，并可在其中执行非UI逻辑以动态加载显示内容。 | +| libraryname | string | 否 | 应用Native层编译输出动态库名称，仅XComponent类型为"surface"时有效。 | +| controller | [XComponentcontroller](#xcomponentcontroller) | 否 | 给组件绑定一个控制器，通过控制器调用组件方法，仅XComponent类型为"surface"时有效。 | + +> **说明：** +> +> type为"component"时，XComponent作为容器，子组件沿垂直方向布局： +> +> - 垂直方向上对齐格式：[FlexAlign](ts-appendix-enums.md#flexalign).Start +> - 水平方向上对齐格式：[FlexAlign](ts-appendix-enums.md#flexalign).Center +> +> 所有的事件响应均不支持。 +> +> 布局方式更改和事件响应均可通过挂载子组件来设置。 +> +> 内部所写的非UI逻辑需要封装在一个或多个函数内。 + +## 属性 +- XComponent显示的内容，可由开发者自定义绘制，通用属性不支持[背景设置](./ts-universal-attributes-background.md)、[透明度设置](./ts-universal-attributes-opacity.md)和[图像效果](./ts-universal-attributes-image-effect.md)。 +- type为"surface"时建议使用EGL/OpenGLES提供的接口设置相关内容。 +- type为"component"时建议使用挂载子组件的方式进行设置相关内容。 ## 事件 +仅type为"surface"时以下事件有效。不支持[通用事件和手势](./Readme-CN.md)。 + ### onLoad onLoad(callback: (event?: object) => void ) @@ -60,7 +80,7 @@ xcomponentController: XComponentController = new XComponentController() getXComponentSurfaceId(): string -获取XComponent对应Surface的ID，供@ohos接口使用，比如camera相关接口。 +获取XComponent对应Surface的ID，供@ohos接口使用，使用方式可参考[相机管理](../apis/js-apis-camera.md)，仅XComponent类型为"surface"时有效。 **返回值:** @@ -74,7 +94,7 @@ getXComponentSurfaceId(): string setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}): void -设置XComponent持有Surface的宽度和高度。 +设置XComponent持有Surface的宽度和高度，仅XComponent类型为"surface"时有效。 **参数:** @@ -89,7 +109,7 @@ setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}): getXComponentContext(): Object -获取XComponent实例对象的context。 +获取XComponent实例对象的context，仅XComponent类型为"surface"时有效。 **返回值:** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-pixel-units.md b/zh-cn/application-dev/reference/arkui-ts/ts-pixel-units.md index e745d745027f7d12a9276a49376e273eaf05e963..654b88ab931a8adbfd3f66d67f09ab33e145e817 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-pixel-units.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-pixel-units.md @@ -8,7 +8,7 @@ | px | 屏幕物理像素单位。 | | vp | 屏幕密度相关像素，根据屏幕像素密度转换为屏幕物理像素，当数值不带单位时，默认单位vp。 | | fp | 字体像素，与vp类似适用屏幕密度变化，随系统字体大小设置变化。 | -| lpx | 视窗逻辑像素单位，lpx单位为实际屏幕宽度与逻辑宽度（通过[designWidth](../../quick-start/package-structure.md)配置）的比值，designWidth默认值为720。当designWidth为720时，在实际宽度为1440物理像素的屏幕上，1lpx为2px大小。 | +| lpx | 视窗逻辑像素单位，lpx单位为实际屏幕宽度与逻辑宽度（通过designWidth配置）的比值，designWidth默认值为720。当designWidth为720时，在实际宽度为1440物理像素的屏幕上，1lpx为2px大小。 | ## 像素单位转换 diff --git a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md index 2292907bbbd3e310757cccdcbe876024aac7bf53..3a4205a1629c71cfe5acb2efc20dec49768fac60 100644 --- a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md +++ b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md @@ -4,6 +4,7 @@ - Ability框架 - [元能力子系统错误码](errorcode-ability.md) - [DistributedSchedule错误码](errorcode-DistributedSchedule.md) + - [卡片错误码](errorcode-form.md) - 包管理 - [包管理子系统通用错误码](errorcode-bundle.md) - [zlib子系统错误码](errorcode-zlib.md) diff --git a/zh-cn/application-dev/reference/errorcodes/errcode-form.md b/zh-cn/application-dev/reference/errorcodes/errorcode-form.md similarity index 100% rename from zh-cn/application-dev/reference/errorcodes/errcode-form.md rename to zh-cn/application-dev/reference/errorcodes/errorcode-form.md diff --git a/zh-cn/application-dev/reference/syscap-list.md b/zh-cn/application-dev/reference/syscap-list.md index 02d5b8465d2ef678cd2cdbecb7d85287d988cb73..0d0665073e134b381f6bb621e775d6b044c8e337 100644 --- a/zh-cn/application-dev/reference/syscap-list.md +++ b/zh-cn/application-dev/reference/syscap-list.md @@ -2,7 +2,7 @@ SysCap，全称SystemCapability，即系统能力，指操作系统中每一个相对独立的特性。 -开发者使用某个接口进行开发前，建议先阅读[SysCap使用指南](../quick-start/syscap.md)，了解Syscap的定义和使用指导。再结合下文中的表格判断具体能力集是否支持某个设备，提高开发效率。 +开发者使用某个接口进行开发前，建议先阅读[SysCap使用指南](syscap.md)，了解Syscap的定义和使用指导。再结合下文中的表格判断具体能力集是否支持某个设备，提高开发效率。 ## SystemCapability.ArkUI.ArkUI.Full diff --git a/zh-cn/application-dev/security/accesstoken-guidelines.md b/zh-cn/application-dev/security/accesstoken-guidelines.md index 568ba39877082e5dd20bc9313ea8f5300620ac9f..745b23f071aaf9ec4a9f2d7278bbb346836386c8 100644 --- a/zh-cn/application-dev/security/accesstoken-guidelines.md +++ b/zh-cn/application-dev/security/accesstoken-guidelines.md @@ -26,9 +26,9 @@ ## 权限申请声明 -应用需要在工程配置文件中，对需要的权限逐个声明，没有在配置文件中声明的权限，应用将无法获得授权。Ability框架提供了两种模型，分别为FA模型和Stage模型，更多信息可以参考[Ability框架概述](../ability/ability-brief.md)。 +应用需要在工程配置文件中，对需要的权限逐个声明，没有在配置文件中声明的权限，应用将无法获得授权。OpenHarmony提供了两种应用模型，分别为FA模型和Stage模型，更多信息可以参考[应用模型解读](../application-models/application-model-description.md)。 -不同的Ability框架模型的应用包结构不同，所使用的配置文件不同，请开发者在申请权限时注意区分。 +不同的应用模型的应用包结构不同，所使用的配置文件不同，请开发者在申请权限时注意区分。 配置文件标签说明如下表。 diff --git a/zh-cn/application-dev/security/app-provision-structure.md b/zh-cn/application-dev/security/app-provision-structure.md index 69d5ff8c0e34359716bc4cd2fe4d0ea436f760c2..dd49a4d625e3dc8a9ed865b9970da66fade9d89e 100644 --- a/zh-cn/application-dev/security/app-provision-structure.md +++ b/zh-cn/application-dev/security/app-provision-structure.md @@ -73,7 +73,7 @@ HarmonyAppProvision文件示例： ### acls对象内部结构 -acls对象包含已授权的[ACL权限](accesstoken-overview.md)。需要指出的是，开发者仍然需要在应用包配置文件（[config.json](../quick-start/package-structure.md)）将acls权限信息填写到reqPermissions属性中。 +acls对象包含已授权的[ACL权限](accesstoken-overview.md)。需要指出的是，开发者仍然需要在[应用包配置文件](../quick-start/module-configuration-file.md#requestpermissions标签)将acls权限信息填写到reqPermissions属性中。 表4 acls对象的内部结构 | 属性名称 | 含义 | 数据类型 | 是否必选 | 是否可缺省 | @@ -81,7 +81,7 @@ acls对象包含已授权的[ACL权限](accesstoken-overview.md)。需要指出 | allowed-acls | 表示已授权的[acl权限](accesstoken-overview.md)列表。 | 字符串数组 | 可选 | 不可缺省 | ### permissions对象内部结构 -permissions对象包含允许使用的受限敏感权限。不同于acls对象，permissions对象中的权限仅代表应用允许使用该敏感权限，权限最终由用户运行时授权。需要指出的是，开发者仍然需要在应用包配置文件（[config.json](../quick-start/package-structure.md)）将permissions权限信息填写到reqPermissions属性中。 +permissions对象包含允许使用的受限敏感权限。不同于acls对象，permissions对象中的权限仅代表应用允许使用该敏感权限，权限最终由用户运行时授权。需要指出的是，开发者仍然需要在[应用包配置文件](../quick-start/module-configuration-file.md#requestpermissions标签)将permissions权限信息填写到reqPermissions属性中。 表5 permissions对象的内部结构 | 属性名称 | 含义 | 数据类型 | 是否必选 | 是否可缺省 | diff --git a/zh-cn/application-dev/security/userauth-guidelines.md b/zh-cn/application-dev/security/userauth-guidelines.md index fa18eefba7491f6ec43b6a92c04c7426cdd59931..a038885378a06e158f561e64a427c45de59155c9 100644 --- a/zh-cn/application-dev/security/userauth-guidelines.md +++ b/zh-cn/application-dev/security/userauth-guidelines.md @@ -29,7 +29,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ### 开发步骤 -1. 申请权限。调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 +1. 申请权限。调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 2. 调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口获取版本信息。 @@ -49,7 +49,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ### 开发步骤 -1. 申请权限。调用[getAvailableStatus](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetavailablestatus9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 +1. 申请权限。调用[getAvailableStatus](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetavailablestatus9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 2. 指定[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，调用[getAvailableStatus](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetavailablestatus9)接口查询当前的设备是否支持相应的认证能力。 @@ -69,7 +69,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ### 开发步骤 -1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 +1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 @@ -131,7 +131,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ### 开发步骤 -1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 +1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 @@ -197,7 +197,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ### 开发步骤 -1. 申请权限。调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 +1. 申请权限。调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 diff --git a/zh-cn/application-dev/task-management/reminder-agent-development.md b/zh-cn/application-dev/task-management/reminder-agent-development.md index 3f7d1c7c55215151f1ba7bd8fc9c2ebdd20a7d41..973b79f879ee3d1cfbdf6a796a263ce12ddffd41 100644 --- a/zh-cn/application-dev/task-management/reminder-agent-development.md +++ b/zh-cn/application-dev/task-management/reminder-agent-development.md @@ -7,24 +7,24 @@ **表1** reminderAgentManager主要接口 -| 接口名 | 描述 | -| -------- | -------- | -| publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void
publishReminder(reminderReq: ReminderRequest): Promise<number> | 发布一个定时提醒类通知。
- 单个应用有效的提醒个数最多支持30个（不包括已经超时，即后续不会再提醒的提醒实例）。
- 整个系统有效的提醒个数最多支持2000个（不包括已经超时，即后续不会再提醒的提醒实例）。 | -| cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
cancelReminder(reminderId: number): Promise<void> | 取消一个指定的提醒类通知（reminderId从publishReminder的返回值获取）。 | -| getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void
getValidReminders(): Promise<Array<ReminderRequest>> | 获取当前应用设置的所有有效的提醒。 | -| cancelAllReminders(callback: AsyncCallback<void>): void
cancelAllReminders(): Promise<void> | 取消当前应用设置的所有提醒。 | -| addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
addNotificationSlot(slot: NotificationSlot): Promise<void> | 注册一个提醒类需要使用的NotificationSlot。 | -| removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void
removeNotificationSlot(slotType: notification.SlotType): Promise<void> | 删除指定类型的NotificationSlot。 | +| 接口名 | 描述 | +| ---------------------------------------- | ---------------------------------------- | +| publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void
publishReminder(reminderReq: ReminderRequest): Promise<number> | 发布一个定时提醒类通知。
- 单个应用有效的提醒个数最多支持30个（不包括已经超时，即后续不会再提醒的提醒实例）。
- 整个系统有效的提醒个数最多支持2000个（不包括已经超时，即后续不会再提醒的提醒实例）。 | +| cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
cancelReminder(reminderId: number): Promise<void> | 取消一个指定的提醒类通知（reminderId从publishReminder的返回值获取）。 | +| getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void
getValidReminders(): Promise<Array<ReminderRequest>> | 获取当前应用设置的所有有效的提醒。 | +| cancelAllReminders(callback: AsyncCallback<void>): void
cancelAllReminders(): Promise<void> | 取消当前应用设置的所有提醒。 | +| addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
addNotificationSlot(slot: NotificationSlot): Promise<void> | 注册一个提醒类需要使用的NotificationSlot。 | +| removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void
removeNotificationSlot(slotType: notification.SlotType): Promise<void> | 删除指定类型的NotificationSlot。 | ## 开发步骤 1. 申请`ohos.permission.PUBLISH_AGENT_REMINDER`权限，配置方式请参阅[访问控制授权申请指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 -2. [使能通知开关](notification-enable.md)，获得用户授权后，才能使用代理提醒功能。 +2. [使能通知开关](../notification/notification-enable.md)，获得用户授权后，才能使用代理提醒功能。 3. 导入模块。 - + ``` import reminderAgentManager from '@ohos.reminderAgentManager'; import NotificationManager from '@ohos.notificationManager'; @@ -32,7 +32,7 @@ 4. 定义目标提醒代理。开发者根据实际需要，选择定义如下类型的提醒。 - 定义倒计时实例。 - + ``` let targetReminderAgent: reminderAgentManager.ReminderRequestTimer = { reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER, // 提醒类型为倒计时类型 @@ -59,7 +59,7 @@ } ``` - 定义日历实例。 - + ``` let targetReminderAgent: reminderAgentManager.ReminderRequestCalendar = { reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_CALENDAR, // 提醒类型为日历类型 @@ -103,7 +103,7 @@ } ``` - 定义闹钟实例。 - + ``` let targetReminderAgent: reminderAgentManager.ReminderRequestAlarm = { reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_ALARM, // 提醒类型为闹钟类型 @@ -141,7 +141,7 @@ ``` 5. 发布相应的提醒代理。代理发布后，应用即可使用后台代理提醒功能。 - + ``` try { reminderAgentManager.publishReminder(targetReminderAgent).then(res => { @@ -161,10 +161,10 @@ ![zh-cn_image_0000001416585578](figures/zh-cn_image_0000001416585578.png) 6. 若需要删除提醒任务，可以通过调用[reminderAgentManager.cancelReminder()](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder)方法来实现。 - + ``` let reminderId = 0; // reminderId的值从发布提醒代理成功之后的回调中获得 - + try { reminderAgentManager.cancelReminder(reminderId).then(() => { console.log("cancelReminder promise"); diff --git a/zh-cn/application-dev/ui/js-framework-file.md b/zh-cn/application-dev/ui/js-framework-file.md index c9d892c9ffc3ccb5afcf2c575dea706731a9236a..a558511c86851d6daac561728d7698095cfff2c5 100644 --- a/zh-cn/application-dev/ui/js-framework-file.md +++ b/zh-cn/application-dev/ui/js-framework-file.md @@ -33,7 +33,8 @@ JS FA应用的JS模块(entry/src/main/js/module)的典型开发目录结构如 - share目录用于配置多个实例共享的资源内容，比如：share中的图片和JSON文件可被default1和default2实例共享。 > **说明：** -> - i18n和resources是开发保留文件夹，不可重命名。 +> +> - i18n和resources文件夹不可重命名。 > > > - 如果share目录中的资源和实例(default)中的资源文件同名且目录一致时，实例中资源的优先级高于share中资源的优先级。 diff --git a/zh-cn/application-dev/ui/ui-ts-components-web.md b/zh-cn/application-dev/ui/ui-ts-components-web.md index 884066df04728957cacc39ab5c1263d003519ced..9a913bd2d0914de37b3157bc38aae4c4c4dcbbe1 100644 --- a/zh-cn/application-dev/ui/ui-ts-components-web.md +++ b/zh-cn/application-dev/ui/ui-ts-components-web.md @@ -231,5 +231,3 @@ struct WebComponent { 针对Web开发，有以下相关实例可供参考： - [`Web`：Web（ArkTS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/master/ETSUI/Web) - -- [Web组件加载本地H5小程序（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/ETSUI/WebComponent) \ No newline at end of file diff --git a/zh-cn/application-dev/windowmanager/application-window-stage.md b/zh-cn/application-dev/windowmanager/application-window-stage.md index a1e23601da5216b1d9af707e36fcc53611fd8d4d..f36870f72026942e0bf3b38d2ec9adf56f892e21 100644 --- a/zh-cn/application-dev/windowmanager/application-window-stage.md +++ b/zh-cn/application-dev/windowmanager/application-window-stage.md @@ -292,7 +292,7 @@ class MainAbility extends Ability { ### 开发步骤 1. 申请权限。 - 创建`WindowType.TYPE_FLOAT`即悬浮窗类型的窗口，需要在`module.json5`文件的`requestPermissions`对象中配置`ohos.permission.SYSTEM_FLOAT_WINDOW`权限。更多配置信息详见[应用包结构配置文件的说明](../quick-start/stage-structure.md)。 + 创建`WindowType.TYPE_FLOAT`即悬浮窗类型的窗口，需要在`module.json5`文件的`requestPermissions`对象中配置`ohos.permission.SYSTEM_FLOAT_WINDOW`权限。更多配置信息详见[Stage模型应用程序包结构](../quick-start/application-package-structure-stage.md)。 > **说明：** > 虽然悬浮窗具备始终在前台显示的能力，但如果创建悬浮窗的应用任务被系统回收，仍然会导致悬浮窗从界面移除。如果想要保持悬浮窗口始终在前台显示，请申请[长时任务](../task-management/background-task-overview.md)。 diff --git a/zh-cn/device-dev/subsystems/subsys-data-relational-database-guide.md b/zh-cn/device-dev/subsystems/subsys-data-relational-database-guide.md index 6ee4d0b87bd4814bee203f445818a8b9d2981cd3..888c1d09552d9b77beaaf73dd3912f892e42b2df 100644 --- a/zh-cn/device-dev/subsystems/subsys-data-relational-database-guide.md +++ b/zh-cn/device-dev/subsystems/subsys-data-relational-database-guide.md @@ -20,15 +20,6 @@ | RdbHelper | std::shared_ptr\ GetRdbStore(const RdbStoreConfig &config, int version, RdbOpenCallback &openCallback, int &errCode) | 根据配置创建或打开数据库。 | | RdbHelper | int DeleteRdbStore(const std::string &path) | 删除指定的数据库。 | -### 数据库的加密 - -关系型数据库提供数据库加密的能力，在创建数据库时若指定了密钥，则会创建为加密数据库。再次使用此数据库时，需要指定该密钥，才能正确打开数据库。 - -表2 数据库修改密钥API -| 类名 | 接口名 | 描述 | -| ---- | ---- | ---- | -| RdbStore | int ChangeEncryptKey(const std::vector &newKey) | 为数据库设置新的加密密钥。注：仅支持加密数据库更换加密密钥。 | - ### 数据库谓词的使用 关系型数据库提供了用于设置数据库操作条件的谓词AbsRdbPredicates，其中包括两个实现子类RdbPredicates和RawRdbPredicates： @@ -36,7 +27,7 @@ - RdbPredicates：开发者无需编写复杂的SQL语句，仅通过调用该类中条件相关的方法，如equalTo、notEqualTo、groupBy、orderByAsc、beginsWith等，就可自动完成SQL语句拼接，方便用户聚焦业务操作。 - RawRdbPredicates：可满足复杂SQL语句的场景，支持开发者自己设置where条件子句和whereArgs参数。不支持equalTo等条件接口的使用。 - 表3 数据库谓词API + 表2 数据库谓词API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbPredicates | AbsPredicates *EqualTo(std::string field, std::string value) | 设置谓词条件，满足field字段与value值相等。 | @@ -58,7 +49,7 @@ 关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。 - 表4 数据表插入API + 表3 数据表插入API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | @@ -68,7 +59,7 @@ 调用删除接口，通过AbsRdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。 - 表5 数据表删除API + 表4 数据表删除API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | int Delete(int &deletedRows, const AbsRdbPredicates &predicates) | 删除数据。
  • deletedRows：删除的记录条数。
  • predicates：Rdb谓词，指定了删除操作的表名和条件。AbsRdbPredicates的实现类有两个：RdbPredicates和RawRdbPredicates。
    • RdbPredicates：支持调用谓词提供的equalTo等接口，设置删除条件。
    • RawRdbPredicates：仅支持设置表名、where条件子句、whereArgs三个参数，不支持equalTo等接口调用。
| @@ -77,7 +68,7 @@ 调用更新接口，传入要更新的数据，并通过AbsRdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。 - 表6 数据表更新API + 表5 数据表更新API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | int Update(int &changedRows, const ValuesBucket &values, const AbsRdbPredicates &predicates) | 更新数据库表中符合谓词指定条件的数据。
  • changedRows：更新的记录条数。
  • values：以ValuesBucket存储的要更新的数据。
  • predicates：指定了更新操作的表名和条件。AbsRdbPredicates的实现类有两个：RdbPredicates和RawRdbPredicates。
    • RdbPredicates：支持调用谓词提供的equalTo等接口，设置更新条件。
    • RawRdbPredicates：仅支持设置表名、where条件子句、whereArgs三个参数，不支持equalTo等接口调用。
| @@ -89,7 +80,7 @@ - 直接调用查询接口。使用该接口，会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作，无需用户传入原生的SQL语句。 - 执行原生的SQL语句进行查询操作。 - 表7 数据表查询API + 表6 数据表查询API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | std::unique_ptr Query(const AbsRdbPredicates &predicates, const std::vector\ columns) | 查询数据。
  • predicates：谓词，可以设置查询条件。AbsRdbPredicates的实现类有两个：RdbPredicates和RawRdbPredicates。
    • RdbPredicates：支持调用谓词提供的equalTo等接口，设置查询条件。
    • RawRdbPredicates：仅支持设置表名、where条件子句、whereArgs三个参数，不支持equalTo等接口调用。
  • columns：规定查询返回的列。
| @@ -99,7 +90,7 @@ 关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。 -表8 结果集API +表7 结果集API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | ResultSet | int GoTo(int offset) | 从结果集当前位置移动指定偏移量。 | @@ -120,7 +111,7 @@ 用户可以对当前数据库中的列表设置为分布式列表。 -表9 设置分布式列表 +表8 设置分布式列表 | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | bool SetDistributedTables(const std::vector& tables) | 设置分布式列表。
  • tables：要设置的分布式列表表名
@@ -129,28 +120,28 @@ 用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。 -表10 根据本地表名获取指定远程设备的分布式表名 +表9 根据本地表名获取指定远程设备的分布式表名 | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | std::string ObtainDistributedTableName(const std::string& device, const std::string& table) | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。
  • device：远程设备ID
  • table：本地表名
### 在设备之间同步数据 -表11 在设备之间同步数据 +表10 在设备之间同步数据 | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | bool Sync(const SyncOption& option, const AbsRdbPredicates& predicate, const SyncCallback& callback) | 在设备之间同步数据。
  • option：同步选项；mode：同步模式(PUSH表示数据从本地设备推送到远程设备/PULL表示数据从远程设备拉至本地设备)；isBlock：是否阻塞
  • callback：指定的callback回调函数
### 注册数据库的观察者 -表12 注册数据库的观察者 +表11 注册数据库的观察者 | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | bool Subscribe(const SubscribeOption& option, RdbStoreObserver *observer) | 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
  • option：订阅类型；
  • observer：指分布式数据库中数据更改事件的观察者
### 从数据库中删除指定类型的指定观察者 -表13 从数据库中删除指定类型的指定观察者 +表12 从数据库中删除指定类型的指定观察者 | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | | RdbStore | bool UnSubscribe(const SubscribeOption& option, RdbStoreObserver *observer) | 从数据库中删除指定类型的指定观察者。
  • option：订阅类型；
  • observer：指已注册的数据更改观察者
@@ -163,7 +154,7 @@ 关系型数据库提供了备份数据库文件的接口，通过databasePath指定的备份文件名（支持路径）备份当前数据库文件。通过返回值判断是否备份成功，成功时返回0，失败时则返回相应的错误码。 - 表14 数据库备份API + 表13 数据库备份API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | @@ -173,7 +164,7 @@ 关系型数据库提供了恢复数据库文件的接口，通过backupPath指定的备份文件名（支持路径）恢复当前数据库文件。通过返回值判断是否恢复成功，成功时返回0，失败时则返回相应的错误码。 - 表15 数据库恢复API + 表14 数据库恢复API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | @@ -183,7 +174,7 @@ 事务（Transaction）是一个对数据库执行工作单元。通过返回值判断事务是否成功，成功时返回0，失败时则返回相应的错误码。 - 表16 事务API + 表15 事务API | 类名 | 接口名 | 描述 | | ---- | ---- | ---- | diff --git a/zh-cn/release-notes/OpenHarmony-v3.0.7-LTS.md b/zh-cn/release-notes/OpenHarmony-v3.0.7-LTS.md new file mode 100644 index 0000000000000000000000000000000000000000..e88c57ae3db39fb0e7f25eb69c4a73b7f8ff9950 --- /dev/null +++ b/zh-cn/release-notes/OpenHarmony-v3.0.7-LTS.md @@ -0,0 +1,126 @@ +# OpenHarmony 3.0.7 LTS + + +## 版本概述 + +此版本为OpenHarmony-3.0-LTS分支上的维护版本，基于OpenHarmony-v3.0.6-LTS版本修复一些安全问题。 + + +## 配套关系 + + **表1** 版本软件和工具配套关系 + +| 软件 | 版本 | 备注 | +| -------- | -------- | -------- | +| OpenHarmony | 3.0.7 LTS | NA | +| HUAWEI DevEco Studio（可选） | 3.0 Beta3 for OpenHarmony | OpenHarmony应用开发推荐使用。 | +| HUAWEI DevEco Device Tool（可选） | 3.0 Release | OpenHarmony智能设备集成开发环境推荐使用。 | + + +## 源码获取 + + +### 前提条件 + +1. 注册码云gitee账号。 + +2. 注册码云SSH公钥，请参考[码云帮助中心](https://gitee.com/help/articles/4191)。 + +3. 安装[git客户端](https://gitee.com/link?target=https%3A%2F%2Fgit-scm.com%2Fbook%2Fzh%2Fv2%2F%25E8%25B5%25B7%25E6%25AD%25A5-%25E5%25AE%2589%25E8%25A3%2585-Git)和[git-lfs](https://gitee.com/vcs-all-in-one/git-lfs?_from=gitee_search#downloading)并配置用户信息。 + + ``` + git config --global user.name "yourname" + git config --global user.email "your-email-address" + git config --global credential.helper store + ``` + +4. 安装码云repo工具，可以执行如下命令。 + + ``` + curl -s https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > /usr/local/bin/repo #如果没有权限，可下载至其他目录，并将其配置到环境变量中chmod a+x /usr/local/bin/repo + pip3 install -i https://repo.huaweicloud.com/repository/pypi/simple requests + ``` + + +### 通过repo获取 + +**方式一（推荐）**：通过repo + ssh 下载（需注册公钥，请参考[码云帮助中心](https://gitee.com/help/articles/4191)）。 + + +``` +repo init -u git@gitee.com:openharmony/manifest.git -b refs/tags/OpenHarmony-v3.0.7-LTS --no-repo-verify +repo sync -c +repo forall -c 'git lfs pull' +``` + +**方式二**：通过repo + https 下载。 + + +``` +repo init -u https://gitee.com/openharmony/manifest.git -b refs/tags/OpenHarmony-v3.0.7-LTS --no-repo-verify +repo sync -c +repo forall -c 'git lfs pull' +``` + + +### 从镜像站点获取 + + **表2** 获取源码路径 + +| **LTS版本源码** | **版本信息** | **下载站点** | **SHA256校验码** | +| -------- | -------- | -------- | -------- | +| 全量代码（标准、轻量和小型系统） | 3.0.7 | [站点](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/code-v3.0.7-LTS.tar.gz) | [SHA256校验码](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/code-v3.0.7-LTS.tar.gz.sha256) | +| 标准系统Hi3516解决方案（二进制） | 3.0.7 | [站点](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/standard.tar.gz) | [SHA256校验码](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/standard.tar.gz.sha256) | +| 轻量系统Hi3861解决方案（二进制） | 3.0.7 | [站点](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_pegasus.tar.gz) | [SHA256校验码](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_pegasus.tar.gz.sha256) | +| 小型系统Hi3516解决方案-LiteOS（二进制） | 3.0.7 | [站点](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_taurus.tar.gz) | [SHA256校验码](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_taurus.tar.gz.sha256) | +| 小型系统Hi3516解决方案-Linux（二进制） | 3.0.7 | [站点](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_taurus_linux.tar.gz) | [SHA256校验码](https://mirrors.huaweicloud.com/openharmony/os/3.0.7/hispark_taurus_linux.tar.gz.sha256) | + + +## 更新说明 + + +### 特性变更 + +此版本不涉及特性变更。 + + +### API变更 + +此版本不涉及API变更。 + + +### 芯片及开发板适配 + +芯片及开发板适配状态请参考[SIG-Devboard](https://gitee.com/openharmony/community/blob/master/sig/sig-devboard/sig_devboard_cn.md)信息。 + + +## 修复安全漏洞列表 + + **表3** 修复的安全漏洞列表 + +| issue编号 | 描述 | 合入链接 | +| -------- | -------- | -------- | +| I5VFI7 | 修复组件Kernel_linux_5.10上的CVE-2022-3303、CVE-2022-42703、CVE-2022-20422、CVE-2022-41222、CVE-2022-3239、CVE-2022-20423、CVE-2022-41850安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/508) | +| I5UHPU | 修复组件Kernel_linux_5.10上的CVE-2022-40768、CVE-2022-3577、CVE-2022-20409、CVE-2022-3566、CVE-2022-3606、CVE-2022-3564、CVE-2022-3649安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/506) | +| I5QBIA | 修复组件Kernel_linux_5.10上的CVE-2022-1184安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/475) | +| I5VFK1 | 修复组件Kernel_linux_5.10上的CVE-2022-20421、CVE-2022-42719、CVE-2022-42720、CVE-2022-42721、CVE-2022-42722、CVE-2022-41674、CVE-2022-3535、CVE-2022-3521、CVE-2022-3565、CVE-2022-3594、CVE-2022-3435、CVE-2022-41849、CVE-2022-3524、CVE-2022-3542、CVE-2022-3534安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/503) | +| I5OJL9 | 修复组件Kernel_linux_5.10上的CVE-2022-26373安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/495) | +| I5WC2X | 修复组件Kernel_linux_5.10上的CVE-2022-23816、CVE-2022-29901、CVE-2022-29900安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/494) | +| I5VQVK | 修复组件Kernel_linux_5.10上的CVE-2022-1462安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/490) | +| I5VP0D | 修复组件Kernel_linux_5.10上的CVE-2022-39189、CVE-2022-39190、CVE-2022-2663安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/489) | +| I5QBPW | 修复组件Kernel_linux_5.10上的CVE-2022-39188、CVE-2022-3078、CVE-2022-2905、CVE-2022-39842安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/481) | +| I5SCE3 | 修复组件Kernel_linux_5.10上的CVE-2022-3202、CVE-2022-40307安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/464) | +| I5QBK8 | 修复组件Kernel_linux_5.10上的CVE-2022-3028，CVE-2022-2977，CVE-2022-2964安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/442) | +| I5RQTK | 修复组件Kernel_linux_5.10上的CVE-2022-3061安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/444) | +| I5R8CM | 修复组件Kernel_linux_5.10上的CVE-2022-2959，CVE-2022-2991安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/436) | +| I5R8BB | 修复组件Kernel_linux_5.10上的CVE-2022-2503安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/435) | +| I5R6VI | 修复组件Kernel_linux_5.10上的CVE-2022-2938安全漏洞 | [PR](https://gitee.com/openharmony/kernel_linux_5.10/pulls/434) | +| I5ZA11 | 修复组件curl上的CVE-2022-32221、CVE-2022-42915、CVE-2022-42916安全漏洞 | [PR](https://gitee.com/openharmony/third_party_curl/pulls/90) | +| I5QBFJ | 修复组件curl上的CVE-2022-35252安全漏洞 | [PR](https://gitee.com/openharmony/third_party_curl/pulls/85) | +| I5UHWM | 修复组件wayland上的CVE-2021-3782安全漏洞 | [PR](https://gitee.com/openharmony/third_party_wayland_standard/pulls/22) | +| I5MVPK | 修复组件css-what上的CVE-2021-33587安全漏洞 | [PR](https://gitee.com/openharmony/third_party_css-what/pulls/9) | +| I5YR0H | 修复组件gstreamer上的CVE-2021-3185安全漏洞 | [PR](https://gitee.com/openharmony/third_party_gstreamer/pulls/207) | +| I5XT87 | 修复组件expat上的CVE-2022-43680安全漏洞 | [PR](https://gitee.com/openharmony/third_party_expat/pulls/22) | +| I5SD4W | 修复组件expat上的CVE-2022-40674安全漏洞 | [PR](https://gitee.com/openharmony/third_party_expat/pulls/19) | + + diff --git a/zh-cn/release-notes/OpenHarmony-v3.2-beta4.md b/zh-cn/release-notes/OpenHarmony-v3.2-beta4.md index b54aac847456dc1dc6200971278fa87899b4cddc..d3d1d025b065830f34932c6214b3d4490dad61fa 100644 --- a/zh-cn/release-notes/OpenHarmony-v3.2-beta4.md +++ b/zh-cn/release-notes/OpenHarmony-v3.2-beta4.md @@ -118,17 +118,17 @@ ArkTS API新增支持错误码的上报，帮助开发者快速捕捉异常， **表2** 获取源码路径 -| 版本源码 | **版本信息** | **下载站点** | **SHA256校验码** | -| --------------------------------------- | ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| 全量代码（标准、轻量和小型系统） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/code-v3.2-Beta4.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/code-v3.2-Beta4.tar.gz.sha256) | -| Hi3861轻量系统解决方案（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/hispark_pegasus.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/hispark_pegasus.tar.gz.sha256) | -| Hi3516轻量系统解决方案-LiteOS（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_LiteOS.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_LiteOS.tar.gz.sha256) | -| Hi3516轻量系统解决方案-Linux（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_Linux.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_Linux.tar.gz.sha256) | -| RK3568标准系统解决方案（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/dayu200_standard_arm32.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/dayu200_standard_arm32.tar.gz.sha256) | -| 标准系统Full SDK包（Mac） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-full.tar.gz.sha256) | -| 标准系统Full SDK包（Windows\Linux） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-full.tar.gz.sha256) | -| 标准系统Public SDK包（Mac） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-public.tar.gz.sha256) | -| 标准系统Public SDK包（Windows\Linux） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-public.tar.gz.sha256) | +| 版本源码 | **版本信息** | **下载站点** | **SHA256校验码** | **软件包容量** | +| --------------------------------------- | ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -------- | +| 全量代码（标准、轻量和小型系统） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/code-v3.2-Beta4.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/code-v3.2-Beta4.tar.gz.sha256) | 19.0 GB | +| Hi3861轻量系统解决方案（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/hispark_pegasus.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/hispark_pegasus.tar.gz.sha256) | 22.6 MB | +| Hi3516轻量系统解决方案-LiteOS（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_LiteOS.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_LiteOS.tar.gz.sha256) | 293.9 MB | +| Hi3516轻量系统解决方案-Linux（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_Linux.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta4/hispark_taurus_Linux.tar.gz.sha256) | 173.2 MB | +| RK3568标准系统解决方案（二进制） | 3.2 Beta4 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/dayu200_standard_arm32.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/dayu200_standard_arm32.tar.gz.sha256) | 3.2 GB | +| 标准系统Full SDK包（Mac） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-full.tar.gz.sha256) | 662.5 MB | +| 标准系统Full SDK包（Windows\Linux） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-full.tar.gz.sha256) | 1.5 GB | +| 标准系统Public SDK包（Mac） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-mac-public.tar.gz.sha256) | 622.2 MB | +| 标准系统Public SDK包（Windows\Linux） | 3.2.9.2 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta4/ohos-sdk-windows_linux-public.tar.gz.sha256) | 1.5 GB | ### 前提条件 diff --git a/zh-cn/release-notes/Readme.md b/zh-cn/release-notes/Readme.md index f17941a51e6a3aeda9802db1bea4f937433a054b..a49143e89ea9989738df2683bd7c51debe9d0f71 100644 --- a/zh-cn/release-notes/Readme.md +++ b/zh-cn/release-notes/Readme.md @@ -11,6 +11,7 @@ - [OpenHarmony v3.1.1 Release (2022-05-31)](OpenHarmony-v3.1.1-release.md) - [OpenHarmony v3.1 Beta (2021-12-31)](OpenHarmony-v3.1-beta.md) - [OpenHarmony v3.0 LTS (2021-09-30)](OpenHarmony-v3.0-LTS.md) +- [OpenHarmony v3.0.7 LTS (2022-12-05)](OpenHarmony-v3.0.7-LTS.md) - [OpenHarmony v3.0.6 LTS (2022-09-15)](OpenHarmony-v3.0.6-LTS.md) - [OpenHarmony v3.0.5 LTS (2022-07-01)](OpenHarmony-v3.0.5-LTS.md) - [OpenHarmony v3.0.3 LTS (2022-04-08)](OpenHarmony-v3.0.3-LTS.md)