Ease of use issue, 401 error message rectification

Signed-off-by: wang-jingwu001 <wangjingwu4@huawei.com>
https://gitee.com/openharmony/interface_sdk-js/issues/I9J4Q6
This commit is contained in:
wang-jingwu001 2024-04-24 09:32:10 +08:00
parent 66937f6c6b
commit 5fe91741f5
24 changed files with 1816 additions and 613 deletions

725
api/@ohos.buffer.d.ts vendored

File diff suppressed because it is too large Load Diff

View File

@ -531,7 +531,9 @@ declare namespace xml {
* @param { string } xml - xml xml The xml text to be converted.
* @param { ConvertOptions } [options] - options option Option Inputted by user to set.
* @returns { Object } Returns a JavaScript object converting from XML text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200002 - Invalid xml string.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -542,7 +544,9 @@ declare namespace xml {
* @param { string } xml - xml xml The xml text to be converted.
* @param { ConvertOptions } [options] - options option Option Inputted by user to set.
* @returns { Object } Returns a JavaScript object converting from XML text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200002 - Invalid xml string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -554,7 +558,9 @@ declare namespace xml {
* @param { string } xml - xml xml The xml text to be converted.
* @param { ConvertOptions } [options] - options option Option Inputted by user to set.
* @returns { Object } Returns a JavaScript object converting from XML text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200002 - Invalid xml string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform

View File

@ -184,7 +184,9 @@ declare namespace process {
*
* @param { number } v - An id.
* @returns { boolean } Return a boolean whether the specified uid belongs to a particular application.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -193,7 +195,9 @@ declare namespace process {
*
* @param { number } v - An id.
* @returns { boolean } Return a boolean whether the specified uid belongs to a particular application.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -203,7 +207,9 @@ declare namespace process {
*
* @param { number } v - An id.
* @returns { boolean } Return a boolean whether the specified uid belongs to a particular application.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -216,7 +222,9 @@ declare namespace process {
*
* @param { string } v - Process name.
* @returns { number } Return the uid based on the specified user name.
* @throws { BusinessError } 401 - The type of v must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -225,7 +233,9 @@ declare namespace process {
*
* @param { string } v - Process name.
* @returns { number } Return the uid based on the specified user name.
* @throws { BusinessError } 401 - The type of v must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -235,7 +245,9 @@ declare namespace process {
*
* @param { string } v - Process name.
* @returns { number } Return the uid based on the specified user name.
* @throws { BusinessError } 401 - The type of v must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -248,7 +260,9 @@ declare namespace process {
*
* @param { number } v - The tid of the process.
* @returns { number } Return the thread priority based on the specified tid.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -257,7 +271,9 @@ declare namespace process {
*
* @param { number } v - The tid of the process.
* @returns { number } Return the thread priority based on the specified tid.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -267,7 +283,9 @@ declare namespace process {
*
* @param { number } v - The tid of the process.
* @returns { number } Return the thread priority based on the specified tid.
* @throws { BusinessError } 401 - The type of v must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -280,7 +298,9 @@ declare namespace process {
*
* @param { number } name - Parameters defined by the system configuration.
* @returns { number } Return the system configuration at runtime.
* @throws { BusinessError } 401 - The type of name must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -289,7 +309,9 @@ declare namespace process {
*
* @param { number } name - Parameters defined by the system configuration.
* @returns { number } Return the system configuration at runtime.
* @throws { BusinessError } 401 - The type of name must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -299,7 +321,9 @@ declare namespace process {
*
* @param { number } name - Parameters defined by the system configuration.
* @returns { number } Return the system configuration at runtime.
* @throws { BusinessError } 401 - The type of name must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -312,7 +336,9 @@ declare namespace process {
*
* @param { string } name - Parameters defined by the system environment variables.
* @returns { string } Return the system value for environment variables.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -321,7 +347,9 @@ declare namespace process {
*
* @param { string } name - Parameters defined by the system environment variables.
* @returns { string } Return the system value for environment variables.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -331,7 +359,9 @@ declare namespace process {
*
* @param { string } name - Parameters defined by the system environment variables.
* @returns { string } Return the system value for environment variables.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -343,7 +373,9 @@ declare namespace process {
* Process exit
*
* @param { number } code - Process exit code.
* @throws { BusinessError } 401 - The type of code must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -351,7 +383,9 @@ declare namespace process {
* Process exit
*
* @param { number } code - Process exit code.
* @throws { BusinessError } 401 - The type of code must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -360,7 +394,9 @@ declare namespace process {
* Process exit
*
* @param { number } code - Process exit code.
* @throws { BusinessError } 401 - The type of code must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -374,7 +410,9 @@ declare namespace process {
* @param { number } signal - Signal sent.
* @param { number } pid - Send signal to target pid.
* @returns { boolean } Return the result of the signal.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -384,7 +422,9 @@ declare namespace process {
* @param { number } signal - Signal sent.
* @param { number } pid - Send signal to target pid.
* @returns { boolean } Return the result of the signal.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -395,7 +435,9 @@ declare namespace process {
* @param { number } signal - Signal sent.
* @param { number } pid - Send signal to target pid.
* @returns { boolean } Return the result of the signal.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice

View File

@ -252,7 +252,7 @@ declare namespace taskpool {
* Set transfer list for this task.
*
* @param { ArrayBuffer[] } [transfer] - transfer Transfer list of this task, empty array is default.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -261,7 +261,7 @@ declare namespace taskpool {
* Set transfer list for this task.
*
* @param { ArrayBuffer[] } [transfer] - transfer Transfer list of this task, empty array is default.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200029 - Can not set an arraybuffer to both transferList and cloneList.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -275,7 +275,10 @@ declare namespace taskpool {
*
* @param { Object[] | ArrayBuffer[] } cloneList - Sendable objects or arrayBuffer objects in this list
* will be transmitted to worker thread in a copy way.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200029 - Can not set an arraybuffer to both transferList and cloneList.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -288,7 +291,7 @@ declare namespace taskpool {
* Register a callback for this task to receive and handle data from the taskpool worker thread.
*
* @param { Function } [callback] - Callback to be registered and executed later on the host side.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -300,7 +303,10 @@ declare namespace taskpool {
* Add dependencies on the task array for this task.
*
* @param { Task[] } tasks - tasks tasks An array of dependent tasks.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200026 - There is a circular dependency.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -313,7 +319,10 @@ declare namespace taskpool {
* Remove dependencies on the task array for this task.
*
* @param { Task[] } tasks - tasks tasks An array of dependent tasks.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200027 - The dependency does not exist.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -454,7 +463,10 @@ declare namespace taskpool {
* Create a TaskGroup instance.
*
* @param { string } name - name name The name of taskGroup.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -467,7 +479,10 @@ declare namespace taskpool {
*
* @param { Function } func - func func Concurrent function to add in task group.
* @param { unknown[] } args - args args The concurrent function arguments.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -478,7 +493,10 @@ declare namespace taskpool {
*
* @param { Function } func - func func Concurrent function to add in task group.
* @param { Object[] } args - args args The concurrent function arguments.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -491,7 +509,10 @@ declare namespace taskpool {
* Add a Task into TaskGroup.
*
* @param { Task } task - task task The task want to add in task group.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -501,7 +522,10 @@ declare namespace taskpool {
* Add a Task into TaskGroup.
*
* @param { Task } task - task task The task want to add in task group.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -534,7 +558,9 @@ declare namespace taskpool {
* Create a SequenceRunner instance.
*
* @param { Priority } priority - Task execution priority, MEDIUM is default.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -547,7 +573,9 @@ declare namespace taskpool {
*
* @param { Task } task - The task want to execute.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200025 - Add dependent task to SequenceRunner.
@ -867,7 +895,10 @@ declare namespace taskpool {
* @param { Function } func - func func Concurrent function want to execute.
* @param { unknown[] } args - args args The concurrent function arguments.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -880,7 +911,10 @@ declare namespace taskpool {
* @param { Function } func - func func Concurrent function want to execute.
* @param { unknown[] } args - args args The concurrent function arguments.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -894,7 +928,10 @@ declare namespace taskpool {
* @param { Function } func - func func Concurrent function want to execute.
* @param { Object[] } args - args args The concurrent function arguments.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -911,7 +948,10 @@ declare namespace taskpool {
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -924,7 +964,10 @@ declare namespace taskpool {
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<unknown> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -938,7 +981,10 @@ declare namespace taskpool {
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not mark as concurrent.
@ -955,7 +1001,10 @@ declare namespace taskpool {
* @param { TaskGroup } group - group group The task group want to execute.
* @param { Priority } [priority] - priority priority Task group priority, MEDIUM is default.
* @returns { Promise<unknown[]> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -967,7 +1016,10 @@ declare namespace taskpool {
* @param { TaskGroup } group - group group The task group want to execute.
* @param { Priority } [priority] - priority priority Task group priority, MEDIUM is default.
* @returns { Promise<Object[]> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -983,7 +1035,10 @@ declare namespace taskpool {
* @param { Task } task - task task The task want to execute.
* @param { Priority } [priority] - priority priority Task priority, MEDIUM is default.
* @returns { Promise<Object> }
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -996,7 +1051,10 @@ declare namespace taskpool {
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task does not exist when it is canceled.
* @throws { BusinessError } 10200016 - The task is executing when it is canceled.
* @syscap SystemCapability.Utils.Lang
@ -1006,7 +1064,10 @@ declare namespace taskpool {
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task does not exist when it is canceled.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1016,7 +1077,10 @@ declare namespace taskpool {
* Cancel a concurrent task.
*
* @param { Task } task - task task The task want to cancel.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200015 - The task does not exist when it is canceled.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1029,7 +1093,10 @@ declare namespace taskpool {
* Cancel a concurrent task group.
*
* @param { TaskGroup } group - group group The task group want to cancel.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200018 - The task group does not exist when it is canceled.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1039,7 +1106,10 @@ declare namespace taskpool {
* Cancel a concurrent task group.
*
* @param { TaskGroup } group - group group The task group want to cancel.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200018 - The task group does not exist when it is canceled.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1071,7 +1141,10 @@ declare namespace taskpool {
* Terminate a long task.
*
* @param { LongTask } longTask - The long task want to terminate.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -1084,7 +1157,10 @@ declare namespace taskpool {
*
* @param { Function } func - The function name to check.
* @returns { boolean } Returns {@code true} if it is a concurrent function; returns {@code false} otherwise.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice

27
api/@ohos.uri.d.ts vendored
View File

@ -73,7 +73,10 @@ declare namespace uri {
* uri: Constructs a URI by parsing a given string.
*
* @param { string } uri - uri uri
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -83,7 +86,10 @@ declare namespace uri {
* uri: Constructs a URI by parsing a given string.
*
* @param { string } uri - uri uri
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -94,7 +100,10 @@ declare namespace uri {
* uri: Constructs a URI by parsing a given string.
*
* @param { string } uri - uri uri
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -146,7 +155,9 @@ declare namespace uri {
*
* @param { URI } other - other other URI object to be compared
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - The type of other must be URI.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -155,7 +166,9 @@ declare namespace uri {
*
* @param { URI } other - other other URI object to be compared
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - The type of other must be URI.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -165,7 +178,9 @@ declare namespace uri {
*
* @param { URI } other - other other URI object to be compared
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - The type of other must be URI.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice

126
api/@ohos.url.d.ts vendored
View File

@ -257,8 +257,7 @@ declare namespace url {
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - The type of init must be string two-dimensional array or object list
* or string or URLParams object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -271,8 +270,7 @@ declare namespace url {
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - The type of init must be string two-dimensional array or object list
* or string or URLParams object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -286,8 +284,7 @@ declare namespace url {
* The input parameter is the URLParams object.
*
* @param { string[][] | Record<string, string> | string | URLParams } [init] - init init
* @throws { BusinessError } 401 - The type of init must be string two-dimensional array or object list
* or string or URLParams object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -300,7 +297,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -309,7 +309,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -319,7 +322,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the search parameter to be inserted.
* @param { string } value - value value Values of search parameters to be inserted.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -331,7 +337,10 @@ declare namespace url {
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -339,7 +348,10 @@ declare namespace url {
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -348,7 +360,10 @@ declare namespace url {
* Deletes the given search parameter and its associated value,from the list of all search parameters.
*
* @param { string } name - name name Name of the key-value pair to be deleted.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -361,7 +376,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -370,7 +388,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -380,7 +401,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key value.
* @returns { string[] } string[] Returns all key-value pairs with the specified name.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -423,7 +447,10 @@ declare namespace url {
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -433,7 +460,10 @@ declare namespace url {
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -444,7 +474,10 @@ declare namespace url {
* @param { function } callbackFn - callbackFn value Current traversal key value,
* key Indicates the name of the key that is traversed.
* @param { Object } [thisArg] - thisArg thisArg to be used as this value for when callbackFn is called
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -457,7 +490,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -466,7 +502,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -476,7 +515,10 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { string | null } Returns the first value found by name. If no value is found, null is returned.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -489,7 +531,9 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -498,7 +542,9 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -508,7 +554,9 @@ declare namespace url {
*
* @param { string } name - name name Specifies the name of a key-value pair.
* @returns { boolean } Returns a Boolean value that indicates whether a found
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -524,7 +572,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -536,7 +587,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -549,7 +603,10 @@ declare namespace url {
*
* @param { string } name - name name Key name of the parameter to be set.
* @param { string } value - value value Indicates the parameter value to be set.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -761,7 +818,10 @@ declare namespace url {
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -773,7 +833,10 @@ declare namespace url {
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -786,7 +849,10 @@ declare namespace url {
* If input is an absolute value, base ignores the value.
* @param { string | URL } [base] - base base Base URL to parse if input is not absolute.
* @returns { URL }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid url string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform

View File

@ -93,7 +93,10 @@ declare class ArrayList<T> {
* @param { number } index - index index at which the specified element is to be inserted
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -106,7 +109,10 @@ declare class ArrayList<T> {
* @param { number } index - index index at which the specified element is to be inserted
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -162,7 +168,10 @@ declare class ArrayList<T> {
* @returns { T } the T type ,returns undefined if arraylist is empty,If the index is
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -174,7 +183,10 @@ declare class ArrayList<T> {
* @returns { T } the T type ,returns undefined if arraylist is empty,If the index is
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -233,7 +245,10 @@ declare class ArrayList<T> {
* @param { number } toIndex - toIndex toIndex the end of the index, excluding the value at that index
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 10200011 - The removeByRange method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -244,7 +259,10 @@ declare class ArrayList<T> {
* @param { number } toIndex - toIndex toIndex the end of the index, excluding the value at that index
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 10200011 - The removeByRange method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -260,7 +278,9 @@ declare class ArrayList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -274,7 +294,9 @@ declare class ArrayList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -290,7 +312,9 @@ declare class ArrayList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -304,7 +328,9 @@ declare class ArrayList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -320,7 +346,9 @@ declare class ArrayList<T> {
* sorted in ascending order;If it returns secondValue minus firstValue, it returns an arraylist sorted in descending order;
* If this parameter is empty, it will default to ASCII sorting
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -334,7 +362,9 @@ declare class ArrayList<T> {
* sorted in ascending order;If it returns secondValue minus firstValue, it returns an arraylist sorted in descending order;
* If this parameter is empty, it will default to ASCII sorting
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -348,7 +378,10 @@ declare class ArrayList<T> {
* @returns { ArrayList<T> }
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 10200011 - The subArrayList method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -360,7 +393,10 @@ declare class ArrayList<T> {
* @returns { ArrayList<T> }
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 10200011 - The subArrayList method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -462,7 +498,9 @@ declare class ArrayList<T> {
*
* @param { number } newCapacity - newCapacity newCapacity
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -472,7 +510,9 @@ declare class ArrayList<T> {
*
* @param { number } newCapacity - newCapacity newCapacity
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -203,7 +203,9 @@ declare class Deque<T> {
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -217,7 +219,9 @@ declare class Deque<T> {
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform

View File

@ -147,7 +147,9 @@ declare class HashMap<K, V> {
*
* @param { HashMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -156,7 +158,9 @@ declare class HashMap<K, V> {
*
* @param { HashMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -169,7 +173,8 @@ declare class HashMap<K, V> {
* @param { V } value - value value Added or updated value
* @returns { Object } the map object after set
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -180,7 +185,8 @@ declare class HashMap<K, V> {
* @param { V } value - value value Added or updated value
* @returns { Object } the map object after set
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -291,7 +297,9 @@ declare class HashMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -306,7 +314,9 @@ declare class HashMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -86,7 +86,10 @@ declare class HashSet<T> {
* @param { T } value - value value need to determine whether to include the element
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -96,7 +99,10 @@ declare class HashSet<T> {
* @param { T } value - value value need to determine whether to include the element
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -108,7 +114,10 @@ declare class HashSet<T> {
* @param { T } value - value value Added element
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -118,7 +127,10 @@ declare class HashSet<T> {
* @param { T } value - value value Added element
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -130,7 +142,10 @@ declare class HashSet<T> {
* @param { T } value - value value Target to be deleted
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -140,7 +155,10 @@ declare class HashSet<T> {
* @param { T } value - value value Target to be deleted
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -172,7 +190,9 @@ declare class HashSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -186,7 +206,9 @@ declare class HashSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -67,7 +67,9 @@ declare class LightWeightMap<K, V> {
*
* @param { LightWeightMap<K, V> } map - map map the Map object to compare
* @returns { boolean } the boolean type
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The hasAll method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -77,7 +79,9 @@ declare class LightWeightMap<K, V> {
*
* @param { LightWeightMap<K, V> } map - map map the Map object to compare
* @returns { boolean } the boolean type
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The hasAll method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -130,7 +134,9 @@ declare class LightWeightMap<K, V> {
*
* @param { number } minimumCapacity - minimumCapacity minimumCapacity Minimum capacity to be reserved
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -140,7 +146,9 @@ declare class LightWeightMap<K, V> {
*
* @param { number } minimumCapacity - minimumCapacity minimumCapacity Minimum capacity to be reserved
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -249,7 +257,10 @@ declare class LightWeightMap<K, V> {
* @returns { K } the key of key-value pairs
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -260,7 +271,10 @@ declare class LightWeightMap<K, V> {
* @returns { K } the key of key-value pairs
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -289,7 +303,9 @@ declare class LightWeightMap<K, V> {
*
* @param { LightWeightMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -298,7 +314,9 @@ declare class LightWeightMap<K, V> {
*
* @param { LightWeightMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -352,7 +370,9 @@ declare class LightWeightMap<K, V> {
* @param { number } index - index index Target subscript for search
* @returns { boolean } the boolean type(Is there a delete value)
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -362,7 +382,9 @@ declare class LightWeightMap<K, V> {
* @param { number } index - index index Target subscript for search
* @returns { boolean } the boolean type(Is there a delete value)
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -394,7 +416,10 @@ declare class LightWeightMap<K, V> {
* @returns { boolean } the boolean type(Is there a value corresponding to the subscript)
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -406,7 +431,10 @@ declare class LightWeightMap<K, V> {
* @returns { boolean } the boolean type(Is there a value corresponding to the subscript)
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -423,7 +451,9 @@ declare class LightWeightMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -438,7 +468,9 @@ declare class LightWeightMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -487,7 +519,10 @@ declare class LightWeightMap<K, V> {
* @returns { V } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -498,7 +533,10 @@ declare class LightWeightMap<K, V> {
* @returns { V } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -88,7 +88,9 @@ declare class LightWeightSet<T> {
* @param { LightWeightSet<T> } set - set set the Set object to provide the added element
* @returns { boolean } the boolean type(Is there any new data added successfully)
* @throws { BusinessError } 10200011 - The addAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -98,7 +100,9 @@ declare class LightWeightSet<T> {
* @param { LightWeightSet<T> } set - set set the Set object to provide the added element
* @returns { boolean } the boolean type(Is there any new data added successfully)
* @throws { BusinessError } 10200011 - The addAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -110,7 +114,9 @@ declare class LightWeightSet<T> {
* @param { LightWeightSet<T> } set - set set the Set object to compare
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The hasAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -120,7 +126,9 @@ declare class LightWeightSet<T> {
* @param { LightWeightSet<T> } set - set set the Set object to compare
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The hasAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -172,7 +180,10 @@ declare class LightWeightSet<T> {
*
* @param { number } minimumCapacity Minimum capacity to be reserved
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of minimumCapacity is out of range.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -183,7 +194,10 @@ declare class LightWeightSet<T> {
*
* @param { number } minimumCapacity Minimum capacity to be reserved
* @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of minimumCapacity is out of range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -236,7 +250,9 @@ declare class LightWeightSet<T> {
* @param { number } index - index index Target subscript for search
* @returns { boolean } the boolean type(Is there a delete value)
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -246,7 +262,9 @@ declare class LightWeightSet<T> {
* @param { number } index - index index Target subscript for search
* @returns { boolean } the boolean type(Is there a delete value)
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -281,7 +299,9 @@ declare class LightWeightSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -296,7 +316,9 @@ declare class LightWeightSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -360,7 +382,9 @@ declare class LightWeightSet<T> {
* @param { number } index - index index Target subscript for search
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -370,7 +394,9 @@ declare class LightWeightSet<T> {
* @param { number } index - index index Target subscript for search
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -92,7 +92,10 @@ declare class LinkedList<T> {
* @param { number } index - index index index at which the specified element is to be inserted
* @param { T } element - element element element to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -103,7 +106,10 @@ declare class LinkedList<T> {
* @param { number } index - index index index at which the specified element is to be inserted
* @param { T } element - element element element to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -117,7 +123,9 @@ declare class LinkedList<T> {
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -128,7 +136,9 @@ declare class LinkedList<T> {
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -241,7 +251,10 @@ declare class LinkedList<T> {
* @returns { T } the T type ,returns undefined if linkedlist is empty,If the index is
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -253,7 +266,10 @@ declare class LinkedList<T> {
* @returns { T } the T type ,returns undefined if linkedlist is empty,If the index is
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -410,7 +426,10 @@ declare class LinkedList<T> {
* @returns { T } the T type ,returns undefined if linkedList is empty
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -422,7 +441,10 @@ declare class LinkedList<T> {
* @returns { T } the T type ,returns undefined if linkedList is empty
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -441,7 +463,9 @@ declare class LinkedList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -458,7 +482,9 @@ declare class LinkedList<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -91,7 +91,10 @@ declare class List<T> {
* @param { number } index - index index index at which the specified element is to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -102,7 +105,10 @@ declare class List<T> {
* @param { number } index - index index index at which the specified element is to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -115,7 +121,9 @@ declare class List<T> {
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -126,7 +134,9 @@ declare class List<T> {
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -182,7 +192,9 @@ declare class List<T> {
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -194,7 +206,9 @@ declare class List<T> {
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -294,7 +308,9 @@ declare class List<T> {
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -306,7 +322,9 @@ declare class List<T> {
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -344,7 +362,9 @@ declare class List<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -358,7 +378,9 @@ declare class List<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -372,7 +394,9 @@ declare class List<T> {
* Specifies the sort order. Must be a function,return number type,If it returns firstValue
* minus secondValue, it returns an list sorted in ascending order;If it returns secondValue
* minus firstValue, it returns an list sorted in descending order;
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -385,7 +409,9 @@ declare class List<T> {
* Specifies the sort order. Must be a function,return number type,If it returns firstValue
* minus secondValue, it returns an list sorted in ascending order;If it returns secondValue
* minus firstValue, it returns an list sorted in descending order;
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -418,7 +444,9 @@ declare class List<T> {
* @returns { List<T> }
* @throws { BusinessError } 10200011 - The getSubList method cannot be bound.
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -430,7 +458,9 @@ declare class List<T> {
* @returns { List<T> }
* @throws { BusinessError } 10200011 - The getSubList method cannot be bound.
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -446,7 +476,9 @@ declare class List<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -460,7 +492,9 @@ declare class List<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -70,7 +70,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Added the key of key-value
* @param { T } value - value value Added the value of key-value
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -80,7 +82,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Added the key of key-value
* @param { T } value - value value Added the value of key-value
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -126,7 +130,9 @@ declare class PlainArray<T> {
* @param { number } key - key key need to determine whether to include the key
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -136,7 +142,9 @@ declare class PlainArray<T> {
* @param { number } key - key key need to determine whether to include the key
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -148,7 +156,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Looking for goals
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -158,7 +168,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Looking for goals
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -170,7 +182,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Looking for goals
* @returns { number } Subscript corresponding to target
* @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -180,7 +194,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Looking for goals
* @returns { number } Subscript corresponding to target
* @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -230,7 +246,9 @@ declare class PlainArray<T> {
* @param { number } index - index index Target subscript for search
* @returns { number } the key of key-value pairs
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -240,7 +258,9 @@ declare class PlainArray<T> {
* @param { number } index - index index Target subscript for search
* @returns { number } the key of key-value pairs
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -252,7 +272,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Target to be deleted
* @returns { T } Target mapped value
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -262,7 +284,9 @@ declare class PlainArray<T> {
* @param { number } key - key key Target to be deleted
* @returns { T } Target mapped value
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -274,7 +298,9 @@ declare class PlainArray<T> {
* @param { number } index - index index Target subscript for search
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -284,7 +310,9 @@ declare class PlainArray<T> {
* @param { number } index - index index Target subscript for search
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -298,7 +326,9 @@ declare class PlainArray<T> {
* @returns { number } Actual deleted quantity
* @throws { BusinessError } 10200011 - The removeRangeFrom method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -310,7 +340,9 @@ declare class PlainArray<T> {
* @returns { number } Actual deleted quantity
* @throws { BusinessError } 10200011 - The removeRangeFrom method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -323,7 +355,9 @@ declare class PlainArray<T> {
* @param { T } value - value value Updated the target mapped value
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -334,7 +368,9 @@ declare class PlainArray<T> {
* @param { T } value - value value Updated the target mapped value
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -365,7 +401,9 @@ declare class PlainArray<T> {
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -376,7 +414,9 @@ declare class PlainArray<T> {
* @returns { T } the value of key-value pairs
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -392,7 +432,9 @@ declare class PlainArray<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -406,7 +448,9 @@ declare class PlainArray<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -134,7 +134,9 @@ declare class Queue<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -148,7 +150,9 @@ declare class Queue<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -172,7 +172,9 @@ declare class Stack<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -186,7 +188,9 @@ declare class Stack<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -44,7 +44,9 @@ declare class TreeMap<K, V> {
* firstValue (required) previous element.
* secondValue (required) next element.
* @throws { BusinessError } 10200012 - The TreeMap's constructor cannot be directly invoked.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -56,7 +58,9 @@ declare class TreeMap<K, V> {
* firstValue (required) previous element.
* secondValue (required) next element.
* @throws { BusinessError } 10200012 - The TreeMap's constructor cannot be directly invoked.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -199,7 +203,9 @@ declare class TreeMap<K, V> {
*
* @param { TreeMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -208,7 +214,9 @@ declare class TreeMap<K, V> {
*
* @param { TreeMap<K, V> } map - map map the Map object to add members
* @throws { BusinessError } 10200011 - The setAll method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -221,7 +229,10 @@ declare class TreeMap<K, V> {
* @param { V } value - value value Added or updated value
* @returns { Object } the map object after set
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -232,7 +243,10 @@ declare class TreeMap<K, V> {
* @param { V } value - value value Added or updated value
* @returns { Object } the map object after set
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -387,7 +401,9 @@ declare class TreeMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -402,7 +418,9 @@ declare class TreeMap<K, V> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

View File

@ -42,7 +42,9 @@ declare class TreeSet<T> {
* firstValue (required) previous element.
* secondValue (required) next element.
* @throws { BusinessError } 10200012 - The TreeSet's constructor cannot be directly invoked.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -54,7 +56,9 @@ declare class TreeSet<T> {
* firstValue (required) previous element.
* secondValue (required) next element.
* @throws { BusinessError } 10200012 - The TreeSet's constructor cannot be directly invoked.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Incorrect parameter types;
* 2.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -117,7 +121,10 @@ declare class TreeSet<T> {
*
* @param { T } value - value value Added element
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
@ -127,7 +134,10 @@ declare class TreeSet<T> {
*
* @param { T } value - value value Added element
* @returns { boolean } the boolean type(Is there contain this element)
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -213,7 +223,10 @@ declare class TreeSet<T> {
* @param { T } key - key key Objective of comparison
* @returns { T } key or undefined
* @throws { BusinessError } 10200011 - The getLowerValue method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -224,7 +237,10 @@ declare class TreeSet<T> {
* @param { T } key - key key Objective of comparison
* @returns { T } key or undefined
* @throws { BusinessError } 10200011 - The getLowerValue method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -237,7 +253,10 @@ declare class TreeSet<T> {
* @param { T } key - key key Objective of comparison
* @returns { T } key or undefined
* @throws { BusinessError } 10200011 - The getHigherValue method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -248,7 +267,10 @@ declare class TreeSet<T> {
* @param { T } key - key key Objective of comparison
* @returns { T } key or undefined
* @throws { BusinessError } 10200011 - The getHigherValue method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -300,7 +322,9 @@ declare class TreeSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -314,7 +338,9 @@ declare class TreeSet<T> {
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - The type of parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10

344
api/@ohos.util.d.ts vendored
View File

@ -95,7 +95,9 @@ declare namespace util {
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } Return the character string formatted in a specific format
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -120,7 +122,9 @@ declare namespace util {
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } a string formatted in a specific format.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -144,7 +148,9 @@ declare namespace util {
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @throws { BusinessError } 401 - The type of errno must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -153,7 +159,9 @@ declare namespace util {
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @throws { BusinessError } 401 - The type of errno must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -166,7 +174,9 @@ declare namespace util {
*
* @param { Function } original - Asynchronous function
* @returns { function } Return a Asynchronous function
* @throws { BusinessError } 401 - The type of original must be Function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
@ -176,7 +186,9 @@ declare namespace util {
*
* @param { Function } original - Asynchronous function
* @returns { function } Return a Asynchronous function
* @throws { BusinessError } 401 - The type of original must be Function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -189,7 +201,9 @@ declare namespace util {
*
* @param { function } original - Asynchronous function
* @returns { function } Return a function that returns promises
* @throws { BusinessError } 401 - The type of original must be Function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -199,7 +213,9 @@ declare namespace util {
*
* @param { function } original - Asynchronous function
* @returns { Function } Return a function that returns promises
* @throws { BusinessError } 401 - The type of original must be Function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -224,7 +240,7 @@ declare namespace util {
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { string } Return a string representing this UUID.
* @throws { BusinessError } 401 - The type of entropyCache must be boolean.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -233,7 +249,7 @@ declare namespace util {
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { string } Return a string representing this UUID.
* @throws { BusinessError } 401 - The type of entropyCache must be boolean.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -245,7 +261,7 @@ declare namespace util {
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { Uint8Array } Return a Uint8Array representing this UUID.
* @throws { BusinessError } 401 - The type of entropyCache must be boolean.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -254,7 +270,7 @@ declare namespace util {
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { Uint8Array } Return a Uint8Array representing this UUID.
* @throws { BusinessError } 401 - The type of entropyCache must be boolean.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -266,7 +282,7 @@ declare namespace util {
*
* @param { string } uuid - String that specifies a UUID
* @returns { Uint8Array } Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails.
* @throws { BusinessError } 401 - The type of uuid must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -275,7 +291,7 @@ declare namespace util {
*
* @param { string } uuid - String that specifies a UUID
* @returns { Uint8Array } Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails.
* @throws { BusinessError } 401 - The type of uuid must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -437,7 +453,7 @@ declare namespace util {
* @param { string } encoding - Decoding format
* @param { object } options - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -447,7 +463,7 @@ declare namespace util {
* @param { string } encoding - Decoding format
* @param { object } options - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -458,7 +474,7 @@ declare namespace util {
* @param { string } [encoding] - Decoding format
* @param { TextDecoderOptions } [options] - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -487,7 +503,9 @@ declare namespace util {
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { object } options - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -499,7 +517,9 @@ declare namespace util {
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { object } options - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -512,7 +532,9 @@ declare namespace util {
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { DecodeWithStreamOptions } [options] - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -618,7 +640,7 @@ declare namespace util {
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - The type of encoding must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -626,7 +648,7 @@ declare namespace util {
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - The type of encoding must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -635,7 +657,7 @@ declare namespace util {
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - The type of encoding must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -648,7 +670,7 @@ declare namespace util {
*
* @param { string } [encoding] - The string for encoding format.
* @returns { TextEncoder }
* @throws { BusinessError } 401 - The type of encoding must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -673,7 +695,7 @@ declare namespace util {
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - The type of input must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -682,7 +704,7 @@ declare namespace util {
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - The type of input must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -692,7 +714,7 @@ declare namespace util {
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - The type of input must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -723,7 +745,9 @@ declare namespace util {
* @returns { object } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -735,7 +759,9 @@ declare namespace util {
* @returns { object } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -748,7 +774,9 @@ declare namespace util {
* @returns { EncodeIntoUint8ArrayInfo } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -804,7 +832,9 @@ declare namespace util {
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @returns { RationalNumber }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -814,7 +844,9 @@ declare namespace util {
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @returns { RationalNumber }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -859,7 +891,9 @@ declare namespace util {
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @throws { BusinessError } 401 - The type of another must be RationalNumber.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -868,7 +902,9 @@ declare namespace util {
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @throws { BusinessError } 401 - The type of another must be RationalNumber.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -930,7 +966,9 @@ declare namespace util {
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common factor of two integers, integer type.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -940,7 +978,9 @@ declare namespace util {
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common factor of two integers, integer type.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1345,7 +1385,7 @@ declare namespace util {
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @throws { BusinessError } 401 - The type of newCapacity must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1353,7 +1393,7 @@ declare namespace util {
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @throws { BusinessError } 401 - The type of newCapacity must be number.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1531,7 +1571,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1540,7 +1582,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1553,7 +1597,9 @@ declare namespace util {
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1563,7 +1609,9 @@ declare namespace util {
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1611,7 +1659,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1620,7 +1670,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1636,7 +1688,9 @@ declare namespace util {
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1649,7 +1703,9 @@ declare namespace util {
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1661,7 +1717,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1670,7 +1728,9 @@ declare namespace util {
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1682,7 +1742,9 @@ declare namespace util {
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1691,7 +1753,9 @@ declare namespace util {
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @throws { BusinessError } 401 - The type of key must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1956,7 +2020,9 @@ declare namespace util {
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -1965,7 +2031,9 @@ declare namespace util {
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1994,7 +2062,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the intersection of a given range and the current range.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2003,7 +2073,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the intersection of a given range and the current range.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2016,7 +2088,9 @@ declare namespace util {
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2026,7 +2100,9 @@ declare namespace util {
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2073,7 +2149,9 @@ declare namespace util {
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and the given lower and upper bounds.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2084,7 +2162,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given range.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2093,7 +2173,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given range.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2105,7 +2187,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given value.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2114,7 +2198,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given value.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2126,7 +2212,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2135,7 +2223,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2147,7 +2237,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2156,7 +2248,9 @@ declare namespace util {
*
* @param { ScopeHelper } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @throws { BusinessError } 401 - The type of range must be ScopeHelper.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2168,7 +2262,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2177,7 +2273,9 @@ declare namespace util {
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range.
* @throws { BusinessError } 401 - The type of value must be object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2404,7 +2502,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2413,7 +2513,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2423,7 +2525,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2435,7 +2539,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and BASIC_URL_SAFE
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2448,7 +2554,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2458,7 +2566,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2469,7 +2579,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2481,7 +2593,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } options - one of the Type enumeration
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2494,7 +2608,9 @@ declare namespace util {
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2504,7 +2620,9 @@ declare namespace util {
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2515,7 +2633,9 @@ declare namespace util {
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2527,7 +2647,9 @@ declare namespace util {
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - one of the Type enumeration
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2540,7 +2662,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2549,7 +2673,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2559,7 +2685,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2571,7 +2699,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and BASIC_URL_SAFE
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -2584,7 +2714,9 @@ declare namespace util {
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2594,7 +2726,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2605,7 +2739,9 @@ declare namespace util {
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - one of the Type enumeration
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - The type of src must be Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -2618,7 +2754,9 @@ declare namespace util {
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
@ -2629,7 +2767,9 @@ declare namespace util {
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -2641,7 +2781,9 @@ declare namespace util {
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - one of the Type enumeration
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - The type of src must be Uint8Array or string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -3411,7 +3553,9 @@ declare namespace util {
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } before - The logic inserted before the method.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
@ -3426,7 +3570,9 @@ declare namespace util {
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } after - The logic inserted after the method.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
@ -3440,7 +3586,9 @@ declare namespace util {
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } instead - The logic replaced with the method.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
@ -3461,7 +3609,9 @@ declare namespace util {
* The StringDecoder constructor.
*
* @param { string } [encoding] - Encoding type of the input data.Default: utf8.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -3473,7 +3623,9 @@ declare namespace util {
*
* @param { string | Uint8Array } chunk - The bytes to decode.
* @returns { string } Returns a decoded string.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -3485,7 +3637,9 @@ declare namespace util {
*
* @param { string | Uint8Array } [chunk] - The bytes to decode.
* @returns { string } Returns any remaining input stored in the internal buffer as a string.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12

View File

@ -41,7 +41,7 @@ declare namespace json {
* @param { string } text - A valid JSON string.
* @param { Transformer } [reviver] - A function that transforms the results.
* @returns { Object | null } Return an Object, array, string, number, boolean, or null value corresponding to JSON text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -52,10 +52,10 @@ declare namespace json {
* Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
*
* @param { Object } value - A JavaScript value, usually an Object or array.
* @param { (number | string)[] | null } [replacer] - An array of strings and numbers that acts as an approved list for selecting the object properties that will be stringified.
* @param { (number | string)[] | null } [replacer] - An array of strings and numbers that acts as an approved list for selecting the object properties that will be stringify.
* @param { string | number } [space] - Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
* @returns { string } Return a JSON text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -69,7 +69,7 @@ declare namespace json {
* @param { Transformer } [replacer] - A function that transforms the results.
* @param { string | number } [space] - Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
* @returns { string } Return a JSON text.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -82,7 +82,7 @@ declare namespace json {
* @param { object } obj - The object parsed from a JSON string.
* @param { string } property - Determine whether the object contains the property.
* @returns { boolean } Return true if the key is in the object, otherwise return false.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
@ -94,7 +94,7 @@ declare namespace json {
*
* @param { object } obj - The object parsed from a JSON string.
* @param { string } property - The property to be removed.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12

241
api/@ohos.worker.d.ts vendored
View File

@ -459,7 +459,10 @@ export interface WorkerEventListener {
*
* @param { Event } event - event Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -470,7 +473,10 @@ export interface WorkerEventListener {
*
* @param { Event } event - event Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -578,7 +584,10 @@ export interface WorkerEventTarget {
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -589,7 +598,10 @@ export interface WorkerEventTarget {
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -600,7 +612,10 @@ export interface WorkerEventTarget {
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -613,7 +628,10 @@ export interface WorkerEventTarget {
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -623,7 +641,10 @@ export interface WorkerEventTarget {
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -635,7 +656,10 @@ export interface WorkerEventTarget {
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -645,7 +669,10 @@ export interface WorkerEventTarget {
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -917,7 +944,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -929,7 +956,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -942,7 +969,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -957,7 +984,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -968,7 +995,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -980,7 +1007,7 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1021,7 +1048,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1032,7 +1062,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1044,7 +1077,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1059,7 +1095,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1070,7 +1109,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1082,7 +1124,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1099,7 +1144,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
*
* @param { Object } message - Data to be sent to the worker thread.
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance that can be transferred.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1117,7 +1165,10 @@ export interface ThreadWorkerGlobalScope extends GlobalScope {
* @param { number } timeout - the specific milliseconds that will wait for result to return, between 0 and 5000.
* @param { Object[] } args - the method argument called on registered globalCallObject.
* @returns { Object } Return the result of method if it has a return value, otherwise return void.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200019 - The globalCallObject is not registered.
@ -1182,7 +1233,10 @@ declare namespace worker {
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200007 - The worker file patch is invalid path.
* @syscap SystemCapability.Utils.Lang
@ -1193,7 +1247,10 @@ declare namespace worker {
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200007 - The worker file patch is invalid path.
* @syscap SystemCapability.Utils.Lang
@ -1205,7 +1262,10 @@ declare namespace worker {
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200007 - The worker file patch is invalid path.
* @syscap SystemCapability.Utils.Lang
@ -1218,7 +1278,7 @@ declare namespace worker {
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1228,7 +1288,7 @@ declare namespace worker {
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1239,7 +1299,7 @@ declare namespace worker {
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1253,7 +1313,7 @@ declare namespace worker {
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1264,7 +1324,7 @@ declare namespace worker {
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1276,7 +1336,7 @@ declare namespace worker {
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1291,7 +1351,7 @@ declare namespace worker {
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1303,7 +1363,7 @@ declare namespace worker {
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1316,7 +1376,7 @@ declare namespace worker {
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1330,7 +1390,7 @@ declare namespace worker {
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1341,7 +1401,7 @@ declare namespace worker {
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1353,7 +1413,7 @@ declare namespace worker {
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1382,7 +1442,10 @@ declare namespace worker {
* @param { Object } message - message Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer ArrayBuffer instance that can be transferred.
* The transferList array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1396,7 +1459,10 @@ declare namespace worker {
* @param { Object } message - message Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer ArrayBuffer instance that can be transferred.
* The transferList array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1411,7 +1477,10 @@ declare namespace worker {
*
* @param { Object } message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1423,7 +1492,10 @@ declare namespace worker {
*
* @param { Object } message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1436,7 +1508,10 @@ declare namespace worker {
*
* @param { Object } message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1453,7 +1528,10 @@ declare namespace worker {
*
* @param { Object } message - Data to be sent to the worker thread.
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance that can be transferred.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
@ -1468,7 +1546,10 @@ declare namespace worker {
*
* @param { string } type - type Adds an event listener to the worker.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1479,7 +1560,10 @@ declare namespace worker {
*
* @param { string } type - type Adds an event listener to the worker.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1493,7 +1577,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event to listen for
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1505,7 +1592,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event to listen for
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1518,7 +1608,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { WorkerEventListener } [listener] - listener Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1529,7 +1622,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { WorkerEventListener } [listener] - listener Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1567,7 +1663,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1578,7 +1677,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
@ -1591,7 +1693,10 @@ declare namespace worker {
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -1601,7 +1706,10 @@ declare namespace worker {
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1613,7 +1721,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -1623,7 +1734,10 @@ declare namespace worker {
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1651,7 +1765,10 @@ declare namespace worker {
* Register globalCallObject for global call.
* @param { string } instanceName - The key to register globalCallObject.
* @param { Object } globalCallObject - The globalCallObject that will be registered.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1662,7 +1779,10 @@ declare namespace worker {
/**
* Remove registered globalCallObject and release strong reference to registered object.
* @param { string } [instanceName] - The exact key that used in registration.
* @throws { BusinessError } 401 - The input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -1684,7 +1804,10 @@ declare namespace worker {
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200007 - The worker file patch is invalid path.
* @syscap SystemCapability.Utils.Lang

167
api/@ohos.xml.d.ts vendored
View File

@ -77,7 +77,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -90,7 +93,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -104,7 +110,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -117,7 +126,10 @@ declare namespace xml {
*
* @param { string } name - Key name of the attribute.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -126,7 +138,10 @@ declare namespace xml {
*
* @param { string } name - Key name of the attribute.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -136,7 +151,9 @@ declare namespace xml {
*
* @param { string } name - Key name of the attribute.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -148,7 +165,10 @@ declare namespace xml {
* Add an empty element.
*
* @param { string } name - Key name of the attribute.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -156,7 +176,10 @@ declare namespace xml {
* Add an empty element.
*
* @param { string } name - Key name of the attribute.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -165,7 +188,10 @@ declare namespace xml {
* Add an empty element.
*
* @param { string } name - Key name of the attribute.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -200,7 +226,10 @@ declare namespace xml {
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -208,7 +237,10 @@ declare namespace xml {
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -217,7 +249,10 @@ declare namespace xml {
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - The type of name must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -253,7 +288,10 @@ declare namespace xml {
*
* @param { string } prefix - Values name of the prefix.
* @param { string } namespace - Values of namespace.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -262,7 +300,10 @@ declare namespace xml {
*
* @param { string } prefix - Values name of the prefix.
* @param { string } namespace - Values of namespace.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -272,7 +313,10 @@ declare namespace xml {
*
* @param { string } prefix - Values name of the prefix.
* @param { string } namespace - Values of namespace.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -284,7 +328,10 @@ declare namespace xml {
* Writes the comment.
*
* @param { string } text - Values of comment.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -292,7 +339,10 @@ declare namespace xml {
* Writes the comment.
*
* @param { string } text - Values of comment.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -301,7 +351,10 @@ declare namespace xml {
* Writes the comment.
*
* @param { string } text - Values of comment.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -313,7 +366,10 @@ declare namespace xml {
* Writes the CDATA.
*
* @param { string } text - Values of CDATA.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -321,7 +377,10 @@ declare namespace xml {
* Writes the CDATA.
*
* @param { string } text - Values of CDATA.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -330,7 +389,10 @@ declare namespace xml {
* Writes the CDATA.
*
* @param { string } text - Values of CDATA.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -342,7 +404,10 @@ declare namespace xml {
* Writes the text.
*
* @param { string } text - Values of text.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -350,7 +415,10 @@ declare namespace xml {
* Writes the text.
*
* @param { string } text - Values of text.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -359,7 +427,10 @@ declare namespace xml {
* Writes the text.
*
* @param { string } text - Values of text.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -371,7 +442,10 @@ declare namespace xml {
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -379,7 +453,10 @@ declare namespace xml {
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -388,7 +465,10 @@ declare namespace xml {
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType.
* @throws { BusinessError } 401 - The type of text must be string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -1114,7 +1194,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -1123,7 +1206,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1133,7 +1219,10 @@ declare namespace xml {
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -1145,8 +1234,10 @@ declare namespace xml {
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - The type of option must be ParseOptions.
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
@ -1154,8 +1245,10 @@ declare namespace xml {
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - The type of option must be ParseOptions.
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -1164,8 +1257,10 @@ declare namespace xml {
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - The type of option must be ParseOptions.
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice

View File

@ -704,6 +704,7 @@ renderbuffertarget
renegotiation
repayment
repeates
replacer
reposition
resizeable
resmgr