diff --git a/BUILD.gn b/BUILD.gn index 95645ea71f8659a3dda0f1a3d04fe4d7ccc6a1cf..cbd7b62ea43f6c16dd6b619b1f57df0b633ddc68 100644 --- a/BUILD.gn +++ b/BUILD.gn @@ -55,6 +55,7 @@ ohos_copy("bundle_arkts") { outputs = [ target_out_dir + "/$target_name" ] module_source_dir = target_out_dir + "/$target_name" module_install_name = "" + license_file = "./LICENCE.md" } ohos_copy_internal("ets_internal_api") { diff --git a/LICENCE.md b/LICENCE.md new file mode 100644 index 0000000000000000000000000000000000000000..e5a55d725222ffe47bff9b2ced202e51fb5fb32e --- /dev/null +++ b/LICENCE.md @@ -0,0 +1,29 @@ +The API design of the arkts.math.Decimal module is based on the third-party software Decimal.js, +which is licensed under the MIT License. To comply with open-source licensing, +we acknowledge the MIT License terms and include this notice. + +Please refer to the full LICENSE text for Decimal.js's licensing terms and conditions. + +The MIT Licence. + +Copyright (c) 2022 Michael Mclaughlin + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/api/@internal/component/ets/alert_dialog.d.ts b/api/@internal/component/ets/alert_dialog.d.ts index be73800416e7c5e70d7b776ebb4e9bdae22cbd1a..b22ac520b2c642925bccf0bdb7bdfd8ce0388926 100644 --- a/api/@internal/component/ets/alert_dialog.d.ts +++ b/api/@internal/component/ets/alert_dialog.d.ts @@ -500,6 +500,15 @@ declare interface AlertDialogButtonOptions { * @since 11 */ action: () => void; + /** + * Define whether the button responds to Enter/Space key by default. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + primary?: boolean; } /** diff --git a/api/@internal/component/ets/alphabet_indexer.d.ts b/api/@internal/component/ets/alphabet_indexer.d.ts index 1a5c6f6ae4266d2be899acec8998c591085d77fe..146edc29a41e2ad49b4abcfaed7352394f7c5ee7 100644 --- a/api/@internal/component/ets/alphabet_indexer.d.ts +++ b/api/@internal/component/ets/alphabet_indexer.d.ts @@ -88,24 +88,6 @@ declare enum IndexerAlign { * @since 11 */ Right, - - /** - * A dialog box is displayed on the start of the index bar. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - START, - - /** - * A dialog box is displayed on the end of the index bar. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - END, } /** diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index 4c46039d506a1a2c14c286618e23ffe9493a79c3..d50d0da20c68c4793337ab1e9ee6f753e6ea4737 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -2615,7 +2615,6 @@ declare interface GeometryTransitionOptions { * whether follow target for the component still in the hierarchy, default: false, stay current. * * @type { ?boolean } - * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -7206,7 +7205,7 @@ declare interface BaseEvent { /** * the Horizontal axis coordinate. * - * @type { ?number } + * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -7217,7 +7216,7 @@ declare interface BaseEvent { /** * the Vertical axis coordinate. * - * @type { ?number } + * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -8509,10 +8508,38 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; +/** + * Defines the callback type used in onGestureRecognizerJudgeBegin. + * + * @typedef { function } GestureRecognizerJudgeBeginCallback + * @param { BaseGestureEvent } event - the event information + * @param { GestureRecognizer } currentRecognizer - the current gesture recognizer of the component + * @param { Array } recognizers - the gesture recognizers of the component on the response chain + * @returns { GestureJudgeResult } the gesture judge result + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array) => GestureJudgeResult; + +/** + * Defines the callback type used in shouldBuiltInRecognizerParallelWith. + * + * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback + * @param { GestureRecognizer } current - the current gesture recognizer of the component + * @param { Array } others - the gesture recognizers of the component on the response chain + * @returns { GestureRecognizer } gesture recognizer of the component + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array) => GestureRecognizer; + /** * Defines the PixelMap type object for ui component. * @@ -9218,8 +9245,8 @@ declare interface DragEvent { * Get dragData from DragEvent. * * @returns { UnifiedData } - get dragData. - * @throws { BusinessError } 190001 - data not found. - * @throws { BusinessError } 190002 - data error. + * @throws { BusinessError } 190001 - Data not found. + * @throws { BusinessError } 190002 - Data error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -9228,8 +9255,8 @@ declare interface DragEvent { * Get dragData from DragEvent. * * @returns { UnifiedData } - get dragData. - * @throws { BusinessError } 190001 - data not found. - * @throws { BusinessError } 190002 - data error. + * @throws { BusinessError } 190001 - Data not found. + * @throws { BusinessError } 190002 - Data error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -9979,6 +10006,37 @@ declare enum SheetMode { EMBEDDED = 1, } +/** + * Define the scroll size mode of the sheet. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare enum ScrollSizeMode { + /** + * Sheet change scroll size after the slide ends. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + FOLLOW_DETENT = 0, + + /** + * Sheet change scroll size during the sliding process. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + CONTINUOUS = 1, +} + /** * Component sheet dismiss * @@ -10023,6 +10081,7 @@ declare interface SheetDismiss { * @interface DismissSheetAction * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface DismissSheetAction { @@ -10055,6 +10114,7 @@ declare interface DismissSheetAction { * @interface SpringBackAction * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface SpringBackAction { @@ -10381,11 +10441,22 @@ declare interface SheetOptions extends BindOptions { */ mode?: SheetMode; + /** + * Determine sheet scroll size mode. + * + * @type { ?ScrollSizeMode } + * @default ScrollSizeMode.FELLOW_DETEND + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + scrollSizeMode?: ScrollSizeMode; + /** * Called when detents of the sheet changed * * @type { ?Callback } - * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -13000,16 +13071,6 @@ declare interface MenuElement { */ icon?: ResourceStr; - /** - * Sets the symbol of the menu element. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - symbolIcon?: SymbolGlyphModifier; - /** * If the value is true, the menu element is available and can respond to operations such as clicking. * If the value is false, the menu element is not available and click operations are not responded. @@ -14473,6 +14534,51 @@ declare class CommonMethod { */ foregroundEffect(options: ForegroundEffectOptions): T; + + /** + * Unified visual effect interface. + * + * @param { VisualEffect } effect - Visual effect parameters. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + visualEffect(effect: VisualEffect): T; + + /** + * Filter applied to the background layer of the component. + * + * @param { Filter } filter - Filter effect parameters. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + backgroundFilter(filter: Filter): T; + + /** + * Filter applied to the foreground layer of the component. + * + * @param { Filter } filter - Filter effect parameters. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + foregroundFilter(filter: Filter): T; + + /** + * Filter applied to the compositing layer of the component. + * + * @param { Filter } filter - Filter effect parameters. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + compositingFilter(filter: Filter): T; + /** * Foreground blur style. * blurStyle:Blur style type. @@ -15342,30 +15448,6 @@ declare class CommonMethod { */ focusBox(style: FocusBoxStyle): T; - /** - * Set container as a focus group with a specific identifier. - * - * @param { string } id - focus scope identifier. - * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - focusScopeId(id: string, isGroup?: boolean): T; - - /** - * Set the focus priority of component in a specific focus scope. - * - * @param { string } scopeId - * @param { FocusPriority } [priority] - the default value is AUTO - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - focusScopePriority(scopeId: string, priority?: FocusPriority): T; - /** * animation * @@ -16422,6 +16504,28 @@ declare class CommonMethod { */ onDisAppear(event: () => void): T; + /** + * This callback is triggered when a component mounts to view tree. + * + * @param { Callback } callback + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + onAttach(callback: Callback): T; + + /** + * This callback is triggered when a component is detached from view tree. + * + * @param { Callback } callback + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + onDetach(callback: Callback): T; + /** * This callback is triggered when the size or position of this component change finished. * @@ -17485,10 +17589,7 @@ declare class CommonMethod { */ /** * Linear Gradient - * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; - * colors: Color description for gradients. - * repeating: repeating. The default value is false + * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. * * @param { object } value * @returns { T } @@ -17574,12 +17675,12 @@ declare class CommonMethod { /** * Angle Gradient * center:is the center point of the angle gradient - * start:Start point of angle gradient. The default value is 0 - * end:End point of angle gradient. The default value is 0 + * start:Start point of angle gradient + * end:End point of angle gradient * number:number - * rotating:rotating. The default value is 0 + * rotating:rotating * colors:Color description for gradients - * repeating:repeating. The default value is false + * repeating:repeating * * @param { object } value * @returns { T } @@ -17655,9 +17756,9 @@ declare class CommonMethod { /** * Radial Gradient * center:Center point of radial gradient - * radius:Radius of Radial Gradient. value range [0, +∞) + * radius:Radius of Radial Gradient * colors:Color description for gradients - * repeating: Refill. The default value is false + * repeating: Refill * * @param { object } value * @returns { T } @@ -17775,6 +17876,7 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ clip(value: boolean): T; @@ -17832,6 +17934,7 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; @@ -17843,6 +17946,7 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ mask(value: ProgressMask): T; @@ -17896,6 +18000,7 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; @@ -18601,6 +18706,29 @@ declare class CommonMethod { */ onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; + /** + * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result + * + * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; + + /** + * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. + * + * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; + /** * Events are monopolized by components. * @@ -20112,23 +20240,24 @@ declare interface MeasureResult extends SizeResult { } /** - * The navigation destination information. + * The router page information. * + * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since 12 */ -declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; +declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; /** - * The router page information. + * The navigation destination information. * - * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since 11 */ - declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; +declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; + /** * The navigation information. @@ -20147,6 +20276,15 @@ declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.Navi * @crossplatform * @since 11 */ +/** + * UIContext + * + * @typedef {import('../api/@ohos.arkui.UIContext').UIContext} UIContext + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; /** @@ -20158,6 +20296,27 @@ declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; */ declare type DrawContext = import('../api/arkui/Graphics').DrawContext; +/** + * VisualEffect + * + * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; + + +/** + * Filter + * + * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; + /** * ComponentContent. * @@ -20168,6 +20327,17 @@ declare type DrawContext = import('../api/arkui/Graphics').DrawContext; */ declare type ComponentContent = import('../api/arkui/ComponentContent').ComponentContent; +/** + * Theme. + * + * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare type Theme = import('../api/@ohos.arkui.theme').Theme; + /** * Custom Component * @@ -20351,6 +20521,17 @@ declare class CustomComponent extends CommonAttribute { */ aboutToRecycle?(): void; + /** + * The onWillApplyTheme function is a custom hook to get active theme object from the context + * + * @param { Theme } theme - Custom theme init params. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + onWillApplyTheme?(theme: Theme): void; + /** * Custom component override this method to layout each of its sub components. * @@ -21053,15 +21234,13 @@ declare class ScrollableCommonMethod extends CommonMethod { /** * Called when the scrollable will scroll. * - * @param { OnScrollCallback } handler - callback of scrollable, - * scrollOffset is offset this frame will scroll, which may or may not be reached. - * scrollState is current scroll state. + * @param { Optional } handler - callback of scrollable. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ - onWillScroll(handler: OnScrollCallback): T; + onWillScroll(handler: Optional): T; /** * Called when the scrollable did scroll. @@ -21138,8 +21317,44 @@ declare class ScrollableCommonMethod extends CommonMethod { } /** - * on scroll callback using in scrollable onWillScroll and onDidScroll. + * The actual offset by which the scrollable scrolls. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class ScrollResult { + /** + * Actual offset by which the scrollable scrolls in vp. + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + offsetRemain: number; +} + +/** + * Called before scroll to allow developer to control real offset the Scrollable can scroll. + * + * @typedef { function } OnWillScrollCallback + * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. + * @param { ScrollState } scrollState - current scroll state. + * @param { ScrollSource } scrollSource - source of current scroll. + * @returns { void | ScrollResult } the remain offset for the scrollable, + * same as scrollOffset when no ScrollResult is returned. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type OnWillScrollCallback = +(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; + +/** + * On scroll callback using in scrollable onDidScroll. * + * @typedef { function } OnScrollCallback + * @param { number } scrollOffset - offset this frame did scroll. + * @param { ScrollState } scrollState - current scroll state. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -21217,6 +21432,7 @@ declare interface EdgeEffectOptions { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare class ChildrenMainSize { @@ -21231,6 +21447,7 @@ declare class ChildrenMainSize { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ constructor(childDefaultSize: number); @@ -21246,6 +21463,7 @@ declare class ChildrenMainSize { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ set childDefaultSize(value: number); @@ -21257,6 +21475,7 @@ declare class ChildrenMainSize { * If the main axis is horizontal, it indicates width. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ get childDefaultSize(): number; @@ -21273,6 +21492,7 @@ declare class ChildrenMainSize { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. * splice(1, 1), Delete the second child. @@ -21291,6 +21511,7 @@ declare class ChildrenMainSize { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ update(index: number, childSize: number): void; @@ -21664,6 +21885,7 @@ declare module 'touchEvent'{ * @typedef Callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface Callback { @@ -21674,6 +21896,7 @@ declare interface Callback { * @returns { V } - Returns result of the callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ (data: T): V; @@ -21691,12 +21914,60 @@ declare interface Callback { */ declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void +/** + * Defines the options about VisibleAreaEvent. + * + * @interface VisibleAreaEventOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + declare interface VisibleAreaEventOptions { + /** + * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. + * + * @type { Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + ratios: Array; + + /** + * The value of expectedUpdateInterval indicates desired update period(ms). + * + * @type { ?number } + * @default 1000 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + expectedUpdateInterval?: number; +} + +/** + * Defines the callback type used in VisibleAreaChange events. + * + * @typedef { function } VisibleAreaChangeCallback + * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. + * It is true as the ratio increases and false as the ratio decreases. + * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type VisibleAreaChangeCallback = (isVisible: boolean, currentRatio: number) => void; + /** * Defines a UICommonEvent which is used to set different common event to target component. * * @interface UICommonEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface UICommonEvent { @@ -21706,6 +21977,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback about the click event. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnClick(callback: Callback | undefined): void; @@ -21716,6 +21988,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnTouch(callback: Callback | undefined): void; @@ -21726,6 +21999,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnAppear(callback: Callback | undefined): void; @@ -21736,6 +22010,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnDisappear(callback: Callback | undefined): void; @@ -21747,6 +22022,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnKeyEvent(callback: Callback | undefined): void; @@ -21757,6 +22033,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnFocus(callback: Callback | undefined): void; @@ -21767,6 +22044,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnBlur(callback: Callback | undefined): void; @@ -21777,6 +22055,7 @@ declare interface UICommonEvent { * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnHover(callback: HoverCallback | undefined): void; @@ -21787,6 +22066,7 @@ declare interface UICommonEvent { * @param { Callback | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnMouse(callback: Callback | undefined): void; @@ -21797,9 +22077,23 @@ declare interface UICommonEvent { * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setOnSizeChange(callback: SizeChangeCallback | undefined): void; + + /** + * Set or reset the callback which is triggered when the visibleArea of component changed. + * + * @param { VisibleAreaEventOptions } options - The options for the visibility event. + * @param { VisibleAreaChangeCallback | undefined } event - The callback will be triggered when the visibleArea of component changed and get close to any number in ratios defined by options. + * If set undefined will reset the target callback. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; } /** diff --git a/api/@internal/component/ets/common_ts_ets_api.d.ts b/api/@internal/component/ets/common_ts_ets_api.d.ts index fe590db2779669b697fb622e89983b70c37f1bd6..df8bb6da9aa318479db0a44cca6cbdbb8e14e8f5 100644 --- a/api/@internal/component/ets/common_ts_ets_api.d.ts +++ b/api/@internal/component/ets/common_ts_ets_api.d.ts @@ -148,6 +148,19 @@ declare class AppStorage { * @atomicservice * @since 11 */ + /** + * Like see @link(), but will create and initialize a new source property in AppStorage if missing + * Same as see LocalStorage.setAndLink() + * + * @param { string } propName - name of source property in AppStorage + * @param { T } defaultValue - value to be used for initializing new property in AppStorage + * default value must be of type T, can be undefined or null. + * @returns { SubscribedAbstractProperty } instance of SubscribedAbstractProperty + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static setAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty; /** @@ -232,6 +245,21 @@ declare class AppStorage { * @atomicservice * @since 11 */ + /** + * + * Like @see prop(), will create and initialize a new source property in AppStorage if missing + * Same as see LocalStorage.setAndProp() + * + * @param { string } propName - name of source property in AppStorage + * @param { T } defaultValue - value to be used for initializing new property in AppStorage. + * default value must be of type T, can be undefined or null. + * @returns { SubscribedAbstractProperty } instance of SubscribedAbstractProperty + * return undefined if named property does not exist in AppStorage. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static setAndProp(propName: string, defaultValue: T): SubscribedAbstractProperty; /** @@ -357,6 +385,20 @@ declare class AppStorage { * @atomicservice * @since 11 */ + /** + * Set value of given property in AppStorage + * Method sets nothing and returns false if property with this name does not exist in AppStorage + * newValue can be undefined or null from API 12. + * Same as see LocalStorage.set() + * + * @param { string } propName + * @param { T } newValue - must be of type T, can be undefined or null + * @returns { boolean } true on success, i.e. when above conditions are satisfied, otherwise false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static set(propName: string, newValue: T): boolean; /** @@ -400,6 +442,19 @@ declare class AppStorage { * @atomicservice * @since 11 */ + /** + * Set value of given property, if it exists, see set() . + * Add property if no property with given name in AppStorage, and initialize with given value. + * newValue can be undefined or null from API 12 + * see LocalStorage.setOrCreate() + * + * @param { string } propName + * @param { T } newValue - must be of type T, can be undefined or null + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static setOrCreate(propName: string, newValue: T): void; /** @@ -868,6 +923,19 @@ declare abstract class SubscribedAbstractProperty { * @since 11 * @form */ + /** + * Updates the value of value of the sync'ed AppStorage/LocalStorage property. + * Sets new value, must be of type T, can be undefined or null. + * `let link : SubscribedAbstractProperty =AppStorage.Link("foo")` + * then `link.set("Hello")` will set the value of "foo" property in AppStorage. + * + * @param { T } newValue + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ abstract set(newValue: T): void; /** @@ -1982,6 +2050,20 @@ declare class LocalStorage { * @since 11 * @form */ + /** + * Set value of given property in LocalStorage + * Method sets nothing and returns false if property with this name does not exist in LocalStorage + * newValue can be undefined or null from API 12. + * + * @param { string } propName + * @param { T } newValue - must be of type T, can be undefined or null + * @returns { boolean } true on success, i.e. when above conditions are satisfied, otherwise false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ set(propName: string, newValue: T): boolean; /** @@ -2026,6 +2108,20 @@ declare class LocalStorage { * @since 11 * @form */ + /** + * Set value of given property, if it exists, see set() . + * Add property if no property with given name and initialize with given value. + * newValue can be undefined or null from API 12 + * + * @param { string } propName + * @param { T } newValue - must be of type T, can be undefined or null + * @returns { boolean } true on success, i.e. when above conditions are satisfied, otherwise false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ setOrCreate(propName: string, newValue: T): boolean; /** @@ -2105,6 +2201,20 @@ declare class LocalStorage { * @since 11 * @form */ + /** + * Like see link(), but will create and initialize a new source property in LocalStorage if missing + * + * @param { string } propName - name of source property in LocalStorage + * @param { T } defaultValue - value to be used for initializing new property in LocalStorage + * default value must be of type T, can be undefined or null. + * @returns { SubscribedAbstractProperty } instance of SubscribedAbstractProperty + * Apps can use SDK functions of base class SubscribedAbstractProperty + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ setAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty; /** @@ -2184,6 +2294,20 @@ declare class LocalStorage { * @since 11 * @form */ + /** + * Like see prop(), will create and initialize a new source property in LocalStorage if missing + * + * @param { string } propName - name of source property in LocalStorage + * @param { S } defaultValue - value to be used for initializing new property in LocalStorage. + * Default value must be of type T, can be undefined or null. + * @returns { SubscribedAbstractProperty } instance of SubscribedAbstractProperty + * Apps can use SDK functions of base class SubscribedAbstractProperty + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ setAndProp(propName: string, defaultValue: S): SubscribedAbstractProperty; /** diff --git a/api/@internal/component/ets/enums.d.ts b/api/@internal/component/ets/enums.d.ts index 8b8e3295b57123a3da04ff857ff7d81276c83266..5ac7dc4280193372ce8e23fb9f9c010dfc8269d6 100644 --- a/api/@internal/component/ets/enums.d.ts +++ b/api/@internal/component/ets/enums.d.ts @@ -7569,17 +7569,9 @@ declare enum CopyOptions { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 - * @form - */ - /** - * Share in cross Device - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 * @form + * @since 11 + * @deprecated since 12 */ CROSS_DEVICE = 3, } @@ -8409,15 +8401,6 @@ declare enum ClickEffectLevel { * @atomicservice * @since 11 */ -/** - * The type of XComponent - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ declare enum XComponentType { /** * Surface type. The default type is used. @@ -8432,14 +8415,6 @@ declare enum XComponentType { * @atomicservice * @since 11 */ - /** - * Surface type. The default type is used. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ SURFACE, /** @@ -8564,6 +8539,79 @@ declare enum NestedScrollMode { PARALLEL, } +/** + * The possible source of scroll event + * @enum { number } ScrollSource + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare enum ScrollSource { + /** + * Drag events. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + DRAG = 0, + + /** + * Fling after the drag has ended with velocity. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + FLING, + + /** + * Over scroll with EdgeEffect.Spring. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + EDGE_EFFECT, + + /** + * Other user input except drag, such as mouse wheel, key event. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + OTHER_USER_INPUT, + + /** + * Drag events of scroll bar. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + SCROLL_BAR, + + /** + * Fling after the drag on scroll bar has ended with velocity. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + SCROLL_BAR_FLING, + + /** + * Member methods of Scroller without animation. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + SCROLLER, + + /** + * Member methods of Scroller with animation. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + SCROLLER_ANIMATION, +} + /** * Enum of RenderFit * diff --git a/api/@internal/component/ets/focus.d.ts b/api/@internal/component/ets/focus.d.ts index 2258aa15cc92136f866fb9794604d42952ae019f..794091f0f63832b8aa4951ef72383409407e4445 100644 --- a/api/@internal/component/ets/focus.d.ts +++ b/api/@internal/component/ets/focus.d.ts @@ -49,41 +49,4 @@ interface FocusBoxStyle { * @since 12 */ strokeWidth?: LengthMetrics; -} - -/** - * Focus Priority - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ -declare enum FocusPriority { - /** - * Default priority. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - AUTO = 0, - - /** - * Prior priority. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - PRIOR = 2000, - - /** - * Previous focus priority. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - PREVIOUS = 3000, } \ No newline at end of file diff --git a/api/@internal/component/ets/gesture.d.ts b/api/@internal/component/ets/gesture.d.ts index b49b1e9dc3ae7ae170af5b0648afaeb1ae2c70c5..175c1899453bcff84b68957935787d8e55169220 100644 --- a/api/@internal/component/ets/gesture.d.ts +++ b/api/@internal/component/ets/gesture.d.ts @@ -574,6 +574,15 @@ declare enum GestureJudgeResult { * @crossplatform * @since 11 */ +/** + * Creating an Object + * + * @namespace GestureControl + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ declare namespace GestureControl { /** * Creating an Object @@ -1781,17 +1790,6 @@ interface GestureInterface { * @since 11 */ tag(tag: string): T; - - /** - * Input source type for touch event response. - * - * @param { Array } value - indicate the input source that allows touch - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - allowedTypes(value: Array): T; } /** @@ -2160,6 +2158,16 @@ declare class PanGestureOptions { * @since 11 */ setFingers(value: number); + + /** + * Get the pan direction attribute. + * + * @returns { PanDirection } - Pan gesture direction + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getDirection(): PanDirection; } /** @@ -3025,16 +3033,6 @@ declare class GestureHandler implements GestureInterface { * @since 12 */ tag(tag: string): T; - /** - * Input source type for touch event response. - * - * @param { Array } types - indicate the input source that allows touch - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - allowedTypes(types: Array): T; } /** @@ -3629,6 +3627,206 @@ declare enum GesturePriority { PRIORITY = 1, } +/** + * Creating an Object + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare enum GestureRecognizerState { + /** + * Ready state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + READY = 0, + /** + * Detecting state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + DETECTING = 1, + /** + * Pending state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + PENDING = 2, + /** + * Blocked state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + BLOCKED = 3, + /** + * Successful state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + SUCCESSFUL = 4, + /** + * Failed state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + FAILED = 5, +} + +/** + * Defines the scrollable target information. + * + * @extends EventTargetInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class ScrollableTargetInfo extends EventTargetInfo { + /** + * Returns whether the scrollable component is at begin. + * + * @returns { boolean } - true is at begin, false is not at begin + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isBegin(): boolean; + /** + * Returns whether the scrollable component is at end. + * + * @returns { boolean } - true is at end, false is not at end + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isEnd(): boolean; +} + +/** + * Defines the event target information. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class EventTargetInfo { + /** + * Returns the component's inspector id. + * + * @returns { string } - the inspector id of the component + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getId(): string; +} + +/** + * Defines the gesture recognizer. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class GestureRecognizer { + /** + * Returns the gesture's tag. + * + * @returns { string } - the gesture's tag + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getTag(): string; + /** + * Returns the gesture's type. + * + * @returns { GestureControl.GestureType } - the gesture's type + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getType(): GestureControl.GestureType; + /** + * Returns whether the gesture recognizer is built in recognizer. + * + * @returns { boolean } - true is built in recognizer, false is not built in recognizer + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isBuiltIn(): boolean; + /** + * set the enabled state of the gesture recognizer. + * + * @param { boolean } isEnabled - Indicates the enabled state. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + setEnabled(isEnabled: boolean): void; + /** + * Returns whether the gesture recognizer is enabled. + * + * @returns { boolean } - true is enabled, false is not enabled + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isEnabled(): boolean; + /** + * Returns the gesture recognizer's state. + * + * @returns { GestureRecognizerState } - the gesture recognizer's state + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getState(): GestureRecognizerState; + /** + * Returns the event target information of the component. + * + * @returns { EventTargetInfo } - the event target information of the component. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getEventTargetInfo(): EventTargetInfo; +} + +/** + * Defines the gesture recognizer. + * + * @extends GestureRecognizer + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class PanRecognizer extends GestureRecognizer { + /** + * Returns the the pan gesture options of the recognizer. + * + * @returns { PanGestureOptions } - Pan gesture options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getPanGestureOptions(): PanGestureOptions; +} + declare module "GestureEventModule" { module "GestureEventModule" { // @ts-ignore diff --git a/api/@internal/component/ets/grid_row.d.ts b/api/@internal/component/ets/grid_row.d.ts index 2b7af4a32d1fa484475e92e669fb92cc609badd4..4dbd1e21e807902738cffa39bb438cb0b0f942b0 100644 --- a/api/@internal/component/ets/grid_row.d.ts +++ b/api/@internal/component/ets/grid_row.d.ts @@ -47,7 +47,7 @@ */ declare interface GridRowSizeOption { /** - * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint + * Grid Row Size Option xs * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -55,7 +55,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint + * Grid Row Size Option xs * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -64,7 +64,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint + * Grid Row Size Option xs * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -76,7 +76,7 @@ declare interface GridRowSizeOption { xs?: Length, /** - * Grid Row Size Option sm, select sm gutter size based on gridRow current breakpoint + * Grid Row Size Option sm * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -84,7 +84,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option sm, select sm gutter size based on gridRow current breakpoint + * Grid Row Size Option sm * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -93,7 +93,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option sm, select sm gutter size based on gridRow current breakpoint + * Grid Row Size Option sm * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -105,7 +105,7 @@ declare interface GridRowSizeOption { sm?: Length, /** - * Grid Row Size Option md, select md gutter size based on gridRow current breakpoint + * Grid Row Size Option md * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -113,7 +113,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option md, select md gutter size based on gridRow current breakpoint + * Grid Row Size Option md * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -122,7 +122,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option md, select md gutter size based on gridRow current breakpoint + * Grid Row Size Option md * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -134,7 +134,7 @@ declare interface GridRowSizeOption { md?: Length, /** - * Grid Row Size Option lg, select lg gutter size based on gridRow current breakpoint + * Grid Row Size Option lg * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -142,7 +142,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option lg, select lg gutter size based on gridRow current breakpoint + * Grid Row Size Option lg * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -151,7 +151,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option lg, select lg gutter size based on gridRow current breakpoint + * Grid Row Size Option lg * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -163,7 +163,7 @@ declare interface GridRowSizeOption { lg?: Length, /** - * Grid Row Size Option xl, select xl gutter size based on gridRow current breakpoint + * Grid Row Size Option xl * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -171,7 +171,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option xl, select xl gutter size based on gridRow current breakpoint + * Grid Row Size Option xl * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -180,7 +180,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option xl, select xl gutter size based on gridRow current breakpoint + * Grid Row Size Option xl * * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -192,14 +192,14 @@ declare interface GridRowSizeOption { xl?: Length, /** - * Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint + * Grid Row Size Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 * @form */ /** - * Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint + * Grid Row Size Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -207,7 +207,7 @@ declare interface GridRowSizeOption { * @form */ /** - * Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint + * Grid Row Size Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -247,7 +247,7 @@ declare interface GridRowSizeOption { */ declare interface GridRowColumnOption { /** - * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint + * Grid Row Column Option xs * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -255,7 +255,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint + * Grid Row Column Option xs * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -264,7 +264,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint + * Grid Row Column Option xs * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -276,7 +276,7 @@ declare interface GridRowColumnOption { xs?: number, /** - * Grid Row Column Option sm, select sm column num based on gridRow current breakpoint + * Grid Row Column Option sm * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -284,7 +284,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option sm, select sm column num based on gridRow current breakpoint + * Grid Row Column Option sm * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -293,7 +293,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option sm, select sm column num based on gridRow current breakpoint + * Grid Row Column Option sm * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -305,7 +305,7 @@ declare interface GridRowColumnOption { sm?: number, /** - * Grid Row Column Option md, select md column num based on gridRow current breakpoint + * Grid Row Column Option md * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -313,7 +313,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option md, select md column num based on gridRow current breakpoint + * Grid Row Column Option md * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -322,7 +322,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option md, select md column num based on gridRow current breakpoint + * Grid Row Column Option md * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -334,7 +334,7 @@ declare interface GridRowColumnOption { md?: number, /** - * Grid Row Column Option lg, select lg column num based on gridRow current breakpoint + * Grid Row Column Option lg * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -342,7 +342,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option lg, select lg column num based on gridRow current breakpoint + * Grid Row Column Option lg * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -351,7 +351,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option lg, select lg column num based on gridRow current breakpoint + * Grid Row Column Option lg * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -363,7 +363,7 @@ declare interface GridRowColumnOption { lg?: number, /** - * Grid Row Column Option xl, select xl column num based on gridRow current breakpoint + * Grid Row Column Option xl * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -371,7 +371,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option xl, select xl column num based on gridRow current breakpoint + * Grid Row Column Option xl * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -380,7 +380,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option xl, select xl column num based on gridRow current breakpoint + * Grid Row Column Option xl * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -392,14 +392,14 @@ declare interface GridRowColumnOption { xl?: number, /** - * Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint + * Grid Row Column Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 * @form */ /** - * Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint + * Grid Row Column Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -407,7 +407,7 @@ declare interface GridRowColumnOption { * @form */ /** - * Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint + * Grid Row Column Option xxl * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -989,7 +989,7 @@ interface GridRowInterface { */ declare class GridRowAttribute extends CommonMethod { /** - * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl + * Callback triggered when the breakpoint changes * * @param { function } callback * @returns { GridRowAttribute } @@ -998,7 +998,7 @@ declare class GridRowAttribute extends CommonMethod { * @form */ /** - * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl + * Callback triggered when the breakpoint changes * * @param { function } callback * @returns { GridRowAttribute } @@ -1008,7 +1008,7 @@ declare class GridRowAttribute extends CommonMethod { * @form */ /** - * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl + * Callback triggered when the breakpoint changes * * @param { function } callback * @returns { GridRowAttribute } diff --git a/api/@internal/component/ets/image.d.ts b/api/@internal/component/ets/image.d.ts index 5f19b6f1262b57e58822445a9512bc3991b30ef4..3f377da5260d7d09a09b3916ae9d114e64682c60 100644 --- a/api/@internal/component/ets/image.d.ts +++ b/api/@internal/component/ets/image.d.ts @@ -983,7 +983,7 @@ declare class ImageAttribute extends CommonMethod { */ /** * Enable image dragging. - * Default value is false. + * Default value is true. * * @param { boolean } value * @returns { ImageAttribute } diff --git a/api/@internal/component/ets/image_common.d.ts b/api/@internal/component/ets/image_common.d.ts index 48a3da32a84c9a1cdd19e7f69538b14c486cf9ca..c02794171accb0d61f3721efba5244ff5a26f710 100644 --- a/api/@internal/component/ets/image_common.d.ts +++ b/api/@internal/component/ets/image_common.d.ts @@ -78,6 +78,7 @@ declare enum ImageAnalyzerType { * * @interface ImageAnalyzerConfig * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ declare interface ImageAnalyzerConfig { @@ -94,6 +95,7 @@ declare interface ImageAnalyzerConfig { * * @type { ImageAnalyzerType[] } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ types: ImageAnalyzerType[]; diff --git a/api/@internal/component/ets/index-full.d.ts b/api/@internal/component/ets/index-full.d.ts index 91b9aab600f57b4a48ce5a5cd4da0ed92722a49f..75b3af797ac56cb1172a6b119eafa1e34335e927 100644 --- a/api/@internal/component/ets/index-full.d.ts +++ b/api/@internal/component/ets/index-full.d.ts @@ -43,6 +43,7 @@ /// /// /// +/// /// /// /// @@ -124,6 +125,7 @@ /// /// /// +/// /// /// /// diff --git a/api/@internal/component/ets/lazy_for_each.d.ts b/api/@internal/component/ets/lazy_for_each.d.ts index 345197f875e0f7529baebf8cc0bd819aa6ade297..bb02ec80b6bfd638f61f8328d399134fa126c806 100644 --- a/api/@internal/component/ets/lazy_for_each.d.ts +++ b/api/@internal/component/ets/lazy_for_each.d.ts @@ -406,12 +406,13 @@ interface DataReloadOperation { /** * All data operation type * + * @typedef DataOperation * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ declare type DataOperation = - DataAddOperation | DataDeleteOperation | DataChangeOperation | DataMoveOperation | DataExchangeOperation | DataReloadOperation + DataAddOperation | DataDeleteOperation | DataChangeOperation | DataMoveOperation | DataExchangeOperation | DataReloadOperation; /** * Data Change Listener. diff --git a/api/@internal/component/ets/list.d.ts b/api/@internal/component/ets/list.d.ts index fcd7db87e5e5a70ad74dbea622195f48bec0b013..a1f546a13087189b2708ac1ebf4079e1c62cece5 100644 --- a/api/@internal/component/ets/list.d.ts +++ b/api/@internal/component/ets/list.d.ts @@ -263,6 +263,7 @@ declare enum ListItemAlign { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare enum ListItemGroupArea { @@ -271,6 +272,7 @@ declare enum ListItemGroupArea { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ NONE = 0, @@ -280,6 +282,7 @@ declare enum ListItemGroupArea { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ IN_LIST_ITEM_AREA = 1, @@ -289,6 +292,7 @@ declare enum ListItemGroupArea { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ IN_HEADER_AREA = 2, @@ -298,6 +302,7 @@ declare enum ListItemGroupArea { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ IN_FOOTER_AREA = 3, @@ -652,6 +657,7 @@ declare interface CloseSwipeActionOptions { * @interface VisibleListContentInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface VisibleListContentInfo { @@ -661,6 +667,7 @@ declare interface VisibleListContentInfo { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ index: number @@ -671,6 +678,7 @@ declare interface VisibleListContentInfo { * @type { ?ListItemGroupArea } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ itemGroupArea?: ListItemGroupArea @@ -681,6 +689,7 @@ declare interface VisibleListContentInfo { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ itemIndexInGroup?: number @@ -692,6 +701,7 @@ declare interface VisibleListContentInfo { * @typedef {function} OnScrollVisibleContentChangeCallback * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type OnScrollVisibleContentChangeCallback = (start: VisibleListContentInfo, end: VisibleListContentInfo) => void; @@ -1457,6 +1467,7 @@ declare class ListAttribute extends ScrollableCommonMethod { * @returns { ListAttribute } the attribute of the list. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ childrenMainSize(value: ChildrenMainSize): ListAttribute; diff --git a/api/@internal/component/ets/menu_item.d.ts b/api/@internal/component/ets/menu_item.d.ts index d2807bd46aa3f377f260fc0d56abd1abdb63d09f..89265ec1eb2c1ee2653abd9ad83018ac98674f27 100644 --- a/api/@internal/component/ets/menu_item.d.ts +++ b/api/@internal/component/ets/menu_item.d.ts @@ -69,16 +69,6 @@ declare interface MenuItemOptions { */ startIcon?: ResourceStr; - /** - * Defines the start display symbol info. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - symbolStartIcon?: SymbolGlyphModifier; - /** * Defines the content string display info. * @@ -131,16 +121,6 @@ declare interface MenuItemOptions { */ endIcon?: ResourceStr; - /** - * Defines the end display symbol info. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - symbolEndIcon?: SymbolGlyphModifier; - /** * Defines the end label info like shortcut. * @@ -338,20 +318,7 @@ declare class MenuItemAttribute extends CommonMethod { * @atomicservice * @since 11 */ - /** - * Whether the relevant check icon is displayed when a menu item is selected. - * Use type ResourceStr or SymbolGlyphModifier to specify icon instead of the default check mark. - * - * @param { boolean | ResourceStr | SymbolGlyphModifier } value - Indicates whether to display icon when selected. - *
true: displays the default check mark when selected. - *
false: does not displays icon when selected. - *
ResourceStr or SymbolGlyphModifier: displays the specified icon when selected. - * @returns { MenuItemAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - selectIcon(value: boolean | ResourceStr | SymbolGlyphModifier): MenuItemAttribute; + selectIcon(value: boolean | ResourceStr): MenuItemAttribute; /** * Triggers a callback when a menu item is selected or unchecked. diff --git a/api/@internal/component/ets/nav_destination.d.ts b/api/@internal/component/ets/nav_destination.d.ts index ccd1c91f6be82605790a50b5670a0cacd0eb114f..924f761459359c28b144208c4a89afbe06d18c86 100644 --- a/api/@internal/component/ets/nav_destination.d.ts +++ b/api/@internal/component/ets/nav_destination.d.ts @@ -351,6 +351,16 @@ declare interface NavDestinationContext { */ pathStack: NavPathStack; + /** + * Get the unique id of NavDestination, which is different from common property id of Component. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + navDestinationId?: string; + /** * Get configuration of current Destination in module.json @@ -554,14 +564,14 @@ declare class NavDestinationAttribute extends CommonMethod void; @@ -1369,6 +1362,7 @@ declare type InterceptionShowCallback = (from: NavDestinationContext|NavBar, to: * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type InterceptionModeCallback = (mode: NavigationMode) => void; @@ -1379,6 +1373,7 @@ declare type InterceptionModeCallback = (mode: NavigationMode) => void; * @interface NavigationInterception * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface NavigationInterception { @@ -1389,6 +1384,7 @@ declare interface NavigationInterception { * @type { ?InterceptionShowCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ willShow?: InterceptionShowCallback; @@ -1399,6 +1395,7 @@ declare interface NavigationInterception { * @type { ?InterceptionShowCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ didShow?: InterceptionShowCallback; @@ -1409,6 +1406,7 @@ declare interface NavigationInterception { * @type { ?InterceptionModeCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ modeChange?: InterceptionModeCallback; @@ -1677,17 +1675,6 @@ declare interface ToolbarItem { */ icon?: ResourceStr; - /** - * The symbol of navigation toolbar item. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - symbolIcon?: SymbolGlyphModifier; - /** * Trigger by navigation toolbar item click. * @@ -1744,17 +1731,6 @@ declare interface ToolbarItem { * @since 11 */ activeIcon?: ResourceStr; - - /** - * The symbol of navigation toolbar item in active state. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - activeSymbolIcon?: SymbolGlyphModifier; } /** @@ -1796,6 +1772,7 @@ declare interface NavigationTitleOptions { * @default BarStyle.STANDARD * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ barStyle?: BarStyle; @@ -1807,6 +1784,7 @@ declare interface NavigationTitleOptions { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare enum BarStyle { @@ -1815,6 +1793,7 @@ declare enum BarStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ STANDARD = 0, @@ -1824,6 +1803,7 @@ declare enum BarStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ STACK = 1, @@ -2043,17 +2023,7 @@ declare class NavigationAttribute extends CommonMethod { * @atomicservice * @since 11 */ - /** - * Sets the back button icon. - * - * @param { string | PixelMap | Resource | SymbolGlyphModifier } value - * @returns { NavigationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - backButtonIcon(value: string | PixelMap | Resource | SymbolGlyphModifier): NavigationAttribute; + backButtonIcon(value: string | PixelMap | Resource): NavigationAttribute; /** * Hide the NavBar, which includes title bar, the child of Navigation and tool bar. Supported in split mode. diff --git a/api/@internal/component/ets/particle.d.ts b/api/@internal/component/ets/particle.d.ts index d314a25166e997d166e4acd674629b525a11ea4f..63ec35320bc2b588ea7921ad437530529e0f8143 100644 --- a/api/@internal/component/ets/particle.d.ts +++ b/api/@internal/component/ets/particle.d.ts @@ -1252,6 +1252,7 @@ declare class ParticleAttribute extends CommonMethod { * @returns { ParticleAttribute } Returns the particle attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ emitter(value : Array) : ParticleAttribute; @@ -1263,6 +1264,7 @@ declare class ParticleAttribute extends CommonMethod { * @returns { ParticleAttribute } Returns the particle attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ disturbanceFields(fields: Array): ParticleAttribute; diff --git a/api/@internal/component/ets/refresh.d.ts b/api/@internal/component/ets/refresh.d.ts index f9b4bac65eb44cf4a78130596e3465ac005957b8..420e033d8c8c1c692e619acd903ed488b963bed0 100644 --- a/api/@internal/component/ets/refresh.d.ts +++ b/api/@internal/component/ets/refresh.d.ts @@ -462,17 +462,6 @@ declare class RefreshAttribute extends CommonMethod { * @since 12 */ onOffsetChange(callback: Callback): RefreshAttribute; - - /** - * Pull-down follow ratio for Refresh. - * - * @param { Optional } ratio - Pull-down follow ratio for Refresh. - * @returns { RefreshAttribute } The attribute of the Refresh. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - pullDownRatio(ratio: Optional): RefreshAttribute; } /** diff --git a/api/@internal/component/ets/rich_editor.d.ts b/api/@internal/component/ets/rich_editor.d.ts index e3d2580c14aaf2078bac70fbbc32a73913e2f177..f25b2c5634d3ee0a4fa4f0a6ca2fb00fdd17ee4f 100644 --- a/api/@internal/component/ets/rich_editor.d.ts +++ b/api/@internal/component/ets/rich_editor.d.ts @@ -675,6 +675,15 @@ declare interface RichEditorTextSpan { * @crossplatform * @since 11 */ +/** + * Defines the richEditor Image Layout Style. + * + * @interface RichEditorLayoutStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface RichEditorLayoutStyle { /** * Outer Margin. @@ -1388,6 +1397,17 @@ declare interface RichEditorTextSpanResult { * @since 12 */ paragraphStyle?: RichEditorParagraphStyle; + + /** + * The preview text. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + previewText?: string; } /** @@ -2197,6 +2217,15 @@ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanS * @crossplatform * @since 11 */ +/** + * Defines the symbol span options of RichEditor. + * + * @interface RichEditorSymbolSpanOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ declare interface RichEditorSymbolSpanOptions { /** * The offset that add custom symbol span at. @@ -2343,6 +2372,17 @@ declare interface RichEditorInsertValue { * @since 11 */ insertValue: string; + + /** + * The preview text. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + previewText?: string; } /** @@ -2521,6 +2561,26 @@ declare interface RichEditorOptions { controller: RichEditorController; } +/** + * Defines the options of RichEditor with StyledString. + * + * @interface RichEditorStyledStringOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare interface RichEditorStyledStringOptions { + /** + * RichEditor controller. + * + * @type { RichEditorStyledStringController } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + controller: RichEditorStyledStringController; +} + /** * Defines the selection menu options. * @@ -2588,20 +2648,14 @@ declare interface SelectionMenuOptions { } /** - * Provides Controller for RichEditor. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ -/** - * Provides Controller for RichEditor. + * Provides Base Controller for RichEditor. * + * @implements TextEditControllerEx * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 + * @since 12 */ -declare class RichEditorController { +declare class RichEditorBaseController implements TextEditControllerEx { /** * Get caret offset from controller. * @@ -2640,6 +2694,126 @@ declare class RichEditorController { */ setCaretOffset(offset: number): boolean; + /** + * close the select menu when menu is on. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 10 + */ + /** + * close the select menu when menu is on. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ + closeSelectionMenu(): void; + + /** + * Get the typing text style. + * + * @returns { RichEditorTextStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + /** + * Get the typing text style. + * + * @returns { RichEditorTextStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + getTypingStyle(): RichEditorTextStyle; + + /** + * Set the typing text style. + * + * @param { RichEditorTextStyle } value - set the typing text style. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + /** + * Set the typing text style. + * + * @param { RichEditorTextStyle } value - set the typing text style. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + setTypingStyle(value: RichEditorTextStyle): void; + + /** + * Text selection is achieved by specifying the start and end positions of the rich editor. + * + * @param { number } selectionStart - The start position of the selected text. + * @param { number } selectionEnd - The end position of the selected text. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + /** + * Specify the start and end positions to select a range of content. + * + * @param { number } selectionStart - The start position of the selected text. + * @param { number } selectionEnd - The end position of the selected text. + * @param { SelectionOptions } [options] - Indicates the options of selection. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; + + /** + * Judge whether is in editing state + * + * @returns { boolean } - true is editing state, false is non editing status + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isEditing(): boolean; + + /** + * Stop editing state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + stopEditing(): void; +} + +/** + * Provides Controller for RichEditor. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 10 + */ +/** + * Provides Controller for RichEditor. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +/** + * Provides Controller for RichEditor. + * + * @extends RichEditorBaseController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare class RichEditorController extends RichEditorBaseController { /** * Add a text span. * @@ -2827,118 +3001,73 @@ declare class RichEditorController { getParagraphs(value?: RichEditorRange): Array; /** - * close the select menu when menu is on. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ - /** - * close the select menu when menu is on. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - closeSelectionMenu(): void; - - /** - * Get the typing text style. + * Called when the content is selected. * - * @returns { RichEditorTextStyle } + * @returns { RichEditorSelection } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** - * Get the typing text style. + * Called when the content is selected. * - * @returns { RichEditorTextStyle } + * @returns { RichEditorSelection } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ - getTypingStyle(): RichEditorTextStyle; + getSelection(): RichEditorSelection; +} +/** + * Provides Controller for RichEditor with StyledString. + * + * @extends RichEditorBaseController + * @implements StyledStringController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare class RichEditorStyledStringController extends RichEditorBaseController implements StyledStringController { /** - * Set the typing text style. - * - * @param { RichEditorTextStyle } value - set the typing text style. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ - /** - * Set the typing text style. + * Set the StyledString of the RichEditor. * - * @param { RichEditorTextStyle } value - set the typing text style. + * @param { StyledString } styledString - StyledString. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice * @since 12 */ - setTypingStyle(value: RichEditorTextStyle): void; + setStyledString(styledString: StyledString): void; /** - * Text selection is achieved by specifying the start and end positions of the rich editor. + * Get the StyledString of the RichEditor. * - * @param { number } selectionStart - The start position of the selected text. - * @param { number } selectionEnd - The end position of the selected text. + * @returns { MutableStyledString } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ - /** - * Specify the start and end positions to select a range of content. - * - * @param { number } selectionStart - The start position of the selected text. - * @param { number } selectionEnd - The end position of the selected text. - * @param { SelectionOptions } [options] - Indicates the options of selection. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice * @since 12 */ - setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; + getStyledString(): MutableStyledString; /** - * Called when the content is selected. - * - * @returns { RichEditorSelection } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ - /** - * Called when the content is selected. + * Get the selection in the StyledString of the RichEditor. * - * @returns { RichEditorSelection } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - getSelection(): RichEditorSelection; - - /** - * Judge whether is in editing state - * - * @returns { boolean } - true is editing state, false is non editing status + * @returns { RichEditorRange } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ - isEditing(): boolean; + getSelection(): RichEditorRange; /** - * Stop editing state. - * + * Register content changed listener + * + * @param { StyledStringChangedListener } listener - content changed listener. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ - stopEditing(): void; + onContentChanged(listener: StyledStringChangedListener): void; } /** @@ -3214,6 +3343,18 @@ declare class RichEditorAttribute extends CommonMethod { */ enableDataDetector(enable: boolean): RichEditorAttribute; + /** + * Enable preview text. + * + * @param { boolean } enable - Enable preview text. + * @returns { RichEditorAttribute } The attribute of the rich editor. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + enablePreviewText(enable: boolean): RichEditorAttribute; + /** * Data detector with config. * @@ -3406,6 +3547,7 @@ declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => vo * @param { number } end - End offset of the selected content in rich editor. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type MenuOnAppearCallback = (start: number, end: number) => void; @@ -3446,6 +3588,17 @@ interface RichEditorInterface { * @since 11 */ (value: RichEditorOptions): RichEditorAttribute; + + /** + * Called when create RichEditor with StyledString. + * + * @param { RichEditorStyledStringOptions} options + * @returns { RichEditorAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + (options: RichEditorStyledStringOptions): RichEditorAttribute; } /** diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index eea13618f7a52c9d7a22534d6bf0c628ac6ee5ae..40f3184ee8e283aefb6962f341f0cb477b2f1412 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -262,6 +262,28 @@ declare interface ScrollEdgeOptions { velocity?: number; } +/** + * Define scrollToIndex options + * + * @interface ScrollToIndexOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare interface ScrollToIndexOptions { + /** + * The extra offset of scrolling to the index, unit is vp. + * + * @type { ?LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + extraOffset?: LengthMetrics; +} + /** * Provides custom animation parameters. * @@ -524,6 +546,7 @@ declare class Scroller { * @throws { BusinessError } 100004 - Controller not bound to component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ fling(velocity: number): void; @@ -552,15 +575,7 @@ declare class Scroller { * @atomicservice * @since 11 */ - /** - * Called when page turning mode is set. - * - * @param { ScrollPageOptions } value - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - scrollPage(value: ScrollPageOptions); + scrollPage(value: { next: boolean }); /** * Called when page turning mode is set. @@ -626,7 +641,19 @@ declare class Scroller { * @atomicservice * @since 11 */ - scrollToIndex(value: number, smooth?: boolean, align?: ScrollAlign); + /** + * Scroll to the specified index. + * + * @param { number } value - Index to jump to. + * @param { boolean } [smooth] - If true, scroll to index item with animation. If false, scroll to index item without animation. + * @param { ScrollAlign } [align] - Sets the alignment mode of a specified index. + * @param { options } [ScrollToIndexOptions] - Sets the options of a specified index, such as extra offset. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + scrollToIndex(value: number, smooth?: boolean, align?: ScrollAlign, options?: ScrollToIndexOptions); /** * Called when the setting slides by offset. @@ -708,35 +735,6 @@ declare class Scroller { getItemRect(index: number): RectResult; } -/* - * Define scroll page options - * @interface ScrollPageOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 12 - */ -declare interface ScrollPageOptions { - /** - * Control whether to scroll to the next page or the previous page. - * - * @type { boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - next: boolean; - - /** - * Set whether the scrollPage have animate. - * - * @type { ?boolean } - * @default false - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - animation?: boolean; -} - /** * Define scroll snap options * @@ -976,15 +974,13 @@ declare class ScrollAttribute extends ScrollableCommonMethod { /** * Called when the Scroll will scroll. * - * @param { ScrollOnScrollCallback } handler - callback of Scroll, - * xOffset and yOffset are offsets this frame will scroll, which may or may not be reached. - * scrollState is current scroll state. + * @param { ScrollOnWillScrollCallback } handler - callback of Scroll * @returns { ScrollAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ - onWillScroll(handler: ScrollOnScrollCallback): ScrollAttribute; + onWillScroll(handler: ScrollOnWillScrollCallback): ScrollAttribute; /** * Called when the Scroll did scroll. @@ -1357,15 +1353,36 @@ declare class ScrollAttribute extends ScrollableCommonMethod { initialOffset(value: OffsetOptions): ScrollAttribute; } - /** - * callback of Scroll, using in onWillScroll and onDidScroll. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ +/** + * callback of Scroll, using in onDidScroll. + * + * @typedef { function } ScrollOnScrollCallback + * @param { number } xOffset - horizontal offset this frame did scroll. + * @param { number } yOffset - vertical offset this frame did scroll. + * @param { ScrollState } scrollState - current scroll state. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ declare type ScrollOnScrollCallback = (xOffset: number, yOffset: number, scrollState: ScrollState) => void; +/** + * Called before scroll to allow developer to control real offset the Scroll can scroll. + * + * @typedef { function } ScrollOnWillScrollCallback + * @param { number } xOffset - horizontal offset this frame will scroll, which may or may not be reached. + * @param { number } yOffset - vertical offset this frame will scroll, which may or may not be reached. + * @param { ScrollState } scrollState - current scroll state. + * @param { ScrollSource } scrollSource - source of current scroll. + * @returns { void | OffsetResult } the remain offset for the Scroll, + * same as (xOffset, yOffset) when no OffsetResult is returned. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare type ScrollOnWillScrollCallback = + (xOffset: number, yOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | OffsetResult; + /** * Defines Scroll Component. * diff --git a/api/@internal/component/ets/search.d.ts b/api/@internal/component/ets/search.d.ts index 962a05607fd6a6de199e444950c98d21561e64d2..b5c8a8ce1e78a64906ebad4905a1bb34be684ea5 100644 --- a/api/@internal/component/ets/search.d.ts +++ b/api/@internal/component/ets/search.d.ts @@ -494,63 +494,6 @@ interface IconOptions { src?: ResourceStr; } -/** - * Defines the cursor style - * - * @interface CaretStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ -/** - * Defines the cursor style - * - * @interface CaretStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ -interface CaretStyle { - /** - * Set the cursor width - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * Set the cursor width - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - width?: Length, - - /** - * Set the cursor color - * - * @type { ?ResourceColor } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * Set the cursor color - * - * @type { ?ResourceColor } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - color?: ResourceColor, -} - /** * Defines the SearchButton options * diff --git a/api/@internal/component/ets/styled_string.d.ts b/api/@internal/component/ets/styled_string.d.ts index 4039046fdca1ee003c145637cf5a27841ca3a7b0..f6553f2590d7eeecf22483de2dd6ac5f639247be 100644 --- a/api/@internal/component/ets/styled_string.d.ts +++ b/api/@internal/component/ets/styled_string.d.ts @@ -398,6 +398,7 @@ declare class DecorationStyle { * @interface DecorationStyleInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface DecorationStyleInterface { @@ -407,6 +408,7 @@ declare interface DecorationStyleInterface { * @type { TextDecorationType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ type: TextDecorationType; @@ -417,6 +419,7 @@ declare interface DecorationStyleInterface { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ color?: ResourceColor; @@ -427,6 +430,7 @@ declare interface DecorationStyleInterface { * @type { ?TextDecorationStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ style?: TextDecorationStyle; diff --git a/api/@internal/component/ets/swiper.d.ts b/api/@internal/component/ets/swiper.d.ts index 4355989ab269c7017051b65267429b5fc2712ea8..a7ba5da0cc2753c53e96fd6ef14c7c5e5e24dace 100644 --- a/api/@internal/component/ets/swiper.d.ts +++ b/api/@internal/component/ets/swiper.d.ts @@ -1728,18 +1728,7 @@ declare class SwiperAttribute extends CommonMethod { * @atomicservice * @since 11 */ - /** - * When the previous item is empty, do not display blank space. - * - * @param { Length } value - The length of previous margin. - * @param { boolean } [ignoreBlank] - Ignoring blank space at the end of the page. - * @returns { SwiperAttribute } The attribute of the swiper. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - prevMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; + prevMargin(value: Length): SwiperAttribute; /** * The next margin which can be used to expose a small portion of the latter item. @@ -1759,18 +1748,7 @@ declare class SwiperAttribute extends CommonMethod { * @atomicservice * @since 11 */ - /** - * When the next item is empty, do not display blank space. - * - * @param { Length } value - The length of next margin. - * @param { boolean } [ignoreBlank] - Ignoring blank space on homepage. - * @returns { SwiperAttribute } The attribute of the swiper. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ - nextMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; + nextMargin(value: Length): SwiperAttribute; /** * Called when the swiper animation start. diff --git a/api/@internal/component/ets/tabs.d.ts b/api/@internal/component/ets/tabs.d.ts index 95cbcfa6d9af569391d24ce428dcf399656bfad2..3c0acb0be47d4d89dfbd251f4622d1d5e6cf8826 100644 --- a/api/@internal/component/ets/tabs.d.ts +++ b/api/@internal/component/ets/tabs.d.ts @@ -90,6 +90,47 @@ declare enum BarMode { Fixed = 1, } +/** + * Declare the animation mode of tab content. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare enum AnimationMode { + /** + * Start animation after tabcontent is fully measured. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + CONTENT_FIRST = 0, + + /** + * Start animation before tabcontent is fully measured. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + ACTION_FIRST = 1, + + /** + * Disable default animation. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + NO_ANIMATION = 2, +} + /** * Declare the location of the bar chart. * @@ -1013,6 +1054,18 @@ declare class TabsAttribute extends CommonMethod { */ animationDuration(value: number): TabsAttribute; + /** + * Set animation mode. + * + * @param { Optional } mode - animation mode for tabs switch animation + * @returns { TabsAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + animationMode(mode: Optional): TabsAttribute; + /** * Called when the tab is switched. * diff --git a/api/@internal/component/ets/text.d.ts b/api/@internal/component/ets/text.d.ts index af1e0d49650308dbbb1236240b14715671628cc4..18a6c0f94e5fac4a0644cdec8cfbbf8d331248b8 100644 --- a/api/@internal/component/ets/text.d.ts +++ b/api/@internal/component/ets/text.d.ts @@ -1051,28 +1051,6 @@ declare class TextAttribute extends CommonMethod { */ fontFeature(value: string): TextAttribute; - /** - * Set the marquee options. - * - * @param { Optional } value - * @returns { TextAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - marqueeOptions(value: Optional): TextAttribute; - - /** - * Called when the text marquee state changes. - * - * @param { Callback } callback - callback of the marquee state change event. - * @returns { TextAttribute } returns the instance of the TextAttribute. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - onMarqueeStateChange(callback: Callback): TextAttribute; - /** * Whether to support sensitive privacy information * @@ -1289,71 +1267,6 @@ declare enum TextResponseType { SELECT = 2, } -/** - * Defines marquee state. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ -declare enum MarqueeState { - /** - * The marquee started. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - START = 0, - - /** - * The marquee a round finished and start next round. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - BOUNCE = 1, - - /** - * The marquee all finished. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - FINISH = 2, -} - -/** - * Defines marquee start policy. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ -declare enum MarqueeStartPolicy { - /** - * Start marquee in any case. This is the default policy. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - DEFAULT = 0, - - /** - * Start marquee only when get focus. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - ON_FOCUS = 1, -} - /** * Defines the options of Text. * @@ -1392,86 +1305,6 @@ declare interface TextOptions { controller: TextController; } -/** - * Defines the marquee options. - * - * @interface MarqueeOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ -declare interface MarqueeOptions { - /** - * Is need start marquee. - * - * @type { boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - start: boolean; - - /** - * The step size of the marquee. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - step?: number; - - /** - * The rounds of the marquee. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - loop?: number; - - /** - * The running direction of the marquee. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - fromStart?: boolean; - - /** - * The waiting time between each round of the marquee. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - delay?: number; - - /** - * Set whether the text is faded out. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - fadeout?: boolean; - - /** - * The start policy for marquee. - * - * @type { ?MarqueeStartPolicy } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - marqueeStartPolicy?: MarqueeStartPolicy; -} - /** * Defines the controller of Text. * diff --git a/api/@internal/component/ets/text_common.d.ts b/api/@internal/component/ets/text_common.d.ts index 4a8b1058ca045ff914e7a021fdeedbaab539281a..ab1e83dd7546d082b952300b1cb1ebe8cd331fb3 100644 --- a/api/@internal/component/ets/text_common.d.ts +++ b/api/@internal/component/ets/text_common.d.ts @@ -189,3 +189,242 @@ declare interface TextRange { * @since 12 */ declare type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRange) => void; + +/** + * Define the text selection controller. + * + * @interface TextBaseController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare interface TextBaseController { + /** + * Set selection to select a range of content. + * + * @param { number } selectionStart - The start position of the selected text. + * @param { number } selectionEnd - The end position of the selected text. + * @param { SelectionOptions } [options] - Indicates the options of selection. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; + + /** + * Close the select menu when menu is on. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + closeSelectionMenu(): void; +} + +/** + * Define the text extended editing controller. + * + * @interface TextEditControllerEx + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare interface TextEditControllerEx extends TextBaseController { + /** + * Judge whether is in editing state + * + * @returns { boolean } - true means that the component is in editing state, false means is non in editing status + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + isEditing(): boolean; + + /** + * Stop editing state. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + stopEditing(): void; + + /** + * Set caret offset. + * + * @param { number } offset - caret offset. + * @returns { boolean } - Return true if the caret offset was successfully set, false otherwise. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + setCaretOffset(offset: number): boolean; + + /** + * Get caret offset from controller. + * + * @returns { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getCaretOffset(): number; +} + +/** + * Define the StyledString controller. + * + * @interface StyledStringController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare interface StyledStringController { + /** + * Set the StyledString of the component. + * + * @param { StyledString } styledString - StyledString. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + setStyledString(styledString: StyledString): void; + + /** + * Get the StyledString of the component. + * + * @returns { MutableStyledString } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + getStyledString(): MutableStyledString; +} + +/** + * Define the StyledString changed listener. + * + * @interface StyledStringChangedListener + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +declare interface StyledStringChangedListener { + /** + * Called before text changed. + * + * @type { ?Callback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + onWillChange?: Callback; + + /** + * Called after text changed. + * + * @type { ?OnDidChangeCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + onDidChange?: OnDidChangeCallback; +} + +/** + * Define the StyledString changed value. + * + * @interface StyledStringChangeValue + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +interface StyledStringChangeValue { + /** + * Range of the content to be replaced. + * + * @type { TextRange } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + range: TextRange; + + /** + * StyledString to replace. + * + * @type { StyledString } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + replacementString: StyledString; + + /** + * Preview StyledString + * + * @type { ?StyledString } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + previewText?: StyledString; +} + +/** + * Defines the cursor style + * + * @interface CaretStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Defines the cursor style + * + * @interface CaretStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +interface CaretStyle { + /** + * Set the cursor width + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ + /** + * Set the cursor width + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ + width?: Length, + + /** + * Set the cursor color + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ + /** + * Set the cursor color + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ + color?: ResourceColor, +} diff --git a/api/@internal/component/ets/text_input.d.ts b/api/@internal/component/ets/text_input.d.ts index 772add21ecc519634e6a9fbba5a9889719355d75..9a710dc56b9a3648a068d204eb1b4774b68e8f4c 100644 --- a/api/@internal/component/ets/text_input.d.ts +++ b/api/@internal/component/ets/text_input.d.ts @@ -184,7 +184,7 @@ declare enum InputType { */ SCREEN_LOCK_PASSWORD = 9, - /** + /* * UserName entry mode. * * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -470,7 +470,7 @@ declare enum EnterKeyType { * @atomicservice * @since 11 */ - Go, + Go = 2, /** * Search. @@ -493,7 +493,7 @@ declare enum EnterKeyType { * @atomicservice * @since 11 */ - Search, + Search = 3, /** * Send. @@ -516,7 +516,7 @@ declare enum EnterKeyType { * @atomicservice * @since 11 */ - Send, + Send = 4, /** * Next. @@ -539,7 +539,7 @@ declare enum EnterKeyType { * @atomicservice * @since 11 */ - Next, + Next = 5, /** * Done. @@ -562,7 +562,7 @@ declare enum EnterKeyType { * @atomicservice * @since 11 */ - Done, + Done = 6, /** * Showed as 'previous' pattern. @@ -1032,44 +1032,6 @@ interface TextInputInterface { (value?: TextInputOptions): TextInputAttribute; } -/** - * CaretStyle object. - * - * @interface CaretStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ -/** - * CaretStyle object. - * - * @interface CaretStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ -interface CaretStyle { - /** - * Define the cursor width of CaretStyle. - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * Define the cursor width of CaretStyle. - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - width?: Length; -} - /** * PasswordIcon object. * @@ -2274,6 +2236,15 @@ declare class TextInputAttribute extends CommonMethod { * @atomicservice * @since 12 */ + /** + * Sets whether enable auto fill or not. + * + * @param { boolean } value - Indicates the flag whether autofill is enabled. + * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 12 + */ enableAutoFill(value: boolean): TextInputAttribute; /** diff --git a/api/@internal/component/ets/time_picker.d.ts b/api/@internal/component/ets/time_picker.d.ts index e69b665e108b5d2b5d3545ea4977393ebfb883ae..439cbf95d9db27425e0b6c61f13781b1f4a6f042 100644 --- a/api/@internal/component/ets/time_picker.d.ts +++ b/api/@internal/component/ets/time_picker.d.ts @@ -466,16 +466,6 @@ declare class TimePickerAttribute extends CommonMethod { * @since 11 */ onChange(callback: (value: TimePickerResult) => void): TimePickerAttribute; - - /** - * Enable or disable haptic feedback. - * - * @param { boolean } enable - Default value is true, set false to disable haptic feedback. - * @returns { TimePickerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 12 - */ - enableHapticFeedback(enable: boolean): TimePickerAttribute; } /** diff --git a/api/@internal/component/ets/units.d.ts b/api/@internal/component/ets/units.d.ts index 9a06d7549b246e2c6e1554b9fe5456246c6d11b1..9dec8ff3b139c950819d5cc5fb0e9c10c0e19fbc 100644 --- a/api/@internal/component/ets/units.d.ts +++ b/api/@internal/component/ets/units.d.ts @@ -2238,6 +2238,16 @@ declare interface LocalizedEdges { * @since 11 * @form */ +/** + * Defines the Bias. + * + * @interface Bias + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ declare interface Bias { /** * Horizontal ratio of the Bias, it must be >= 0. diff --git a/api/@internal/component/ets/video.d.ts b/api/@internal/component/ets/video.d.ts index a8ca90bcbf569d3bdfa58c7de655f1b63e9df8d1..8b2f7d5edd5c0abe763c5c6057db0943ac3077bb 100644 --- a/api/@internal/component/ets/video.d.ts +++ b/api/@internal/component/ets/video.d.ts @@ -624,6 +624,14 @@ declare class VideoController { * @since 11 */ setCurrentTime(value: number, seekMode: SeekMode); + + /** + * Provide the reset method of video playback. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + reset(): void; } /** diff --git a/api/@internal/component/ets/web.d.ts b/api/@internal/component/ets/web.d.ts index ec9d5f5d85ea8e70328d45fea11a250b085760df..d25c7c811977751540cac5f54b5590d583d93c6a 100644 --- a/api/@internal/component/ets/web.d.ts +++ b/api/@internal/component/ets/web.d.ts @@ -146,6 +146,17 @@ type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingDa */ type OnRenderProcessRespondingCallback = () => void; +/** +* The callback of ViewportFit Changed. + * + * @typedef {function} OnViewportFitChangedCallback + * @param {ViewportFit} viewportFit - details of OnViewportFitChangedCallback. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ +type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void; + /** * Enum type supplied to {@link getMessageLevel} for receiving the console log level of JavaScript. * @@ -2433,6 +2444,45 @@ declare enum RenderMode { SYNC_RENDER = 1, } +/** + * Defines the viewport-fit type, related to {@link ViewportFit}. + * + * @enum { number } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ +declare enum ViewportFit { + /** + * No effect - the whole web page is viewable(default) + * + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + AUTO = 0, + + /** + * The initial layout viewport and the visual viewport are set to the + * largest rectangle which is inscribe in the display of the device. + * + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + CONTAINS = 1, + + /** + * The initial layout viewport and the visual viewport are set to the + * circumscribe rectangle of the physical screen of the device. + * + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + COVER = 2, +} + /** * Defines the context menu param, related to {@link WebContextMenuParam} method. * @@ -3618,7 +3668,7 @@ declare class EventResult { /** * Set whether the event is consumed. - * + * * @param { boolean } result - True if the event is consumed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -7071,35 +7121,45 @@ declare class WebAttribute extends CommonMethod { enableNativeMediaPlayer(config: NativeMediaPlayerConfig): WebAttribute; /** - * Sets the enable window drag smooth for web. + * Triggered when render process not responding. * - * @param { boolean } mode - True if it needs to enable window drag smooth. + * @param { OnRenderProcessNotRespondingCallback } callback The triggered function when render process not responding. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @atomicservice * @since 12 */ - enableSmoothDragResize(mode: boolean): WebAttribute; + onRenderProcessNotResponding(callback: OnRenderProcessNotRespondingCallback): WebAttribute; /** - * Triggered when render process not responding. + * Triggered when the unresponsive render process becomes responsive. * - * @param { OnRenderProcessNotRespondingCallback } callback The triggered function when render process not responding. + * @param { OnRenderProcessRespondingCallback } callback The triggered function when the unresponsive render process becomes responsive. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @since 12 */ - onRenderProcessNotResponding(callback: OnRenderProcessNotRespondingCallback): WebAttribute; + onRenderProcessResponding(callback: OnRenderProcessRespondingCallback): WebAttribute; /** - * Triggered when the unresponsive render process becomes responsive. + * Set the custom text menu. * - * @param { OnRenderProcessRespondingCallback } callback The triggered function when the unresponsive render process becomes responsive. + * @param { Array } expandedMenuOptions - Customize text menu options. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @since 12 */ - onRenderProcessResponding(callback: OnRenderProcessRespondingCallback): WebAttribute; + selectionMenuOptions(expandedMenuOptions: Array): WebAttribute; + + /** + * Triggered when the viewport-fit meta is detected for web page. + * + * @param { OnViewportFitChangedCallback } callback - The callback for onViewportFitChanged. + * @returns { WebAttribute } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + onViewportFitChanged(callback: OnViewportFitChangedCallback): WebAttribute; } /** @@ -7207,3 +7267,41 @@ declare interface SslErrorEvent { */ isMainFrame: boolean; } + +/** + * Defines the menu item option. + * + * @interface ExpandedMenuItemOptions + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ +declare interface ExpandedMenuItemOptions { + /** + * Customize what the menu displays. + * + * @type { ResourceStr } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + content: ResourceStr; + /** + * Customize the icon before the menu displays content. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + startIcon?: ResourceStr; + /** + * Get the selected text information. + * + * @type { function } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + action: (selectedText: {plainText: string}) => void; +} diff --git a/api/@internal/component/ets/with_theme.d.ts b/api/@internal/component/ets/with_theme.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..1a9ba2ee52e5f7920e6160b88fc39326038a63a9 --- /dev/null +++ b/api/@internal/component/ets/with_theme.d.ts @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +/** + * CustomTheme. + * + * @typedef {import('../api/@ohos.arkui.theme').CustomTheme} CustomTheme + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare type CustomTheme = import('../api/@ohos.arkui.theme').CustomTheme; + +/** + * Defines the struct of WithThemeOptions. + * + * @interface WithThemeOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +declare interface WithThemeOptions { + /** + * Custom Theme. + * + * @type { ?CustomTheme } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: CustomTheme; + + /** + * Theme Color Mode. + * + * @type { ?ThemeColorMode } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + colorMode?: ThemeColorMode; +} + +/** +* Define the function of WithThemeInterface. +* +* @typedef { function } WithThemeInterface +* @param { WithThemeOptions } options +* @returns { WithThemeAttribute } withThemeAttribute object +* @syscap SystemCapability.ArkUI.ArkUI.Full +* @crossplatform +* @since 12 +*/ +declare type WithThemeInterface = (options: WithThemeOptions) => WithThemeAttribute; + +/** +* Defines the WithTheme attribute functions.. +* +* @syscap SystemCapability.ArkUI.ArkUI.Full +* @crossplatform +* @atomicservice +* @since 12 +*/ +declare class WithThemeAttribute { +} + +/** +* Defines WithTheme Logic Component. +* +* @syscap SystemCapability.ArkUI.ArkUI.Full +* @crossplatform +* @atomicservice +* @since 12 +*/ +declare const WithTheme: WithThemeInterface; + +/** +* Defines WithTheme Logic Component Instance. +* +* @syscap SystemCapability.ArkUI.ArkUI.Full +* @crossplatform +* @atomicservice +* @since 12 +*/ +declare const WithThemeInstance: WithThemeAttribute; \ No newline at end of file diff --git a/api/@internal/component/ets/xcomponent.d.ts b/api/@internal/component/ets/xcomponent.d.ts index b462b638d81fb7d792f7d98d378b9ecf8c1618f7..979857d2e430187e4050a790dde31bca436a3ab6 100644 --- a/api/@internal/component/ets/xcomponent.d.ts +++ b/api/@internal/component/ets/xcomponent.d.ts @@ -23,6 +23,7 @@ * * @interface SurfaceRect * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ declare interface SurfaceRect { @@ -31,6 +32,7 @@ declare interface SurfaceRect { * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ offsetX?: number; @@ -40,6 +42,7 @@ declare interface SurfaceRect { * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ offsetY?: number; @@ -49,6 +52,7 @@ declare interface SurfaceRect { * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ surfaceWidth: number; @@ -58,6 +62,7 @@ declare interface SurfaceRect { * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ surfaceHeight: number; @@ -68,6 +73,7 @@ declare interface SurfaceRect { * * @interface SurfaceRotationOptions * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ declare interface SurfaceRotationOptions { @@ -76,6 +82,7 @@ declare interface SurfaceRotationOptions { * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ lock?: boolean; @@ -92,6 +99,7 @@ declare interface SurfaceRotationOptions { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare class XComponentController { @@ -106,6 +114,7 @@ declare class XComponentController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ constructor(); @@ -123,6 +132,7 @@ declare class XComponentController { * @returns { string } The id of surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getXComponentSurfaceId(): string; @@ -140,6 +150,7 @@ declare class XComponentController { * @returns { Object } The context of native XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getXComponentContext(): Object; @@ -170,6 +181,7 @@ declare class XComponentController { * * @param { SurfaceRect } rect - The surface rectangle information. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ setXComponentSurfaceRect(rect: SurfaceRect): void; @@ -179,6 +191,7 @@ declare class XComponentController { * * @returns { SurfaceRect } The surface rectangle information. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ getXComponentSurfaceRect(): SurfaceRect; @@ -188,6 +201,7 @@ declare class XComponentController { * * @param { SurfaceRotationOptions } rotationOptions - The surface rotation options. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ setXComponentSurfaceRotation(rotationOptions: SurfaceRotationOptions): void; @@ -197,6 +211,7 @@ declare class XComponentController { * * @returns { Required } The surface rotation options result. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ getXComponentSurfaceRotation(): Required; @@ -206,6 +221,7 @@ declare class XComponentController { * * @param { string } surfaceId - The id of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ onSurfaceCreated(surfaceId: string): void; @@ -216,6 +232,7 @@ declare class XComponentController { * @param { string } surfaceId - The id of the surface created by XComponent. * @param { SurfaceRect } rect - The rectangle information of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ onSurfaceChanged(surfaceId: string, rect: SurfaceRect): void; @@ -225,6 +242,7 @@ declare class XComponentController { * * @param { string } surfaceId - The id of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ onSurfaceDestroyed(surfaceId: string): void; @@ -238,6 +256,7 @@ declare class XComponentController { * @throws { BusinessError } 110002 - Image analysis is currently being executed. * @throws { BusinessError } 110003 - Image analysis is stopped. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ startImageAnalyzer(config: ImageAnalyzerConfig): Promise; @@ -246,6 +265,7 @@ declare class XComponentController { * Stop image analyzer. * * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ stopImageAnalyzer(): void; @@ -264,6 +284,7 @@ declare class XComponentController { * @interface XComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ interface XComponentInterface { @@ -275,6 +296,15 @@ interface XComponentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ + /** + * Constructor parameters + * + * @param { object } value - Indicates the options of the xcomponent. + * @returns { XComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 12 + */ (value: { id: string; type: string; libraryname?: string; controller?: XComponentController }): XComponentAttribute; /** @@ -292,6 +322,7 @@ interface XComponentInterface { * @returns { XComponentAttribute } The attribute of the xcomponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ (value: { id: string; type: XComponentType; libraryname?: string; controller?: XComponentController }): XComponentAttribute; @@ -310,6 +341,7 @@ interface XComponentInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare class XComponentAttribute extends CommonMethod { @@ -328,6 +360,7 @@ declare class XComponentAttribute extends CommonMethod { * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ onLoad(callback: (event?: object) => void): XComponentAttribute; @@ -347,6 +380,7 @@ declare class XComponentAttribute extends CommonMethod { * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ onDestroy(event: () => void): XComponentAttribute; @@ -357,6 +391,7 @@ declare class XComponentAttribute extends CommonMethod { * @param { boolean } enable * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ enableAnalyzer(enable: boolean): XComponentAttribute; @@ -373,6 +408,7 @@ declare class XComponentAttribute extends CommonMethod { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare const XComponent: XComponentInterface; @@ -388,6 +424,7 @@ declare const XComponent: XComponentInterface; * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare const XComponentInstance: XComponentAttribute; diff --git a/api/@ohos.InputMethodExtensionAbility.d.ts b/api/@ohos.InputMethodExtensionAbility.d.ts index 19df89416a1608ed797169d3956ea6087a798db1..26739d0d1609fca91a59f0c460890d425eb346f4 100644 --- a/api/@ohos.InputMethodExtensionAbility.d.ts +++ b/api/@ohos.InputMethodExtensionAbility.d.ts @@ -42,8 +42,6 @@ export default class InputMethodExtensionAbility { * Called back when a input method extension is started for initialization. * * @param { Want } want - Indicates the want of created service extension. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @StageModelOnly * @since 9 @@ -53,7 +51,6 @@ export default class InputMethodExtensionAbility { /** * Called back before a input method extension is destroyed. * - * @throws { BusinessError } 401 - parameter error. Possible causes: Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @StageModelOnly * @since 9 diff --git a/api/@ohos.UiTest.d.ts b/api/@ohos.UiTest.d.ts index 7550416980ed5963d989334afd6072f4b4fbefc9..2c2fd36b155d7bb3237a6bc3cabbab267de499a9 100644 --- a/api/@ohos.UiTest.d.ts +++ b/api/@ohos.UiTest.d.ts @@ -1059,6 +1059,15 @@ declare interface Point { * @atomicservice * @since 11 */ +/** + * Represents the rectangle area on the device screen. + * + * @typedef Rect + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ declare interface Rect { /** * The x-coordinate of the top left corner of the rectangle. @@ -1075,6 +1084,15 @@ declare interface Rect { * @atomicservice * @since 11 */ + /** + * The x-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ readonly left: number; /** * The y-coordinate of the top left corner of the rectangle. @@ -1091,6 +1109,15 @@ declare interface Rect { * @atomicservice * @since 11 */ + /** + * The y-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ readonly top: number; /** * The x-coordinate at the bottom right corner of the rectangle. @@ -1107,6 +1134,15 @@ declare interface Rect { * @atomicservice * @since 11 */ + /** + * The x-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ readonly right: number; /** * The y-coordinate at the bottom right corner of the rectangle. @@ -1123,6 +1159,15 @@ declare interface Rect { * @atomicservice * @since 11 */ + /** + * The y-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ readonly bottom: number; } @@ -1516,6 +1561,14 @@ declare enum MouseButton { * @atomicservice * @since 11 */ +/** + * Describes the attribute requirements for the target Components. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ declare class On { /** * Specifies the text for the target Component. @@ -2036,6 +2089,15 @@ declare class On { * @since 11 * @test */ +/** + * Represents an Component of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + * @test + */ declare class Component { /** * Click this {@link Component}. @@ -2747,6 +2809,18 @@ declare class Component { * @since 11 * @test */ + /** + * Get the bounds rect of this {@link Component}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + * @test + */ getBounds(): Promise; /** @@ -2898,6 +2972,16 @@ declare class Component { * @since 11 * @test */ +/** + * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform + * coordinates-based UI actions,capture screen and so on. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + * @test + */ declare class Driver { /** * Create an {@link Driver} object. diff --git a/api/@ohos.abilityAccessCtrl.d.ts b/api/@ohos.abilityAccessCtrl.d.ts index 512f662203edb28043572b3123a88558d50ceb65..08184338e68410b7c5cac06d0b97e895f29ee0ef 100644 --- a/api/@ohos.abilityAccessCtrl.d.ts +++ b/api/@ohos.abilityAccessCtrl.d.ts @@ -115,7 +115,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @since 9 */ @@ -128,7 +128,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @since 9 */ @@ -140,7 +140,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @crossplatform * @since 10 @@ -153,7 +153,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice @@ -169,7 +169,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @crossplatform * @since 10 @@ -182,7 +182,7 @@ declare namespace abilityAccessCtrl { * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice @@ -198,7 +198,7 @@ declare namespace abilityAccessCtrl { * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @param { AsyncCallback } requestCallback Callback for the result from requesting permissions. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @since 9 @@ -211,7 +211,7 @@ declare namespace abilityAccessCtrl { * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @param { AsyncCallback } requestCallback Callback for the result from requesting permissions. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @crossplatform @@ -224,8 +224,8 @@ declare namespace abilityAccessCtrl { *
The context must belong to the Stage model and only supports UIAbilityContext and UIExtensionContext. * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @param { AsyncCallback } requestCallback Callback for the result from requesting permissions. - * @throws { BusinessError } 401 - The parameter check failed. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @crossplatform @@ -246,7 +246,7 @@ declare namespace abilityAccessCtrl { * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @returns { Promise } Returns result of requesting permissions. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @since 9 @@ -259,7 +259,7 @@ declare namespace abilityAccessCtrl { * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @returns { Promise } Returns result of requesting permissions. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @crossplatform @@ -273,7 +273,7 @@ declare namespace abilityAccessCtrl { * @param { Array } permissionList - Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @returns { Promise } Returns result of requesting permissions. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 12100001 - The parameter is invalid. The context is invalid when it does not belong to the application itself. + * @throws { BusinessError } 12100001 - Invalid Parameter. The context is invalid when it does not belong to the application itself. * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @crossplatform @@ -293,13 +293,13 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.GRANT_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the flags value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100003 - The specified permission does not exist. * @throws { BusinessError } 12100006 - The application specified by the tokenID is not allowed to be granted with the specified permission. * Either the application is a sandbox or the tokenID is from a remote device. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 8 @@ -317,13 +317,13 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.GRANT_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the flags value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100003 - The specified permission does not exist. * @throws { BusinessError } 12100006 - The application specified by the tokenID is not allowed to be granted with the specified permission. * Either the application is a sandbox or the tokenID is from a remote device. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 8 @@ -346,13 +346,13 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.REVOKE_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the flags value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100003 - The specified permission does not exist. * @throws { BusinessError } 12100006 - The application specified by the tokenID is not allowed to be revoked with the specified permission. * Either the application is a sandbox or the tokenID is from a remote device. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 8 @@ -370,13 +370,13 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.REVOKE_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the flags value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100003 - The specified permission does not exist. * @throws { BusinessError } 12100006 - The application specified by the tokenID is not allowed to be revoked with the specified permission. * Either the application is a sandbox or the tokenID is from a remote device. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 8 @@ -398,11 +398,11 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission specified below. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100003 - The specified permission does not exist. * @throws { BusinessError } 12100006 - The operation is not allowed. Either the application is a sandbox or the tokenID is from a remote device. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 8 @@ -419,10 +419,10 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission specified below. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The string size of permissionName is larger than 256, * or the status value is invalid. * @throws { BusinessError } 12100003 - The specified permission does not exist. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 12 @@ -438,9 +438,9 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission specified below. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The string size of permissionName is larger than 256. + * @throws { BusinessError } 12100001 - Invalid Parameter. The string size of permissionName is larger than 256. * @throws { BusinessError } 12100003 - The specified permission does not exist. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 12 @@ -468,9 +468,9 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.GET_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the permissionList is empty. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the permissionList is empty. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @syscap SystemCapability.Security.AccessToken * @systemapi * @since 12 @@ -492,10 +492,10 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.GET_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. - * @throws { BusinessError } 12100004 - The interface is called repeatedly with the same input. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100004 - The API is used repeatedly with the same input. * @throws { BusinessError } 12100005 - The registration time has exceeded the limitation. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -521,9 +521,9 @@ declare namespace abilityAccessCtrl { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.GET_SENSITIVE_PERMISSIONS". * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenIDs or permissionNames in the list are all invalid. - * @throws { BusinessError } 12100004 - The interface is not used together with "on". - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenIDs or permissionNames in the list are all invalid. + * @throws { BusinessError } 12100004 - The API is not used in pair with 'on'. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi diff --git a/api/@ohos.account.appAccount.d.ts b/api/@ohos.account.appAccount.d.ts index c5f5e24e1e07d310fb77b93db65d4e3dd7a351ca..5a9815243558f5b9ff678f588da2d46ebf40c29c 100644 --- a/api/@ohos.account.appAccount.d.ts +++ b/api/@ohos.account.appAccount.d.ts @@ -811,8 +811,6 @@ declare namespace appAccount { *
have gained the ohos.permission.GET_ALL_APP_ACCOUNTS permission. * * @returns { Promise> } Returns a list of application accounts. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.AppAccount * @since 9 diff --git a/api/@ohos.account.distributedAccount.d.ts b/api/@ohos.account.distributedAccount.d.ts index 5313c4da2c97d8125008e2f6327ea3c48abba827..1a32ca0a838d3d4b686bff8d508c3007019af9f0 100644 --- a/api/@ohos.account.distributedAccount.d.ts +++ b/api/@ohos.account.distributedAccount.d.ts @@ -89,8 +89,6 @@ declare namespace distributedAccount { * @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS or ohos.permission.GET_DISTRIBUTED_ACCOUNTS or ohos.permission.DISTRIBUTED_DATASYNC * @returns { Promise } The distributed information of the current OS account. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 diff --git a/api/@ohos.account.osAccount.d.ts b/api/@ohos.account.osAccount.d.ts index 9672b662fca63b02132e2a336a7c38e558f49790..850a2fdc958e924d2ff271951e613c57d9f890df 100644 --- a/api/@ohos.account.osAccount.d.ts +++ b/api/@ohos.account.osAccount.d.ts @@ -154,7 +154,8 @@ declare namespace osAccount { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300008 - Restricted Account. @@ -202,8 +203,6 @@ declare namespace osAccount { * Checks whether the function of supporting multiple OS accounts is enabled. * * @returns { Promise } Returns {@code true} if this function is enabled; returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -457,8 +456,6 @@ declare namespace osAccount { * Checks whether current OS account is testable. * * @returns { Promise } Returns {@code true} if this account is testable; returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -789,8 +786,6 @@ declare namespace osAccount { * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @returns { Promise } Returns the number of created OS accounts. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -835,8 +830,6 @@ declare namespace osAccount { * Get the local ID of the current OS account. * * @returns { Promise } Returns the local ID of the current account. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -986,8 +979,6 @@ declare namespace osAccount { * * @returns { Promise } Returns the maximum number of OS accounts that can be created. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. @@ -1110,8 +1101,6 @@ declare namespace osAccount { * @returns { Promise> } Returns a list of OS accounts. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. @@ -1157,8 +1146,6 @@ declare namespace osAccount { * Gets the local IDs of all activated OS accounts. * * @returns { Promise> } Returns all activated accounts. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -1301,7 +1288,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Returns information about the created OS account; returns {@code null} if the creation fails. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid type or domainInfo. @@ -1352,7 +1340,8 @@ declare namespace osAccount { * @returns { Promise } Returns information about the created OS account; returns {@code null} if the creation fails. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid type, domainInfo or options. @@ -1425,8 +1414,6 @@ declare namespace osAccount { * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @returns { Promise } Returns information about the current OS account; returns {@code null} if the query fails. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -1438,8 +1425,6 @@ declare namespace osAccount { * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.GET_LOCAL_ACCOUNTS * @returns { Promise } Returns information about the current OS account; returns {@code null} if the query fails. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 10 @@ -1541,8 +1526,6 @@ declare namespace osAccount { * * @returns { Promise } Returns the OS account type. The value can be {@link OsAccountType#ADMIN}, * {@link OsAccountType#NORMAL}, and {@link OsAccountType#GUEST}. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -1635,8 +1618,6 @@ declare namespace osAccount { * @permission ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS * @returns { Promise } Returns the DVID if obtained; returns an empty string if no OHOS account has logged in. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @since 9 @@ -2018,8 +1999,6 @@ declare namespace osAccount { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. @@ -2473,7 +2452,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Returns an executor property. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid request. * @throws { BusinessError } 12300003 - Account not found. @@ -2507,7 +2487,8 @@ declare namespace osAccount { * @returns { Promise } Returns an executor property. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid request. * @throws { BusinessError } 12300003 - Account not found. @@ -2591,7 +2572,8 @@ declare namespace osAccount { * @returns { Uint8Array } Returns a context ID for cancellation. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid challenge, authType or authTrustLevel. * @throws { BusinessError } 12300101 - Credential is incorrect. @@ -2626,7 +2608,8 @@ declare namespace osAccount { * @returns { Uint8Array } Returns a context ID for cancellation. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid challenge, authType, authTrustLevel or options. * @throws { BusinessError } 12300003 - Account not found. @@ -2691,7 +2674,8 @@ declare namespace osAccount { * @returns { Uint8Array } Returns a context ID for cancellation. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid challenge, authType or authTrustLevel. * @throws { BusinessError } 12300003 - Account not found. @@ -3542,7 +3526,8 @@ declare namespace osAccount { * @returns { Promise } Returns the added domain server config. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid server config parameters. @@ -3562,7 +3547,8 @@ declare namespace osAccount { * @returns { Promise } Returns void. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300212 - Server config not found. @@ -3581,7 +3567,8 @@ declare namespace osAccount { * @returns { Promise } Returns the domain server config. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300003 - Domain account not found. @@ -3641,8 +3628,7 @@ declare namespace osAccount { * @returns { Promise } Returns a challenge value. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. @@ -3658,7 +3644,7 @@ declare namespace osAccount { * @returns { Promise } Returns a challenge value. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300008 - Restricted account. @@ -3705,7 +3691,8 @@ declare namespace osAccount { * @param { IIdmCallback } callback - Indicates the callback to get results and acquireInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid credentialInfo, i.e. authType or authSubType. * @throws { BusinessError } 12300101 - Token is invalid. @@ -3751,7 +3738,8 @@ declare namespace osAccount { * @param { IIdmCallback } callback - Indicates the callback to get results and acquireInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid credentialInfo, i.e. authType or authSubType. * @throws { BusinessError } 12300003 - Account not found. @@ -3788,7 +3776,7 @@ declare namespace osAccount { * @param { number } [accountId] - Indicates the local ID of the OS account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300008 - Restricted account. @@ -3901,8 +3889,7 @@ declare namespace osAccount { * the specified type for the current user. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid authType. * @throws { BusinessError } 12300102 - Credential not enrolled. @@ -3921,7 +3908,7 @@ declare namespace osAccount { * according to the options. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid options. * @throws { BusinessError } 12300003 - Account not found. @@ -3940,7 +3927,8 @@ declare namespace osAccount { * @returns { Promise } Returns the enrolled identifier. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameters error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid authType. * @throws { BusinessError } 12300003 - Account not found. @@ -3986,7 +3974,7 @@ declare namespace osAccount { /** * Indicates the enumeration of the authentication intent. * - * @enum { number } ResultCode + * @enum { number } AuthIntent * @syscap SystemCapability.Account.OsAccount * @systemapi * @since 12 diff --git a/api/@ohos.advertising.AdComponent.d.ets b/api/@ohos.advertising.AdComponent.d.ets index 314ab050e0f46917b1790ca0075378ca373432fa..7e6ff81114514da280b95de81f2d403390e25d66 100644 --- a/api/@ohos.advertising.AdComponent.d.ets +++ b/api/@ohos.advertising.AdComponent.d.ets @@ -78,6 +78,14 @@ declare struct AdComponent { */ interactionListener: advertising.AdInteractionListener; + /** + * The builder param to render customized ad content. + * @type { ?() => void } + * @syscap SystemCapability.Advertising.Ads + * @since 12 + */ + @BuilderParam adRenderer?: () => void; + /** * The method to build ad component. * @syscap SystemCapability.Advertising.Ads diff --git a/api/@ohos.advertising.d.ts b/api/@ohos.advertising.d.ts index 75b4213d2694cb72b3241c56c554cb2e7378fcc7..e6a77beb36328ad662d13132f6b8a74aeae20d82 100644 --- a/api/@ohos.advertising.d.ts +++ b/api/@ohos.advertising.d.ts @@ -17,7 +17,7 @@ * @file Provides the capability to load and display advertisements * @kit AdsKit */ - +import type web_webview from './@ohos.web.webview'; import type common from './@ohos.app.ability.common'; import type { Advertisement as _Advertisement } from './advertising/advertisement'; @@ -480,10 +480,10 @@ declare namespace advertising { /** * Show the reward and interstitial ad. - * @param { Advertisement } ad - Indicates the advertisement content information. - * @param { AdDisplayOptions } options - Indicates interaction option object use to show the ad. + * @param { Advertisement } ad - Indicates the advertisement content information. ad is required. + * @param { AdDisplayOptions } options - Indicates interaction option object use to show the ad. options is required. * @param { common.UIAbilityContext } context - Indicates the ui ability context of the media application. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800004 - Failed to display the ad. * @syscap SystemCapability.Advertising.Ads @@ -491,10 +491,10 @@ declare namespace advertising { */ /** * Show the reward and interstitial ad. - * @param { Advertisement } ad - Indicates the advertisement content information. - * @param { AdDisplayOptions } options - Indicates interaction option object use to show the ad. + * @param { Advertisement } ad - Indicates the advertisement content information. ad is required. + * @param { AdDisplayOptions } options - Indicates interaction option object use to show the ad. options is required. * @param { common.UIAbilityContext } context - Indicates the ui ability context of the media application. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800004 - Failed to display the ad. * @syscap SystemCapability.Advertising.Ads @@ -532,10 +532,12 @@ declare namespace advertising { /** * Load ad. - * @param { AdRequestParams } adParam - Indicates the parameters in the request. + * @param { AdRequestParams } adParam - Indicates the parameters in the request. adParam.adId is required. + *
adParam.adType must be number and valid. adParam.adWidth and adParam.adHeight must be number and greater than zero * @param { AdOptions } adOptions - Indicates the ad options. * @param { AdLoadListener } listener - Indicates the listener to be registered that use to load ad. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800003 - Failed to load the ad request. * @syscap SystemCapability.Advertising.Ads @@ -543,10 +545,12 @@ declare namespace advertising { */ /** * Load ad. - * @param { AdRequestParams } adParam - Indicates the parameters in the request. + * @param { AdRequestParams } adParam - Indicates the parameters in the request. adParam.adId is required. + *
adParam.adType must be number and valid. adParam.adWidth and adParam.adHeight must be number and greater than zero * @param { AdOptions } adOptions - Indicates the ad options. * @param { AdLoadListener } listener - Indicates the listener to be registered that use to load ad. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800003 - Failed to load the ad request. * @syscap SystemCapability.Advertising.Ads @@ -557,10 +561,12 @@ declare namespace advertising { /** * Load ad with multi-slots. - * @param { AdRequestParams[] } adParams - Indicates the parameters in the request. + * @param { AdRequestParams[] } adParams - Indicates the parameters in the request. adParam.adId is required. + *
adParam.adType must be number and valid. adParam.adWidth and adParam.adHeight must be number and greater than zero * @param { AdOptions } adOptions - Indicates the ad options. * @param { MultiSlotsAdLoadListener } listener - Indicates the listener to be registered that use to load ad. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800003 - Failed to load the ad request. * @syscap SystemCapability.Advertising.Ads @@ -568,10 +574,12 @@ declare namespace advertising { */ /** * Load ad with multi-slots. - * @param { AdRequestParams[] } adParams - Indicates the parameters in the request. + * @param { AdRequestParams[] } adParams - Indicates the parameters in the request. adParam.adId is required. + *
adParam.adType must be number and valid. adParam.adWidth,adParam.adHeight must be number and greater than zero * @param { AdOptions } adOptions - Indicates the ad options. * @param { MultiSlotsAdLoadListener } listener - Indicates the listener to be registered that use to load ad. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed * @throws { BusinessError } 21800001 - System internal error. * @throws { BusinessError } 21800003 - Failed to load the ad request. * @syscap SystemCapability.Advertising.Ads @@ -580,6 +588,43 @@ declare namespace advertising { */ loadAdWithMultiSlots(adParams: AdRequestParams[], adOptions: AdOptions, listener: MultiSlotsAdLoadListener): void; } + + /** + * Get message body for ad requesting. + * @param { AdRequestParams[] } adParams - Indicates the parameters in the request. + * @param { AdOptions } adOptions - Indicates the ad options. + * @returns { Promise } The promise of ad request message body. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + * @throws { BusinessError } 21800001 - System internal error. + * @syscap SystemCapability.Advertising.Ads + * @since 12 + */ + function getAdRequestBody(adParams: AdRequestParams[], adOptions: AdOptions): Promise; + + /** + * Pass ad response message and parse into advertisements. + * @param { string } adResponse - Indicate the ad response message. + * @param { MultiSlotsAdLoadListener } listener - Indicates the listener to be registered that use to load ad. + * @param { common.UIAbilityContext } context - Indicates the ui ability context of the media application. + * @throws { BusinessError } 401 - Invalid input parameter.Possible causes: 1. Mandatory parameters are left unspecified. + * @throws { BusinessError } 21800001 - System internal error. + * @throws { BusinessError } 21800005 - Failed to parse the ad response. + * @syscap SystemCapability.Advertising.Ads + * @since 12 + */ + function parseAdResponse(adResponse: string, listener: MultiSlotsAdLoadListener, context: common.UIAbilityContext): void; + + /** + * Register ad javascript proxy interface into webview in order to enable web Ad. + * @param { web_webview.WebviewController } controller - Indicates webview controller to register ad javascript proxy interface. + * @param { common.UIAbilityContext } context - Indicates the ui ability context of the media application. + * @throws { BusinessError } 401 - Invalid input parameter. Possible causes: 1. Mandatory parameters are left unspecified. + * @throws { BusinessError } 21800001 - System internal error. + * @syscap SystemCapability.Advertising.Ads + * @atomicservice + * @since 12 + */ + function registerWebAdInterface(controller: web_webview.WebviewController, context: common.UIAbilityContext): void; } export default advertising; \ No newline at end of file diff --git a/api/@ohos.ai.mindSporeLite.d.ts b/api/@ohos.ai.mindSporeLite.d.ts index 639b78d775ee2b2d99d22ad5ddf13e80ee7cae86..afab866740a748ac687ba73f6296683dfd23ce10 100644 --- a/api/@ohos.ai.mindSporeLite.d.ts +++ b/api/@ohos.ai.mindSporeLite.d.ts @@ -43,7 +43,7 @@ declare namespace mindSporeLite { /** * Create a Model instance from file path. * @param { string } model - model indicates model path to be loaded - * @param { Callback } callback - the callback of model + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -54,8 +54,8 @@ declare namespace mindSporeLite { /** * Create a Model instance from file path. * @param { string } model - model indicates model path to be loaded - * @param { Context } context - context indicates model context information - * @param { Callback } callback - the callback of model + * @param { Context } [context] - context indicates model context information + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -67,7 +67,7 @@ declare namespace mindSporeLite { /** * Create a Model instance from buffer * @param { ArrayBuffer } model - model indicates model buffer to be loaded - * @param { Context } [context] - context indicates model context information + * @param { Context } context - context indicates model context information * @returns { Promise } the promise returned by the function. * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly @@ -80,7 +80,7 @@ declare namespace mindSporeLite { /** * Create a Model instance from buffer * @param { ArrayBuffer } model - model indicates model buffer to be loaded - * @param { Callback } callback - the callback of model + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -91,8 +91,8 @@ declare namespace mindSporeLite { /** * Create a Model instance from buffer * @param { ArrayBuffer } model - model indicates model buffer to be loaded - * @param { Context } context - context indicates model context information - * @param { Callback } callback - the callback of model + * @param { Context } [context] - context indicates model context information + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -104,7 +104,7 @@ declare namespace mindSporeLite { /** * Creates a Model instance file description * @param { number } model - model indicates model file description to be loaded - * @param { Context } [context] - context indicates model context information + * @param { Context } context - context indicates model context information * @returns { Promise } the promise returned by the function. * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly @@ -117,7 +117,7 @@ declare namespace mindSporeLite { /** * Create a Model instance from file description * @param { number } model - model indicates model file description to be loaded - * @param { Callback } callback - the callback of model + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -128,8 +128,8 @@ declare namespace mindSporeLite { /** * Create a Model instance from file description * @param { number } model - model indicates model file description to be loaded - * @param { Context } context - context indicates model context information - * @param { Callback } callback - the callback of model + * @param { Context } [context] - context indicates model context information + * @param { callback: Callback } callback - the callback of model * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -221,7 +221,7 @@ declare namespace mindSporeLite { /** * Infer model * @param { MSTensor[] } inputs - indicates the MSTensor array of the inputs. - * @param { Callback } callback - the callback of MSTensor array. + * @param { callback: Callback } callback - the callback of MSTensor array. * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -231,7 +231,7 @@ declare namespace mindSporeLite { /** * Infer model * @param { MSTensor[] } inputs - indicates the MSTensor array of the inputs. - * @returns { Promise } the promise returned by the function. + * @returns { Promise } the promise returned by the function. * @syscap SystemCapability.AI.MindSporeLite * @stagemodelonly * @since 10 @@ -428,28 +428,22 @@ declare namespace mindSporeLite { */ interface Context { /** - * The target device - * @type {?string[]} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The target device + * @type {string[]} + * @since 10 + */ target?: string[]; /** - * The cpu device information - * @type {?CpuDevice} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The cpu device information + * @type {CpuDevice} + * @since 10 + */ cpu?: CpuDevice; /** - * The NNRT device information - * @type {?NNRTDevice} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The NNRT device information + * @type {NNRTDevice} + * @since 10 + */ nnrt?: NNRTDevice; } @@ -462,36 +456,28 @@ declare namespace mindSporeLite { */ interface CpuDevice { /** - * The thread num - * @type {?number} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The thread num + * @type {number} + * @since 10 + */ threadNum?: number; /** - * The thread affinity mode - * @type {?ThreadAffinityMode} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The thread affinity mode + * @type {ThreadAffinityMode} + * @since 10 + */ threadAffinityMode?: ThreadAffinityMode; /** - * The thread affinity core list - * @type {?number[]} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The thread affinity core list + * @type {number[]} + * @since 10 + */ threadAffinityCoreList?: number[]; /** - * The precision mode - * @type {?string} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly - * @since 10 - */ + * The precision mode + * @type {string} + * @since 10 + */ precisionMode?: string; } @@ -741,7 +727,6 @@ declare namespace mindSporeLite { /** * Thread affinity mode is no bind. * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NO_AFFINITIES = 0, @@ -749,7 +734,6 @@ declare namespace mindSporeLite { /** * Thread affinity mode is big cores first * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ BIG_CORES_FIRST = 1, @@ -757,7 +741,6 @@ declare namespace mindSporeLite { /** * Thread affinity mode is little cores first * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ LITTLE_CORES_FIRST = 2, @@ -774,48 +757,36 @@ declare namespace mindSporeLite { /** * The name of the tensor. * @type {string} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ name: string; /** * The shape of the tensor. * @type {number[]} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ shape: number[]; /** * The number of elements in the tensor. * @type {number} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ elementNum: number; /** * The data size of the tensor. * @type {number} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ dataSize: number; /** * The data type of the tensor. * @type {DataType} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ dtype: DataType; /** * The format of the tensor. - * @type {Format} - * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly + * @type {DataType} * @since 10 */ format: Format; @@ -850,84 +821,72 @@ declare namespace mindSporeLite { /** * data type is unknown * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ TYPE_UNKNOWN = 0, /** * data type is int8 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_INT8 = 32, /** * data type is int16 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_INT16 = 33, /** * data type is int32 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_INT32 = 34, /** * data type is int64 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_INT64 = 35, /** * data type is uint8 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_UINT8 = 37, /** * data type is uint16 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_UINT16 = 38, /** * data type is uint32 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_UINT32 = 39, /** * data type is uint64 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_UINT64 = 40, /** * data type is float16 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_FLOAT16 = 42, /** * data type is float32 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_FLOAT32 = 43, /** * data type is float64 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NUMBER_TYPE_FLOAT64 = 44, @@ -944,49 +903,42 @@ declare namespace mindSporeLite { /** * data format is default * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ DEFAULT_FORMAT = -1, /** * data format is NCHW * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NCHW = 0, /** * data format is NHWC * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NHWC = 1, /** * data format is NHWC4 * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ NHWC4 = 2, /** * data format is HWKC * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ HWKC = 3, /** * data format is HWCK * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ HWCK = 4, /** * data format is KCHW * @syscap SystemCapability.AI.MindSporeLite - * @stagemodelonly * @since 10 */ KCHW = 5, diff --git a/api/@ohos.app.ability.UIExtensionContentSession.d.ts b/api/@ohos.app.ability.UIExtensionContentSession.d.ts index 827c0aaa7684dcd1d59af3b09f5265fe517c5643..096ca79d537158a4bc586192481985c210a02839 100644 --- a/api/@ohos.app.ability.UIExtensionContentSession.d.ts +++ b/api/@ohos.app.ability.UIExtensionContentSession.d.ts @@ -31,7 +31,7 @@ import type uiExtension from './@ohos.arkui.uiExtension'; * class of ui extension content session. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ export default class UIExtensionContentSession { @@ -45,7 +45,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ /** @@ -58,7 +58,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ sendData(data: Record): void; @@ -73,7 +73,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ setReceiveDataCallback(callback: (data: Record) => void): void; @@ -88,7 +88,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ setReceiveDataForResultCallback(callback: (data: Record) => Record): void; @@ -102,7 +102,7 @@ export default class UIExtensionContentSession { * 2. Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ loadContent(path: string, storage?: LocalStorage): void; @@ -138,7 +138,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -173,7 +173,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbility(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -210,7 +210,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbility(want: Want, options?: StartOptions): Promise; @@ -246,7 +246,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ startAbilityAsCaller(want: Want, callback: AsyncCallback): void; @@ -281,7 +281,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ startAbilityAsCaller(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -318,7 +318,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ startAbilityAsCaller(want: Want, options?: StartOptions): Promise; @@ -354,7 +354,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbilityForResult(want: Want, callback: AsyncCallback): void; @@ -389,7 +389,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -426,7 +426,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ startAbilityForResult(want: Want, options?: StartOptions): Promise; @@ -438,7 +438,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ terminateSelf(callback: AsyncCallback): void; @@ -448,7 +448,7 @@ export default class UIExtensionContentSession { * * @returns { Promise } The promise returned by the function. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ terminateSelf(): Promise; @@ -461,7 +461,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; @@ -474,7 +474,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ terminateSelfWithResult(parameter: AbilityResult): Promise; @@ -489,7 +489,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 10 */ setWindowBackgroundColor(color: string): void; @@ -505,7 +505,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ setWindowPrivacyMode(isPrivacyMode: boolean): Promise; @@ -521,7 +521,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 10 */ setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback): void; @@ -544,9 +544,23 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Starts the UIAbility or UIExtensionAbility by type. + * + * @param { string } type - The type of target ability. + * @param { Record } wantParam - Indicates the want parameter. + * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. + * @param { AsyncCallback } callback - The callback of startAbility. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 16000050 - Internal error. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @since 12 + */ startAbilityByType(type: string, wantParam: Record, abilityStartCallback: AbilityStartCallback, callback: AsyncCallback): void; @@ -568,9 +582,23 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Starts the UIAbility or UIExtensionAbility by type. + * + * @param { string } type - The type of target ability. + * @param { Record } wantParam - Indicates the want parameter. + * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 16000050 - Internal error. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @since 12 + */ startAbilityByType(type: string, wantParam: Record, abilityStartCallback: AbilityStartCallback): Promise; @@ -582,7 +610,7 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ getUIExtensionHostWindowProxy(): uiExtensionHost.UIExtensionHostWindowProxy; @@ -593,7 +621,7 @@ export default class UIExtensionContentSession { * @returns { uiExtension.WindowProxy } Returns the UIExtension Window proxy. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly + * @stagemodelonly * @since 12 */ getUIExtensionWindowProxy(): uiExtension.WindowProxy; diff --git a/api/@ohos.app.ability.autoFillManager.d.ts b/api/@ohos.app.ability.autoFillManager.d.ts index 75c5b2280fe17b6ab41bf42541c226f35a5437e9..464735b110fb6853d3fe88387891af749c7ec4c9 100644 --- a/api/@ohos.app.ability.autoFillManager.d.ts +++ b/api/@ohos.app.ability.autoFillManager.d.ts @@ -32,35 +32,69 @@ import { PopupPlacement } from './application/AutoFillPopupConfig'; * * @namespace autoFillManager * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @StageModelOnly + * @stagemodelonly * @since 11 */ +/** + * This module provides the function of auto fill manager. + * + * @namespace autoFillManager + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @atomicservice + * @since 12 + */ declare namespace autoFillManager { /** * Auto save callback. * * @interface AutoSaveCallback * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Auto save callback. + * + * @interface AutoSaveCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @atomicservice + * @since 12 + */ export interface AutoSaveCallback { /** * Called when auto save request is successfully handled. * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Called when auto save request is successfully handled. + * + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @atomicservice + * @since 12 + */ onSuccess(): void; /** * Called when auto save request is failed to be handled. * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Called when auto save request is failed to be handled. + * + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @atomicservice + * @since 12 + */ onFailure(): void; } @@ -69,12 +103,26 @@ declare namespace autoFillManager { * * @param { UIContext } context - Indicates the ui context where the save operation will be performed. * @param { AutoSaveCallback } [callback] - Indicates the callback that used to receive the result. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Get instance id failed; + *
2. Parse instance id failed; 3. The second parameter is not of type callback. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * Trigger an auto save request. + * + * @param { UIContext } context - Indicates the ui context where the save operation will be performed. + * @param { AutoSaveCallback } [callback] - Indicates the callback that used to receive the result. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Get instance id failed; + *
2. Parse instance id failed; 3. The second parameter is not of type callback. + * @throws { BusinessError } 16000050 - Internal error. + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @atomicservice + * @since 12 + */ export function requestAutoSave(context: UIContext, callback?: AutoSaveCallback): void; /** @@ -82,9 +130,19 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of view data. + * + * @typedef { _ViewData.default } ViewData + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type ViewData = _ViewData.default; /** @@ -92,9 +150,19 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of page node info. + * + * @typedef { _PageNodeInfo.default } PageNodeInfo + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type PageNodeInfo = _PageNodeInfo.default; /** @@ -102,9 +170,18 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The enum of auto fill type. + * + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export { AutoFillType }; /** @@ -112,9 +189,19 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of fill request. + * + * @typedef { _AutoFillRequest.FillRequest } FillRequest + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type FillRequest = _AutoFillRequest.FillRequest; /** @@ -122,17 +209,29 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of save request. + * + * @typedef { _AutoFillRequest.SaveRequest } SaveRequest + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type SaveRequest = _AutoFillRequest.SaveRequest; /** * The interface of update request. * + * @typedef { _AutoFillRequest.UpdateRequest } UpdateRequest * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly + * @atomicservice * @since 12 */ export type UpdateRequest = _AutoFillRequest.UpdateRequest; @@ -142,9 +241,19 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of fill response. + * + * @typedef { _AutoFillRequest.FillResponse } FillResponse + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type FillResponse = _AutoFillRequest.FillResponse; /** @@ -152,9 +261,19 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of fill request callback. + * + * @typedef { _AutoFillRequest.FillRequestCallback } FillRequestCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type FillRequestCallback = _AutoFillRequest.FillRequestCallback; /** @@ -162,17 +281,29 @@ declare namespace autoFillManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ + /** + * The interface of save request callback. + * + * @typedef { _AutoFillRequest.SaveRequestCallback } SaveRequestCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @atomicservice + * @since 12 + */ export type SaveRequestCallback = _AutoFillRequest.SaveRequestCallback; /** * Auto fill rectangle. * + * @typedef { _AutoFillRect.default } AutoFillRect * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly + * @atomicservice * @since 12 */ export type AutoFillRect = _AutoFillRect.default; @@ -184,6 +315,7 @@ declare namespace autoFillManager { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi * @stagemodelonly + * @atomicservice * @since 12 */ export type AutoFillPopupConfig = _AutoFillPopupConfig.default; @@ -195,6 +327,7 @@ declare namespace autoFillManager { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi * @stagemodelonly + * @atomicservice * @since 12 */ export type PopupSize = _AutoFillPopupConfig.PopupSize; @@ -205,6 +338,7 @@ declare namespace autoFillManager { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi * @stagemodelonly + * @atomicservice * @since 12 */ export { PopupPlacement }; diff --git a/api/@ohos.app.ability.autoStartupManager.d.ts b/api/@ohos.app.ability.autoStartupManager.d.ts index 3f8af935fc1f68aa7daed02e6ae52f7aa10ffeb4..94a697f0bac6395de37ff13f8196aea4bb37284c 100644 --- a/api/@ohos.app.ability.autoStartupManager.d.ts +++ b/api/@ohos.app.ability.autoStartupManager.d.ts @@ -40,7 +40,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -58,7 +59,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -76,7 +78,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000013 - The application is controlled by EDM. * @throws { BusinessError } 16000050 - Internal error. @@ -96,7 +99,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000013 - The application is controlled by EDM. * @throws { BusinessError } 16000050 - Internal error. @@ -116,7 +120,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000013 - The application is controlled by EDM. * @throws { BusinessError } 16000050 - Internal error. @@ -136,7 +141,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000013 - The application is controlled by EDM. * @throws { BusinessError } 16000050 - Internal error. @@ -156,7 +162,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -173,7 +180,8 @@ declare namespace autoStartupManager { * @throws { BusinessError } 201 - Permission denied, interface caller does not have permission * "ohos.permission.MANAGE_APP_BOOT". * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi diff --git a/api/@ohos.app.ability.dialogSession.d.ts b/api/@ohos.app.ability.dialogSession.d.ts index 1a06a1446e66405938b0c0d49d693a0b4baa226a..6ab936aa5b247c3e9b4e93619186732b8b9b57ae 100644 --- a/api/@ohos.app.ability.dialogSession.d.ts +++ b/api/@ohos.app.ability.dialogSession.d.ts @@ -119,6 +119,17 @@ declare namespace dialogSession { * @since 11 */ bundleLabelId: number; + + /** + * The ability is visible + * + * @type { boolean } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ + visible: boolean; } /** diff --git a/api/@ohos.app.appstartup.StartupTask.d.ets b/api/@ohos.app.appstartup.StartupTask.d.ets index c53b5fa83da5300a0c23aeb75f01a33759e1614f..58d90b744b2b3c6b7a46d1fdebc8142044dfe809 100755 --- a/api/@ohos.app.appstartup.StartupTask.d.ets +++ b/api/@ohos.app.appstartup.StartupTask.d.ets @@ -33,22 +33,22 @@ export default class StartupTask { * Called when specific dependent task complete. * * @param { string } dependency - Indicates name of specific dependent startup task. - * @param { ESObject } result - Indicates result of specific dependent startup task. + * @param { Object } result - Indicates result of specific dependent startup task. * @syscap SystemCapability.Ability.AppStartup * @stagemodelonly * @since 12 */ - onDependencyCompleted?(dependency: string, result: ESObject): void; + onDependencyCompleted?(dependency: string, result: Object): void; /** * Initializes current startup task. * A developer could override this function to init current task and return a result for other tasks. * * @param { AbilityStageContext } context - Indicates ability stage context. - * @returns { Promise } The result of initialization. + * @returns { Promise } The result of initialization. * @syscap SystemCapability.Ability.AppStartup * @stagemodelonly * @since 12 */ - init(context: AbilityStageContext): Promise; + init(context: AbilityStageContext): Promise; } diff --git a/api/@ohos.app.form.formAgent.d.ts b/api/@ohos.app.form.formAgent.d.ts index 446955dc175298f7f16a547e72971adf7af8792f..d9723e72e1345af990d2714e5545b5b07401b693 100644 --- a/api/@ohos.app.form.formAgent.d.ts +++ b/api/@ohos.app.form.formAgent.d.ts @@ -38,7 +38,8 @@ declare namespace formAgent { * @param { Want } want - The want of the form to publish. * @param { AsyncCallback } callback - The callback is used to return the form id. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -46,6 +47,23 @@ declare namespace formAgent { * @systemapi * @since 11 */ + /** + * Request to publish a form to the form host. + * + * @permission ohos.permission.AGENT_REQUIRE_FORM + * @param { Want } want - The want of the form to publish. + * @param { AsyncCallback } callback - The callback is used to return the form id. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501008 - Waiting for the form addition to the desktop timed out. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 12 + */ function requestPublishForm(want: Want, callback: AsyncCallback): void; /** @@ -55,7 +73,8 @@ declare namespace formAgent { * @param { Want } want - The want of the form to publish. * @returns { Promise } Returns the form id. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -63,6 +82,23 @@ declare namespace formAgent { * @systemapi * @since 11 */ + /** + * Request to publish a form to the form host. + * + * @permission ohos.permission.AGENT_REQUIRE_FORM + * @param { Want } want - The want of the form to publish. + * @returns { Promise } Returns the form id. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501008 - Waiting for the form addition to the desktop timed out. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 12 + */ function requestPublishForm(want: Want): Promise; } export default formAgent; diff --git a/api/@ohos.app.form.formBindingData.d.ts b/api/@ohos.app.form.formBindingData.d.ts index dc6b13b3f13c64b604d119c2121c0127ab448547..d7b279e54b111317718e6707fda1e6fe50ee6f53 100644 --- a/api/@ohos.app.form.formBindingData.d.ts +++ b/api/@ohos.app.form.formBindingData.d.ts @@ -41,7 +41,8 @@ declare namespace formBindingData { * * @param { Object | string } [obj] - Indicates the FormBindingData instance data. * @returns { FormBindingData } Returns the FormBindingData. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @since 9 */ @@ -50,7 +51,8 @@ declare namespace formBindingData { * * @param { Object | string } [obj] - Indicates the FormBindingData instance data. * @returns { FormBindingData } Returns the FormBindingData. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 diff --git a/api/@ohos.app.form.formHost.d.ts b/api/@ohos.app.form.formHost.d.ts index d92c0b6dca2d4f53ec84b7436fb281801e96c685..6911d97e5cbfb5d018ac7a167e1c09fb91348e7a 100644 --- a/api/@ohos.app.form.formHost.d.ts +++ b/api/@ohos.app.form.formHost.d.ts @@ -41,9 +41,10 @@ declare namespace formHost { * @returns { Promise } Return the form info. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -62,12 +63,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of deleteForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -84,12 +86,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -107,12 +110,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of releaseForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -131,12 +135,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of releaseForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -155,12 +160,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -179,12 +185,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of requestForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -203,12 +210,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -228,12 +236,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 12 @@ -248,12 +257,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of castToNormalForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -268,12 +278,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -290,9 +301,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of notifyVisibleForms. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -310,9 +322,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -330,9 +343,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of notifyInvisibleForms. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -350,9 +364,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -370,11 +385,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of enableFormsUpdate. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -391,11 +407,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -412,12 +429,13 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of disableFormsUpdate. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -434,12 +452,13 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -452,7 +471,8 @@ declare namespace formHost { * * @param { AsyncCallback } callback - The callback of isSystemReady. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -478,9 +498,10 @@ declare namespace formHost { * @param { AsyncCallback> } callback - The callback is used to return the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -495,8 +516,8 @@ declare namespace formHost { * @returns { Promise> } Returns the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -512,9 +533,10 @@ declare namespace formHost { * @param { AsyncCallback> } callback - The callback is used to return the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -532,9 +554,10 @@ declare namespace formHost { * @param { AsyncCallback> } callback - The callback is used to return the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -556,9 +579,10 @@ declare namespace formHost { * @returns { Promise> } Returns the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -575,9 +599,10 @@ declare namespace formHost { * @returns { Promise> } Returns the FormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -593,12 +618,13 @@ declare namespace formHost { * @permission ohos.permission.REQUIRE_FORM * @param { Array } formIds - Indicates the specified form id. * @param { AsyncCallback } callback - The callback is used to return the number of invalid forms deleted - * by the Form Manager Service. + * by the Form Manager Service. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -615,9 +641,10 @@ declare namespace formHost { * @returns { Promise } Returns the number of invalid forms deleted by the Form Manager Service. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -634,9 +661,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback is used to return the form state. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -654,9 +682,10 @@ declare namespace formHost { * @returns { Promise } Returns the form state. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -672,7 +701,8 @@ declare namespace formHost { * @param { 'formUninstall' } type - Indicates event type. * @param { Callback } callback - The callback of formUninstall. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -686,7 +716,8 @@ declare namespace formHost { * @param { 'formUninstall' } type - Indicates event type. * @param { Callback } [callback] - The callback of formUninstall. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -703,11 +734,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of notifyFormsVisible. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -724,11 +756,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -745,11 +778,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of notifyFormsEnableUpdate. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -770,11 +804,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -790,11 +825,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of shareForm. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -810,11 +846,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 @@ -830,9 +867,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of notifyFormsPrivacyProtected. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -853,9 +891,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -870,7 +909,8 @@ declare namespace formHost { * @param { string } formId - Indicates the form ID. * @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback of acquireFormData. * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -888,9 +928,10 @@ declare namespace formHost { * @param { string } formId - Indicates the form ID. * @param { AsyncCallback> } callback - The callback of acquireFormData. * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * invalid input parameter during form operation @@ -908,7 +949,8 @@ declare namespace formHost { * @param { string } formId - Indicates the form ID. * @returns { Promise<{ [key: string]: Object }> } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -926,9 +968,10 @@ declare namespace formHost { * @param { string } formId - Indicates the form ID. * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * invalid input parameter during form operation @@ -950,11 +993,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of setRouterProxy. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -972,11 +1016,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -991,11 +1036,12 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of clearRouterProxy. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -1010,11 +1056,12 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -1028,10 +1075,11 @@ declare namespace formHost { * @param { string } formId - Indicates the form id. * @param { formInfo.PublishFormResult } result - The result of publish form. * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @syscap SystemCapability.Ability.Form @@ -1049,9 +1097,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -1068,9 +1117,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of setFormsRecyclable. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -1087,9 +1137,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -1106,9 +1157,10 @@ declare namespace formHost { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -1125,9 +1177,10 @@ declare namespace formHost { * @param { AsyncCallback } callback - The callback of recoverForms. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -1144,12 +1197,13 @@ declare namespace formHost { * @param { formInfo.FormLocation } location - The location of the form. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - caller is not system app. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly diff --git a/api/@ohos.app.form.formInfo.d.ts b/api/@ohos.app.form.formInfo.d.ts index 7b1131305220292ff42fdd979212a5de617d8c1d..1f88115d6abe024d781764bdf516603542046078 100644 --- a/api/@ohos.app.form.formInfo.d.ts +++ b/api/@ohos.app.form.formInfo.d.ts @@ -1663,7 +1663,7 @@ declare namespace formInfo { * @since 12 */ OTHER = -1, - + /** * Form is on the desktop * @@ -1672,7 +1672,7 @@ declare namespace formInfo { * @since 12 */ DESKTOP = 0, - + /** * Form is on the form center. * @@ -1681,7 +1681,7 @@ declare namespace formInfo { * @since 12 */ FORM_CENTER = 1, - + /** * Form is on the form manager. * @@ -1690,7 +1690,7 @@ declare namespace formInfo { * @since 12 */ FORM_MANAGER = 2, - + /** * Form is on the negative screen. * @@ -1699,7 +1699,7 @@ declare namespace formInfo { * @since 12 */ NEGATIVE_SCREEN = 3, - + /** * Form is on the form center of negative screen. * @@ -1708,7 +1708,7 @@ declare namespace formInfo { * @since 12 */ FORM_CENTER_NEGATIVE_SCREEN = 4, - + /** * Form is on the form manager of negative screen. * @@ -1717,7 +1717,7 @@ declare namespace formInfo { * @since 12 */ FORM_MANAGER_NEGATIVE_SCREEN = 5, - + /** * Form is on the screen lock. * @@ -1726,7 +1726,7 @@ declare namespace formInfo { * @since 12 */ SCREEN_LOCK = 6, - + /** * Form is on the ai suggestion. * diff --git a/api/@ohos.app.form.formObserver.d.ts b/api/@ohos.app.form.formObserver.d.ts index 495fed58f2a919f138a059d62c5fdaceb7e1939d..c2b937519b6be500d5944d70af38dac127440e1c 100644 --- a/api/@ohos.app.form.formObserver.d.ts +++ b/api/@ohos.app.form.formObserver.d.ts @@ -40,7 +40,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -57,7 +58,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -74,7 +76,8 @@ declare namespace formObserver { * @param { Callback } [observerCallback] - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -90,7 +93,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -107,7 +111,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -124,7 +129,8 @@ declare namespace formObserver { * @param { Callback } [observerCallback] - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -140,7 +146,8 @@ declare namespace formObserver { * @param { Callback> } observerCallback - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -157,7 +164,8 @@ declare namespace formObserver { * @param { Callback> } observerCallback - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -177,7 +185,8 @@ declare namespace formObserver { * @param { Callback> } observerCallback - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -194,7 +203,8 @@ declare namespace formObserver { * @param { Callback> } observerCallback - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -215,7 +225,8 @@ declare namespace formObserver { * @param { Callback> } [observerCallback] - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -236,7 +247,8 @@ declare namespace formObserver { * @param { Callback> } [observerCallback] - The callback is used to return * the running form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -256,9 +268,10 @@ declare namespace formObserver { * @param { string } [hostBundleName] - Indicates the bundle name of the form host application. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -275,9 +288,10 @@ declare namespace formObserver { * @param { string } [hostBundleName] - Indicates the bundle name of the form host application. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -296,9 +310,10 @@ declare namespace formObserver { * @returns { Promise> } Returns the RunningFormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @syscap SystemCapability.Ability.Form * @systemapi * @since 10 @@ -314,9 +329,10 @@ declare namespace formObserver { * @returns { Promise> } Returns the RunningFormInfo. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -334,8 +350,9 @@ declare namespace formObserver { * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -355,8 +372,9 @@ declare namespace formObserver { * @param { AsyncCallback> } callback - The callback of getFormInstancesByFilter. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -377,8 +395,9 @@ declare namespace formObserver { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -397,8 +416,9 @@ declare namespace formObserver { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -416,8 +436,9 @@ declare namespace formObserver { * @param { AsyncCallback } callback - The callback of getFormInstancesById. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -436,8 +457,9 @@ declare namespace formObserver { * @param { AsyncCallback } callback - The callback of getFormInstancesById. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -460,7 +482,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -477,7 +500,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -493,7 +517,8 @@ declare namespace formObserver { * @param { Callback } [observerCallback] - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -509,7 +534,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -526,7 +552,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -542,7 +569,8 @@ declare namespace formObserver { * @param { Callback } [observerCallback] - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -558,7 +586,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -575,7 +604,8 @@ declare namespace formObserver { * @param { Callback } observerCallback - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 @@ -591,7 +621,8 @@ declare namespace formObserver { * @param { Callback } [observerCallback] - The callback is used to return the running * form info. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi * @since 11 diff --git a/api/@ohos.app.form.formProvider.d.ts b/api/@ohos.app.form.formProvider.d.ts index 6b801f0a9e3c2c63bb17a3614b0d598a2cc8443a..b4547c409e707dd13593ac29744a9b6147a9dd5a 100644 --- a/api/@ohos.app.form.formProvider.d.ts +++ b/api/@ohos.app.form.formProvider.d.ts @@ -45,7 +45,8 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @param { AsyncCallback } callback - The callback of setFormNextRefreshTime. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -62,14 +63,15 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @param { AsyncCallback } callback - The callback of setFormNextRefreshTime. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 @@ -82,7 +84,8 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -99,14 +102,15 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 @@ -120,7 +124,8 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback of updateForm. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -137,13 +142,14 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback of updateForm. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 @@ -161,7 +167,8 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. @@ -178,13 +185,14 @@ declare namespace formProvider { * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. - * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 @@ -197,7 +205,8 @@ declare namespace formProvider { * * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { AsyncCallback> } callback - The callback is used to return the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -210,8 +219,9 @@ declare namespace formProvider { * * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { AsyncCallback> } callback - The callback is used to return the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -225,7 +235,8 @@ declare namespace formProvider { * Client to communication with FormManagerService. * * @param { AsyncCallback> } callback - The callback is used to return the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -237,8 +248,9 @@ declare namespace formProvider { * Client to communication with FormManagerService. * * @param { AsyncCallback> } callback - The callback is used to return the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -253,7 +265,8 @@ declare namespace formProvider { * * @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @returns { Promise> } Returns the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -266,8 +279,9 @@ declare namespace formProvider { * * @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @returns { Promise> } Returns the formInfo. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -283,8 +297,9 @@ declare namespace formProvider { * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback is used to return the form id. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -303,8 +318,9 @@ declare namespace formProvider { * @param { Want } want - The want of the form to publish. * @param { AsyncCallback } callback - The callback is used to return the form id. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -320,8 +336,9 @@ declare namespace formProvider { * @param { formBindingData.FormBindingData } [formBindingData] - Indicates the form data. * @returns { Promise } Returns the form id. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form @@ -334,9 +351,10 @@ declare namespace formProvider { * Check if the request of publishing a form is supported by the host * * @param { AsyncCallback } callback - The callback is used to return true if the request is supported. - * @throws { BusinessError } 202 - If the application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi @@ -348,8 +366,8 @@ declare namespace formProvider { * Check if the request of publishing a form is supported by the host * * @returns { Promise } Returns true if the request is supported. - * @throws { BusinessError } 202 - If the application is not a system application. - * @throws { BusinessError } 16500050 - An IPC connection error happened. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi diff --git a/api/@ohos.application.BackupExtensionAbility.d.ts b/api/@ohos.application.BackupExtensionAbility.d.ts index 887eea71f6affa13bfbcdc5f0a69b0e7412de1c0..12657d111038680c7e2c32b257169f8b88fee7e4 100644 --- a/api/@ohos.application.BackupExtensionAbility.d.ts +++ b/api/@ohos.application.BackupExtensionAbility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023 Huawei Device Co., Ltd. + * Copyright (c) 2024 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -18,7 +18,7 @@ * @kit CoreFileKit */ -import type ExtensionContext from './application/ExtensionContext'; +import type BackupExtensionContext from './@ohos.file.BackupExtensionContext'; /** * Describe bundle version @@ -66,7 +66,15 @@ export default class BackupExtensionAbility { * @StageModelOnly * @since 11 */ - context: ExtensionContext; + /** + * Indicates backup extension ability context. + * + * @type { BackupExtensionContext } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @StageModelOnly + * @since 12 + */ + context: BackupExtensionContext; /** * Callback to be called when the backup procedure is started. diff --git a/api/@ohos.application.DataShareExtensionAbility.d.ts b/api/@ohos.application.DataShareExtensionAbility.d.ts index 8b80c6485d02af997973f91d0436c1300a38237b..72557ae3ec05191482ad8e7a02a6a4b59a54d2a4 100644 --- a/api/@ohos.application.DataShareExtensionAbility.d.ts +++ b/api/@ohos.application.DataShareExtensionAbility.d.ts @@ -29,6 +29,7 @@ import dataShare from './@ohos.data.dataShare'; * Struct for a batch update operation. * * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi * @stagemodelonly * @since 12 */ diff --git a/api/@ohos.arkui.UIContext.d.ts b/api/@ohos.arkui.UIContext.d.ts index 5527aea7aa2690efa1dbc7047c05f8866d3d88fe..4f8ceead56c2bc32e2a4f988751fed6cdbd3412f 100644 --- a/api/@ohos.arkui.UIContext.d.ts +++ b/api/@ohos.arkui.UIContext.d.ts @@ -33,7 +33,7 @@ import type observer from './@ohos.arkui.observer'; import promptAction from './@ohos.promptAction'; import router from './@ohos.router'; import type componentUtils from './@ohos.arkui.componentUtils'; -import { ComponentContent } from './@ohos.arkui.node'; +import { ComponentContent, FrameNode } from './@ohos.arkui.node'; import type { AnimatorOptions, AnimatorResult } from './@ohos.animator'; import type { Callback, AsyncCallback } from './@ohos.base'; import type { Color, FontStyle, Nullable } from 'CommonEnums'; @@ -47,10 +47,10 @@ import type { CustomBuilder, DragItemInfo, DragEvent } from 'DragControllerParam import { MeasureOptions } from './@ohos.measure'; import type dragController from './@ohos.arkui.dragController'; import image from './@ohos.multimedia.image'; -import { LocalStorage } from 'StateManagement'; -import type common from './@ohos.app.ability.common'; import { GestureEvent } from 'GestureEventModule'; import { ClickEvent } from 'ClickEventModule'; +import { LocalStorage } from 'StateManagement'; +import type common from './@ohos.app.ability.common'; import type pointer from './@ohos.multimodalInput.pointer'; /** @@ -218,9 +218,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -234,9 +234,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -253,9 +253,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -269,9 +269,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -289,9 +289,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -306,9 +306,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -326,9 +326,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -343,9 +343,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -363,7 +363,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -378,7 +378,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -396,7 +396,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -411,7 +411,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -430,7 +430,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -446,7 +446,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -465,7 +465,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -481,7 +481,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -604,7 +604,7 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -617,7 +617,7 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -669,9 +669,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -684,9 +684,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -702,9 +702,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -717,9 +717,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -736,9 +736,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -752,9 +752,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -771,9 +771,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -787,9 +787,9 @@ export class Router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -806,7 +806,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -820,7 +820,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -837,7 +837,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -848,7 +848,7 @@ export class Router { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - if the number of parameters is less than 1 or the type of the url parameter is not string. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -866,7 +866,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -878,7 +878,7 @@ export class Router { * @param { AsyncCallback } callback - the callback of replaceNamedRoute. * @throws { BusinessError } 401 - if the number of parameters is less than 1 or the type of the url parameter is not string. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -896,7 +896,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -911,7 +911,7 @@ export class Router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -944,7 +944,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -957,7 +957,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -974,7 +974,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -988,7 +988,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1005,7 +1005,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1019,7 +1019,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1036,7 +1036,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1054,7 +1054,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1071,7 +1071,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1085,7 +1085,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1104,9 +1104,10 @@ export class PromptAction { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103302 - the ComponentContent has already been opened. + * @throws { BusinessError } 103302 - Dialog content already exists * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ openCustomDialog(dialogContent: ComponentContent, options?: promptAction.BaseDialogOptions): Promise; @@ -1125,6 +1126,7 @@ export class PromptAction { * @throws { BusinessError } 103303 - the ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ updateCustomDialog(dialogContent: ComponentContent, options: promptAction.BaseDialogOptions): Promise; @@ -1142,6 +1144,7 @@ export class PromptAction { * @throws { BusinessError } 103303 - the ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ closeCustomDialog(dialogContent: ComponentContent): Promise; @@ -1448,7 +1451,8 @@ export class UIObserver { * Registers a callback function to be called when the navigation switched to a new navDestination. * * @param { 'navDestinationSwitch' } type - The type of event to listen for. Must be 'navDestinationSwitch'. - * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. + * @param { Callback } callback - The callback function to be called when + * the navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -1462,8 +1466,8 @@ export class UIObserver { * Removes a callback function that was previously registered with `on()`. * * @param { 'navDestinationSwitch' } type - The type of event to remove the listener for. Must be 'navDestinationSwitch'. - * @param { Callback } [callback] - The callback function to remove. If not provided, all callbacks for the given event type - * will be removed. + * @param { Callback } [callback] - The callback function to remove. If not provided, + * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -1478,7 +1482,8 @@ export class UIObserver { * * @param { 'navDestinationSwitch' } type - The type of event to listen for. Must be 'navDestinationSwitch'. * @param { observer.NavDestinationSwitchObserverOptions } observerOptions - Options. - * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. + * @param { Callback } callback - The callback function to be called when the + * navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -1494,8 +1499,8 @@ export class UIObserver { * * @param { 'navDestinationSwitch' } type - The type of event to remove the listener for. Must be 'navDestinationSwitch'. * @param { observer.NavDestinationSwitchObserverOptions } observerOptions - Options. - * @param { Callback } [callback] - The callback function to remove. If not provided, all callbacks for the given event type - * will be removed. + * @param { Callback } [callback] - The callback function to remove. If not provided, + * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 @@ -1939,6 +1944,7 @@ export class DragController { * class MeasureUtils * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class MeasureUtils { @@ -1949,6 +1955,7 @@ export class MeasureUtils { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ measureText(options: MeasureOptions): number; @@ -1960,6 +1967,7 @@ export class MeasureUtils { * @returns { SizeOptions } width and height for text to display * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ measureTextSize(options: MeasureOptions): SizeOptions; @@ -1968,12 +1976,14 @@ export class MeasureUtils { /** * class FocusController * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ export class FocusController { /** * clear focus to the root container. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ clearFocus(): void; @@ -1982,9 +1992,10 @@ export class FocusController { * request focus to the specific component. * @param { string } key - the inspector key of the component. * @throws { BusinessError } 150001 - the component cannot be focused. - * @throws { BusinessError } 150002 - there are components in ancestor nodes cannot be focused. + * @throws { BusinessError } 150002 - This component has an unfocusable ancestor * @throws { BusinessError } 150003 - the component is not on tree or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ requestFocus(key: string): void; @@ -1995,6 +2006,7 @@ export class FocusController { * * @typedef {pointer.PointerStyle} PointerStyle * @syscap SystemCapability.MultimodalInput.Input.Pointer + * @atomicservice * @since 12 */ export type PointerStyle = pointer.PointerStyle; @@ -2004,6 +2016,7 @@ export type PointerStyle = pointer.PointerStyle; * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class CursorController { @@ -2012,6 +2025,7 @@ export class CursorController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ restoreDefault(): void; @@ -2021,6 +2035,7 @@ export class CursorController { * @param { PointerStyle } value - cursor style enum. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setCursor(value: PointerStyle): void; @@ -2031,6 +2046,7 @@ export class CursorController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class ContextMenuController { @@ -2039,6 +2055,7 @@ export class ContextMenuController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ close(): void; @@ -2058,6 +2075,7 @@ export type Context = common.Context; /** * class ComponentSnapshot * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ export class ComponentSnapshot { @@ -2068,6 +2086,7 @@ export class ComponentSnapshot { * @param { AsyncCallback } callback - Callback that contains the snapshot in PixelMap format. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ get(id: string, callback: AsyncCallback): void; @@ -2079,6 +2098,7 @@ export class ComponentSnapshot { * @returns { Promise } A Promise with the snapshot in PixelMap format. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ get(id: string): Promise; @@ -2090,6 +2110,7 @@ export class ComponentSnapshot { * @param { AsyncCallback } callback - Callback that contains the snapshot in PixelMap format. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback): void; @@ -2101,6 +2122,7 @@ export class ComponentSnapshot { * @returns { Promise } A Promise with the snapshot in PixelMap format. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ createFromBuilder(builder: CustomBuilder): Promise; @@ -2187,6 +2209,7 @@ export class UIContext { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getFilteredInspectorTree(filters?: Array): string; @@ -2203,6 +2226,7 @@ export class UIContext { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getFilteredInspectorTreeById(id: string, depth: number, filters?: Array): string; @@ -2287,6 +2311,7 @@ export class UIContext { * @returns { OverlayManager } object OverlayManager. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getOverlayManager(): OverlayManager; @@ -2506,6 +2531,7 @@ export class UIContext { * @returns { MeasureUtils } the MeasureUtils * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getMeasureUtils(): MeasureUtils; @@ -2531,6 +2557,14 @@ export class UIContext { */ keyframeAnimateTo(param: KeyframeAnimateParam, keyframes: Array): void; + /** + * Get FocusController. + * @returns { FocusController } the FocusController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + getFocusController(): FocusController; + /** * Define animation functions for immediate distribution. * @@ -2550,6 +2584,7 @@ export class UIContext { * @returns { FrameNode | null } The instance of FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getFrameNodeById(id: string): FrameNode | null; @@ -2561,24 +2596,30 @@ export class UIContext { * @returns { FrameNode | null } - The FrameNode with the target uniqueId, or null if the frameNode is not existed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getFrameNodeByUniqueId(id: number): FrameNode | null; /** - * Get FocusController. - * @returns { FocusController } the FocusController + * Dynamic dimming. + * + * @param { string } id - The id of FrameNode. + * @param { number } value - Compared to the original level of dimming.value range [0,1], + * set values less than 0 to 0 and values greater than 1 to 1. * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi * @since 12 */ - getFocusController(): FocusController; - + setDynamicDimming(id: string, value: number): void; + /** * Get object cursor controller. * * @returns { CursorController } object cursor controller. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getCursorController(): CursorController; @@ -2589,6 +2630,7 @@ export class UIContext { * @returns { ContextMenuController } object context menu controller. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getContextMenuController(): ContextMenuController; @@ -2597,6 +2639,7 @@ export class UIContext { * Get ComponentSnapshot. * @returns { ComponentSnapshot } the ComponentSnapshot * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ getComponentSnapshot(): ComponentSnapshot; @@ -2606,6 +2649,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ vp2px(value: number): number; @@ -2615,6 +2659,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ px2vp(value: number): number; @@ -2624,6 +2669,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ fp2px(value: number): number; @@ -2633,6 +2679,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ px2fp(value: number): number; @@ -2642,6 +2689,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ lpx2px(value: number): number; @@ -2651,6 +2699,7 @@ export class UIContext { * @param { number } value * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice * @since 12 */ px2lpx(value: number): number; @@ -2662,6 +2711,7 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @stagemodelonly * @crossplatform + * @atomicservice * @since 12 */ getSharedLocalStorage(): LocalStorage | undefined; @@ -2673,28 +2723,18 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @stagemodelonly * @crossplatform + * @atomicservice * @since 12 */ getHostContext(): Context | undefined; - /** - * Dynamic dimming. - * - * @param { string } id - The id of FrameNode. - * @param { number } value - Compared to the original level of dimming.value range [0,1], - * set values less than 0 to 0 and values greater than 1 to 1. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since 12 - */ - setDynamicDimming(id: string, value: number): void; - /** * Get the name of current window. * * @returns { string | undefined } The name of current window, or undefined if the window doesn't exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getWindowName(): string | undefined; diff --git a/api/@ohos.arkui.advanced.Chip.d.ets b/api/@ohos.arkui.advanced.Chip.d.ets index 0a28b41694b215141850eac765b871edb9971200..e63d63acbdec05384b85e0407d14c82348bed75b 100755 --- a/api/@ohos.arkui.advanced.Chip.d.ets +++ b/api/@ohos.arkui.advanced.Chip.d.ets @@ -21,7 +21,6 @@ /// import { ResourceStr } from 'GlobalResource'; -import { SymbolGlyphModifier } from './@ohos.arkui.modifier'; /** * Enum for ChipSize @@ -227,37 +226,6 @@ export interface SuffixIconOptions extends IconCommonOptions { */ export interface PrefixIconOptions extends IconCommonOptions {} -/** - * Defines symbol options. - * - * @interface SymbolOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ -export interface SymbolOptions { - - /** - * Symbol normal. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - normal?: SymbolGlyphModifier; - - /** - * Symbol activated. - * - * @type { ?SymbolGlyphModifier } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - activated?: SymbolGlyphModifier; -} - /** * Defines label margin. * @@ -478,16 +446,6 @@ export interface ChipOptions { */ prefixIcon?: PrefixIconOptions; - /** - * Chip prefix symbol. - * - * @type { ?SymbolOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - prefixSymbol?: SymbolOptions; - /** * Chip label. * @@ -526,16 +484,6 @@ export interface ChipOptions { */ suffixIcon?: SuffixIconOptions; - /** - * Chip suffix symbol. - * - * @type { ?SymbolOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - suffixSymbol?: SymbolOptions; - /** * Show close icon. * diff --git a/api/@ohos.arkui.advanced.ChipGroup.d.ets b/api/@ohos.arkui.advanced.ChipGroup.d.ets index ba1d4e3f805f268270044954204c33526f3bc2e9..015d8023f3288dfe407285c1b3929f9fc7ecb7d1 100644 --- a/api/@ohos.arkui.advanced.ChipGroup.d.ets +++ b/api/@ohos.arkui.advanced.ChipGroup.d.ets @@ -21,8 +21,8 @@ /// import { ResourceStr } from 'GlobalResource'; -import { ChipSize, SymbolOptions } from '@ohos.arkui.advanced.Chip'; -import { SymbolGlyphModifier } from './@ohos.arkui.modifier'; +import { ChipSize } from '@ohos.arkui.advanced.Chip'; + /** * Defines icon options. @@ -97,16 +97,6 @@ export interface ChipGroupItemOptions { */ prefixIcon?: IconOptions; - /** - * Prefix symbol. - * - * @type { ?SymbolOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - prefixSymbol?: SymbolOptions; - /** * Chip label. * @@ -127,16 +117,6 @@ export interface ChipGroupItemOptions { */ suffixIcon?: IconOptions; - /** - * suffix symbol. - * - * @type { ?SymbolOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ - suffixSymbol?: SymbolOptions; - /** * Allow close. * @@ -262,7 +242,7 @@ export interface ChipGroupSpaceOptions { */ export interface IconItemOptions { /** - * IconOptions. + * IconItemOptions. * * @type { IconOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -295,13 +275,13 @@ export declare struct IconGroupSuffix { /** * Suffix item. * - * @type { Array } + * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 12 */ @Prop - items: Array; + items: Array; } @@ -372,7 +352,7 @@ export declare struct ChipGroup { chipGroupSpace?: ChipGroupSpaceOptions; /** - * Chip group callback. + * Chip group callback. when chip status is changed, this onChange is called. * * @type { ?Callback> } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -391,4 +371,5 @@ export declare struct ChipGroup { */ @BuilderParam suffix?: Callback; -} \ No newline at end of file +} + diff --git a/api/@ohos.arkui.advanced.Dialog.d.ets b/api/@ohos.arkui.advanced.Dialog.d.ets index 8a552fb7276e5bc0d01e39d8586c8a1d38fc5ce1..9289c16bdac5e0e7985fd2bb53bd5035eb74bf74 100644 --- a/api/@ohos.arkui.advanced.Dialog.d.ets +++ b/api/@ohos.arkui.advanced.Dialog.d.ets @@ -21,6 +21,7 @@ /// import { ResourceStr } from 'GlobalResource'; +import { Theme, CustomTheme } from '@ohos.arkui.theme'; /** * Declare ButtonOptions @@ -271,6 +272,16 @@ export declare struct TipsDialog { * @since 11 */ secondaryButton?: ButtonOptions; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } /** @@ -370,6 +381,16 @@ export declare struct SelectDialog { * @since 11 */ radioContent: Array; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } /** @@ -483,6 +504,16 @@ export declare struct ConfirmDialog { * @since 11 */ secondaryButton?: ButtonOptions; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } /** @@ -570,6 +601,16 @@ export declare struct AlertDialog { * @since 11 */ secondaryButton?: ButtonOptions; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } /** @@ -613,6 +654,16 @@ export declare struct LoadingDialog { * @since 11 */ content?: ResourceStr; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } /** @@ -671,4 +722,14 @@ export declare struct CustomContentDialog { * @since 12 */ buttons?: ButtonOptions[]; + /** + * Custom Theme. + * + * @type { ?(Theme | CustomTheme) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + theme?: Theme | CustomTheme; } \ No newline at end of file diff --git a/api/@ohos.arkui.advanced.DownloadFileButton.d.ets b/api/@ohos.arkui.advanced.DownloadFileButton.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..4dadd5eb536a624aa90fd3d942c07877a405a27c --- /dev/null +++ b/api/@ohos.arkui.advanced.DownloadFileButton.d.ets @@ -0,0 +1,350 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ArkUI + */ + +/** + * Enum for DownloadIconStyle + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare enum DownloadIconStyle { + /** + * FULL_FILLED type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + FULL_FILLED = 1, + + /** + * LINES type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + LINES = 2 +} + +/** + * Enum for DownloadDescription + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare enum DownloadDescription { + + /** + * Description is DOWNLOAD. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + DOWNLOAD = 1, + + /** + * Description is DOWNLOAD_FILE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + DOWNLOAD_FILE = 2, + + /** + * Description is SAVE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + SAVE = 3, + + /** + * Description is SAVE_IMAGE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + SAVE_IMAGE = 4, + + /** + * Description is SAVE_FILE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + SAVE_FILE = 5, + + /** + * Description is DOWNLOAD_AND_SHARE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + DOWNLOAD_AND_SHARE = 6, + + /** + * Description is RECEIVE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + RECEIVE = 7, + + /** + * Description is CONTINUE_TO_RECEIVE. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + CONTINUE_TO_RECEIVE = 8 +} + +/** + * Enum for DownloadDescription + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare enum DownloadLayoutDirection { + + /** + * Layout direction is HORIZONTAL. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + HORIZONTAL = 0, + + /** + * Layout direction is VERTICAL. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + VERTICAL = 1 +} + +/** + * Defines the download content options. + * + * @interface DownloadContentOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export interface DownloadContentOptions { + /** + * DownloadFileButton icon Style. + * + * @type { ?DownloadIconStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + icon?: DownloadIconStyle; + + /** + * DownloadFileButton description. + * + * @type { ?DownloadDescription } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + text?: DownloadDescription; +} + +/** + * Defines the DownloadFileButton style option. + * + * @interface DownloadStyleOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export interface DownloadStyleOptions { + + /** + * Icon size. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconSize?: Dimension; + + /** + * Layout direction. + * + * @type { ?DownloadLayoutDirection } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + layoutDirection?: DownloadLayoutDirection; + + /** + * Font size. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontSize?: Dimension; + + /** + * Font Style. + * + * @type { ?FontStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontStyle?: FontStyle; + + /** + * Font weight. + * + * @type { ?(number | FontWeight | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontWeight?: number | FontWeight | string; + + /** + * Font family. + * + * @type { ?(string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontFamily?: string | Resource; + + /** + * Font color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontColor?: ResourceColor; + + /** + * Icon color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconColor?: ResourceColor; + + /** + * Text and Icon space. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + textIconSpace?: Dimension; +} + +/** + * Declare Component DownloadFileButton + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +@Component +export declare struct DownloadFileButton { + /** + * Set DownloadFileButton Content. + * + * @type { DownloadContentOptions }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + @State contentOptions: DownloadContentOptions; + /** + * Set DownloadFileButton Style. + * + * @type { DownloadStyleOptions }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + @State styleOptions: DownloadStyleOptions; +} \ No newline at end of file diff --git a/api/@ohos.arkui.advanced.FormMenu.d.ets b/api/@ohos.arkui.advanced.FormMenu.d.ets new file mode 100755 index 0000000000000000000000000000000000000000..544246414709181a7f4d02217685260c23f6c675 --- /dev/null +++ b/api/@ohos.arkui.advanced.FormMenu.d.ets @@ -0,0 +1,93 @@ +/* +* Copyright (C) 2024 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** + * @file Defines the form menu + * @kit ArkUI + */ + +import formBindingData from './@ohos.app.form.formBindingData'; +import Want from './@ohos.app.ability.Want'; +import { AsyncCallback } from './@ohos.base'; + +/** + * Defines the form menu item style. + * + * @interface FormMenuItemStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ +export interface FormMenuItemStyle { + /** + * Defines options of the form menu. + * + * @type { ?MenuItemOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + options?: MenuItemOptions; +} + +/** + * Defines the add form options. + * + * @interface AddFormOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ +export interface AddFormOptions { + /** + * Indicates the form data. + * + * @type { ?formBindingData.FormBindingData } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + formBindingData?: formBindingData.FormBindingData; + + /** + * The callback is used to return the form id. + * + * @type { ?AsyncCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + callback?: AsyncCallback; + + /** + * The style of the menu item. + * + * @type { ?FormMenuItemStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + style?: FormMenuItemStyle; +} + +/** + * Build function of AddFormMenuItem. + * + * @param { Want } want - The want of the form to publish. + * @param { string } componentId - The id of the component used to get form snapshot. + * @param { AddFormOptions } [options] - Add form options. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ +@Builder +export declare function AddFormMenuItem( + want: Want, + componentId: string, + options?: AddFormOptions +): void; \ No newline at end of file diff --git a/api/@ohos.arkui.advanced.SegmentButton.d.ets b/api/@ohos.arkui.advanced.SegmentButton.d.ets index 5dde80d992720ecf296a7747aedff207df917d40..6bbfe35571dddb74db50e51b9afd80e0a1843dd8 100644 --- a/api/@ohos.arkui.advanced.SegmentButton.d.ets +++ b/api/@ohos.arkui.advanced.SegmentButton.d.ets @@ -555,6 +555,15 @@ interface TabSegmentButtonConstructionOptions extends CommonSegmentButtonOptions * @crossplatform * @since 11 */ + /** + * The items of tab type of SegmentButton. + * + * @type { ItemRestriction } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ buttons: ItemRestriction; } diff --git a/api/@ohos.arkui.advanced.SubHeader.d.ets b/api/@ohos.arkui.advanced.SubHeader.d.ets index 82eb83e0cda31eb2d8043757a63e9a2bd3f0edc8..24b72620d0d547637489d6202c2c5824aa77fb05 100644 --- a/api/@ohos.arkui.advanced.SubHeader.d.ets +++ b/api/@ohos.arkui.advanced.SubHeader.d.ets @@ -211,6 +211,7 @@ export declare class SelectOptions { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare enum SymbolRenderingStrategy { @@ -219,6 +220,7 @@ declare enum SymbolRenderingStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ SINGLE = 0, @@ -228,6 +230,7 @@ declare enum SymbolRenderingStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ MULTIPLE_COLOR = 1, @@ -237,6 +240,7 @@ declare enum SymbolRenderingStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ MULTIPLE_OPACITY = 2, @@ -248,6 +252,7 @@ declare enum SymbolRenderingStrategy { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare enum SymbolEffectStrategy { @@ -256,6 +261,7 @@ declare enum SymbolEffectStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ NONE = 0, @@ -265,6 +271,7 @@ declare enum SymbolEffectStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ SCALE = 1, @@ -274,6 +281,7 @@ declare enum SymbolEffectStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ HIERARCHICAL = 2, diff --git a/api/@ohos.arkui.componentUtils.d.ts b/api/@ohos.arkui.componentUtils.d.ts index 57f3dfdfd31f76374939365a3def9ddf1f325aeb..270a04e3aeecfca9614ad4e61f97856a46da3bf9 100644 --- a/api/@ohos.arkui.componentUtils.d.ts +++ b/api/@ohos.arkui.componentUtils.d.ts @@ -31,6 +31,14 @@ * @atomicservice * @since 11 */ +/** + * This module provides functionality for component coordinates and sizes. + * @namespace componentUtils + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ declare namespace componentUtils { /** @@ -46,6 +54,14 @@ declare namespace componentUtils { * @atomicservice * @since 11 */ + /** + * Component information. + * @typedef ComponentInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface ComponentInfo { /** @@ -246,6 +262,14 @@ declare namespace componentUtils { * @atomicservice * @since 11 */ + /** + * Defines the size property. + * @typedef Size + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface Size { /** @@ -378,6 +402,14 @@ declare namespace componentUtils { * @atomicservice * @since 11 */ + /** + * Translation Result + * @typedef TranslateResult + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface TranslateResult { /** @@ -463,6 +495,14 @@ declare namespace componentUtils { * @atomicservice * @since 11 */ + /** + * Scale Result + * @typedef ScaleResult + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface ScaleResult { /** @@ -594,6 +634,14 @@ declare namespace componentUtils { * @atomicservice * @since 11 */ + /** + * Rotation Result. + * @typedef RotateResult + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ interface RotateResult { /** diff --git a/api/@ohos.arkui.dragController.d.ts b/api/@ohos.arkui.dragController.d.ts index f2ef14e0df859e060d267800a6857f81f7a79b24..fc652dea5668e5440d48c9ea15d12f0af05087be 100644 --- a/api/@ohos.arkui.dragController.d.ts +++ b/api/@ohos.arkui.dragController.d.ts @@ -31,6 +31,13 @@ import type { ResourceColor, TouchPoint } from 'DragControllerUnitParam'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ +/** + * This module allows developers to trigger a drag event. + * @namespace dragController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 12 + */ declare namespace dragController { /** * Defines the Drag Status. @@ -218,6 +225,14 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * DragInfo object description + * + * @interface DragInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 12 + */ interface DragInfo { /** * A unique identifier to identify which touch point. diff --git a/api/@ohos.arkui.modifier.d.ts b/api/@ohos.arkui.modifier.d.ts index b9d6b02c21734dd960ef6403a38df5342565c108..cee301beb1144b7fe0f7d66cc8da8bd3c02dc699 100644 --- a/api/@ohos.arkui.modifier.d.ts +++ b/api/@ohos.arkui.modifier.d.ts @@ -583,7 +583,6 @@ export { WaterFlowModifier } from './arkui/WaterFlowModifier'; /** * Export AttributeUpdater, which is used to update attributes to native side. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi * @crossplatform * @since 12 */ diff --git a/api/@ohos.arkui.node.d.ts b/api/@ohos.arkui.node.d.ts index 3167c10ca3d3c311d2c68b7a595a0e78630f6366..59af0c8d0f59093d53ace3d34ded4e28ffa1fba3 100644 --- a/api/@ohos.arkui.node.d.ts +++ b/api/@ohos.arkui.node.d.ts @@ -45,6 +45,15 @@ export { NodeController } from './arkui/NodeController'; */ export { FrameNode, LayoutConstraint } from './arkui/FrameNode'; +/** + * Export FrameNode. FrameNode defines a basic type of node which contains a RenderNode. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +export { typeNode } from './arkui/FrameNode'; + /** * Export Graphics. Defines the basic types related to the Graphics. * @@ -61,7 +70,7 @@ export { DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4 * @crossplatform * @since 12 */ -export { LengthUnit, SizeT, LengthMetrics, ColorMetrics } from './arkui/Graphics'; +export { LengthUnit, SizeT, LengthMetric, LengthMetrics, ColorMetrics } from './arkui/Graphics'; /** * Export RenderNode. RenderNode contains node tree operations and render property operations on node. diff --git a/api/@ohos.arkui.observer.d.ts b/api/@ohos.arkui.observer.d.ts index 46f3b34ba77c3408b6efc3e44fda21accf19b574..1a507fe7569c83b171cf78b1d4154e5dc8f1a93c 100644 --- a/api/@ohos.arkui.observer.d.ts +++ b/api/@ohos.arkui.observer.d.ts @@ -69,7 +69,7 @@ declare namespace uiObserver { * @form */ /** - * When the NavDestination is displayed. + * When the NavDestination displayed. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -103,6 +103,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 * @form */ @@ -113,6 +114,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 * @form */ @@ -124,6 +126,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ ON_WILL_SHOW = 4, @@ -134,6 +137,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ ON_WILL_HIDE = 5, @@ -144,6 +148,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ ON_WILL_APPEAR = 6, @@ -154,6 +159,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ ON_WILL_DISAPPEAR = 7, @@ -163,6 +169,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 * @form */ @@ -279,6 +286,7 @@ declare namespace uiObserver { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export enum ScrollEventType { @@ -287,6 +295,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ SCROLL_START = 0, @@ -296,6 +305,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ SCROLL_STOP = 1 @@ -382,6 +392,7 @@ declare namespace uiObserver { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ index: number; @@ -392,6 +403,7 @@ declare namespace uiObserver { * @type { ?Object } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ param?: Object; @@ -402,6 +414,7 @@ declare namespace uiObserver { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ navDestinationId: string; @@ -413,6 +426,7 @@ declare namespace uiObserver { * @interface NavigationInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface NavigationInfo { @@ -422,6 +436,7 @@ declare namespace uiObserver { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ navigationId: string; @@ -432,6 +447,7 @@ declare namespace uiObserver { * @type { NavPathStack } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ pathStack: NavPathStack; @@ -443,6 +459,7 @@ declare namespace uiObserver { * @interface ScrollEventInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface ScrollEventInfo { @@ -452,16 +469,29 @@ declare namespace uiObserver { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ id: string, + /** + * The uniqueId of the scrollable component. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + uniqueId: number, + /** * Changed ScrollEvent type. * * @type { ScrollEventType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ scrollEvent: ScrollEventType, @@ -472,19 +502,21 @@ declare namespace uiObserver { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ offset: number } /** - * observer options. - * - * @interface ObserverOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * observer options. + * + * @interface ObserverOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ export interface ObserverOptions { /** * component id. @@ -492,6 +524,7 @@ declare namespace uiObserver { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ id: string @@ -614,6 +647,7 @@ declare namespace uiObserver { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ pageId: string; @@ -624,6 +658,7 @@ declare namespace uiObserver { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class DensityInfo { @@ -633,6 +668,7 @@ declare namespace uiObserver { * @type { UIContext } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ context: UIContext; @@ -643,6 +679,7 @@ declare namespace uiObserver { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ density: number; @@ -654,6 +691,7 @@ declare namespace uiObserver { * @interface NavDestinationSwitchInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface NavDestinationSwitchInfo { @@ -663,6 +701,7 @@ declare namespace uiObserver { * @type { UIAbilityContext | UIContext } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ context: UIAbilityContext | UIContext; @@ -673,6 +712,7 @@ declare namespace uiObserver { * @type { NavDestinationInfo | NavBar } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ from: NavDestinationInfo | NavBar; @@ -683,6 +723,7 @@ declare namespace uiObserver { * @type { NavDestinationInfo | NavBar } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ to: NavDestinationInfo | NavBar; @@ -693,6 +734,7 @@ declare namespace uiObserver { * @type { NavigationOperation } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ operation: NavigationOperation; @@ -704,6 +746,7 @@ declare namespace uiObserver { * @interface NavDestinationSwitchObserverOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface NavDestinationSwitchObserverOptions { @@ -713,6 +756,7 @@ declare namespace uiObserver { * @type { ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ navigationId: ResourceStr; @@ -818,6 +862,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the scroll event start or stop. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on(type: 'scrollEvent', options: ObserverOptions, callback: Callback): void; @@ -831,6 +876,7 @@ declare namespace uiObserver { * scroll ID will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off(type: 'scrollEvent', options: ObserverOptions, callback?: Callback): void; @@ -842,6 +888,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the scroll event start or stop. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on(type: 'scrollEvent', callback: Callback): void; @@ -854,6 +901,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off(type: 'scrollEvent', callback?: Callback): void; @@ -911,9 +959,10 @@ declare namespace uiObserver { * * @param { 'densityUpdate' } type - The type of event to listen for. Must be 'densityUpdate'. * @param { UIContext } context - The context scope of the observer. - * @param { Callback } callback - The callback function to be called when the router page is updated. + * @param { Callback } callback - The callback function to be called when the screen density is updated. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on(type: 'densityUpdate', context: UIContext, callback: Callback): void; @@ -927,6 +976,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off(type: 'densityUpdate', context: UIContext, callback?: Callback): void; @@ -939,6 +989,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the draw command will be drawn. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on(type: 'willDraw', context: UIContext, callback: Callback): void; @@ -952,6 +1003,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off(type: 'willDraw', context: UIContext, callback?: Callback): void; @@ -964,6 +1016,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the layout is done. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on(type: 'didLayout', context: UIContext, callback: Callback): void; @@ -977,6 +1030,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off(type: 'didLayout', context: UIContext, callback?: Callback): void; @@ -989,6 +1043,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on( @@ -1006,6 +1061,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off( @@ -1023,6 +1079,7 @@ declare namespace uiObserver { * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function on( @@ -1042,6 +1099,7 @@ declare namespace uiObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export function off( diff --git a/api/@ohos.arkui.theme.d.ts b/api/@ohos.arkui.theme.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..bec047f52697f106ecc076ddb9293cfb431d6a38 --- /dev/null +++ b/api/@ohos.arkui.theme.d.ts @@ -0,0 +1,670 @@ + +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ArkUI + */ +/** + * Defines the struct of Theme. + * + * @interface Theme + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare interface Theme { + /** + * Define tokens associated with color resources. + * + * @type { Colors } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + colors: Colors; +} + +/** + * Defines the struct of Colors. + * + * @interface Colors + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare interface Colors { + + /** + * System brand Color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + brand: ResourceColor; + + /** + * System warning Color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + warning: ResourceColor; + + /** + * System alert Color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + alert: ResourceColor; + + /** + * System confirm Color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + confirm: ResourceColor; + + /** + * First level text color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontPrimary: ResourceColor; + + /** + * Secondary text color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontSecondary: ResourceColor; + + /** + * tertiary text color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontTertiary: ResourceColor; + + /** + * Fourth text color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontFourth: ResourceColor; + + /** + * Emphasize text color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontEmphasize: ResourceColor; + + /** + * First level text inversion, used on colored backgrounds. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontOnPrimary: ResourceColor; + + /** + * Secondary level text inversion, used on colored backgrounds. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontOnSecondary: ResourceColor; + + /** + * Tertiary level text inversion, used on colored backgrounds. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontOnTertiary: ResourceColor; + + /** + * Fourth level text inversion, used on colored backgrounds. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + fontOnFourth: ResourceColor; + + /** + * First level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconPrimary: ResourceColor; + + /** + * Secondary level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconSecondary: ResourceColor; + + /** + * Tertiary level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconTertiary: ResourceColor; + + /** + * Fourth level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconFourth: ResourceColor; + + /** + * Emphasize level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconEmphasize: ResourceColor; + + /** + * Secondary emphasize level icon color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconSubEmphasize: ResourceColor; + + /** + * First level icon reversed, used on a colored background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconOnPrimary: ResourceColor; + + /** + * Secondary level icon reversed, used on a colored background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconOnSecondary: ResourceColor; + + /** + * Tertiary level icon reversed, used on a colored background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconOnTertiary: ResourceColor; + + /** + * Fourth level icon reversed, used on a colored background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + iconOnFourth: ResourceColor; + + /** + * System Primary level background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + backgroundPrimary: ResourceColor; + + /** + * System Secondary level background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + backgroundSecondary: ResourceColor; + + /** + * System tertiary level background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + backgroundTertiary: ResourceColor; + + /** + * System fourth level background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + backgroundFourth: ResourceColor; + + /** + * System emphasize level background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + backgroundEmphasize: ResourceColor; + + /** + * CompForegroundPrimary color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compForegroundPrimary: ResourceColor; + + /** + * CompBackgroundPrimary color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundPrimary: ResourceColor; + + /** + * CompBackgroundPrimaryTran color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundPrimaryTran: ResourceColor; + + /** + * CompBackgroundPrimaryContrary color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundPrimaryContrary: ResourceColor; + + /** + * CompBackgroundGray color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundGray: ResourceColor; + + /** + * 10% black universal control background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundSecondary: ResourceColor; + + /** + * 5% black universal control background. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundTertiary: ResourceColor; + + /** + * 100% bright brand background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundEmphasize: ResourceColor; + + /** + * Black neutral high gloss color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundNeutral: ResourceColor; + + /** + * 20% High gloss brand background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compEmphasizeSecondary: ResourceColor; + + /** + * 10% High gloss brand background color. + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compEmphasizeTertiary: ResourceColor; + + /** + * Universal Division Line Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compDivider: ResourceColor; + + /** + * CompCommonContrary Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compCommonContrary: ResourceColor; + + /** + * CompBackgroundFocus Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compBackgroundFocus: ResourceColor; + + /** + * CompFocusedPrimary Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compFocusedPrimary: ResourceColor; + + /** + * CompFocusedSecondary Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compFocusedSecondary: ResourceColor; + + /** + * CompFocusedTertiary Color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + compFocusedTertiary: ResourceColor; + + /** + * Hover interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactiveHover: ResourceColor; + + /** + * Pressed interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactivePressed: ResourceColor; + + /** + * Focus interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactiveFocus: ResourceColor; + + /** + * Active interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactiveActive: ResourceColor; + + /** + * Select interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactiveSelect: ResourceColor; + + /** + * Click interactive color + * + * @type { ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + interactiveClick: ResourceColor; +} + +/** + * Defines the struct of CustomTheme. + * + * @interface CustomTheme + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare interface CustomTheme { + /** + * Define tokens associated with color resources.. + * + * @type { ?CustomColors } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + colors?: CustomColors; +} + +/** + * Defines the struct of CustomColors. + * + * @typedef { Partial } CustomColors + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare type CustomColors = Partial; + +/** + * Class ThemeControl provides the Theme management for whole Ability and pages. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ +export declare class ThemeControl { + /** + * Sets the default Theme: + * - for whole Ability when invoked from the Ability level code. + * - for the ArkUI page and for later opened pages when invoked at the ArkUI page level. + * + * @param { CustomTheme } theme + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + static setDefaultTheme(theme: CustomTheme): void; +} diff --git a/api/@ohos.bluetooth.a2dp.d.ts b/api/@ohos.bluetooth.a2dp.d.ts index 3602d7b03128dc08bcbbae91adfe0a7cf63a6ac0..599a1f620da4c8f98477b60004100fca19e9c1e1 100644 --- a/api/@ohos.bluetooth.a2dp.d.ts +++ b/api/@ohos.bluetooth.a2dp.d.ts @@ -32,6 +32,7 @@ declare namespace a2dp { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ @@ -41,7 +42,8 @@ declare namespace a2dp { * create the instance of a2dp profile. * * @returns { A2dpSourceProfile } Returns the instance of profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter.Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -63,7 +65,8 @@ declare namespace a2dp { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -82,7 +85,8 @@ declare namespace a2dp { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -101,7 +105,8 @@ declare namespace a2dp { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { PlayingState } Returns the playing state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -120,7 +125,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -139,7 +145,8 @@ declare namespace a2dp { * @param { AsyncCallback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -158,7 +165,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -177,7 +185,8 @@ declare namespace a2dp { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -196,7 +205,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -215,7 +225,8 @@ declare namespace a2dp { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -234,7 +245,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -253,7 +265,8 @@ declare namespace a2dp { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -272,7 +285,8 @@ declare namespace a2dp { * @returns { CodecInfo } Returns the CodecInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -291,7 +305,8 @@ declare namespace a2dp { * @param { CodecInfo } codecInfo - Indicates the CodecInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -311,7 +326,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -330,7 +346,8 @@ declare namespace a2dp { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -350,7 +367,8 @@ declare namespace a2dp { * If returns { @code -1 } means allow devices automatic play music when connected. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.access.d.ts b/api/@ohos.bluetooth.access.d.ts index 83f54b96ba41639bbef7230653362ef38e780416..ecc92c5796ea75b7dadc39d948f59446a4f3abdd 100644 --- a/api/@ohos.bluetooth.access.d.ts +++ b/api/@ohos.bluetooth.access.d.ts @@ -86,6 +86,22 @@ declare namespace access { */ function disableBluetooth(): void; + /** + * Restrict Bluetooth BR/EDR ability on a device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @systemapi + * @since 12 + */ + function restrictBluetooth(): Promise; + /** * Obtains the Bluetooth status of a device. * @@ -120,7 +136,8 @@ declare namespace access { * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -169,7 +186,8 @@ declare namespace access { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -182,7 +200,8 @@ declare namespace access { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -198,7 +217,8 @@ declare namespace access { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -211,7 +231,8 @@ declare namespace access { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core diff --git a/api/@ohos.bluetooth.baseProfile.d.ts b/api/@ohos.bluetooth.baseProfile.d.ts index da51376e8cac719b068c19e7eff1f2f404f3c41b..91f2eb59f39d342c4d041400fe0cbe7320158af5 100644 --- a/api/@ohos.bluetooth.baseProfile.d.ts +++ b/api/@ohos.bluetooth.baseProfile.d.ts @@ -32,6 +32,7 @@ declare namespace baseProfile { /** * Indicate the profile connection state. * + * @typedef { constant.ProfileConnectionState } ProfileConnectionState * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ @@ -175,7 +176,8 @@ declare namespace baseProfile { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -196,7 +198,8 @@ declare namespace baseProfile { * @param { AsyncCallback } callback - the callback of setConnectionStrategy. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -216,7 +219,8 @@ declare namespace baseProfile { * @param { AsyncCallback } callback - the callback of getConnectionStrategy. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -236,7 +240,8 @@ declare namespace baseProfile { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -271,7 +276,8 @@ declare namespace baseProfile { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { ProfileConnectionState } Returns the connection state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -289,7 +295,8 @@ declare namespace baseProfile { * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -303,7 +310,8 @@ declare namespace baseProfile { * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 diff --git a/api/@ohos.bluetooth.ble.d.ts b/api/@ohos.bluetooth.ble.d.ts index de57d0abdfaf141a1b3db52b1352f98559bd7941..23ae59db186deddb0e003de4cb9099c061b203b7 100644 --- a/api/@ohos.bluetooth.ble.d.ts +++ b/api/@ohos.bluetooth.ble.d.ts @@ -75,7 +75,8 @@ declare namespace ble { * * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { GattClientDevice } Returns a Gatt client device instance {@code GattClientDevice}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -85,7 +86,8 @@ declare namespace ble { * * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { GattClientDevice } Returns a Gatt client device instance {@code GattClientDevice}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -118,7 +120,8 @@ declare namespace ble { * {@link ScanOptions#interval} set to 0, {@link ScanOptions#dutyMode} set to {@link SCAN_MODE_LOW_POWER} * and {@link ScanOptions#matchMode} set to {@link MATCH_MODE_AGGRESSIVE}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -137,12 +140,14 @@ declare namespace ble { * and {@link ScanOptions#matchMode} set to {@link MATCH_MODE_AGGRESSIVE}. * and {@link ScanOptions#phyType} set to {@link PHY_LE_ALL_SUPPORTED}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice * @since 12 */ function startBLEScan(filters: Array, options?: ScanOptions): void; @@ -159,6 +164,19 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Stops BLE scanning. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ function stopBLEScan(): void; /** @@ -169,7 +187,8 @@ declare namespace ble { * @param { AdvertiseData } advData - Indicates the advertising data. * @param { AdvertiseData } advResponse - Indicates the scan response associated with the advertising data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -185,7 +204,8 @@ declare namespace ble { * @param { AdvertiseData } advData - Indicates the advertising data. * @param { AdvertiseData } advResponse - Indicates the scan response associated with the advertising data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -233,7 +253,8 @@ declare namespace ble { * @param { AdvertisingParams } advertisingParams - Indicates the params for BLE advertising. * @param { AsyncCallback } callback - the callback of advertise ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -253,7 +274,8 @@ declare namespace ble { * @param { AdvertisingParams } advertisingParams - Indicates the param for BLE advertising. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -270,7 +292,8 @@ declare namespace ble { * @param { AdvertisingEnableParams } advertisingEnableParams - Indicates the params for enable advertising. * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -287,7 +310,8 @@ declare namespace ble { * @param { AdvertisingEnableParams } advertisingEnableParams - Indicates the params for enable advertising. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -304,7 +328,8 @@ declare namespace ble { * @param { AdvertisingDisableParams } advertisingDisableParams - Indicates the params for disable advertising. * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -321,7 +346,8 @@ declare namespace ble { * @param { AdvertisingDisableParams } advertisingDisableParams - Indicates the params for disable advertising. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -339,7 +365,8 @@ declare namespace ble { * @param { number } advertisingId - Indicates the ID for this BLE advertising. * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -357,7 +384,8 @@ declare namespace ble { * @param { number } advertisingId - Indicates the ID for this BLE advertising. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -374,7 +402,8 @@ declare namespace ble { * @param { 'advertisingStateChange' } type - Type of the advertising state to listen for. * @param { Callback } callback - Callback used to listen for the advertising state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -389,7 +418,8 @@ declare namespace ble { * @param { 'advertisingStateChange' } type - Type of the advertising state to listen for. * @param { Callback } callback - Callback used to listen for the advertising state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -404,12 +434,28 @@ declare namespace ble { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Subscribe BLE scan result. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. + * @param { Callback> } callback - Callback used to listen for the scan result event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ function on(type: 'BLEDeviceFind', callback: Callback>): void; /** @@ -419,12 +465,28 @@ declare namespace ble { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Unsubscribe BLE scan result. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. + * @param { Callback> } callback - Callback used to listen for the scan result event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ function off(type: 'BLEDeviceFind', callback?: Callback>): void; /** @@ -450,7 +512,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { GattService } service - Indicates the service to add. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -465,7 +528,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { GattService } service - Indicates the service to add. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -482,7 +546,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } serviceUuid - Indicates the UUID of the service to remove. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -497,7 +562,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } serviceUuid - Indicates the UUID of the service to remove. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -545,7 +611,8 @@ declare namespace ble { * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -553,6 +620,25 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Sends a notification of a change in a specified local characteristic with a asynchronous callback. + *

This method should be called for every BLE peripheral device that has requested notifications. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". + * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. + * @param { AsyncCallback } callback - Callback used to return the result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ notifyCharacteristicChanged( deviceId: string, notifyCharacteristic: NotifyCharacteristic, @@ -568,7 +654,8 @@ declare namespace ble { * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -576,6 +663,25 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Sends a notification of a change in a specified local characteristic with a asynchronous callback. + *

This method should be called for every BLE peripheral device that has requested notifications. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". + * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ notifyCharacteristicChanged(deviceId: string, notifyCharacteristic: NotifyCharacteristic): Promise; /** @@ -584,7 +690,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { ServerResponse } serverResponse - Indicates the response parameters {@link ServerResponse}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -592,6 +699,22 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Sends a response to a specified read or write request to a given BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { ServerResponse } serverResponse - Indicates the response parameters {@link ServerResponse}. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ sendResponse(serverResponse: ServerResponse): void; /** @@ -601,7 +724,8 @@ declare namespace ble { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -613,7 +737,8 @@ declare namespace ble { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -628,7 +753,8 @@ declare namespace ble { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -640,7 +766,8 @@ declare namespace ble { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -655,7 +782,8 @@ declare namespace ble { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -667,7 +795,8 @@ declare namespace ble { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -682,7 +811,8 @@ declare namespace ble { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -694,7 +824,8 @@ declare namespace ble { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -709,11 +840,26 @@ declare namespace ble { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Subscribe descriptor read event. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. + * @param { Callback } callback - Callback used to listen for the descriptor read event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ on(type: 'descriptorRead', callback: Callback): void; /** @@ -723,11 +869,26 @@ declare namespace ble { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Unsubscribe descriptor read event. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. + * @param { Callback } callback - Callback used to listen for the descriptor read event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ off(type: 'descriptorRead', callback?: Callback): void; /** @@ -737,11 +898,26 @@ declare namespace ble { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Subscribe descriptor write event. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. + * @param { Callback } callback - Callback used to listen for the descriptor write event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ on(type: 'descriptorWrite', callback: Callback): void; /** @@ -751,11 +927,26 @@ declare namespace ble { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Unsubscribe descriptor write event. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. + * @param { Callback } callback - Callback used to listen for the descriptor write event. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ off(type: 'descriptorWrite', callback?: Callback): void; /** @@ -765,7 +956,8 @@ declare namespace ble { * @param { 'connectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -777,7 +969,8 @@ declare namespace ble { * @param { 'connectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -792,7 +985,8 @@ declare namespace ble { * @param { 'connectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -804,7 +998,8 @@ declare namespace ble { * @param { 'connectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -819,7 +1014,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -833,7 +1029,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -926,6 +1123,20 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Disables a BLE peripheral device. + *

This method unregisters the device and clears the registered callbacks and handles. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ close(): void; /** @@ -934,13 +1145,29 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback } callback - Callback used to obtain the device name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Obtains the name of BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { AsyncCallback } callback - Callback used to obtain the device name. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ getDeviceName(callback: AsyncCallback): void; /** @@ -949,13 +1176,29 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise } Returns a string representation of the name if obtained; * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter.Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Obtains the name of BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @returns { Promise } Returns a string representation of the name if obtained; + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter.Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ getDeviceName(): Promise; /** @@ -964,7 +1207,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback> } callback - Callback used to catch the services. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -977,7 +1221,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback> } callback - Callback used to catch the services. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -993,7 +1238,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise> } Returns the list of services {@link GattService} of the BLE peripheral device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1006,7 +1252,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise> } Returns the list of services {@link GattService} of the BLE peripheral device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1023,7 +1270,8 @@ declare namespace ble { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @param { AsyncCallback } callback - Callback invoked to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1038,7 +1286,8 @@ declare namespace ble { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @param { AsyncCallback } callback - Callback invoked to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1056,7 +1305,8 @@ declare namespace ble { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @returns { Promise } - Promise used to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1071,7 +1321,8 @@ declare namespace ble { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @returns { Promise } - Promise used to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1089,7 +1340,8 @@ declare namespace ble { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @param { AsyncCallback } callback - Callback invoked to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1097,6 +1349,23 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Reads the descriptor of a BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. + * @param { AsyncCallback } callback - Callback invoked to return the descriptor read. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2901000 - Read forbidden. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ readDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback): void; /** @@ -1106,7 +1375,8 @@ declare namespace ble { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @returns { Promise } - Promise used to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -1114,6 +1384,23 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Reads the descriptor of a BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. + * @returns { Promise } - Promise used to return the descriptor read. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2901000 - Read forbidden. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ readDescriptorValue(descriptor: BLEDescriptor): Promise; /** @@ -1124,7 +1411,8 @@ declare namespace ble { * @param { GattWriteType } writeType - Write type of the characteristic. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1140,7 +1428,8 @@ declare namespace ble { * @param { GattWriteType } writeType - Write type of the characteristic. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1163,7 +1452,8 @@ declare namespace ble { * @param { GattWriteType } writeType - Write type of the characteristic. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1179,7 +1469,8 @@ declare namespace ble { * @param { GattWriteType } writeType - Write type of the characteristic. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1197,7 +1488,8 @@ declare namespace ble { * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1205,6 +1497,23 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Writes the descriptor of a BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. + * @param { AsyncCallback } callback - Callback used to return the result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2901001 - Write forbidden. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ writeDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback): void; /** @@ -1214,7 +1523,8 @@ declare namespace ble { * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -1222,6 +1532,23 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Writes the descriptor of a BLE peripheral device. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2901001 - Write forbidden. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ writeDescriptorValue(descriptor: BLEDescriptor): Promise; /** @@ -1230,7 +1557,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback } callback - Callback invoked to return the RSSI, in dBm. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1242,7 +1570,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback } callback - Callback invoked to return the RSSI, in dBm. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1257,7 +1586,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise } Returns the RSSI value. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1269,7 +1599,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise } Returns the RSSI value. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1284,7 +1615,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { number } mtu - The maximum transmission unit. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1297,7 +1629,8 @@ declare namespace ble { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { number } mtu - The maximum transmission unit. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1316,7 +1649,8 @@ declare namespace ble { * that notification is enabled, and the value {@code false} indicates that indication is disabled. * @param { AsyncCallback } callback - the callback of setCharacteristicChangeNotification. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1332,7 +1666,8 @@ declare namespace ble { * that notification is enabled, and the value {@code false} indicates that indication is disabled. * @param { AsyncCallback } callback - the callback of setCharacteristicChangeNotification. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1355,7 +1690,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1371,7 +1707,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1390,7 +1727,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @param { AsyncCallback } callback - the callback of setCharacteristicChangeIndication. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1406,7 +1744,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @param { AsyncCallback } callback - the callback of setCharacteristicChangeIndication. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1429,7 +1768,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1445,7 +1785,8 @@ declare namespace ble { * that indication is enabled, and the value {@code false} indicates that indication is disabled. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1462,7 +1803,8 @@ declare namespace ble { * @param { 'BLECharacteristicChange' } type - Type of the characteristic value changed event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic value changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1474,7 +1816,8 @@ declare namespace ble { * @param { 'BLECharacteristicChange' } type - Type of the characteristic value changed event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic value changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1489,7 +1832,8 @@ declare namespace ble { * @param { 'BLECharacteristicChange' } type - Type of the characteristic value changed event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic value changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1501,7 +1845,8 @@ declare namespace ble { * @param { 'BLECharacteristicChange' } type - Type of the characteristic value changed event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic value changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1516,7 +1861,8 @@ declare namespace ble { * @param { 'BLEConnectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1528,7 +1874,8 @@ declare namespace ble { * @param { 'BLEConnectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1543,7 +1890,8 @@ declare namespace ble { * @param { 'BLEConnectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1555,7 +1903,8 @@ declare namespace ble { * @param { 'BLEConnectionStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1570,7 +1919,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1582,7 +1932,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1597,7 +1948,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1609,7 +1961,8 @@ declare namespace ble { * @param { 'BLEMtuChange' } type - Type of the mtu changed event to listen for. * @param { Callback } callback - Callback used to listen for the mtu changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice @@ -1861,6 +2214,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the value of the indication or notification sent by the Gatt server. + * + * @typedef NotifyCharacteristic + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface NotifyCharacteristic { /** * The UUID of the {@link GattService} instance to which the characteristic belongs @@ -1868,28 +2229,57 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ - serviceUuid: string; /** - * The UUID of a NotifyCharacteristic instance + * The UUID of the {@link GattService} instance to which the characteristic belongs * * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @atomicservice + * @since 12 */ - characteristicUuid: string; + serviceUuid: string; /** - * The value of a NotifyCharacteristic instance + * The UUID of a NotifyCharacteristic instance * * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ - characteristicValue: ArrayBuffer; /** - * Specifies whether to request confirmation from the BLE peripheral device (indication) or + * The UUID of a NotifyCharacteristic instance + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ + characteristicUuid: string; + /** + * The value of a NotifyCharacteristic instance + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @since 10 + */ + /** + * The value of a NotifyCharacteristic instance + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ + characteristicValue: ArrayBuffer; + /** + * Specifies whether to request confirmation from the BLE peripheral device (indication) or * send a notification. Value {@code true} indicates the former and {@code false} indicates the latter. * * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Specifies whether to request confirmation from the BLE peripheral device (indication) or + * send a notification. Value {@code true} indicates the former and {@code false} indicates the latter. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ confirm: boolean; } @@ -2118,6 +2508,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the parameters of the Gatt client's descriptor read request. + * + * @typedef DescriptorReadRequest + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface DescriptorReadRequest { /** * Indicates the address of the client that initiates the read request @@ -2125,6 +2523,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the address of the client that initiates the read request + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceId: string; /** * The Id of the read request @@ -2132,6 +2537,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The Id of the read request + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ transId: number; /** * Indicates the byte offset of the start position for reading characteristic value @@ -2139,6 +2551,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the byte offset of the start position for reading characteristic value + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ offset: number; /** * The UUID of a DescriptorReadRequest instance @@ -2146,6 +2565,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of a DescriptorReadRequest instance + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ descriptorUuid: string; /** * The UUID of the characteristic to which the descriptor belongs @@ -2153,6 +2579,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of the characteristic to which the descriptor belongs + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ characteristicUuid: string; /** * The UUID of the service to which the descriptor belongs @@ -2160,6 +2593,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of the service to which the descriptor belongs + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceUuid: string; } @@ -2170,6 +2610,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the parameters of the Gatt client's characteristic write request. + * + * @typedef DescriptorWriteRequest + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface DescriptorWriteRequest { /** * Indicates the address of the client that initiates the write request @@ -2177,6 +2625,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the address of the client that initiates the write request + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceId: string; /** * The Id of the write request @@ -2184,6 +2639,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The Id of the write request + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ transId: number; /** * Indicates the byte offset of the start position for writing characteristic value @@ -2191,6 +2653,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the byte offset of the start position for writing characteristic value + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ offset: number; /** * Whether this request should be pending for later operation @@ -2198,6 +2667,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Whether this request should be pending for later operation + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ isPrepared: boolean; /** * Whether the remote client need a response @@ -2205,6 +2681,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Whether the remote client need a response + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ needRsp: boolean; /** * Indicates the value to be written @@ -2212,6 +2695,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the value to be written + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ value: ArrayBuffer; /** * The UUID of a DescriptorWriteRequest instance @@ -2219,6 +2709,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of a DescriptorWriteRequest instance + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ descriptorUuid: string; /** * The UUID of the characteristic to which the descriptor belongs @@ -2226,6 +2723,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of the characteristic to which the descriptor belongs + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ characteristicUuid: string; /** * The UUID of the service to which the descriptor belongs @@ -2233,6 +2737,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The UUID of the service to which the descriptor belongs + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceUuid: string; } @@ -2243,6 +2754,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the parameters of a response send by the server to a specified read or write request. + * + * @typedef ServerResponse + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface ServerResponse { /** * Indicates the address of the client to which to send the response @@ -2250,6 +2769,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the address of the client to which to send the response + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceId: string; /** * The Id of the write request @@ -2257,6 +2783,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The Id of the write request + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ transId: number; /** * Indicates the status of the read or write request, set this parameter to '0' in normal cases @@ -2264,6 +2797,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the status of the read or write request, set this parameter to '0' in normal cases + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ status: number; /** * Indicates the byte offset of the start position for reading or writing operation @@ -2271,6 +2811,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the byte offset of the start position for reading or writing operation + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ offset: number; /** * Indicates the value to be sent @@ -2278,6 +2825,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Indicates the value to be sent + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ value: ArrayBuffer; } @@ -2334,6 +2888,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the contents of the scan results. + * + * @typedef ScanResult + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface ScanResult { /** * Address of the scanned device @@ -2341,6 +2903,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Address of the scanned device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceId: string; /** * RSSI of the remote device @@ -2348,6 +2917,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * RSSI of the remote device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ rssi: number; /** * The raw data of broadcast packet @@ -2355,6 +2931,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The raw data of broadcast packet + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ data: ArrayBuffer; /** * The local name of the BLE device @@ -2362,6 +2945,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The local name of the BLE device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceName: string; /** * Connectable of the remote device @@ -2369,6 +2959,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Connectable of the remote device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ connectable: boolean; } @@ -2729,6 +3326,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the criteria for filtering scanning results can be set. + * + * @typedef ScanFilter + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface ScanFilter { /** * The address of a BLE peripheral device @@ -2736,6 +3341,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The address of a BLE peripheral device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ deviceId?: string; /** @@ -2744,6 +3356,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The name of a BLE peripheral device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ name?: string; /** @@ -2752,6 +3371,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The service UUID of a BLE peripheral device + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceUuid?: string; /** @@ -2760,6 +3386,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Service UUID mask. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceUuidMask?: string; /** @@ -2768,6 +3401,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Service solicitation UUID. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceSolicitationUuid?: string; /** @@ -2776,6 +3416,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Service solicitation UUID mask. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceSolicitationUuidMask?: string; /** @@ -2784,6 +3431,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Service data. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceData?: ArrayBuffer; /** @@ -2792,6 +3446,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Service data mask. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ serviceDataMask?: ArrayBuffer; /** @@ -2800,6 +3461,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Manufacture id. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ manufactureId?: number; /** @@ -2808,6 +3476,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Manufacture data. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ manufactureData?: ArrayBuffer; /** @@ -2816,6 +3491,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Manufacture data mask. + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ manufactureDataMask?: ArrayBuffer; } @@ -2826,6 +3508,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Describes the parameters for scan. + * + * @typedef ScanOptions + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interface ScanOptions { /** * Time of delay for reporting the scan result @@ -2833,6 +3523,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Time of delay for reporting the scan result + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ interval?: number; /** * Bluetooth LE scan mode @@ -2840,6 +3537,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Bluetooth LE scan mode + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ dutyMode?: ScanDuty; /** * Match mode for Bluetooth LE scan filters hardware match @@ -2847,11 +3551,19 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Match mode for Bluetooth LE scan filters hardware match + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ matchMode?: MatchMode; /** * Physical Layer used during scan. * * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice * @since 12 */ phyType?: PhyType; @@ -2998,6 +3710,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The enum of scan duty. + * + * @enum { number } + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ enum ScanDuty { /** * low power mode @@ -3005,6 +3725,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * low power mode + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ SCAN_MODE_LOW_POWER = 0, /** * balanced power mode @@ -3012,6 +3739,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * balanced power mode + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ SCAN_MODE_BALANCED = 1, /** * Scan using highest duty cycle @@ -3019,6 +3753,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * Scan using highest duty cycle + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ SCAN_MODE_LOW_LATENCY = 2 } @@ -3029,6 +3770,14 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * The enum of BLE match mode. + * + * @enum { number } + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ enum MatchMode { /** * aggressive mode @@ -3036,6 +3785,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * aggressive mode + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ MATCH_MODE_AGGRESSIVE = 1, /** * sticky mode @@ -3043,6 +3799,13 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ + /** + * sticky mode + * + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 + */ MATCH_MODE_STICKY = 2 } @@ -3089,6 +3852,7 @@ declare namespace ble { * * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice * @since 12 */ enum PhyType { @@ -3096,6 +3860,7 @@ declare namespace ble { * Use 1M phy for scanning. * * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice * @since 12 */ PHY_LE_1M = 1, @@ -3103,6 +3868,7 @@ declare namespace ble { * Use all supported Phys for scanning. * * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice * @since 12 */ PHY_LE_ALL_SUPPORTED = 255 diff --git a/api/@ohos.bluetooth.connection.d.ts b/api/@ohos.bluetooth.connection.d.ts index dc02fe8fafd35cd32b417a887a3b1fc60e0e9635..45bafae6bb739e9d477be5de936aa0c97fa0f2f1 100644 --- a/api/@ohos.bluetooth.connection.d.ts +++ b/api/@ohos.bluetooth.connection.d.ts @@ -93,7 +93,7 @@ declare namespace connection { * Otherwise, {@link ProfileConnectionState#STATE_DISCONNECTED} is returned. * @returns { ProfileConnectionState } Returns the connection state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -111,7 +111,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @param { AsyncCallback } callback - the callback of pairDevice. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -126,7 +127,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @param { AsyncCallback } callback - the callback of pairDevice. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -144,7 +146,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -159,7 +162,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -181,7 +185,8 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of pairCredibleDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -203,7 +208,8 @@ declare namespace connection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -222,7 +228,8 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of cancelPairedDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -241,7 +248,8 @@ declare namespace connection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -260,7 +268,8 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of cancelPairingDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -279,7 +288,8 @@ declare namespace connection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -297,7 +307,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { string } Returns the device name in character string format. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -312,7 +323,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { string } Returns the device name in character string format. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -330,7 +342,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { DeviceClass } The class of the remote device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -390,7 +403,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { BondState } Returns the pair state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -405,7 +419,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { BondState } Returns the pair state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -423,7 +438,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @param { boolean } accept - Indicates whether to accept the pairing request, {@code true} indicates accept or {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -441,7 +457,8 @@ declare namespace connection { * @param { string } code - The pin code entered by the user. * @param { AsyncCallback } callback - the callback of setDevicePinCode. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -459,7 +476,8 @@ declare namespace connection { * @param { string } code - The pin code entered by the user. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -475,7 +493,8 @@ declare namespace connection { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } name - Indicates a valid Bluetooth name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -492,7 +511,8 @@ declare namespace connection { * @param { ScanMode } mode - Indicates the Bluetooth scan mode to set. * @param { number } duration - Indicates the duration in seconds, in which the host is discoverable. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -593,7 +613,8 @@ declare namespace connection { * @param { AsyncCallback> } callback - the callback of getLocalProfileUuids. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -611,7 +632,8 @@ declare namespace connection { * @returns { Promise> } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -630,7 +652,8 @@ declare namespace connection { * @param { AsyncCallback> } callback - the callback of getRemoteProfileUuids. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -649,7 +672,8 @@ declare namespace connection { * @returns { Promise> } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -668,7 +692,8 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -687,7 +712,8 @@ declare namespace connection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -706,7 +732,8 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -724,7 +751,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { Promise } Returns battery info. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -740,7 +768,8 @@ declare namespace connection { * @returns { string } Returns the remote device's product ID. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -759,7 +788,8 @@ declare namespace connection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -778,11 +808,28 @@ declare namespace connection { * @param { string } name - New device name. Max length is 64 bytes. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 12 + */ + /** + * Modify remote device name. + * + * @permission ohos.permission.ACCESS_BLUETOOTH + * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". + * @param { string } name - New device name. Max length is 64 bytes. + * @returns { Promise } Returns the promise object. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 2900001 - Service stopped. + * @throws { BusinessError } 2900003 - Bluetooth switch is off. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @atomicservice + * @since 12 */ function setRemoteDeviceName(deviceId: string, name: string): Promise; @@ -794,7 +841,8 @@ declare namespace connection { * @param { DeviceType } type - Indicates device type. * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -810,7 +858,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { Promise } Returns the device type. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -826,7 +875,8 @@ declare namespace connection { * @param { 'bluetoothDeviceFind' } type - Type of the discovering event to listen for. * @param { Callback> } callback - Callback used to listen for the discovering event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -839,7 +889,8 @@ declare namespace connection { * @param { 'bluetoothDeviceFind' } type - Type of the discovering event to listen for. * @param { Callback> } callback - Callback used to listen for the discovering event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -882,7 +933,8 @@ declare namespace connection { * @param { 'discoveryResult' } type - Type of the discovering event to listen for. * @param { Callback> } callback - Callback used to listen for the discovering event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -913,7 +965,8 @@ declare namespace connection { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -928,7 +981,8 @@ declare namespace connection { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -943,7 +997,8 @@ declare namespace connection { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -958,7 +1013,8 @@ declare namespace connection { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core diff --git a/api/@ohos.bluetooth.hfp.d.ts b/api/@ohos.bluetooth.hfp.d.ts index d91e20335809e33e28e1b98d3f69390be9413848..8f51046113cce0bdab43160bd25a248f94c89e86 100644 --- a/api/@ohos.bluetooth.hfp.d.ts +++ b/api/@ohos.bluetooth.hfp.d.ts @@ -31,6 +31,7 @@ declare namespace hfp { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ @@ -40,7 +41,8 @@ declare namespace hfp { * create the instance of hfp profile. * * @returns { HandsFreeAudioGatewayProfile } Returns the instance of profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -62,7 +64,8 @@ declare namespace hfp { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -81,7 +84,8 @@ declare namespace hfp { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.hid.d.ts b/api/@ohos.bluetooth.hid.d.ts index 30d5f6832bb0b7b54f4404679f8717ac233425f5..7b29b33d16f7a924a6d91f6c72cb8207823767c1 100644 --- a/api/@ohos.bluetooth.hid.d.ts +++ b/api/@ohos.bluetooth.hid.d.ts @@ -31,6 +31,7 @@ declare namespace hid { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ @@ -40,7 +41,8 @@ declare namespace hid { * create the instance of hid profile. * * @returns { HidHostProfile } Returns the instance of hid profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -62,7 +64,8 @@ declare namespace hid { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -81,7 +84,8 @@ declare namespace hid { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.map.d.ts b/api/@ohos.bluetooth.map.d.ts index 5eb638dad4864df17155a215c32de6ff94513b4e..2d7e21df5ccde4841bc5029a8ea2baeaa32cc220 100644 --- a/api/@ohos.bluetooth.map.d.ts +++ b/api/@ohos.bluetooth.map.d.ts @@ -32,6 +32,7 @@ declare namespace map { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 11 */ @@ -40,6 +41,7 @@ declare namespace map { /** * Indicate the phone book access authorization. * + * @typedef { constant.AccessAuthorization } AccessAuthorization * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 11 @@ -50,7 +52,8 @@ declare namespace map { * create the instance of MAP MSE profile. * * @returns { MapMseProfile } Returns the instance of map mse profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 11 @@ -72,7 +75,8 @@ declare namespace map { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -93,7 +97,8 @@ declare namespace map { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -113,7 +118,8 @@ declare namespace map { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.pan.d.ts b/api/@ohos.bluetooth.pan.d.ts index d937b6bfd4726d86fd78c5572d3a9d289f70a698..cd1b3dd177d4aa852f757b38738bc31083264e19 100644 --- a/api/@ohos.bluetooth.pan.d.ts +++ b/api/@ohos.bluetooth.pan.d.ts @@ -31,6 +31,7 @@ declare namespace pan { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 */ @@ -40,7 +41,8 @@ declare namespace pan { * create the instance of pan profile. * * @returns { PanProfile } Returns the instance of pan profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -62,7 +64,8 @@ declare namespace pan { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -81,7 +84,8 @@ declare namespace pan { * @param { boolean } enable - Specifies whether to enable tethering. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.pbap.d.ts b/api/@ohos.bluetooth.pbap.d.ts index fb408ebdbd2d03da0c4ea8b643a2cfdc1bb55858..71acd17a81051e88bec133f1b4aadeaa5d91b0ff 100644 --- a/api/@ohos.bluetooth.pbap.d.ts +++ b/api/@ohos.bluetooth.pbap.d.ts @@ -33,6 +33,7 @@ declare namespace pbap { /** * Base interface of profile. * + * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @since 11 */ @@ -41,6 +42,7 @@ declare namespace pbap { /** * Indicate the phone book access authorization. * + * @typedef { constant.AccessAuthorization } AccessAuthorization * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 11 @@ -86,7 +88,8 @@ declare namespace pbap { * create the instance of PBAP server profile. * * @returns { PbapServerProfile } Returns the instance of pan profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 11 @@ -108,7 +111,8 @@ declare namespace pbap { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -129,7 +133,8 @@ declare namespace pbap { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -150,7 +155,8 @@ declare namespace pbap { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -170,7 +176,8 @@ declare namespace pbap { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -190,7 +197,8 @@ declare namespace pbap { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -211,7 +219,8 @@ declare namespace pbap { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -236,7 +245,8 @@ declare namespace pbap { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -256,7 +266,8 @@ declare namespace pbap { * @param { AsyncCallback } callback - the callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -276,7 +287,8 @@ declare namespace pbap { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetooth.socket.d.ts b/api/@ohos.bluetooth.socket.d.ts index 3f6fbf7bf5c0392eb0961dd2e13de2f6beff6de4..3452cf8164a95646abefcae84b2d1117bc012de6 100644 --- a/api/@ohos.bluetooth.socket.d.ts +++ b/api/@ohos.bluetooth.socket.d.ts @@ -36,7 +36,8 @@ declare namespace socket { * @param { SppOptions } options - Indicates the listen parameters. * @param { AsyncCallback } callback - Callback used to return a server socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -52,7 +53,8 @@ declare namespace socket { * * @param { number } serverSocket - Indicates the server socket ID, returned by {@link sppListen}. * @param { AsyncCallback } callback - Callback used to return a client socket ID. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -71,7 +73,8 @@ declare namespace socket { * @param { SppOptions } options - Indicates the connect parameters {@link SppOptions}. * @param { AsyncCallback } callback - Callback used to return a client socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -86,7 +89,8 @@ declare namespace socket { * Disables an spp server socket and releases related resources. * * @param { number } socket - Indicates the server socket ID, returned by {@link sppListen}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -99,7 +103,8 @@ declare namespace socket { * Disables an spp client socket and releases related resources. * * @param { number } socket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -113,7 +118,8 @@ declare namespace socket { * * @param { number } clientSocket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. * @param { ArrayBuffer } data - Indicates the data to write. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2901054 - IO error. * @throws { BusinessError } 2900099 - Operation failed. @@ -128,7 +134,8 @@ declare namespace socket { * @param { 'sppRead' } type - Type of the spp read event to listen for. * @param { number } clientSocket - Client socket ID, which is obtained by sppAccept or sppConnect. * @param { Callback } callback - Callback used to listen for the spp read event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2901054 - IO error. * @throws { BusinessError } 2900099 - Operation failed. @@ -143,7 +150,8 @@ declare namespace socket { * @param { 'sppRead' } type - Type of the spp read event to listen for. * @param { number } clientSocket - Client socket ID, which is obtained by sppAccept or sppConnect. * @param { Callback } callback - Callback used to listen for the spp read event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 diff --git a/api/@ohos.bluetooth.wearDetection.d.ts b/api/@ohos.bluetooth.wearDetection.d.ts index 011a4045f343cc8c16a2ebf68921a86ea85ca5ef..8f2512f2ff3a342c70721e515f4ff09fd0a44e6c 100644 --- a/api/@ohos.bluetooth.wearDetection.d.ts +++ b/api/@ohos.bluetooth.wearDetection.d.ts @@ -36,7 +36,8 @@ declare namespace wearDetection { * @param { AsyncCallback } callback - the Callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -55,7 +56,8 @@ declare namespace wearDetection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -74,7 +76,8 @@ declare namespace wearDetection { * @param { AsyncCallback } callback - the Callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -93,7 +96,8 @@ declare namespace wearDetection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -112,7 +116,8 @@ declare namespace wearDetection { * @param { AsyncCallback } callback - the Callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -131,7 +136,8 @@ declare namespace wearDetection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -150,7 +156,8 @@ declare namespace wearDetection { * @param { AsyncCallback } callback - the Callback result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -169,7 +176,8 @@ declare namespace wearDetection { * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. diff --git a/api/@ohos.bluetoothManager.d.ts b/api/@ohos.bluetoothManager.d.ts index 3305795f808e4c72348792e6f48d8d0636f4b9b9..e14b6d474c1444eecd00bf728407e48fc47fcc3b 100644 --- a/api/@ohos.bluetoothManager.d.ts +++ b/api/@ohos.bluetoothManager.d.ts @@ -109,7 +109,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } deviceId - The address of the remote device to pair. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -126,7 +127,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } deviceId - The address of the remote device to pair. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -145,7 +147,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device to be removed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -164,7 +167,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device to be removed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -184,7 +188,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device. * @returns { string } Returns the device name in character string format. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -202,7 +207,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device. * @returns { string } Returns the device name in character string format. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -221,7 +227,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device. * @returns { DeviceClass } The class of the remote device, {@link DeviceClass}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -239,7 +246,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - The address of the remote device. * @returns { DeviceClass } The class of the remote device, {@link DeviceClass}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -380,7 +388,8 @@ declare namespace bluetoothManager { * @param { ProfileId } profileId - The profile id. * @returns { ProfileConnectionState } Returns the connection state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -399,7 +408,8 @@ declare namespace bluetoothManager { * @param { ProfileId } profileId - The profile id. * @returns { ProfileConnectionState } Returns the connection state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -419,7 +429,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device. * @param { boolean } accept - Indicates whether to accept the pairing request, {@code true} indicates accept or {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -437,7 +448,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device. * @param { boolean } accept - Indicates whether to accept the pairing request, {@code true} indicates accept or {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -455,7 +467,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } name - Indicates a valid Bluetooth name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -472,7 +485,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } name - Indicates a valid Bluetooth name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -491,7 +505,8 @@ declare namespace bluetoothManager { * @param { ScanMode } mode - Indicates the Bluetooth scan mode to set, {@link ScanMode}. * @param { number } duration - Indicates the duration in seconds, in which the host is discoverable. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -509,7 +524,8 @@ declare namespace bluetoothManager { * @param { ScanMode } mode - Indicates the Bluetooth scan mode to set, {@link ScanMode}. * @param { number } duration - Indicates the duration in seconds, in which the host is discoverable. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -624,7 +640,8 @@ declare namespace bluetoothManager { * @param { 'bluetoothDeviceFind' } type - Type of the discovering event to listen for. * @param { Callback> } callback - Callback used to listen for the discovering event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -640,7 +657,8 @@ declare namespace bluetoothManager { * @param { 'bluetoothDeviceFind' } type - Type of the discovering event to listen for. * @param { Callback> } callback - Callback used to listen for the discovering event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -688,7 +706,8 @@ declare namespace bluetoothManager { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event, {@link BondStateParam}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -704,7 +723,8 @@ declare namespace bluetoothManager { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event, {@link BondStateParam}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -721,7 +741,8 @@ declare namespace bluetoothManager { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -737,7 +758,8 @@ declare namespace bluetoothManager { * @param { 'bondStateChange' } type - Type of the bond state event to listen for. * @param { Callback } callback - Callback used to listen for the bond state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -754,7 +776,8 @@ declare namespace bluetoothManager { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -770,7 +793,8 @@ declare namespace bluetoothManager { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -787,7 +811,8 @@ declare namespace bluetoothManager { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -803,7 +828,8 @@ declare namespace bluetoothManager { * @param { 'pinRequired' } type - Type of the pairing request event to listen for. * @param { Callback } callback - Callback used to listen for the pairing request event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -820,7 +846,8 @@ declare namespace bluetoothManager { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -836,7 +863,8 @@ declare namespace bluetoothManager { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -853,7 +881,8 @@ declare namespace bluetoothManager { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -869,7 +898,8 @@ declare namespace bluetoothManager { * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. * @param { Callback } callback - Callback used to listen for the Bluetooth state event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -887,7 +917,8 @@ declare namespace bluetoothManager { * @param { SppOption } option - Indicates the listen parameters {@link SppOption}. * @param { AsyncCallback } callback - Callback used to return a server socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -907,7 +938,8 @@ declare namespace bluetoothManager { * @param { SppOption } option - Indicates the listen parameters {@link SppOption}. * @param { AsyncCallback } callback - Callback used to return a server socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -925,7 +957,8 @@ declare namespace bluetoothManager { * * @param { number } serverSocket - Indicates the server socket ID, returned by {@link sppListen}. * @param { AsyncCallback } callback - Callback used to return a client socket ID. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -946,7 +979,8 @@ declare namespace bluetoothManager { * @param { SppOption } option - Indicates the connect parameters {@link SppOption}. * @param { AsyncCallback } callback - Callback used to return a client socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -966,7 +1000,8 @@ declare namespace bluetoothManager { * @param { SppOption } option - Indicates the connect parameters {@link SppOption}. * @param { AsyncCallback } callback - Callback used to return a client socket ID. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -983,7 +1018,8 @@ declare namespace bluetoothManager { * Disables an spp server socket and releases related resources. * * @param { number } socket - Indicates the server socket ID, returned by {@link sppListen}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -998,7 +1034,8 @@ declare namespace bluetoothManager { * Disables an spp client socket and releases related resources. * * @param { number } socket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -1014,7 +1051,8 @@ declare namespace bluetoothManager { * * @param { number } clientSocket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. * @param { ArrayBuffer } data - Indicates the data to write. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2901054 - IO error. * @throws { BusinessError } 2900099 - Operation failed. @@ -1031,7 +1069,8 @@ declare namespace bluetoothManager { * @param { 'sppRead' } type - Type of the spp read event to listen for. * @param { number } clientSocket - Client socket ID, which is obtained by sppAccept or sppConnect. * @param { Callback } callback - Callback used to listen for the spp read event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2901054 - IO error. * @throws { BusinessError } 2900099 - Operation failed. @@ -1048,7 +1087,8 @@ declare namespace bluetoothManager { * @param { 'sppRead' } type - Type of the spp read event to listen for. * @param { number } clientSocket - Client socket ID, which is obtained by sppAccept or sppConnect. * @param { Callback } callback - Callback used to listen for the spp read event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1062,7 +1102,8 @@ declare namespace bluetoothManager { * * @param { ProfileId } profileId - The profile id.. * @returns { A2dpSourceProfile | HandsFreeAudioGatewayProfile | HidHostProfile | PanProfile } Returns the instance of profile. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1124,7 +1165,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of bluetooth device. * @returns { ProfileConnectionState } Returns {@link ProfileConnectionState} of device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1143,7 +1185,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of bluetooth device. * @returns { ProfileConnectionState } Returns {@link ProfileConnectionState} of device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1173,7 +1216,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1191,7 +1235,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1210,7 +1255,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1228,7 +1274,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1246,7 +1293,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1260,7 +1308,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1274,7 +1323,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1288,7 +1338,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1302,7 +1353,8 @@ declare namespace bluetoothManager { * * @param { string } device - The address of the remote device. * @returns { PlayingState } Returns {@link PlayingState} of the remote device. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1320,7 +1372,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } device - The address of the remote device. * @returns { PlayingState } Returns {@link PlayingState} of the remote device. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1350,7 +1403,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1368,7 +1422,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1387,7 +1442,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.DISCOVER_BLUETOOTH * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1405,7 +1461,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1423,7 +1480,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1437,7 +1495,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1451,7 +1510,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1465,7 +1525,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1492,7 +1553,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1512,7 +1574,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to connect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1533,7 +1596,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1553,7 +1617,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1572,7 +1637,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1586,7 +1652,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1600,7 +1667,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1614,7 +1682,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1641,7 +1710,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1661,7 +1731,8 @@ declare namespace bluetoothManager { * @param { string } device - The address of the remote device to disconnect. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1680,7 +1751,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1694,7 +1766,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for . * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1708,7 +1781,8 @@ declare namespace bluetoothManager { * * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1722,7 +1796,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for. * @param { Callback } callback - Callback used to listen for event. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -1739,7 +1814,8 @@ declare namespace bluetoothManager { * that tethering is enabled, and the value {@code false} indicates that tethering is disabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1760,7 +1836,8 @@ declare namespace bluetoothManager { * that tethering is enabled, and the value {@code false} indicates that tethering is disabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1829,7 +1906,8 @@ declare namespace bluetoothManager { * * @param { string } deviceId - The address of the remote device. * @returns { GattClientDevice } Returns a JavaScript Gatt client device instance {@code GattClientDevice}. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -1882,7 +1960,8 @@ declare namespace bluetoothManager { * {@link ScanOptions#interval} set to 0, {@link ScanOptions#dutyMode} set to {@link SCAN_MODE_LOW_POWER} * and {@link ScanOptions#matchMode} set to {@link MATCH_MODE_AGGRESSIVE}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1903,7 +1982,8 @@ declare namespace bluetoothManager { * {@link ScanOptions#interval} set to 0, {@link ScanOptions#dutyMode} set to {@link SCAN_MODE_LOW_POWER} * and {@link ScanOptions#matchMode} set to {@link MATCH_MODE_AGGRESSIVE}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -1953,7 +2033,8 @@ declare namespace bluetoothManager { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1969,7 +2050,8 @@ declare namespace bluetoothManager { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -1986,7 +2068,8 @@ declare namespace bluetoothManager { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -2002,7 +2085,8 @@ declare namespace bluetoothManager { * @param { 'BLEDeviceFind' } type - Type of the scan result event to listen for. * @param { Callback> } callback - Callback used to listen for the scan result event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -2032,7 +2116,8 @@ declare namespace bluetoothManager { * @param { AdvertiseData } advData - Indicates the advertising data. * @param { AdvertiseData } advResponse - Indicates the scan response associated with the advertising data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2052,7 +2137,8 @@ declare namespace bluetoothManager { * @param { AdvertiseData } advData - Indicates the advertising data. * @param { AdvertiseData } advResponse - Indicates the scan response associated with the advertising data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2102,7 +2188,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { GattService } service - Indicates the service to add. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2120,7 +2207,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { GattService } service - Indicates the service to add. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2138,7 +2226,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { string } serviceUuid - Indicates the UUID of the service to remove. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2156,7 +2245,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { string } serviceUuid - Indicates the UUID of the service to remove. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2208,7 +2298,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - Indicates the address of the BLE peripheral device to receive the notification. * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2227,7 +2318,8 @@ declare namespace bluetoothManager { * @param { string } deviceId - Indicates the address of the BLE peripheral device to receive the notification. * @param { NotifyCharacteristic } notifyCharacteristic - Indicates the local characteristic that has changed. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2245,7 +2337,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { ServerResponse } serverResponse - Indicates the response parameters {@link ServerResponse}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2262,7 +2355,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { ServerResponse } serverResponse - Indicates the response parameters {@link ServerResponse}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth switch is off. @@ -2281,7 +2375,8 @@ declare namespace bluetoothManager { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2296,7 +2391,8 @@ declare namespace bluetoothManager { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2312,7 +2408,8 @@ declare namespace bluetoothManager { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2327,7 +2424,8 @@ declare namespace bluetoothManager { * @param { 'characteristicRead' } type - Type of the characteristic read event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2343,7 +2441,8 @@ declare namespace bluetoothManager { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2358,7 +2457,8 @@ declare namespace bluetoothManager { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2374,7 +2474,8 @@ declare namespace bluetoothManager { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2389,7 +2490,8 @@ declare namespace bluetoothManager { * @param { 'characteristicWrite' } type - Type of the characteristic write event to listen for. * @param { Callback } callback - Callback used to listen for the characteristic write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2405,7 +2507,8 @@ declare namespace bluetoothManager { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2420,7 +2523,8 @@ declare namespace bluetoothManager { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2436,7 +2540,8 @@ declare namespace bluetoothManager { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2451,7 +2556,8 @@ declare namespace bluetoothManager { * @param { 'descriptorRead' } type - Type of the descriptor read event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor read event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2467,7 +2573,8 @@ declare namespace bluetoothManager { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2482,7 +2589,8 @@ declare namespace bluetoothManager { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2498,7 +2606,8 @@ declare namespace bluetoothManager { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2513,7 +2622,8 @@ declare namespace bluetoothManager { * @param { 'descriptorWrite' } type - Type of the descriptor write event to listen for. * @param { Callback } callback - Callback used to listen for the descriptor write event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2529,7 +2639,8 @@ declare namespace bluetoothManager { * @param { 'connectStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2544,7 +2655,8 @@ declare namespace bluetoothManager { * @param { 'connectStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2560,7 +2672,8 @@ declare namespace bluetoothManager { * @param { 'connectStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 9 @@ -2575,7 +2688,8 @@ declare namespace bluetoothManager { * @param { 'connectStateChange' } type - Type of the connection state changed event to listen for. * @param { Callback } callback - Callback used to listen for the connection state changed event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @since 10 @@ -2698,7 +2812,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { AsyncCallback } callback - Callback used to obtain the device name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2714,7 +2829,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback } callback - Callback used to obtain the device name. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2732,7 +2848,8 @@ declare namespace bluetoothManager { * @returns { Promise } Returns a string representation of the name if obtained; * returns {@code null} if the name fails to be obtained or the name does not exist. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2749,7 +2866,8 @@ declare namespace bluetoothManager { * @returns { Promise } Returns a string representation of the name if obtained; * returns {@code null} if the name fails to be obtained or the name does not exist. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2766,7 +2884,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { AsyncCallback> } callback - Callback used to catch the services. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2782,7 +2901,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback> } callback - Callback used to catch the services. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2799,7 +2919,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @returns { Promise> } Returns the list of services {@link GattService} of the BLE peripheral device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2815,7 +2936,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise> } Returns the list of services {@link GattService} of the BLE peripheral device. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -2833,7 +2955,8 @@ declare namespace bluetoothManager { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @param { AsyncCallback } callback - Callback invoked to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2851,7 +2974,8 @@ declare namespace bluetoothManager { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @param { AsyncCallback } callback - Callback invoked to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2870,7 +2994,8 @@ declare namespace bluetoothManager { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @returns { Promise } - Promise used to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2888,7 +3013,8 @@ declare namespace bluetoothManager { * @param { BLECharacteristic } characteristic - Indicates the characteristic to read. * @returns { Promise } - Promise used to return the characteristic value read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2907,7 +3033,8 @@ declare namespace bluetoothManager { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @param { AsyncCallback } callback - Callback invoked to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2925,7 +3052,8 @@ declare namespace bluetoothManager { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @param { AsyncCallback } callback - Callback invoked to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2944,7 +3072,8 @@ declare namespace bluetoothManager { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @returns { Promise } - Promise used to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2962,7 +3091,8 @@ declare namespace bluetoothManager { * @param { BLEDescriptor } descriptor - Indicates the descriptor to read. * @returns { Promise } - Promise used to return the descriptor read. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901000 - Read forbidden. @@ -2980,7 +3110,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { BLECharacteristic } characteristic - Indicates the characteristic to write. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -2997,7 +3128,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { BLECharacteristic } characteristic - Indicates the characteristic to write. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -3015,7 +3147,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -3032,7 +3165,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { BLEDescriptor } descriptor - Indicates the descriptor to write. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2901001 - Write forbidden. @@ -3050,7 +3184,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { AsyncCallback } callback - Callback invoked to return the RSSI, in dBm. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -3065,7 +3200,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { AsyncCallback } callback - Callback invoked to return the RSSI, in dBm. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -3081,7 +3217,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @returns { Promise } Returns the RSSI value. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -3096,7 +3233,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @returns { Promise } Returns the RSSI value. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core @@ -3112,7 +3250,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.USE_BLUETOOTH * @param { number } mtu - The maximum transmission unit. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -3128,7 +3267,8 @@ declare namespace bluetoothManager { * @permission ohos.permission.ACCESS_BLUETOOTH * @param { number } mtu - The maximum transmission unit. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -3147,7 +3287,8 @@ declare namespace bluetoothManager { * @param { boolean } enable - Specifies whether to enable notification of the characteristic. The value {@code true} indicates * that notification is enabled, and the value {@code false} indicates that notification is disabled. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. @@ -3165,7 +3306,8 @@ declare namespace bluetoothManager { * @param { boolean } enable - Specifies whether to enable notification of the characteristic. The value {@code true} indicates * that notification is enabled, and the value {@code false} indicates that notification is disabled. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900099 - Operation failed. diff --git a/api/@ohos.bundle.bundleManager.d.ts b/api/@ohos.bundle.bundleManager.d.ts index 507d5473ac2c4b7c08451d1be7b9781f77d35073..f4df06c72219980a4f666d34dd08dc99c11fa06f 100644 --- a/api/@ohos.bundle.bundleManager.d.ts +++ b/api/@ohos.bundle.bundleManager.d.ts @@ -2901,7 +2901,7 @@ declare namespace bundleManager { * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700303 - GetExtResource failed due to no extend resource. + * @throws { BusinessError } 17700303 - Failed to obtain extended resources. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 12 @@ -2920,7 +2920,7 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700002 - The specified moduleName is not found. - * @throws { BusinessError } 17700304 - EnableDynamicIcon failed due to parse dynamic icon failed. + * @throws { BusinessError } 17700304 - Failed to enable the dynamic icon. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 12 @@ -2937,7 +2937,7 @@ declare namespace bundleManager { * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700305 - DisableDynamicIcon failed due to no dynamic icon. + * @throws { BusinessError } 17700305 - Failed to disable the dynamic icon. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 12 @@ -2954,7 +2954,7 @@ declare namespace bundleManager { * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700306 - No dynamic icon. + * @throws { BusinessError } 17700306 - Failed to obtain the dynamic icon. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 12 @@ -2970,7 +2970,7 @@ declare namespace bundleManager { * @param { AsyncCallback } callback - Indicates the callback of verifyAbc result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700201 - verifyAbc failed. + * @throws { BusinessError } 17700201 - Failed to verify the abc file. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 11 */ @@ -2985,7 +2985,7 @@ declare namespace bundleManager { * @returns { Promise } Returns verifyAbc result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700201 - verifyAbc failed. + * @throws { BusinessError } 17700201 - Failed to verify the abc file. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 11 */ @@ -3028,7 +3028,7 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter bundleName is empty. * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700053 - Not app gallery call. + * @throws { BusinessError } 17700053 - The caller is not AppGallery. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 11 @@ -3043,7 +3043,7 @@ declare namespace bundleManager { * @returns { Promise } Returns deleteAbc result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700202 - deleteAbc failed. + * @throws { BusinessError } 17700202 - Failed to delete the abc file. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 11 */ @@ -3107,7 +3107,7 @@ declare namespace bundleManager { * @since 12 */ function getDeveloperIds(appDistributionType?: number): Array; - + /** * Switch uninstall state of a specified application. * @@ -3118,22 +3118,24 @@ declare namespace bundleManager { * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700060 - The specified application can not be uninstalled. + * @throws { BusinessError } 17700060 - The specified application cannot be uninstalled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 12 */ function switchUninstallState(bundleName: string, state: boolean): void; - + /** * Obtains configuration information about an application. * + * @typedef { _ApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains configuration information about an application. * + * @typedef { _ApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3143,12 +3145,14 @@ declare namespace bundleManager { /** * Indicates the metadata information about a module. * + * @typedef { _ModuleMetadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 10 */ /** * Indicates the metadata information about a module. * + * @typedef { _ModuleMetadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3158,12 +3162,14 @@ declare namespace bundleManager { /** * Indicates the Metadata. * + * @typedef { _Metadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Indicates the Metadata. * + * @typedef { _Metadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3173,12 +3179,14 @@ declare namespace bundleManager { /** * Obtains configuration information about a bundle. * + * @typedef { _BundleInfo.BundleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains configuration information about a bundle. * + * @typedef { _BundleInfo.BundleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3188,12 +3196,14 @@ declare namespace bundleManager { /** * The scene which is used. * + * @typedef { _BundleInfo.UsedScene } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * The scene which is used. * + * @typedef { _BundleInfo.UsedScene } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3203,12 +3213,14 @@ declare namespace bundleManager { /** * Indicates the required permissions details defined in file config.json. * + * @typedef { _BundleInfo.ReqPermissionDetail } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Indicates the required permissions details defined in file config.json. * + * @typedef { _BundleInfo.ReqPermissionDetail } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3218,12 +3230,14 @@ declare namespace bundleManager { /** * Indicates the SignatureInfo. * + * @typedef { _BundleInfo.SignatureInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Indicates the SignatureInfo. * + * @typedef { _BundleInfo.SignatureInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3233,12 +3247,14 @@ declare namespace bundleManager { /** * Obtains configuration information about a module. * + * @typedef { _HapModuleInfo.HapModuleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains configuration information about a module. * + * @typedef { _HapModuleInfo.HapModuleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3247,13 +3263,15 @@ declare namespace bundleManager { /** * Obtains preload information about a module. - * + * + * @typedef { _HapModuleInfo.PreloadItem } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains preload information about a module. * + * @typedef { _HapModuleInfo.PreloadItem } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3263,12 +3281,14 @@ declare namespace bundleManager { /** * Obtains dependency information about a module. * + * @typedef { _HapModuleInfo.Dependency } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains dependency information about a module. * + * @typedef { _HapModuleInfo.Dependency } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3278,21 +3298,34 @@ declare namespace bundleManager { /** * Obtains the router item about a module. * + * @typedef { _HapModuleInfo.RouterItem} * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 12 */ export type RouterItem = _HapModuleInfo.RouterItem; + /** + * Obtains the data item within router item. + * + * @typedef { _HapModuleInfo.DataItem } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 12 + */ + export type DataItem = _HapModuleInfo.DataItem; + /** * Obtains configuration information about an ability. * + * @typedef { _AbilityInfo.AbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains configuration information about an ability. * + * @typedef { _AbilityInfo.AbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3302,12 +3335,14 @@ declare namespace bundleManager { /** * Contains basic Ability information. Indicates the window size.. * + * @typedef { _AbilityInfo.WindowSize } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Contains basic Ability information. Indicates the window size.. * + * @typedef { _AbilityInfo.WindowSize } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3316,13 +3351,15 @@ declare namespace bundleManager { /** * Obtains extension information about a bundle. - * + * + * @typedef { _ExtensionAbilityInfo.ExtensionAbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Obtains extension information about a bundle. * + * @typedef { _ExtensionAbilityInfo.ExtensionAbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3332,6 +3369,7 @@ declare namespace bundleManager { /** * Indicates the defined permission details in file config.json. * + * @typedef { _PermissionDef } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -3341,12 +3379,14 @@ declare namespace bundleManager { /** * Contains basic Ability information, which uniquely identifies an ability. * + * @typedef { _ElementName } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** * Contains basic Ability information, which uniquely identifies an ability. * + * @typedef { _ElementName } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 @@ -3356,6 +3396,7 @@ declare namespace bundleManager { /** * Contains shared bundle info. * + * @typedef { _SharedBundleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -3365,6 +3406,7 @@ declare namespace bundleManager { /** * Obtains profile file information about a bundle. * + * @typedef { _AppProvisionInfo.AppProvisionInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -3374,6 +3416,7 @@ declare namespace bundleManager { /** * Obtains profile file validity about a bundle. * + * @typedef { _AppProvisionInfo.Validity } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -3383,22 +3426,13 @@ declare namespace bundleManager { /** * Obtains information about a recoverable preinstalled application. * + * @typedef { _RecoverableApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 11 */ export type RecoverableApplicationInfo = _RecoverableApplicationInfo; - /** - * Indicates the information of preinstalled application. - * - * @typedef { _PreinstalledApplicationInfo } - * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @systemapi - * @since 12 - */ - export type PreinstalledApplicationInfo = _PreinstalledApplicationInfo; - /** * Obtains configuration information about an skill * @@ -3418,6 +3452,16 @@ declare namespace bundleManager { * @since 12 */ export type SkillUrl = _Skill.SkillUri; + + /** + * Indicates the information of preinstalled application. + * + * @typedef { _PreinstalledApplicationInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ + export type PreinstalledApplicationInfo = _PreinstalledApplicationInfo; } export default bundleManager; diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index 0c2d648ea43d0018cdb56c5984d44aa5a64fc475..4857778b105e95e1ff82a0bfeaecc50bbb195fe6 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -110,8 +110,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. * @param { AsyncCallback } callback - The callback of installing HAPs result. @@ -151,8 +150,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. * @param { AsyncCallback } callback - The callback of installing HAPs result. @@ -187,6 +185,47 @@ declare namespace installer { * @systemapi * @since 11 */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } installParam - Indicates other parameters required for the installation. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ install(hapFilePaths: Array, installParam: InstallParam, callback: AsyncCallback): void; /** @@ -225,8 +264,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { AsyncCallback } callback - The callback of installing HAPs result. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or @@ -262,8 +300,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { AsyncCallback } callback - The callback of installing HAPs result. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or @@ -294,6 +331,45 @@ declare namespace installer { * @systemapi * @since 11 */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ install(hapFilePaths: Array, callback: AsyncCallback): void; /** @@ -334,8 +410,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. * @returns { Promise } @@ -375,8 +450,7 @@ declare namespace installer { * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or - * ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. * @returns { Promise } @@ -411,6 +485,47 @@ declare namespace installer { * @systemapi * @since 11 */ + /** + * Install haps for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. + * @returns { Promise } + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ install(hapFilePaths: Array, installParam?: InstallParam): Promise; /** @@ -669,42 +784,6 @@ declare namespace installer { */ updateBundleForSelf(hapFilePaths: Array, installParam?: InstallParam): Promise; - /** - * Add extend resources. - * - * @permission ohos.permission.INSTALL_BUNDLE - * @param { string } bundleName - Indicates the bundleName. - * @param { Array } filePaths - Indicates the file path for extend resources. - * @returns { Promise } Returns addExtResource result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700301 - AddExtResource failed due to parse file failed. - * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @systemapi - * @since 12 - */ - addExtResource(bundleName: string, filePaths: Array): Promise; - - /** - * Remove extend resources. - * - * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE - * @param { string } bundleName - Indicates the bundleName. - * @param { Array } moduleName - Indicates the moduleNames for extend resources. - * @returns { Promise } Returns removeExtResource result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700001 - The specified bundleName is not found. - * @throws { BusinessError } 17700302 - RemoveExtResource failed due to module does not exist. - * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @systemapi - * @since 12 - */ - removeExtResource(bundleName: string, moduleNames: Array): Promise; - /** * Uninstall updates for a pre-installed application. * @@ -723,6 +802,42 @@ declare namespace installer { * @since 12 */ uninstallUpdates(bundleName: string, installParam?: InstallParam): Promise; + + /** + * Add extend resources. + * + * @permission ohos.permission.INSTALL_BUNDLE + * @param { string } bundleName - Indicates the bundleName. + * @param { Array } filePaths - Indicates the file path for extend resources. + * @returns { Promise } Returns addExtResource result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700001 - The specified bundleName is not found. + * @throws { BusinessError } 17700301 - AddExtResource failed due to parse file failed. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ + addExtResource(bundleName: string, filePaths: Array): Promise; + + /** + * Remove extend resources. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE + * @param { string } bundleName - Indicates the bundleName. + * @param { Array } moduleName - Indicates the moduleNames for extend resources. + * @returns { Promise } Returns removeExtResource result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700001 - The specified bundleName is not found. + * @throws { BusinessError } 17700302 - RemoveExtResource failed due to module does not exist. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 12 + */ + removeExtResource(bundleName: string, moduleNames: Array): Promise; } /** diff --git a/api/@ohos.calendarManager.d.ts b/api/@ohos.calendarManager.d.ts index 5a0ce6b29249f8e9730eed07d5e38deef6acd095..19cdb33d7304ae32da5df31c7612e83517a61c71 100644 --- a/api/@ohos.calendarManager.d.ts +++ b/api/@ohos.calendarManager.d.ts @@ -55,7 +55,7 @@ declare namespace calendarManager { * @since 11 */ function getCalendarManager(context: Context) : CalendarManager; - + /** * Defines the CalendarManager class and provides functions to access the calendar data. * @@ -78,7 +78,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - calendar account to create calendar * @returns { Promise } the promise with calendar corresponding to account * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -92,7 +92,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - calendar account to create calendar * @param { AsyncCallback } callback - the callback of createCalendar * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -106,7 +106,7 @@ declare namespace calendarManager { * @param { Calendar } calendar - calendar to be deleted * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -120,7 +120,7 @@ declare namespace calendarManager { * @param { Calendar } calendar - calendar to be deleted * @param { AsyncCallback } callback - the callback of deleteCalendar * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -134,7 +134,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - specify calendar account to retrieve * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -146,7 +146,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - specify calendar account to retrieve * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @atomicservice @@ -161,7 +161,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - specify calendar account to retrieve * @param { AsyncCallback } callback - the callback of getCalendar * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -173,7 +173,7 @@ declare namespace calendarManager { * @param { CalendarAccount } calendarAccount - specify calendar account to retrieve * @param { AsyncCallback } callback - the callback of getCalendar * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @atomicservice @@ -187,7 +187,7 @@ declare namespace calendarManager { * @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR * @param { AsyncCallback } callback - the callback of getCalendar with default calendar instance * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -198,7 +198,7 @@ declare namespace calendarManager { * @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR * @param { AsyncCallback } callback - the callback of getCalendar with default calendar instance * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @atomicservice @@ -212,7 +212,7 @@ declare namespace calendarManager { * @permission ohos.permission.READ_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 @@ -225,12 +225,23 @@ declare namespace calendarManager { * @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR * @param {AsyncCallback} callback - the callback of getAllCalendars * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Applications.CalendarData * @since 10 */ getAllCalendars(callback: AsyncCallback): void; + + /** + * Create a single event,invoking this interface will open the event creation page. + * + * @param { Event } event - Indicates the information about a single event. + * @returns { Promise } the promise with event id. + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + editEvent(event: Event): Promise; } /** @@ -727,6 +738,15 @@ declare namespace calendarManager { * @since 11 */ service?: EventService; + + /** + * Unique identifier of the event + * @type { ?string } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + identifier?: string; } /** @@ -988,6 +1008,33 @@ declare namespace calendarManager { * @since 11 */ expire?: number; + + /** + * Repetition count of recurrence event. + * @type { ?number } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + count?: number; + + /** + * Repeat interval of recurrence event. + * @type { ?number } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + interval?: number; + + /** + * Excluded dates of recurrence event. + * @type { ?number[] } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + excludedDates?: number[]; } /** @@ -1100,6 +1147,40 @@ declare namespace calendarManager { * @since 11 */ email: string; + + /** + * Role of the Attendee. + * @type { ?AttendeeRole } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + role?: AttendeeRole; + } + + /** + * Enum for the attendee role + * @enum { string } + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + export enum AttendeeRole { + /** + * The organizer of a meeting. + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + ORGANIZER = 'organizer', + + /** + * The participant of a meeting. + * @syscap SystemCapability.Applications.CalendarData + * @atomicservice + * @since 12 + */ + PARTICIPANT = 'participant' } /** diff --git a/api/@ohos.commonEventManager.d.ts b/api/@ohos.commonEventManager.d.ts index 05d1fb0226aa1f0c4dd158b0e5cfd8c0778e35cc..2a91cebd6b875abe8d0a0508c49cbd950941248b 100644 --- a/api/@ohos.commonEventManager.d.ts +++ b/api/@ohos.commonEventManager.d.ts @@ -46,7 +46,8 @@ declare namespace commonEventManager { * * @param { string } event - name of the common event. * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -59,7 +60,8 @@ declare namespace commonEventManager { * * @param { string } event - name of the common event. * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -68,6 +70,22 @@ declare namespace commonEventManager { * @atomicservice * @since 11 */ + /** + * Publishes an ordered, sticky, or standard common event. + * + * @param { string } event - name of the common event. + * @param { AsyncCallback } callback - The callback of publish. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1500004 - not System services + * @throws { BusinessError } 1500007 - error sending message to Common Event Service + * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization + * @throws { BusinessError } 1500009 - error obtaining system parameters + * @syscap SystemCapability.Notification.CommonEvent + * @crossplatform + * @atomicservice + * @since 12 + */ function publish(event: string, callback: AsyncCallback): void; /** @@ -77,7 +95,8 @@ declare namespace commonEventManager { * @param { CommonEventPublishData } options - Indicate the CommonEventPublishData containing the common event * content and attributes. * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -92,7 +111,8 @@ declare namespace commonEventManager { * @param { CommonEventPublishData } options - Indicate the CommonEventPublishData containing the common event * content and attributes. * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -101,6 +121,24 @@ declare namespace commonEventManager { * @atomicservice * @since 11 */ + /** + * Publishes an ordered, sticky, or standard common event. + * + * @param { string } event - name of the common event. + * @param { CommonEventPublishData } options - Indicate the CommonEventPublishData containing the common event + * content and attributes. + * @param { AsyncCallback } callback - The callback of publish. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1500004 - not System services + * @throws { BusinessError } 1500007 - error sending message to Common Event Service + * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization + * @throws { BusinessError } 1500009 - error obtaining system parameters + * @syscap SystemCapability.Notification.CommonEvent + * @crossplatform + * @atomicservice + * @since 12 + */ function publish(event: string, options: CommonEventPublishData, callback: AsyncCallback): void; /** @@ -110,7 +148,8 @@ declare namespace commonEventManager { * @param { number } userId - Specified the user to receive the common events. * @param { AsyncCallback } callback - The callback of publishAsUser. * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -130,7 +169,8 @@ declare namespace commonEventManager { * content and attributes. * @param { AsyncCallback } callback - The callback of publishAsUser. * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not System services or System app * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -152,7 +192,8 @@ declare namespace commonEventManager { * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @param { AsyncCallback } callback - The callback is used to return the * CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ @@ -162,7 +203,8 @@ declare namespace commonEventManager { * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @param { AsyncCallback } callback - The callback is used to return the * CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice @@ -178,7 +220,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @returns { Promise } Returns the CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ @@ -187,7 +230,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @returns { Promise } Returns the CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice @@ -200,7 +244,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @returns { CommonEventSubscriber } Returns the CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 10 */ @@ -209,7 +254,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscribeInfo } subscribeInfo - Indicates the information of the subscriber. * @returns { CommonEventSubscriber } Returns the CommonEventSubscriber object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @atomicservice * @since 11 @@ -221,7 +267,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscriber } subscriber - Indicate the subscriber of the common event. * @param { AsyncCallback } callback - The callback is used to return the CommonEventData object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - capability not supported * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -233,7 +280,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscriber } subscriber - Indicate the subscriber of the common event. * @param { AsyncCallback } callback - The callback is used to return the CommonEventData object. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - capability not supported * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -249,7 +297,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscriber } subscriber - Indicate the subscriber of the common event. * @param { AsyncCallback } [callback] - The callback of unsubscribe. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - capability not supported * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -261,7 +310,8 @@ declare namespace commonEventManager { * * @param { CommonEventSubscriber } subscriber - Indicate the subscriber of the common event. * @param { AsyncCallback } [callback] - The callback of unsubscribe. - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - capability not supported * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -280,7 +330,8 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of removeStickyCommonEvent. * @throws { BusinessError } 201 - The application dose not have permission to call the interface * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not system service * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -298,7 +349,8 @@ declare namespace commonEventManager { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - The application dose not have permission to call the interface * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500004 - not system service * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization @@ -314,7 +366,8 @@ declare namespace commonEventManager { * @param { boolean } enable - static subscribe event enable/disable state. * @param { AsyncCallback } callback - Specified callback method. * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization * @syscap SystemCapability.Notification.CommonEvent @@ -330,7 +383,8 @@ declare namespace commonEventManager { * @param { boolean } enable - static subscribe event enable/disable state. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization * @syscap SystemCapability.Notification.CommonEvent @@ -347,7 +401,8 @@ declare namespace commonEventManager { * @param { Array } events - The events array. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 202 - not system app - * @throws { BusinessError } 401 - parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1500007 - error sending message to Common Event Service * @throws { BusinessError } 1500008 - Common Event Service does not complete initialization * @syscap SystemCapability.Notification.CommonEvent @@ -791,6 +846,13 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ + /** + * Distributed account login successfully. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGIN = 'common.event.DISTRIBUTED_ACCOUNT_LOGIN', /** @@ -799,6 +861,13 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ + /** + * Distributed account logout successfully. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = 'common.event.DISTRIBUTED_ACCOUNT_LOGOUT', /** @@ -807,6 +876,13 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ + /** + * Distributed account is invalid. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = 'common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID', /** @@ -815,6 +891,13 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @since 9 */ + /** + * Distributed account logs off. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = 'common.event.DISTRIBUTED_ACCOUNT_LOGOFF', /** @@ -2049,6 +2132,26 @@ declare namespace commonEventManager { * @since 12 */ COMMON_EVENT_DYNAMIC_ICON_CHANGED = 'usual.event.DYNAMIC_ICON_CHANGED', + + /** + * This common event means that minors mode is enabled. + * This is a protected common event that can only be sent by system. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ + COMMON_EVENT_MINORSMODE_ON = 'usual.event.MINORSMODE_ON', + + /** + * This common event means that minors mode is disabled. + * This is a protected common event that can only be sent by system. + * + * @syscap SystemCapability.Notification.CommonEvent + * @atomicservice + * @since 12 + */ + COMMON_EVENT_MINORSMODE_OFF = 'usual.event.MINORSMODE_OFF', } /** @@ -2109,6 +2212,14 @@ declare namespace commonEventManager { * @atomicservice * @since 11 */ + /** + * Describes the information of the subscriber + * + * @syscap SystemCapability.Notification.CommonEvent + * @crossplatform + * @atomicservice + * @since 12 + */ export type CommonEventPublishData = _CommonEventPublishData; } diff --git a/api/@ohos.configPolicy.d.ts b/api/@ohos.configPolicy.d.ts index 9315f42542207eeda44d480305db85da3de00cf7..22a06da443c92d646db30f0d3d26867667881efc 100644 --- a/api/@ohos.configPolicy.d.ts +++ b/api/@ohos.configPolicy.d.ts @@ -99,7 +99,8 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { AsyncCallback } callback - contains the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 8 @@ -112,7 +113,8 @@ declare namespace configPolicy { * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. * @param { AsyncCallback } callback - contains the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -124,9 +126,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, only valid when followMode is USER_DEFINED. * @param { AsyncCallback } callback - contains the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -138,7 +141,8 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @returns { Promise } the promise returns the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 8 @@ -150,9 +154,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, must be set when followMode is USER_DEFINED. * @returns { Promise } the promise returns the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -164,9 +169,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, must be set when followMode is USER_DEFINED. * @returns { string } the path of the highest priority config file. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -178,7 +184,8 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { AsyncCallback> } callback - contains paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 8 @@ -191,7 +198,8 @@ declare namespace configPolicy { * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. * @param { AsyncCallback> } callback - contains paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -203,9 +211,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, only valid when followMode is USER_DEFINED. * @param { AsyncCallback> } callback - contains paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -217,7 +226,8 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @returns { Promise> } the promise returns paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 8 @@ -229,9 +239,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, must be set when followMode is USER_DEFINED. * @returns { Promise> } the promise returns paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -243,9 +254,10 @@ declare namespace configPolicy { * * @param { string } relPath - the relative path of the config file. * @param { FollowXMode } followMode - the follow mode. - * @param { string } extra - set follow rule add path. + * @param { string } extra - set follow rule add path, must be set when followMode is USER_DEFINED. * @returns { Array } the paths of config files. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 11 @@ -256,7 +268,8 @@ declare namespace configPolicy { * Gets the config directory in the device architecture, ordered by priority from low to high. * * @param { AsyncCallback> } callback - contains paths of config directories. - * @throws { BusinessError } 401 - invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. * @since 8 diff --git a/api/@ohos.connectedTag.d.ts b/api/@ohos.connectedTag.d.ts index 8ac5a08a3edb035a12695210996338ed54d83e14..3080bea055db8dea75ee6592749d29c39219632a 100644 --- a/api/@ohos.connectedTag.d.ts +++ b/api/@ohos.connectedTag.d.ts @@ -159,7 +159,10 @@ declare namespace connectedTag { * @param { number[] } data Indicates the NDEF data to send, which is a byte array. * @returns { Promise } The void. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3200101 - Connected NFC tag running state is abnormal in service. * @syscap SystemCapability.Communication.ConnectedTag @@ -174,7 +177,10 @@ declare namespace connectedTag { * @param { number[] } data Indicates the NDEF data to send, which is a byte array. * @param { AsyncCallback } callback * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3200101 - Connected NFC tag running state is abnormal in service. * @syscap SystemCapability.Communication.ConnectedTag diff --git a/api/@ohos.contact.d.ts b/api/@ohos.contact.d.ts index 8f19e2216d2304e5f182b71d1e60aa218d026176..9a6923764181c0111489cba47a65138738b44277 100644 --- a/api/@ohos.contact.d.ts +++ b/api/@ohos.contact.d.ts @@ -52,20 +52,6 @@ declare namespace contact { * @deprecated since 10 * @useinstead contact.addContact#addContact */ - /** - * Creates a contact. - * - * @permission ohos.permission.WRITE_CONTACTS - * @param { Contact } contact - Indicates the contact information. - * @param { AsyncCallback } callback - Returns the contact ID (which can be obtained - * by {@link Contact#getId()}) if the creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the - * creation fails. - * @syscap SystemCapability.Applications.ContactsData - * @atomicservice - * @since 12 - * @deprecated since 10 - * @useinstead contact.addContact#addContact - */ function addContact(contact: Contact, callback: AsyncCallback): void; /** @@ -111,19 +97,6 @@ declare namespace contact { * @deprecated since 10 * @useinstead contact.addContact#addContact */ - /** - * Creates a contact. - * - * @permission ohos.permission.WRITE_CONTACTS - * @param { Contact } contact - Indicates the contact information. - * @returns { Promise } Returns the contact ID (which can be obtained by {@link Contact#getId()}) if the - * creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the creation fails. - * @syscap SystemCapability.Applications.ContactsData - * @atomicservice - * @since 12 - * @deprecated since 10 - * @useinstead contact.addContact#addContact - */ function addContact(contact: Contact): Promise; /** diff --git a/api/@ohos.cooperate.d.ts b/api/@ohos.cooperate.d.ts index 634873168c6b06cbc18485e86a880299961949a2..039bc80d7b0bc8218971df4a6b63c577c5931c09 100644 --- a/api/@ohos.cooperate.d.ts +++ b/api/@ohos.cooperate.d.ts @@ -296,7 +296,8 @@ declare namespace cooperate { * Prepares for screen hopping. * * @param { AsyncCallback } callback Asynchronous callback used to return the operation result. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -309,7 +310,8 @@ declare namespace cooperate { * Prepares for screen hopping. * * @returns { Promise } the promise returned by the function. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -326,7 +328,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -340,7 +342,8 @@ declare namespace cooperate { * @returns { Promise } the promise returned by the function. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -351,7 +354,8 @@ declare namespace cooperate { * Cancels the preparation for screen hopping. * * @param { AsyncCallback } callback Asynchronous callback used to return the operation result. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -364,7 +368,8 @@ declare namespace cooperate { * Cancels the preparation for screen hopping. * * @returns { Promise } the promise returned by the function. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -381,7 +386,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -407,7 +412,8 @@ declare namespace cooperate { * @param { string } targetNetworkId Descriptor of the target device for screen hopping. * @param { number } inputDeviceId Identifier of the input device for screen hopping. * @param { AsyncCallback } callback Asynchronous callback used to return the operation result. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @throws {BusinessError} 20900001 - Operation failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. @@ -423,7 +429,8 @@ declare namespace cooperate { * @param { string } targetNetworkId Descriptor of the target device for screen hopping. * @param { number }inputDeviceId Identifier of the input device for screen hopping. * @returns { Promise } the promise returned by the function. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @throws {BusinessError} 20900001 - Operation failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. @@ -443,7 +450,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @throws {BusinessError} 20900001 - Operation failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. @@ -461,7 +468,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @throws {BusinessError} 20900001 - Operation failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. @@ -474,7 +481,8 @@ declare namespace cooperate { * * @param { boolean } isUnchained Whether the cross-device link is unchained. * @param { AsyncCallback } callback Asynchronous callback used to return the operation result. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -505,7 +513,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -531,7 +539,8 @@ declare namespace cooperate { * * @param { string } networkId Descriptor of the target device for screen hopping. * @param { AsyncCallback } callback Asynchronous callback used to return the screen hopping status. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -546,7 +555,8 @@ declare namespace cooperate { * @param { string } networkId Descriptor of the target device for screen hopping. * @returns { Promise } Returns {@code true} the screen hopping status; * returns {@code false} otherwise. - * @throws {BusinessError} 401 - Parameter error. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -565,7 +575,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -582,7 +592,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -594,8 +604,9 @@ declare namespace cooperate { * * @param { 'cooperate' } type Change type. * @param { Callback<{ networkId: string, msg: CooperateMsg }> } callback Asynchronous callback used to - * return the screen hopping status change event. - * @throws {BusinessError} 401 - Parameter error. + *
return the screen hopping status change event. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -609,8 +620,9 @@ declare namespace cooperate { * * @param { 'cooperate' } type Change type. * @param { Callback } callback Callback for which listening - * is disabled. If this parameter is not specified, listening will be disabled for all registered callbacks. - * @throws {BusinessError} 401 - Parameter error. + *
is disabled. If this parameter is not specified, listening will be disabled for all registered callbacks. + * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 10 @@ -625,11 +637,11 @@ declare namespace cooperate { * @permission ohos.permission.COOPERATE_MANAGER * @param { 'cooperateMessage' } type - Change type. * @param { Callback } callback - Asynchronous callback used to - * return the screen hopping status change event. + *
return the screen hopping status change event. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -642,11 +654,11 @@ declare namespace cooperate { * @permission ohos.permission.COOPERATE_MANAGER * @param { 'cooperateMessage' } type - Change type. * @param { Callback } [callback] - Callback for which listening - * is disabled. If this parameter is not specified, listening will be disabled for all registered callbacks. + *
is disabled. If this parameter is not specified, listening will be disabled for all registered callbacks. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes:1.Incorrect parameter types.2.Parameter - * verification failed. + *
verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 11 @@ -663,7 +675,7 @@ declare namespace cooperate { * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 12 @@ -677,11 +689,11 @@ declare namespace cooperate { * @param { 'cooperateMouse' } type - Event type, which is **cooperateMouse**. * @param { string } networkId - Specified device. * @param { Callback } [callback] - Callback for receiving reported events. - * If no callback is specified, listening will be disabled for all **cooperateMouse** events of the device specified by **networkId**. + *
If no callback is specified, listening will be disabled for all **cooperateMouse** events of the device specified by **networkId**. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - Not system application. * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2.Incorrect parameter types.3.Parameter verification failed. + *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Cooperate * @systemapi Hide this for inner system use. * @since 12 diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts index 667d5ec7e463f654541a55610247b79dba3b0534..565584d59ffb3f7e7cbf7ea718cc6541068854e3 100644 --- a/api/@ohos.curves.d.ts +++ b/api/@ohos.curves.d.ts @@ -385,7 +385,8 @@ declare namespace curves { */ interface ICurve { /** - * Get curve value by fraction. + * Get curve value by fraction.params,the parameter value range is from 0 to 1. + * 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0. * * @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1]. * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. @@ -394,7 +395,8 @@ declare namespace curves { * @since 9 */ /** - * Get curve value by fraction. + * Get curve value by fraction.params,the parameter value range is from 0 to 1. + * 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0. * * @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1]. * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. @@ -404,7 +406,8 @@ declare namespace curves { * @since 10 */ /** - * Get curve value by fraction. + * Get curve value by fraction.params,the parameter value range is from 0 to 1. + * 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0. * * @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1]. * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. diff --git a/api/@ohos.data.cloudData.d.ts b/api/@ohos.data.cloudData.d.ts index 886dc281305fcfa2a84ec1bd900046320c2a6b34..4199905018b2d22a3138efb31a6a3850bc7950e5 100644 --- a/api/@ohos.data.cloudData.d.ts +++ b/api/@ohos.data.cloudData.d.ts @@ -89,7 +89,7 @@ declare namespace cloudData { /** * Extra data, which contains the following fields. - * { + * '{ * "data": "{ * "accountId": "aaa", * "bundleName": "com.bbb.xxx", @@ -97,7 +97,7 @@ declare namespace cloudData { * "databaseScopes": ["private", "shared"], * "recordTypes": ["xxx", "yyy", "zzz"] * }" - * } + * }' * All fields are mandatory. * * @type { string } @@ -373,8 +373,7 @@ declare namespace cloudData { * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission verification failed, which * is usually returned by VerifyAccessToken. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -394,8 +393,7 @@ declare namespace cloudData { * to return the data changes. * @throws { BusinessError } 201 - Permission verification failed, which * is usually returned by VerifyAccessToken. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -416,8 +414,7 @@ declare namespace cloudData { * to return the data changes. * @throws { BusinessError } 201 - Permission verification failed, which * is usually returned by VerifyAccessToken. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -472,7 +469,7 @@ declare namespace cloudData { * @param { string } [storeId] - Indicates the store ID. * @returns { Promise>> } Promise used to return the result. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 202 - Permission denied. The application is not a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -495,8 +492,9 @@ declare namespace cloudData { * @param { string } [storeId] - Indicates the store ID. * @returns { Promise> } Promise used to return the result. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 202 - Permission denied. The application is not a system application. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.DistributedDataManager.CloudSync.Config * @systemapi @@ -1064,8 +1062,7 @@ declare namespace cloudData { * @param { Array } participants - Participants to share. * @param { Array } [columns] - Columns to be shared. * @returns { Promise } - Promise used to return {@link relationalStore.ResultSet}. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1089,8 +1086,7 @@ declare namespace cloudData { * @param { Array } participants - Participants to share. * @param { AsyncCallback } callback - Indicates the * callback invoked to return the {@link relationalStore.ResultSet}. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1115,8 +1111,7 @@ declare namespace cloudData { * @param { Array } columns - Columns to be shared. * @param { AsyncCallback } callback - Indicates the * callback invoked to return the {@link relationalStore.ResultSet}. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1140,8 +1135,7 @@ declare namespace cloudData { * involved in the data sharing. * @param { AsyncCallback>>> } callback - Indicates the * callback invoked to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1162,8 +1156,7 @@ declare namespace cloudData { * @param { Array } participants - Indicates the participants * involved in the data sharing. * @returns { Promise>>> } - Promise used to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1184,8 +1177,7 @@ declare namespace cloudData { * involved. * @param { AsyncCallback>>> } callback - Indicates the callback invoked * to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1206,8 +1198,7 @@ declare namespace cloudData { * @param { Array } participants - Indicates the participants * involved. * @returns { Promise>>> } - Promise used to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1225,8 +1216,7 @@ declare namespace cloudData { * * @param { string } sharingResource - Indicates the sharing resource. * @param { AsyncCallback> } callback - The callback of exit. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1241,8 +1231,7 @@ declare namespace cloudData { * * @param { string } sharingResource - Indicates the sharing resource. * @returns { Promise> } - The promise returned by the function. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1260,8 +1249,7 @@ declare namespace cloudData { * whose permissions are to be changed. * @param { AsyncCallback>>> } callback - Indicates the * callback invoked to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1282,8 +1270,7 @@ declare namespace cloudData { * @param { Array } participants - Indicates the participants * whose permissions are to be changed. * @returns { Promise>>> } - Promise used to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1302,8 +1289,7 @@ declare namespace cloudData { * @param { string } sharingResource - Indicates the sharing resource. * @param { AsyncCallback>> } callback - Indicates the * callback invoked to return the participants obtained. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1318,8 +1304,7 @@ declare namespace cloudData { * * @param { string } sharingResource - Indicates the sharing resource. * @returns { Promise>> } - Promise used to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1335,8 +1320,7 @@ declare namespace cloudData { * @param { string } invitationCode - Indicates the invitation code. * @param { AsyncCallback>> } callback - Indicates the * callback invoked to return the participants obtained. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1354,8 +1338,7 @@ declare namespace cloudData { * * @param { string } invitationCode - Indicates the invitation code. * @returns { Promise>> } - Promise used to return the result. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1372,8 +1355,7 @@ declare namespace cloudData { * @param { State } state - Indicates the state of invitation. * @param { AsyncCallback> } callback - Indicates the callback * invoked to return the sharing resource. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1389,8 +1371,7 @@ declare namespace cloudData { * @param { string } invitationCode - Indicates the invitation code. * @param { State } state - Indicates the state of invitation. * @returns { Promise> } - Promise used to return the sharing resource. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1406,8 +1387,7 @@ declare namespace cloudData { * @param { string } sharingResource - Indicates the sharing resource. * @param { State } state - Indicates the state of invitation. * @param { AsyncCallback> } callback - Indicates the callback. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. @@ -1423,8 +1403,7 @@ declare namespace cloudData { * @param { string } sharingResource - Indicates the sharing resource. * @param { State } state - Indicates the state of invitation. * @returns { Promise> } - The promise returned by the function. - * @throws { BusinessError } 202 - Permission verification failed, which is - * returned when the system API is not called by a system application. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. diff --git a/api/@ohos.data.commonType.d.ts b/api/@ohos.data.commonType.d.ts index 18b0c1a5bbcf7c807e5895695acf473b4f6fb868..112b97db21ca0cad0f62ec1e849ea6011868538d 100644 --- a/api/@ohos.data.commonType.d.ts +++ b/api/@ohos.data.commonType.d.ts @@ -107,7 +107,14 @@ declare namespace commonType { * @crossplatform * @since 11 */ - name: string; + /** + * The name of asset. + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + name: string | undefined; /** * The uri of asset. @@ -117,7 +124,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - uri: string; + /** + * The uri of asset. + * + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + uri: string | undefined; /** * The path of asset. @@ -127,7 +142,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - path: string; + /** + * The path of asset. + * + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + path: string | undefined; /** * The created time of asset. @@ -137,7 +160,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - createTime: string; + /** + * The created time of asset. + * + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + createTime: string | undefined; /** * The modified time of asset. If this field changes, the asset is considered to have changed. @@ -147,7 +178,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - modifyTime: string; + /** + * The modified time of asset. If this field changes, the asset is considered to have changed. + * + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + modifyTime: string | undefined; /** * The size of asset. If this field changes, the asset is considered to have changed. @@ -157,7 +196,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - size: string; + /** + * The size of asset. If this field changes, the asset is considered to have changed. + * + * @type { string | undefined } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + size: string | undefined; /** * The status of asset. @@ -167,7 +214,15 @@ declare namespace commonType { * @crossplatform * @since 11 */ - status?: AssetStatus; + /** + * The status of asset. + * + * @type { ?(AssetStatus | undefined) } + * @syscap SystemCapability.DistributedDataManager.CommonType + * @crossplatform + * @since 12 + */ + status?: AssetStatus | undefined; } /** diff --git a/api/@ohos.data.dataShare.d.ts b/api/@ohos.data.dataShare.d.ts index 13508da70b7093a0bbc1206e374ffdbfc086ce84..93316ad30b9b2cdc56a4a747fb1f9f095a4f564e 100644 --- a/api/@ohos.data.dataShare.d.ts +++ b/api/@ohos.data.dataShare.d.ts @@ -137,7 +137,7 @@ declare namespace dataShare { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly @@ -153,7 +153,7 @@ declare namespace dataShare { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly @@ -622,7 +622,7 @@ declare namespace dataShare { * @param { Template } template - The template to add. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly @@ -636,7 +636,7 @@ declare namespace dataShare { * @param { Template } template - The template to add. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @throws { BusinessError } 15700013 - The DataShareHelper instance is already closed. * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer @@ -653,7 +653,7 @@ declare namespace dataShare { * @param { string } subscriberId - The subscribe id. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly @@ -666,7 +666,7 @@ declare namespace dataShare { * @param { string } subscriberId - The subscribe id. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 15700011 - The uri is not exist. + * @throws { BusinessError } 15700011 - The URI is not exist. * @throws { BusinessError } 15700013 - The DataShareHelper instance is already closed. * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer diff --git a/api/@ohos.data.relationalStore.d.ts b/api/@ohos.data.relationalStore.d.ts index 60d8efcd18ddaaee567bf130cae7b15f96731065..e1f5aca4c1d68790a8dad8618d4a34d9f2901dc8 100644 --- a/api/@ohos.data.relationalStore.d.ts +++ b/api/@ohos.data.relationalStore.d.ts @@ -3037,7 +3037,7 @@ declare namespace relationalStore { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. * @throws { BusinessError } 14800024 - SQLite: The database file is locked. @@ -3100,7 +3100,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3149,7 +3149,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3208,7 +3208,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3257,7 +3257,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3291,7 +3291,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3350,7 +3350,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3409,7 +3409,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3442,7 +3442,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3504,7 +3504,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3555,7 +3555,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3622,7 +3622,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3673,7 +3673,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3708,7 +3708,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3782,7 +3782,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3862,7 +3862,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3919,7 +3919,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -3975,7 +3975,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4007,7 +4007,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4074,7 +4074,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4143,7 +4143,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4187,7 +4187,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4229,7 +4229,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4271,7 +4271,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4306,7 +4306,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi * @StageModelOnly @@ -4344,7 +4344,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi * @StageModelOnly @@ -4387,7 +4387,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi * @StageModelOnly @@ -4422,7 +4422,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4450,7 +4450,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4492,7 +4492,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4534,7 +4534,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4551,7 +4551,7 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 12 @@ -4587,7 +4587,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4636,7 +4636,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4690,7 +4690,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4733,7 +4733,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4784,7 +4784,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4832,7 +4832,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4879,7 +4879,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4928,7 +4928,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -4973,7 +4973,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5033,7 +5033,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5076,7 +5076,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. - * @throws { BusinessError } 14800000 - Inner error.+ + * @throws { BusinessError } 14800000 - Inner error. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 10 @@ -5093,7 +5093,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5127,7 +5127,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5161,7 +5161,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5193,7 +5193,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5240,7 +5240,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5271,7 +5271,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5314,7 +5314,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5345,7 +5345,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5387,7 +5387,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5417,7 +5417,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5470,7 +5470,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800010 - Invalid database path. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5524,7 +5524,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5578,7 +5578,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -5632,7 +5632,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. @@ -6638,7 +6638,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800018 - No data meets the condition. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. @@ -6670,7 +6670,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800018 - No data meets the condition. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. @@ -6703,7 +6703,7 @@ declare namespace relationalStore { * @throws { BusinessError } 14800000 - Inner error. * @throws { BusinessError } 14800011 - Database corrupted. * @throws { BusinessError } 14800014 - Already closed. - * @throws { BusinessError } 14800015 - The database is busy. + * @throws { BusinessError } 14800015 - The database does not respond. * @throws { BusinessError } 14800021 - SQLite: Generic error. * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. * @throws { BusinessError } 14800023 - SQLite: Access permission denied. diff --git a/api/@ohos.data.sendablePreferences.d.ets b/api/@ohos.data.sendablePreferences.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..b0fa633f6ee9f36c8c78d9a96d9a319b2925de95 --- /dev/null +++ b/api/@ohos.data.sendablePreferences.d.ets @@ -0,0 +1,508 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ArkData + */ + +import { Callback } from './@ohos.base'; +import Context from './application/BaseContext'; +import collections from '../arkts/@arkts.collections'; +import lang from '../arkts/@arkts.lang'; + +/** + * Provides interfaces to obtain and modify preferences data. + * + * @namespace sendablePreferences + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + * @name sendablePreferences + */ +declare namespace sendablePreferences { + /** + * Maximum length of a key. + * + * @constant + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + const MAX_KEY_LENGTH: number; + + /** + * Maximum length of a value. + * + * @constant + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + const MAX_VALUE_LENGTH: number; + + /** + * Defines the configuration of a preferences file. + * + * @interface Options + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + interface Options { + /** + * Name of the preferences file. + * + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + name: string; + + /** + * Application group ID. + * + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @StageModelOnly + * @atomicservice + * @since 12 + */ + dataGroupId?: string | null; + } + + /** + * Obtains a {@link Preferences} instance matching the specified preferences file name. + *

The {@link references} instance loads all data of the preferences file and + * resides in the cache. You can use removePreferencesFromCache to remove the instance from the cache. + * + * @param { Context } context - Indicates the context of application or capability. + * @param { Options } options - Indicates information about the preferences file. For details, see {@link Options}. + * @returns { Promise } Promise used to return the {@link Preferences}. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15501001 - Only supported in stage mode. + * @throws { BusinessError } 15501002 - The data group id is not valid. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + function getPreferences(context: Context, options: Options): Promise; + + /** + * Obtains a {@link Preferences} instance matching a specified preferences file name. + * This API returns the result synchronously. + *

The {@link references} instance loads all data of the preferences file and + * resides in the cache. You can use removePreferencesFromCache to remove the instance from the cache. + * + * @param { Context } context - Indicates the context of application or capability. + * @param { Options } options - Indicates information about the preferences file. For details, see {@link Options}. + * @returns { Preferences } return the {@link Preferences}. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15501001 - Only supported in stage mode. + * @throws { BusinessError } 15501002 - The data group id is not valid. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + function getPreferencesSync(context: Context, options: Options): Preferences; + + /** + * Deletes a {@link Preferences} instance matching the specified preferences file name + * from the cache (which is equivalent to calling removePreferencesFromCache) and deletes + * the preferences file. + *

When deleting a {@link Preferences} instance, you must release all references + * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency + * will occur. + * + * @param { Context } context - Indicates the context of application or capability. + * @param { Options } options - Indicates information about the preferences file. For details, see {@link Options}. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15500010 - Failed to delete preferences file. + * @throws { BusinessError } 15501001 - Only supported in stage mode. + * @throws { BusinessError } 15501002 - The data group id is not valid. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + function deletePreferences(context: Context, options: Options): Promise; + + /** + * Removes a {@link Preferences} instance matching the specified preferences file name + * from the cache. + *

When removing a {@link Preferences} instance, you must release all references + * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency + * will occur. + * + * @param { Context } context - Indicates the context of application or capability. + * @param { Options } options - Indicates information about the preferences file. For details, see {@link Options}. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15501001 - Only supported in stage mode. + * @throws { BusinessError } 15501002 - The data group id is not valid. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + function removePreferencesFromCache(context: Context, options: Options): Promise; + + /** + * Removes a {@link Preferences} instance matching the specified preferences file name + * from the cache. This API returns the result synchronously. + *

When removing a {@link Preferences} instance, you must release all references + * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency + * will occur. + * + * @param { Context } context - Indicates the context of application or capability. + * @param { Options } options - Indicates information about the preferences file. For details, see {@link Options}. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15501001 - Only supported in stage mode. + * @throws { BusinessError } 15501002 - The data group id is not valid. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + function removePreferencesFromCacheSync(context: Context, options: Options): void; + + /** + * Provides interfaces to obtain and modify preferences data. + *

The preferences data is stored in a file, which matches only one {@link Preferences} instance in the cache. + * You can use getPreferences to obtain the {@link Preferences} instance matching + * the file that stores preferences data, and use removePreferencesFromCache + * to remove the {@link Preferences} instance from the cache. + * + * @interface Preferences + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + interface Preferences extends lang.ISendable { + /** + * Obtains the value of a preferences instance. + *

If the value is {@code null} or not in the lang.ISendable format, the default value is returned. + * + * @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @param { lang.ISendable } defValue - Indicates the default value to return. + * @returns { Promise } Promise used to return the result. If a value matching the specified key + * is found, the value is returned. Otherwise, the default value is returned. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + get(key: string, defValue: lang.ISendable): Promise; + + /** + * Obtains the value of a preferences instance. This API returns the result synchronously. + *

If the value is {@code null} or not in the lang.ISendable format, the default value is returned. + * + * @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @param { lang.ISendable } defValue - Indicates the default value to return. + * @returns { lang.ISendable } If a value matching the specified key is found, the value is returned. Otherwise, + * the default value is returned. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + getSync(key: string, defValue: lang.ISendable): lang.ISendable; + + /** + * Obtains all the keys and values of a preferences instance in an object. + * + * @returns { Promise } Promise used to return the values and keys obtained in an object. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + getAll(): Promise; + + /** + * Obtains all the keys and values of a preferences instance. This API returns the result synchronously. + * + * @returns { lang.ISendable } Returns the values and keys obtained in an object. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + getAllSync(): lang.ISendable; + + /** + * Checks whether the {@link Preferences} instance contains a value matching the specified key. + * + * @param { string } key - Indicates the key of the value to check. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @returns { Promise } Promise used to return the result. {@code true} is returned if the + * {@link Preferences} object contains a value matching the specified key; {@code false} is returned otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + has(key: string): Promise; + + /** + * Checks whether the {@link Preferences} instance contains a value matching the specified key. + * This API returns the result synchronously. + * + * @param { string } key - Indicates the key of the value to check. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @returns { boolean } {@code true} is returned if the {@link Preferences} object contains a value matching + * the specified key; {@code false} is returned otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + hasSync(key: string): boolean; + + /** + * Sets an lang.ISendable value for the key in the {@link Preferences} object. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @param { string } key - Indicates the key of the preferences to set. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @param { lang.ISendable } value - Indicates the value of the preferences. + * MAX_VALUE_LENGTH. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + put(key: string, value: lang.ISendable): Promise; + + /** + * Sets an lang.ISendable value for the key in the {@link Preferences} object. + * This API returns the result synchronously. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @param { string } key - Indicates the key of the preferences to set. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @param { lang.ISendable } value - Indicates the value of the preferences. + * MAX_VALUE_LENGTH. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + putSync(key: string, value: lang.ISendable): void; + + /** + * Deletes the preferences with a specified key from the {@link Preferences} object. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + delete(key: string): Promise; + + /** + * Deletes the preferences with a specified key from the {@link Preferences} object. This API returns the result + * synchronously. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + deleteSync(key: string): void; + + /** + * Clears all preferences from the {@link Preferences} object. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + clear(): Promise; + + /** + * Clears all preferences from the {@link Preferences} object. This API returns the result synchronously. + *

You can call the {@link #flush} method to save the {@link Preferences} object to the file. + * + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + clearSync(): void; + + /** + * Flushes the {@link Preferences} object to the file. + * + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + flush(): Promise; + + /** + * Registers an observer to listen for the change of a {@link Preferences} object. + * + * @param { 'change' } type - Indicates the type of the event to observe. + * @param { Callback } callback - Indicates the callback used to return the preferences changes. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + on(type: 'change', callback: Callback): void; + + /** + * Registers an observer to listen for the change of a {@link Preferences} object in multiple processes. + * + * @param { 'multiProcessChange' } type - Indicates the type of the event to observe. + * @param { Callback } callback - Indicates the callback used to return the preferences changed + * in multiple processes. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @throws { BusinessError } 15500019 - Failed to obtain subscription service. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + on(type: 'multiProcessChange', callback: Callback): void; + + /** + * Registers an observer to listen for changes to the {@link Preferences} object. + * + * @param { 'dataChange' } type - Indicates the type of the event to observe. + * @param { Array } keys - Indicates one or more keys to listen for. + * @param { Callback } callback - Indicates the callback used to return the data change. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + on(type: 'dataChange', keys: Array, callback: Callback): void; + + /** + * Unregisters an observer used to listen for changes to the {@link Preferences} object. + * + * @param { 'change' } type - Indicates the event type. + * @param { Callback } callback - Indicates the callback to unregister. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + off(type: 'change', callback?: Callback): void; + + /** + * Unregisters an observer used to listen for the preferences changed in multiple processes. + * + * @param { 'multiProcessChange' } type - Indicates the event type. + * @param { Callback } callback - Indicates the callback to unregister. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + off(type: 'multiProcessChange', callback?: Callback): void; + + /** + * Unregisters an observer for changes to the {@ link Preferences} object. + * + * @param { 'dataChange' } type - Indicates the event type. + * @param { Array } keys - Indicates the data whose changes are not observed. + * @param { Callback } callback - Indicates the callback to unregister. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 15500000 - Inner error. + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * @atomicservice + * @since 12 + */ + off(type: 'dataChange', keys: Array, callback?: Callback): void; + } +} + +export default sendablePreferences; diff --git a/api/@ohos.data.unifiedDataChannel.d.ts b/api/@ohos.data.unifiedDataChannel.d.ts index 162cf9b92ca56a90dbfdb0e15b5aa983f5e32b2b..4175e4ed1fd8f91b0579d1256d1aa9ba8c69bf76 100644 --- a/api/@ohos.data.unifiedDataChannel.d.ts +++ b/api/@ohos.data.unifiedDataChannel.d.ts @@ -64,6 +64,7 @@ declare namespace unifiedDataChannel { /** * Indicated delay get UnifiedData + * * @typedef {function} GetDelayData * @param { string } type - the type of UnifiedData required. * @returns { UnifiedData } Return the UnifiedData required. @@ -115,7 +116,7 @@ declare namespace unifiedDataChannel { * @atomicservice * @since 12 */ - timestamp?: Date; + readonly timestamp?: Date; /** * Indicates the scope of clipboard data which can be used. * If it is not set or is incorrectly set, The default value is CrossDevice. @@ -1040,7 +1041,17 @@ declare namespace unifiedDataChannel { * @atomicservice * @since 11 */ - DATA_HUB = 'DataHub' + DATA_HUB = 'DataHub', + + /** + * Indicates the intention of drag + * + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ + DRAG = 'Drag' } /** @@ -1295,6 +1306,36 @@ declare namespace unifiedDataChannel { * @since 11 */ function deleteData(options: Options): Promise>; + + /** + * Set app sharing options. + * + * @param { intention } Describe the sharing channel that UDMF support. + * @param { shareOptions } Types of scope that UnifiedData can be used. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 20400001 - Settings already exist. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ + function setAppShareOptions(intention: Intention, shareOptions: ShareOptions): void; + + /** + * Remove app sharing options. + * + * @param { intention } Describe the sharing channel that UDMF support. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ + function removeAppShareOptions(intention: Intention): void; } export default unifiedDataChannel; diff --git a/api/@ohos.deviceAttest.d.ts b/api/@ohos.deviceAttest.d.ts index e76d5869dc485632f356d6872ea47692ee98fc12..45f5185b457149595fae3e5dd256019086dd69c1 100644 --- a/api/@ohos.deviceAttest.d.ts +++ b/api/@ohos.deviceAttest.d.ts @@ -32,10 +32,10 @@ declare namespace deviceAttest { * Obtains the AttestResultInfo object. * * @param { AsyncCallback } callback Indicates the callback containing the AttestResultInfo object. - * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 202 - This api is system api, Please use the system application to call this api. * @throws { BusinessError } 401 - Input parameters wrong, the number of parameters is incorrect, or the type of parameters is incorrect. - * @throws { BusinessError } 20000001 - system service exception. + * @throws { BusinessError } 20000001 - System service exception, please try again or reboot your device. * @syscap SystemCapability.XTS.DeviceAttest * @systemapi Hide this for inner system use. * @since 9 @@ -46,10 +46,10 @@ declare namespace deviceAttest { * Obtains the AttestResultInfo object. * * @returns { Promise } Returns that the AttestResultInfo object is returned in Promise mode. - * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 202 - This api is system api, Please use the system application to call this api. * @throws { BusinessError } 401 - Input parameters wrong, the number of parameters is incorrect, or the type of parameters is incorrect. - * @throws { BusinessError } 20000001 - system service exception. + * @throws { BusinessError } 20000001 - System service exception, please try again or reboot your device. * @syscap SystemCapability.XTS.DeviceAttest * @systemapi Hide this for inner system use. * @since 9 @@ -60,10 +60,10 @@ declare namespace deviceAttest { * Obtains the AttestResultInfo object. * * @returns { AttestResultInfo } Obtains the AttestResultInfo object synchronously. - * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 202 - This api is system api, Please use the system application to call this api. * @throws { BusinessError } 401 - Input parameters wrong, the number of parameters is incorrect, or the type of parameters is incorrect. - * @throws { BusinessError } 20000001 - system service exception. + * @throws { BusinessError } 20000001 - System service exception, please try again or reboot your device. * @syscap SystemCapability.XTS.DeviceAttest * @systemapi Hide this for inner system use. * @since 9 diff --git a/api/@ohos.display.d.ts b/api/@ohos.display.d.ts index 41256edd21ac6ebafa4d1345cf2191fa55ad696b..fb2dad45de3d6a35c6a06ff0e8190e3210928ea7 100644 --- a/api/@ohos.display.d.ts +++ b/api/@ohos.display.d.ts @@ -164,6 +164,17 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ + /** + * Register the callback for display changes. + * + * @param { 'add' | 'remove' | 'change' } type the event of display change + * @param { Callback } callback the display id of changed + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ function on(type: 'add' | 'remove' | 'change', callback: Callback): void; /** @@ -176,6 +187,17 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ + /** + * Unregister the callback for display changes. + * + * @param { 'add' | 'remove' | 'change' } type the event of display change event + * @param { Callback } callback the display id of changed + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ function off(type: 'add' | 'remove' | 'change', callback?: Callback): void; /** @@ -208,7 +230,6 @@ declare namespace display { * Check whether the device is foldable. * * @returns { boolean } true means the device is foldable. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 @@ -219,7 +240,6 @@ declare namespace display { * Get the current fold status of the foldable device. * * @returns { FoldStatus } fold status of device. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 @@ -232,12 +252,23 @@ declare namespace display { * @param { 'foldStatusChange' } type the event of fold status changes * @param { Callback } callback Callback used to return the current fold status of device * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + *
2. Incorrect parameter types. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Register the callback for fold status changes. + * + * @param { 'foldStatusChange' } type the event of fold status changes + * @param { Callback } callback Callback used to return the current fold status of device + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ function on(type: 'foldStatusChange', callback: Callback): void; /** @@ -247,11 +278,22 @@ declare namespace display { * @param { Callback } callback Callback used to return the current fold status of device * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Unregister the callback for fold status changes. + * + * @param { 'foldStatusChange' } type the event of fold status changes + * @param { Callback } callback Callback used to return the current fold status of device + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ function off(type: 'foldStatusChange', callback?: Callback): void; /** @@ -261,9 +303,9 @@ declare namespace display { * @param { Callback> } callback Callback used to return the current fold angle of device. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ function on(type: 'foldAngleChange', callback: Callback>): void; @@ -275,9 +317,9 @@ declare namespace display { * @param { Callback> } callback Callback used to return the current fold angle of device. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ function off(type: 'foldAngleChange', callback?: Callback>): void; @@ -289,9 +331,9 @@ declare namespace display { * @param { Callback } callback Callback used to return the device capture status. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ function on(type: 'captureStatusChange', callback: Callback): void; @@ -303,9 +345,9 @@ declare namespace display { * @param { Callback } callback Callback used to return the device capture status. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ function off(type: 'captureStatusChange', callback?: Callback): void; @@ -315,7 +357,6 @@ declare namespace display { * Check whether the device is captured. * * @returns { boolean } true means the device is captured. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 12 @@ -326,7 +367,6 @@ declare namespace display { * Get the display mode of the foldable device. * * @returns { FoldDisplayMode } display mode of the foldable device. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 @@ -340,7 +380,6 @@ declare namespace display { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. @@ -355,11 +394,22 @@ declare namespace display { * @param { Callback } callback Callback used to return the current fold display mode * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Register the callback for fold display mode changes. + * + * @param { 'foldDisplayModeChange' } type the event of fold display mode changes + * @param { Callback } callback Callback used to return the current fold display mode + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ function on(type: 'foldDisplayModeChange', callback: Callback): void; /** @@ -369,18 +419,28 @@ declare namespace display { * @param { Callback } callback Callback used to return the current fold display mode * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Unregister the callback for fold display mode changes. + * + * @param { 'foldDisplayModeChange' } type the event of fold display mode changes + * @param { Callback } callback Callback used to return the current fold display mode + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ function off(type: 'foldDisplayModeChange', callback?: Callback): void; /** * Get the fold crease region in the current display mode. * * @returns { FoldCreaseRegion } fold crease region in the current display mode. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 10 @@ -394,7 +454,6 @@ declare namespace display { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. @@ -409,6 +468,14 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Enumerates the fold status. + * + * @enum { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ enum FoldStatus { /** * Fold Status Unknown. @@ -416,6 +483,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Fold Status Unknown. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_STATUS_UNKNOWN = 0, /** * Fold Status Expanded. @@ -423,6 +497,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Fold Status Expanded. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_STATUS_EXPANDED, /** * Fold Status Folded. @@ -430,6 +511,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Fold Status Folded. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_STATUS_FOLDED, /** * Fold Status Half Folded. @@ -437,6 +525,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Fold Status Half Folded. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_STATUS_HALF_FOLDED } @@ -447,6 +542,14 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Enumerates the fold display mode. + * + * @enum { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ enum FoldDisplayMode { /** * Unknown Display. @@ -454,6 +557,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Unknown Display. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_DISPLAY_MODE_UNKNOWN = 0, /** * Full Display. @@ -461,6 +571,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Full Display. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_DISPLAY_MODE_FULL, /** * Main Display. @@ -468,6 +585,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Main Display. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_DISPLAY_MODE_MAIN, /** * Sub Display. @@ -475,6 +599,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Sub Display. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_DISPLAY_MODE_SUB, /** * Coordination Display. @@ -482,6 +613,13 @@ declare namespace display { * @syscap SystemCapability.Window.SessionManager * @since 10 */ + /** + * Coordination Display. + * + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ FOLD_DISPLAY_MODE_COORDINATION } diff --git a/api/@ohos.dlpPermission.d.ts b/api/@ohos.dlpPermission.d.ts index e600a539021622adfdb3eac45a6edf863ee0942d..5dfdf798913ca87288f7d59f8b3bba22ee54adc9 100644 --- a/api/@ohos.dlpPermission.d.ts +++ b/api/@ohos.dlpPermission.d.ts @@ -1423,7 +1423,6 @@ declare namespace dlpPermission { * Cleans sandbox application configuration. This method uses a promise to return the result. * * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 19100001 - Invalid parameter value. * @throws { BusinessError } 19100007 - This API cannot be called by DLP sandbox applications. * @throws { BusinessError } 19100011 - System service exception. @@ -1437,7 +1436,6 @@ declare namespace dlpPermission { * Obtains sandbox application configuration. This method uses a promise to return the result. * * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 19100001 - Invalid parameter value. * @throws { BusinessError } 19100011 - System service exception. * @throws { BusinessError } 19100018 - Not authorized application. diff --git a/api/@ohos.enterprise.accountManager.d.ts b/api/@ohos.enterprise.accountManager.d.ts index c18ff73e917c9fce53a00c182e153da443a0d317..b9398fa989f4a05fcf9c33d27c2da357d620e35e 100644 --- a/api/@ohos.enterprise.accountManager.d.ts +++ b/api/@ohos.enterprise.accountManager.d.ts @@ -39,10 +39,10 @@ declare namespace accountManager { * The admin must have the corresponding permission. * @param { boolean } disallow - true if the user is not allowed to add local account. * @param { AsyncCallback } callback - the callback of disallowAddLocalAccount. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -61,10 +61,10 @@ declare namespace accountManager { * The admin must have the corresponding permission. * @param { boolean } disallow - true if the user is not allowed to add local account. * @returns { Promise } the promise returned by the disallowAddLocalAccount. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -83,10 +83,10 @@ declare namespace accountManager { * The admin must have the corresponding permission. * @param { number } userId - indicates the user ID. It cannot be the ID of a user that does not exist. * @param { boolean } disallow - true if the specific user is not allowed to add an OS account. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -105,10 +105,10 @@ declare namespace accountManager { * If the admin is not empty, it must have the corresponding permission. * @param { number } userId - indicates the user ID. It cannot be the ID of a user that does not exist. * @returns { boolean } true if the specific user is not allowed to add an OS account. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -128,11 +128,11 @@ declare namespace accountManager { * @param { string } name - the OS account name. It cannot be empty. * @param { osAccount.OsAccountType } type - the OS account type. It can only be one of specified types. * @returns { osAccount.OsAccountInfo } information about the OS account added. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201003 - failed to add an OS account. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201003 - Failed to add an OS account. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -151,9 +151,9 @@ declare namespace accountManager { * The admin must have the corresponding permission. * @param { boolean } disallow - true if the specific account or all accounts are not allowed to add an OS account. * @param { number } [accountId] - indicates the account ID. It cannot be the ID of an account that does not exist. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -171,9 +171,9 @@ declare namespace accountManager { * If the admin is not empty, it must have the corresponding permission. * @param { number } [accountId] - indicates the account ID. It cannot be the ID of an account that does not exist. * @returns { boolean } true if the specific account or all accounts are not allowed to add an OS account. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -192,10 +192,10 @@ declare namespace accountManager { * @param { string } name - the OS account name. It cannot be empty. * @param { osAccount.OsAccountType } type - the OS account type. It can only be one of correct types. * @returns { Promise } information about the OS account added. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201003 - failed to add an OS account. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201003 - Failed to add an OS account. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.adminManager.d.ts b/api/@ohos.enterprise.adminManager.d.ts index a93918c21d2d22d4cb334480aee844bab4896c3a..2ae9489348fc1015cc4278bf50c4d3e2a8b7d20d 100644 --- a/api/@ohos.enterprise.adminManager.d.ts +++ b/api/@ohos.enterprise.adminManager.d.ts @@ -146,11 +146,11 @@ declare namespace adminManager { * @param { EnterpriseInfo } enterpriseInfo - enterpriseInfo indicates the enterprise information of the calling application. * @param { AdminType } type - type indicates the type of administrator to set. * @param { AsyncCallback } callback - the callback of enableAdmin. - * @throws { BusinessError } 9200003 - the administrator ability component is invalid. - * @throws { BusinessError } 9200004 - failed to enable the administrator application of the device. - * @throws { BusinessError } 9200007 - the system ability work abnormally. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200003 - The administrator ability component is invalid. + * @throws { BusinessError } 9200004 - Failed to activate the administrator application of the device. + * @throws { BusinessError } 9200007 - The system ability works abnormally. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -171,11 +171,11 @@ declare namespace adminManager { * @param { AdminType } type - type indicates the type of administrator to set. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of enableAdmin. - * @throws { BusinessError } 9200003 - the administrator ability component is invalid. - * @throws { BusinessError } 9200004 - failed to enable the administrator application of the device. - * @throws { BusinessError } 9200007 - the system ability work abnormally. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200003 - The administrator ability component is invalid. + * @throws { BusinessError } 9200004 - Failed to activate the administrator application of the device. + * @throws { BusinessError } 9200007 - The system ability works abnormally. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -196,11 +196,11 @@ declare namespace adminManager { * @param { AdminType } type - type indicates the type of administrator to set. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the enableAdmin. - * @throws { BusinessError } 9200003 - the administrator ability component is invalid. - * @throws { BusinessError } 9200004 - failed to enable the administrator application of the device. - * @throws { BusinessError } 9200007 - the system ability work abnormally. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200003 - The administrator ability component is invalid. + * @throws { BusinessError } 9200004 - Failed to activate the administrator application of the device. + * @throws { BusinessError } 9200007 - The system ability works abnormally. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -218,9 +218,9 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of disableAdmin. - * @throws { BusinessError } 9200005 - failed to disable the administrator application of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200005 - Failed to deactivate the administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -239,9 +239,9 @@ declare namespace adminManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of disableAdmin. - * @throws { BusinessError } 9200005 - failed to disable the administrator application of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200005 - Failed to deactivate the administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -260,8 +260,8 @@ declare namespace adminManager { * The admin must have the corresponding permission. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the disableAdmin. - * @throws { BusinessError } 9200005 - failed to disable the administrator application of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200005 - Failed to deactivate the administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -277,9 +277,9 @@ declare namespace adminManager { * @permission ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN * @param { String } bundleName - bundleName indicates the administrator bundle information. * @param { AsyncCallback } callback - the callback of disableSuperAdmin. - * @throws { BusinessError } 9200005 - failed to disable the administrator application of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200005 - Failed to deactivate the administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -296,9 +296,9 @@ declare namespace adminManager { * @permission ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN * @param { String } bundleName - bundleName indicates the administrator bundle information. * @returns { Promise } the promise returned by the disableSuperAdmin. - * @throws { BusinessError } 9200005 - failed to disable the administrator application of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200005 - Failed to deactivate the administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -313,7 +313,7 @@ declare namespace adminManager { * * @param { Want } admin - admin indicates the administrator ability information. * @param { AsyncCallback } callback - callback contained true if the administrator is enabled. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -329,7 +329,7 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - callback contained true if the administrator is enabled. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -345,7 +345,7 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } promise contained true if the administrator is enabled. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -360,8 +360,8 @@ declare namespace adminManager { * * @param { Want } admin - admin indicates the administrator ability information. * @param { AsyncCallback } callback - callback contained the enterprise info of administrator. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -376,8 +376,8 @@ declare namespace adminManager { * * @param { Want } admin - admin indicates the administrator ability information. * @returns { Promise } promise contained the enterprise info of administrator. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -395,9 +395,9 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { EnterpriseInfo } enterpriseInfo - enterpriseInfo indicates the enterprise information of the calling application. * @param { AsyncCallback } callback - the callback of setEnterpriseInfo. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -415,9 +415,9 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { EnterpriseInfo } enterpriseInfo - enterpriseInfo indicates the enterprise information of the calling application. * @returns { Promise } the promise returned by the setEnterpriseInfo. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -432,7 +432,7 @@ declare namespace adminManager { * * @param { String } bundleName - bundleName indicates the administrator bundle information. * @param { AsyncCallback } callback - callback contained true if the administrator is super administrator. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -447,7 +447,7 @@ declare namespace adminManager { * * @param { String } bundleName - bundleName indicates the administrator bundle information. * @returns { Promise } promise contained true if the administrator is super administrator. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -464,10 +464,10 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. * @param { AsyncCallback } callback - the callback of subscribeManagedEvent. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -484,10 +484,10 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. * @returns { Promise } the promise returned by the subscribeManagedEvent. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -504,10 +504,10 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. * @param { AsyncCallback } callback - the callback of unsubscribeManagedEvent. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -524,10 +524,10 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. * @returns { Promise } the promise returned by the unsubscribeManagedEvent. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -544,11 +544,11 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { string } bundleName - bundleName indicates the administrator bundle information. * @param { AsyncCallback } callback - the callback of authorizeAdmin. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200009 - authorize permission to the application failed. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200009 - Failed to grant the permission to the application. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -565,11 +565,11 @@ declare namespace adminManager { * @param { Want } admin - admin indicates the administrator ability information. * @param { string } bundleName - bundleName indicates the administrator bundle information. * @returns { Promise } the promise returned by the authorizeAdmin. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200009 - authorize permission to the application failed. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200009 - Failed to grant the permission to the application. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -583,6 +583,7 @@ declare namespace adminManager { * Get the super administrator of device. * * @returns { Promise } promise contained the want indicates the super administrator of the device. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi * @StageModelOnly @@ -596,9 +597,9 @@ declare namespace adminManager { * @permission ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -613,9 +614,9 @@ declare namespace adminManager { * @permission ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT * @param { Want } admin - admin indicates the administrator ability information. * @param { Array } managedEvents - managedEvents indicates the managed events to subscribe. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200008 - the specified system events enum is invalid. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200008 - The specified system event is invalid. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.applicationManager.d.ts b/api/@ohos.enterprise.applicationManager.d.ts index d2a68c54cf9b4e5a697917fcc577e534e323ff38..9cf9effc7d896e6a88f0ad9bee933729bec21b9e 100644 --- a/api/@ohos.enterprise.applicationManager.d.ts +++ b/api/@ohos.enterprise.applicationManager.d.ts @@ -39,10 +39,10 @@ declare namespace applicationManager { * @param { Array } appIds - ids of the bundle are disallowed to run. The size of the array after setting * cannot be greater than 200. * @param { AsyncCallback } callback - the callback of addDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -63,10 +63,10 @@ declare namespace applicationManager { * cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of addDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -87,10 +87,10 @@ declare namespace applicationManager { * cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @returns { Promise } the promise returned by the addDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -110,9 +110,9 @@ declare namespace applicationManager { * @param { Array } appIds - ids of the bundle are disallowed to run. The size of the array after setting * cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -131,10 +131,10 @@ declare namespace applicationManager { * @param { Array } appIds - ids of the bundle are disallowed to run. The size of the array after setting * cannot be greater than 200. * @param { AsyncCallback } callback - the callback of removeDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -155,10 +155,10 @@ declare namespace applicationManager { * cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of removeDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -179,10 +179,10 @@ declare namespace applicationManager { * cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @returns { Promise } the promise returned by the removeDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -202,9 +202,9 @@ declare namespace applicationManager { * @param { Array } appIds - ids of the bundle are disallowed to run. The size of the array after setting * cannot be greater than 200. * @param { number } [accountId] - accountId indicates the user ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -221,10 +221,10 @@ declare namespace applicationManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback> } callback - the callback of getDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -243,10 +243,10 @@ declare namespace applicationManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback> } callback - the callback of getDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -265,10 +265,10 @@ declare namespace applicationManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @returns { Promise> } the promise returned by the getDisallowedRunningBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -287,9 +287,9 @@ declare namespace applicationManager { * The admin must have the corresponding permission. * @param { number } [accountId] - accountId indicates the user ID. * @returns { Array } ids of the bundle are disallowed to run. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -308,9 +308,9 @@ declare namespace applicationManager { * @param { Array } autoStartApps - autoStartApps indicates the information of auto start app ability. * The bundleName and abilityName of the want cannot be non-exist. * The size of the array after setting cannot be greater than 10. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -329,9 +329,9 @@ declare namespace applicationManager { * @param { Array } autoStartApps - autoStartApps indicates the information of auto start app ability. * The bundleName and abilityName of the want cannot be non-exist. * The size of the array after setting cannot be greater 10. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -348,9 +348,9 @@ declare namespace applicationManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Array } the information of auto start applications. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.bluetoothManager.d.ts b/api/@ohos.enterprise.bluetoothManager.d.ts index f139bd2a701451b2cd1f0eff90bdd683b5362c6f..1c9743f96381df89674d2b6c6bf4150d18fd5c57 100644 --- a/api/@ohos.enterprise.bluetoothManager.d.ts +++ b/api/@ohos.enterprise.bluetoothManager.d.ts @@ -79,9 +79,9 @@ declare namespace bluetoothManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { BluetoothInfo } the bluetooth information. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -98,10 +98,10 @@ declare namespace bluetoothManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { boolean } disabled - true if disable the bluetooth, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -119,10 +119,10 @@ declare namespace bluetoothManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { boolean } true if the bluetooth is disabled, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -141,10 +141,10 @@ declare namespace bluetoothManager { * The admin must have the corresponding permission. * @param { Array } deviceIds - IDs of the bluetooth devices to be added to the list. * The size of the array after setting cannot be greater than 1000. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200010 - a conflicting policy has been configured. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200010 - A conflict policy has been configured. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -162,9 +162,9 @@ declare namespace bluetoothManager { * The admin must have the corresponding permission. * @param { Array } deviceIds - IDs of the bluetooth devices to be removed from the list. * The size of the array after setting cannot be greater than 1000. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -181,9 +181,9 @@ declare namespace bluetoothManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { Array } IDs of the bluetooth devices in the list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.browser.d.ts b/api/@ohos.enterprise.browser.d.ts index 5132e385a01a201313064d7c6051f8d6caf35228..6b7b437bb2ee4da08cce13a92aa0174179fd745f 100644 --- a/api/@ohos.enterprise.browser.d.ts +++ b/api/@ohos.enterprise.browser.d.ts @@ -40,10 +40,10 @@ declare namespace browser { * @param { string } policies - browser policies that need to set. It must be a correct JSON character string that * can be converted into browser policies. * @param { AsyncCallback } callback - the callback of setPolicies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -64,10 +64,10 @@ declare namespace browser { * @param { string } policies - browser policies that need to set. It must be a correct JSON character string that * can be converted into browser policies. * @returns { Promise } the promise returned by the setPolicies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -85,8 +85,8 @@ declare namespace browser { * The admin must have the corresponding permission. * @param { string } appId - id of the bundle that need to set policies. It cannot be empty. * @param { AsyncCallback } callback - the callback carries the browser policies returned by the getPolicies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -104,8 +104,8 @@ declare namespace browser { * The admin must have the corresponding permission. * @param { string } appId - id of the bundle that need to set policies. It cannot be empty. * @returns { Promise } the promise carries the browser policies returned by the getPolicies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -126,9 +126,9 @@ declare namespace browser { * @param { string } policyName - policyName indicates the browser policy name that need to set. * @param { string } policyValue - policyValue indicates the browser policy value that need to set. It must be a * correct JSON character string that can be converted into browser policies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -145,7 +145,7 @@ declare namespace browser { * The admin must have the corresponding permission. * @param { string } appId - id of the bundle that need to get policies. It cannot be empty. * @returns { string } the browser policies returned by the getPolicies. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.bundleManager.d.ts b/api/@ohos.enterprise.bundleManager.d.ts index 0f0d4fe50640bc5b45cd63cb99e7186158db75ee..ed736b6a2bdf316e0262bc4deab61cbaf20fa192 100644 --- a/api/@ohos.enterprise.bundleManager.d.ts +++ b/api/@ohos.enterprise.bundleManager.d.ts @@ -67,10 +67,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can be installed. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of addAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -91,10 +91,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of addAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -115,10 +115,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the addAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -138,9 +138,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can be installed. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -159,10 +159,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can be installed. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of removeAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -183,10 +183,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of removeAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -207,10 +207,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the removeAllowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -230,9 +230,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can be installed. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -249,10 +249,10 @@ declare namespace bundleManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -271,10 +271,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -293,10 +293,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise> } the promise that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -315,9 +315,9 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. * @returns { Array } ids of the bundle that can be installed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -336,10 +336,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be installed. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of addDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -360,10 +360,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of addDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -384,10 +384,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the addDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -407,9 +407,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be installed. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -428,10 +428,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be installed. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of removeDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -452,10 +452,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of removeDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -476,10 +476,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the removeDisallowedInstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -499,9 +499,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be installed. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -518,10 +518,10 @@ declare namespace bundleManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -540,10 +540,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -562,10 +562,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise> } the promise that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -584,9 +584,9 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. * @returns { Array } ids of the bundle that can not be installed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -605,10 +605,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be uninstalled. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of addDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -629,10 +629,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of addDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -653,10 +653,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the addDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -676,9 +676,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be uninstalled. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -697,10 +697,10 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be uninstalled. The size of the array after * setting cannot be greater than 200. * @param { AsyncCallback } callback - the callback of removeDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -721,10 +721,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback } callback - the callback of removeDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -745,10 +745,10 @@ declare namespace bundleManager { * setting cannot be greater than 200. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise } the promise returned by the removeDisallowedUninstallBundles. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -768,9 +768,9 @@ declare namespace bundleManager { * @param { Array } appIds - ids of the bundle that can not be uninstalled. The size of the array after * setting cannot be greater than 200. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -787,10 +787,10 @@ declare namespace bundleManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -809,10 +809,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } userId - userId indicates the user ID. * @param { AsyncCallback> } callback - the callback that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -831,10 +831,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @returns { Promise> } the promise that contains the appid list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -853,9 +853,9 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { number } [accountId] - accountId indicates the account ID or do not pass account ID. * @returns { Array } ids of the bundle that can not be uninstalled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -872,10 +872,10 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { string } bundleName - indicates the bundle name of the application to be uninstalled. * @param { AsyncCallback } callback - the callback of uninstalling application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -894,10 +894,10 @@ declare namespace bundleManager { * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { number } userId - userId indicates the user ID or do not pass user ID. * @param { AsyncCallback } callback - the callback of uninstalling application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -916,10 +916,10 @@ declare namespace bundleManager { * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { boolean } isKeepData - isKeepData indicates whether keep the data. * @param { AsyncCallback } callback - the callback of uninstalling application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -939,10 +939,10 @@ declare namespace bundleManager { * @param { number } userId - userId indicates the user ID or do not pass user ID. * @param { boolean } isKeepData - isKeepData indicates whether keep the data. * @param { AsyncCallback } callback - the callback of uninstalling application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -962,9 +962,9 @@ declare namespace bundleManager { * @param { number } [userId] - userId indicates the user ID or do not pass user ID. * @param { boolean } [isKeepData] - isKeepData indicates whether keep the data. * @returns { Promise } the promise of uninstalling application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -981,11 +981,11 @@ declare namespace bundleManager { * The admin must have the corresponding permission. * @param { Array } hapFilePaths - indicates the path of the application to be installed. * @param { AsyncCallback } callback - the callback of installing application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201002 - the application install failed. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201002 - Failed to install the application. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1006,11 +1006,11 @@ declare namespace bundleManager { * It may contain two fields: userId and installFlag. * The flag can only be one of correct flags. * @param { AsyncCallback } callback - the callback of installing application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201002 - the application install failed. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201002 - Failed to install the application. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1031,10 +1031,10 @@ declare namespace bundleManager { * It may contain two fields: userId and installFlag. * The flag can only be one of correct flags. * @returns { Promise } the promise of installing application result. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201002 - the application install failed. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201002 - Failed to install the application. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.dateTimeManager.d.ts b/api/@ohos.enterprise.dateTimeManager.d.ts index 59e456d5b4d801a1573bf38c260df8a3dc809e55..66b8935f1cdf420db626113a8a85c14c7b881f6e 100644 --- a/api/@ohos.enterprise.dateTimeManager.d.ts +++ b/api/@ohos.enterprise.dateTimeManager.d.ts @@ -39,10 +39,10 @@ declare namespace dateTimeManager { * The admin must have the corresponding permission. * @param { number } time - time indicates the target time stamp (ms). * @param { AsyncCallback } callback - the callback of setDateTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -61,10 +61,10 @@ declare namespace dateTimeManager { * The admin must have the corresponding permission. * @param { number } time - time indicates the target time stamp (ms). * @returns { Promise } the promise returned by the setDateTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -83,10 +83,10 @@ declare namespace dateTimeManager { * The admin must have the corresponding permission. * @param { boolean } disallow - true if the user is not allowed to modify the system time. * @param { AsyncCallback } callback - the callback of disallowModifyDateTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -105,10 +105,10 @@ declare namespace dateTimeManager { * The admin must have the corresponding permission. * @param { boolean } disallow - true if the user is not allowed to modify the system time. * @returns { Promise } the promise returned by the disallowModifyDateTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -126,10 +126,10 @@ declare namespace dateTimeManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @param { AsyncCallback } callback - return true if modify datetime is not allowed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -147,10 +147,10 @@ declare namespace dateTimeManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { Promise } return true if modify datetime is not allowed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.deviceControl.d.ts b/api/@ohos.enterprise.deviceControl.d.ts index 58f510b24e29e235f9d09a3d1c82ef0ea6de648b..f30c25d3f2d664e983ac519737a3345c83526944 100644 --- a/api/@ohos.enterprise.deviceControl.d.ts +++ b/api/@ohos.enterprise.deviceControl.d.ts @@ -37,10 +37,10 @@ declare namespace deviceControl { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of resetFactory. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -58,10 +58,10 @@ declare namespace deviceControl { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by the resetFactory. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -78,10 +78,10 @@ declare namespace deviceControl { * @permission ohos.permission.ENTERPRISE_REBOOT * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -98,10 +98,10 @@ declare namespace deviceControl { * @permission ohos.permission.ENTERPRISE_REBOOT * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -118,10 +118,10 @@ declare namespace deviceControl { * @permission ohos.permission.ENTERPRISE_LOCK_DEVICE * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -141,9 +141,9 @@ declare namespace deviceControl { * @param { string } operate - operate indicates the operation to be performed, * the supported device operations include lockScreen, resetFactory, reboot and shutDown. * @param { string } [addition] - addition indicates the specify additional parameters when performing the operation. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.deviceInfo.d.ts b/api/@ohos.enterprise.deviceInfo.d.ts index 45773fe7190c68a893fa137b36909a7af7138f22..68d57b5eed5b7e01371748b0e6c8a2382ac6c87a 100644 --- a/api/@ohos.enterprise.deviceInfo.d.ts +++ b/api/@ohos.enterprise.deviceInfo.d.ts @@ -37,10 +37,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of getDeviceSerial. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -58,10 +58,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by the getDeviceSerial. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -79,10 +79,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of getDisplayVersion. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -100,10 +100,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by the getDisplayVersion. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -121,10 +121,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of getDeviceName. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -142,10 +142,10 @@ declare namespace deviceInfo { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by the getDeviceName. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -165,9 +165,9 @@ declare namespace deviceInfo { * @param { string } label - label indicates the specific information that needs to be queried, * the supported device information include deviceName, deviceSerial and simInfo. * @returns { string } the specific information of device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.deviceSettings.d.ts b/api/@ohos.enterprise.deviceSettings.d.ts index 2deff57f66dc6d75829b4367fc9372af429f012c..513c1e4c681b773bd065479d9419e8616095d5ac 100644 --- a/api/@ohos.enterprise.deviceSettings.d.ts +++ b/api/@ohos.enterprise.deviceSettings.d.ts @@ -184,10 +184,10 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { number } time - screen off time. The minimum value is 15000. It is recommended that the time * is consistent with the optional screen-off time of the device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -205,10 +205,10 @@ declare namespace deviceSettings { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of getScreenOffTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -226,10 +226,10 @@ declare namespace deviceSettings { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by the getScreenOffTime. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -248,11 +248,11 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { CertBlob } certificate - certificate file content and alias. It cannot be empty or more than 40 characters. * @param { AsyncCallback } callback - The callback carries the uri of the certificate used to uninstall - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -271,11 +271,11 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { CertBlob } certificate - certificate file content and alias. It cannot be empty or more than 40 characters. * @returns { Promise } the promise carries the uri of the certificate used to uninstall - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -294,11 +294,11 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { string } certUri - uri of the certificate. It cannot be empty or more than 64 characters. * @param { AsyncCallback } callback - the callback of uninstallUserCertificate. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -317,11 +317,11 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { string } certUri - uri of the certificate. It cannot be empty or more than 64 characters. * @returns { Promise } the promise returned by the uninstallUserCertificate. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -340,10 +340,10 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { PowerScene } powerScene - the scene to execute power policy. Only timeout scenario is supported now. * @param { PowerPolicy } powerPolicy - device power policy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -362,10 +362,10 @@ declare namespace deviceSettings { * The admin must have the corresponding permission. * @param { PowerScene } powerScene - the scene to execute power policy. Only timeout scenario is supported now. * @returns { PowerPolicy } device power policy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -389,16 +389,16 @@ declare namespace deviceSettings { * When the power policy is set, only timeout scenario is available now. * When the screen off time is set, the minimum value is 15000. It is recommended that * the time is consistent with the optional screen-off time of the device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 12 */ - function setValue(admin: Want, item: string, value: string): void + function setValue(admin: Want, item: string, value: string): void; /** * Gets the device settings value. @@ -410,16 +410,16 @@ declare namespace deviceSettings { * @param { string } item - item indicates the device properties that need to be get, including screenOff and powerPolicy. * screenOff means the device screen off time, powerPolicy means the device power policy. * @returns { string } device settings policy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 12 */ - function getValue(admin: Want, item: string): string + function getValue(admin: Want, item: string): string; } export default deviceSettings; diff --git a/api/@ohos.enterprise.locationManager.d.ts b/api/@ohos.enterprise.locationManager.d.ts index 9c2e1868c7072afc735ef34d2db00dc538da0eb4..c517dabb00d6efcd0b69b0df28ef6cbec6fb958a 100644 --- a/api/@ohos.enterprise.locationManager.d.ts +++ b/api/@ohos.enterprise.locationManager.d.ts @@ -74,9 +74,9 @@ declare namespace locationManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { LocationPolicy } policy - the policy of location service. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -93,9 +93,9 @@ declare namespace locationManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { LocationPolicy } the policy of location service. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.networkManager.d.ts b/api/@ohos.enterprise.networkManager.d.ts index 110ed7bfb5872ba4b64f1be4c6fcd82cd618a2c5..2f24106ba6210b92147941b1ad10470f2275586c 100644 --- a/api/@ohos.enterprise.networkManager.d.ts +++ b/api/@ohos.enterprise.networkManager.d.ts @@ -522,10 +522,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback> } callback - the callback of getAllNetworkInterfaces. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -543,10 +543,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise> } the promise returned by getAllNetworkInterfaces. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -564,9 +564,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Array } all the network interfaces of the device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -584,10 +584,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get ip address. * @param { AsyncCallback } callback - the callback of getIpAddress. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -606,10 +606,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get ip address. * @returns { Promise } the promise returned by getIpAddress. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -628,9 +628,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - the ip address of the network interface. * @returns { string } the promise returned by getIpAddress. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -648,10 +648,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get mac address. * @param { AsyncCallback } callback - the callback of getMac. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -670,10 +670,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get mac address. * @returns { Promise } the promise returned by getMac. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -692,9 +692,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get mac address. * @returns { string } the mac address of the network interface. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -712,10 +712,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get status. * @param { AsyncCallback } callback - the callback of isNetworkInterfaceDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -734,10 +734,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get status. * @returns { Promise } the promise returned by isNetworkInterfaceDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -756,9 +756,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to get status. * @returns { boolean } true if disable the network interfaces, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -777,10 +777,10 @@ declare namespace networkManager { * @param { string } networkInterface - networkInterface indicates the network interface to set status. * @param { boolean } isDisabled - True if disable the network interfaces, otherwise false. * @param { AsyncCallback } callback - the callback of setNetworkInterfaceDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -800,10 +800,10 @@ declare namespace networkManager { * @param { string } networkInterface - networkInterface indicates the network interface to set status. * @param { boolean } isDisabled - True if disable the network interfaces, otherwise false. * @returns { Promise } the promise returned setNetworkInterfaceDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -822,9 +822,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { string } networkInterface - networkInterface indicates the network interface to set status. * @param { boolean } isDisabled - True if disable the network interfaces, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -842,10 +842,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { connection.HttpProxy } httpProxy - network global proxy configuration information. * @param { AsyncCallback } callback - the callback of setGlobalProxy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -864,10 +864,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { connection.HttpProxy } httpProxy - network global proxy configuration information. * @returns { Promise } the promise returned by the setGlobalProxy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -885,9 +885,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { connection.HttpProxy } httpProxy - network global proxy configuration information. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -904,10 +904,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the administrator ability information.If the admin is not empty, it must * have the corresponding permission. * @param { AsyncCallback } callback - the callback carries the network global proxy configuration information. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -925,10 +925,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the administrator ability information.If the admin is not empty, it must * have the corresponding permission. * @returns { Promise } the promise carries the network global proxy configuration information. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -946,9 +946,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the administrator ability information.If the admin is not empty, it must * have the corresponding permission. * @returns { connection.HttpProxy } the network global proxy configuration information. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -966,10 +966,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { AddFilterRule } filterRule - iptables filter rule configuration information. * @param { AsyncCallback } callback - the callback of addIptablesFilterRule. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -988,10 +988,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { AddFilterRule } filterRule - iptables filter rule configuration information. * @returns { Promise } the promise returned by the addIptablesFilterRule. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1010,10 +1010,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { RemoveFilterRule } filterRule - iptables filter rule configuration information. * @param { AsyncCallback } callback - the callback of removeIptablesFilterRule. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1032,10 +1032,10 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { RemoveFilterRule } filterRule - iptables filter rule configuration information. * @returns { Promise } the promise returned by the removeIptablesFilterRule. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1053,10 +1053,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback carries the iptables rules in the table filter. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1074,10 +1074,10 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise carries the iptables rules in the table filter. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1095,9 +1095,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { FirewallRule } firewallRule - firewall rule that needs to be added. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1115,9 +1115,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { FirewallRule } firewallRule - matching rule used to remove firewall rule. * if firewallRule or firewallRule#direction,firewallRule#action is empty, multiple firewall rule can be removed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1134,9 +1134,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Array } an array of added firewall rules. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1153,9 +1153,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { DomainFilterRule } domainFilterRule - domain filter rule that needs to be added. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1173,9 +1173,9 @@ declare namespace networkManager { * The admin must have the corresponding permission. * @param { DomainFilterRule } domainFilterRule - matching rule used to remove domain filter rule. * if domainFilterRule or domainFilterRule#action is empty, multiple domain filter rule can be removed. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -1192,9 +1192,9 @@ declare namespace networkManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Array } an array of added domain filter rules. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.restrictions.d.ts b/api/@ohos.enterprise.restrictions.d.ts index 2775cc8975b3cda7aab227b46d49989094300b71..e7a0dab8adc9453630fa1ab919c428a1c74034e8 100644 --- a/api/@ohos.enterprise.restrictions.d.ts +++ b/api/@ohos.enterprise.restrictions.d.ts @@ -38,10 +38,10 @@ declare namespace restrictions { * The admin must have the corresponding permission. * @param { boolean } disabled - true if the user disables the printing function. * @param { AsyncCallback } callback - the callback of setPrinterDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -60,10 +60,10 @@ declare namespace restrictions { * The admin must have the corresponding permission. * @param { boolean } disabled - true if the user disables the printing function. * @returns { Promise } the promise returned by the setPrinterDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -81,10 +81,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @param { AsyncCallback } callback - the callback of isPrinterDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -102,10 +102,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { Promise } the promise returned by the isPrinterDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -124,10 +124,10 @@ declare namespace restrictions { * The admin must have the corresponding permission. * @param { boolean } disabled - true if the user disables the HDC function. * @param { AsyncCallback } callback - the callback of setHdcDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -146,10 +146,10 @@ declare namespace restrictions { * The admin must have the corresponding permission. * @param { boolean } disabled - true if the user disables the HDC function. * @returns { Promise } the promise returned by the setHdcDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -167,10 +167,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @param { AsyncCallback } callback - the callback of isHdcDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -188,10 +188,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { Promise } the promise returned by the isHdcDisabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -200,7 +200,7 @@ declare namespace restrictions { * @since 10 */ function isHdcDisabled(admin: Want): Promise; - + /** * Disables the microphone of device. * @@ -208,10 +208,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { boolean } disable - true if disable the microphone of device, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -228,10 +228,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { boolean } true if the microphone of device is disabled, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -248,10 +248,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { boolean } disabled - true if set the fingerprint authorization capability disabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -268,10 +268,10 @@ declare namespace restrictions { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { boolean } true if the fingerprint authorization capability is disabled. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -290,9 +290,9 @@ declare namespace restrictions { * @param { string } feature - feature indicates the specific feature to be disallowed or allowed, * the supported device features include modifyDateTime, bluetooth, printer, hdc, microphone, fingerprint, usb and wifi. * @param { boolean } disallow - true if disallow the specific feature of device, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -310,9 +310,9 @@ declare namespace restrictions { * @param { string } feature - feature indicates the specific feature to be queried, * the supported device features include modifyDateTime, bluetooth, printer, hdc, microphone, fingerprint, usb and wifi. * @returns { boolean } true if the specific feature of device is disallowed, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.securityManager.d.ts b/api/@ohos.enterprise.securityManager.d.ts index 514af00f917b8c6c8de026f40cdddd2f4237082f..0d29e9ea6f1828c2a97b5bc3ec28dcee5b7d3c34 100644 --- a/api/@ohos.enterprise.securityManager.d.ts +++ b/api/@ohos.enterprise.securityManager.d.ts @@ -88,10 +88,10 @@ declare namespace securityManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { string } the security patch tag of the device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -109,10 +109,10 @@ declare namespace securityManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { DeviceEncryptionStatus } device encryption status. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -132,9 +132,9 @@ declare namespace securityManager { * @param { string } item - item indicates the specified security policy that needs to be obtained, including patch and encryption. * patch means the device security patch tag, and encryption means the device encryption status. * @returns { string } security policy of the specific type. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -152,10 +152,10 @@ declare namespace securityManager { * The admin must have the corresponding permission. * @param { CertBlob } certificate - certificate file content and alias. It cannot be empty or more than 40 characters. * @returns { Promise } the promise carries the uri of the certificate used to uninstall - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -173,10 +173,10 @@ declare namespace securityManager { * The admin must have the corresponding permission. * @param { string } certUri - uri of the certificate. It cannot be empty or more than 64 characters. * @returns { Promise } the promise returned by the uninstallUserCertificate. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9201001 - manage certificate failed - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9201001 - Failed to manage the certificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -192,9 +192,9 @@ declare namespace securityManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { PasswordPolicy } policy - password policy to be set. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -210,9 +210,9 @@ declare namespace securityManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { PasswordPolicy } policy - the password policy of the device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.systemManager.d.ts b/api/@ohos.enterprise.systemManager.d.ts index 2cb9bb267833774fe6fb53b49ac6481fb842bf63..c09ce73502e0dc75c9b0d16bac8f88aadb23d4c2 100644 --- a/api/@ohos.enterprise.systemManager.d.ts +++ b/api/@ohos.enterprise.systemManager.d.ts @@ -69,140 +69,6 @@ declare namespace systemManager { packageType: string; } - /** - * System update policy type. - * - * @enum { number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - enum PolicyType { - /** - * Default update policy - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - DEFAULT = 0, - - /** - * Prohibit update policy - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - PROHIBIT = 1, - - /** - * Update to specific software version policy - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - UPDATE_TO_SPECIFIC_VERSION = 2, - - /** - * Force immediate update policy - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - FORCE_IMMEDIATE_UPDATE = 3, - - /** - * Update within a specified time window - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - WINDOWS = 4, - - /** - * Delay the update for a period of time - * - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - POSTPONE = 5 - } - - /** - * OTA update policy. - * - * @typedef OtaUpdatePolicy - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - export interface OtaUpdatePolicy { - /** - * Software update type. - * - * @type { PolicyType } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - policyType: PolicyType; - - /** - * Software version. - * - * @type { string } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - version: string; - - /** - * The latest time of update. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - latestUpdateTime?: number; - - /** - * The time of delay update. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - delayUpdateTime?: number; - - /** - * The start time of installation window. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - installStartTime?: number; - - /** - * The end time of installation window. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - installEndTime?: number; - } - /** * Sets NTP server. * This function can be called by a super administrator. @@ -211,9 +77,9 @@ declare namespace systemManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { string } server - the address of NTP server. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -230,9 +96,9 @@ declare namespace systemManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { string } the address of NTP server. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -240,44 +106,6 @@ declare namespace systemManager { * @since 12 */ function getNTPServer(admin: Want): string; - - /** - * Sets device OTA update policy. - * This function can be called by a super administrator. - * - * @permission ohos.permission.ENTERPRISE_MANAGE_SYSTEM - * @param { Want } admin - admin indicates the enterprise admin extension ability information. - * The admin must have the corresponding permission. - * @param { OtaUpdatePolicy } policy - OTA update policy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - function setOtaUpdatePolicy(admin: Want, policy: OtaUpdatePolicy): void; - - /** - * Gets device OTA update policy. - * This function can be called by a super administrator. - * - * @permission ohos.permission.ENTERPRISE_MANAGE_SYSTEM - * @param { Want } admin - admin indicates the enterprise admin extension ability information. - * The admin must have the corresponding permission. - * @returns { OtaUpdatePolicy } OTA update policy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 12 - */ - function getOtaUpdatePolicy(admin: Want): OtaUpdatePolicy; } export default systemManager; \ No newline at end of file diff --git a/api/@ohos.enterprise.usbManager.d.ts b/api/@ohos.enterprise.usbManager.d.ts index b8f954df831a823d7f07138f8a482f9d8d1d8f80..d1d81c6bdbbdd98b393ec3ded2fabd83da7527a5 100644 --- a/api/@ohos.enterprise.usbManager.d.ts +++ b/api/@ohos.enterprise.usbManager.d.ts @@ -105,10 +105,10 @@ declare namespace usbManager { * The admin must have the corresponding permission. * @param { UsbPolicy } usbPolicy - usb policy code. * @param { AsyncCallback } callback - the callback of setUsbPolicy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -127,10 +127,10 @@ declare namespace usbManager { * The admin must have the corresponding permission. * @param { UsbPolicy } usbPolicy - usb policy code. * @returns { Promise } the promise returned setUsbPolicy. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -148,11 +148,11 @@ declare namespace usbManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { boolean } disable - true if disable USB, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200010 - a conflicting policy has been configured. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200010 - A conflict policy has been configured. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -170,10 +170,10 @@ declare namespace usbManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * If the admin is not empty, it must have the corresponding permission. * @returns { boolean } true if USB is disabled, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -192,10 +192,10 @@ declare namespace usbManager { * The admin must have the corresponding permission. * @param { Array } usbDeviceIds - an array of added USB device ids. * The size of the array after setting cannot be greater 1000. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200010 - a conflicting policy has been configured. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200010 - A conflict policy has been configured. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -213,9 +213,9 @@ declare namespace usbManager { * The admin must have the corresponding permission. * @param { Array } usbDeviceIds - an array of removed USB device ids. * The size of the array after setting cannot be greater 1000. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -232,9 +232,9 @@ declare namespace usbManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Array } an array of the available USB device trust list. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -251,10 +251,10 @@ declare namespace usbManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { UsbPolicy } usbPolicy - USB policy of storage device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 9200010 - a conflicting policy has been configured. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 9200010 - A conflict policy has been configured. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -271,9 +271,9 @@ declare namespace usbManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { UsbPolicy } USB policy of storage device. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.enterprise.wifiManager.d.ts b/api/@ohos.enterprise.wifiManager.d.ts index 850ff0e36694328f0a869ea7a74aaeb3a5309b9d..c970fc1fecdf8c6ae68e1d013b33f4db4e105cc3 100644 --- a/api/@ohos.enterprise.wifiManager.d.ts +++ b/api/@ohos.enterprise.wifiManager.d.ts @@ -708,10 +708,10 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { AsyncCallback } callback - the callback of isWifiActive. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -729,10 +729,10 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { Promise } the promise returned by isWifiActive. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -750,9 +750,9 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @returns { boolean } true if Wi-Fi is active. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -769,10 +769,10 @@ declare namespace wifiManager { * The admin must have the corresponding permission. * @param { WifiProfile } profile - profile indicates the profile of wifi. * @param { AsyncCallback } callback - the callback of setWifiProfile. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -790,10 +790,10 @@ declare namespace wifiManager { * The admin must have the corresponding permission. * @param { WifiProfile } profile - profile indicates the profile of wifi. * @returns { Promise } the promise returned by setWifiProfile. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -810,9 +810,9 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { WifiProfile } profile - profile indicates the profile of Wi-Fi. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -829,10 +829,10 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the enterprise admin extension ability information. * The admin must have the corresponding permission. * @param { boolean } disabled - true if set the Wi-Fi disabled, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager @@ -850,10 +850,10 @@ declare namespace wifiManager { * @param { Want } admin - admin indicates the administrator ability information.If the admin is not empty, it must * have the corresponding permission. * @returns { boolean } true if the Wi-Fi is disabled, otherwise false. - * @throws { BusinessError } 9200001 - the application is not an administrator of the device. - * @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - the application does not have permission to call this function. - * @throws { BusinessError } 202 - not system application. + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. + * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager diff --git a/api/@ohos.events.emitter.d.ts b/api/@ohos.events.emitter.d.ts index 39f460d462ccde1c449aaf21cbb66877631134d2..67f5fa18d9b523598bff271eec0da42d4bb3bbd7 100644 --- a/api/@ohos.events.emitter.d.ts +++ b/api/@ohos.events.emitter.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2024 Huawei Device Co., Ltd. + * Copyright (c) 2021 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -53,16 +53,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Subscribe to a certain event in persistent manner and receives the event callback. - * - * @param { InnerEvent } event - indicate event to subscribe to. - * @param { Callback } callback - indicate callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function on(event: InnerEvent, callback: Callback): void; /** @@ -74,16 +64,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Subscribe to a event by specific id in persistent manner and receives the event callback. - * - * @param { string } eventId - indicate ID of the event to subscribe to. - * @param { Callback } callback - indicate callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function on(eventId: string, callback: Callback): void; /** @@ -105,17 +85,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Subscribe to a certain event in one-shot manner and unsubscribe from it - * after the event callback is received. - * - * @param { InnerEvent } event - indicate event to subscribe to in one shot. - * @param { Callback } callback - indicate callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function once(event: InnerEvent, callback: Callback): void; /** @@ -128,17 +97,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Subscribe to a event by specific id in one-shot manner and unsubscribe from it - * after the event callback is received. - * - * @param { string } eventId - indicate ID of the event to subscribe to in one shot. - * @param { Callback } callback - indicate callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function once(eventId: string, callback: Callback): void; /** @@ -156,15 +114,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Unsubscribe from an event. - * - * @param { number } eventId - indicate ID of the event to unsubscribe from. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function off(eventId: number): void; /** @@ -175,19 +124,10 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Unsubscribe from an event. - * - * @param { string } eventId - indicate ID of the event to unsubscribe from. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function off(eventId: string): void; /** - * Unsubscribe specified callback function from an event. + * Unsubscribe from an event. * * @param { number } eventId - indicates ID of the event to unsubscribe from. * @param { Callback } callback - indicates callback used to receive the event. @@ -195,7 +135,7 @@ declare namespace emitter { * @since 10 */ /** - * Unsubscribe specified callback function from an event. + * Unsubscribe from an event. * * @param { number } eventId - indicates ID of the event to unsubscribe from. * @param { Callback } callback - indicates callback used to receive the event. @@ -203,20 +143,10 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Unsubscribe specified callback function from an event. - * - * @param { number } eventId - indicates ID of the event to unsubscribe from. - * @param { Callback } callback - indicates callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function off(eventId: number, callback: Callback): void; /** - * Unsubscribe specified callback function from an event. + * Unsubscribe from an event. * * @param { string } eventId - indicates ID of the event to unsubscribe from. * @param { Callback } callback - indicates callback used to receive the event. @@ -224,16 +154,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Unsubscribe specified callback function from an event. - * - * @param { string } eventId - indicates ID of the event to unsubscribe from. - * @param { Callback } callback - indicates callback used to receive the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function off(eventId: string, callback: Callback): void; /** @@ -253,16 +173,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Emits an event to the event queue. - * - * @param { InnerEvent } event - indicate event to emit. - * @param { EventData } [data] - indicate data carried by the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function emit(event: InnerEvent, data?: EventData): void; /** @@ -274,16 +184,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Emits an event by specific id to the event queue. - * - * @param { string } eventId - indicate ID of the event to emit. - * @param { EventData } [data] - indicate data carried by the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function emit(eventId: string, data?: EventData): void; /** @@ -296,17 +196,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Emits an event by specific id to the event queue. - * - * @param { string } eventId - indicate ID of the event to emit. - * @param { Options } options - Indicates the {@link Options} option of the emit priority of the event. - * @param { EventData } [data] - indicate data carried by the event. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function emit(eventId: string, options: Options, data?: EventData): void; /** @@ -318,16 +207,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Obtains the number of subscribe listener count. - * - * @param { number | string } eventId - indicates ID of the event to unsubscribe from. - * @returns { number } Returns the number of listener count. - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ function getListenerCount(eventId: number | string): number; /** @@ -361,15 +240,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Data carried by the event. - * - * @type { ?object } - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ data?: { [key: string]: any }; } @@ -404,15 +274,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Event ID, which is used to identify an event. - * - * @type { number } - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ eventId: number; /** @@ -430,15 +291,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Emit priority of the event. The default priority is {@link EventPriority.LOW}. - * - * @type { ?EventPriority } - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ priority?: EventPriority; } @@ -471,14 +323,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Indicates that the event will be emitted immediately. - * - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ IMMEDIATE = 0, /** @@ -494,14 +338,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Indicates that the event will be emitted before low-priority events. - * - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ HIGH, /** @@ -517,14 +353,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Indicates that the event will be emitted before idle-priority events. By default, an event is in LOW priority. - * - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ LOW, /** @@ -540,14 +368,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Indicates that the event will be emitted after all the other events. - * - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ IDLE, } @@ -575,15 +395,6 @@ declare namespace emitter { * @atomicservice * @since 11 */ - /** - * Emit priority of the event. The default priority is {@link EventPriority.LOW}. - * - * @type { ?EventPriority } - * @syscap SystemCapability.Notification.Emitter - * @crossplatform - * @atomicservice - * @since 12 - */ priority?: EventPriority; } } diff --git a/api/@ohos.file.AlbumPickerComponent.d.ets b/api/@ohos.file.AlbumPickerComponent.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..df13d0896caa282d296a5c372a4d9ce05a9d119b --- /dev/null +++ b/api/@ohos.file.AlbumPickerComponent.d.ets @@ -0,0 +1,90 @@ +/* + * Copyright (C) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file A component which supports applications to select album + * @kit MediaLibraryKit + */ + +import { PickerColorMode } from '@ohos.file.PhotoPickerComponent'; + +/** + * AlbumPickerComponent: can select a certain album and display the images in that album through PhotoPickerComponent + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +@Component +export declare struct AlbumPickerComponent { + /** + * AlbumPickerOptions + * + * @type { ?AlbumPickerOptions } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Corea + * @atomicservice + * @since 12 + */ + albumPickerOptions?: AlbumPickerOptions; + + /** + * Callback when select an album, will return album uri + * + * @type { ?function } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + onAlbumClick?: (albumInfo: AlbumInfo) => boolean; +} + +/** + * AlbumPickerOptions Object + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class AlbumPickerOptions { + /** + * AlbumPickerComponent theme color + * + * @type { ?PickerColorMode } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + themeColorMode?: PickerColorMode; +} + + +/** + * AlbumInfo: include album uri + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class AlbumInfo { + /** + * Album uri + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + uri?: string; +} \ No newline at end of file diff --git a/api/@ohos.file.BackupExtensionContext.d.ts b/api/@ohos.file.BackupExtensionContext.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..f3d95e9776ab493dd0c633f6ab11848e39fb8642 --- /dev/null +++ b/api/@ohos.file.BackupExtensionContext.d.ts @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit CoreFileKit + */ + +import ExtensionContext from './application/ExtensionContext'; + +/** + * The context of an ability or an application. It allows access to + * application-specific resources. + * Can only be obtained through the ability. + * + * @extends ExtensionContext + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @StageModelOnly + * @since 12 + */ +export default class BackupExtensionContext extends ExtensionContext { + /** + * Indicates backup dir. + * + * @type { string } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @StageModelOnly + * @since 12 + */ + readonly backupDir: string; +} \ No newline at end of file diff --git a/api/@ohos.file.PhotoPickerComponent.d.ets b/api/@ohos.file.PhotoPickerComponent.d.ets index 139efe3379eb623def224fc2b82e0a1aae1fcac0..aeff7fbbc219c127f6bcf53a4ee6d363abafe9a3 100644 --- a/api/@ohos.file.PhotoPickerComponent.d.ets +++ b/api/@ohos.file.PhotoPickerComponent.d.ets @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Huawei Device Co., Ltd. + * Copyright (C) 2024 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -59,6 +59,47 @@ export declare struct PhotoPickerComponent { */ onDeselect?: (uri: string) => void; + /** + * Callback when click item. include click camera item and thumbnail item, will return itemInfo + * + * @type { ?function } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + onItemClicked?: (itemInfo: ItemInfo, clickType: ClickType) => boolean; + + /** + * Callback when enter photo browser, will return photoBrowserInfo + * + * @type { ?function } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + onEnterPhotoBrowser?: (photoBrowserInfo: PhotoBrowserInfo) => boolean; + + /** + * Callback when exit photo browser, will return photoBrowserInfo + * + * @type { ?function } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + onExitPhotoBrowser?: (photoBrowserInfo: PhotoBrowserInfo) => boolean; + + /** + * Callback when pickerController is ready. + * Set data to picker component by pickerController is supported after pickerController is ready + * + * @type { ?function } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + onPickerControllerReady?: () => void; + /** * PickerController * @@ -99,6 +140,16 @@ export declare class PickerController { * @since 12 */ setData(dataType: DataType, data: Object): void; + + /** + * Set max select count to picker component, include max_total_count, max_photo_count and max_video_count. + * + * @param { MaxSelected } maxSelected - max select count data + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + setMaxSelected(maxSelected: MaxSelected): void; } /** @@ -138,6 +189,222 @@ export declare class PickerOptions extends photoAccessHelper.BaseSelectOptions { * @since 12 */ isRepeatSelectSupported?: boolean; + + /** + * Support to set checkbox text color + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + checkboxTextColor?: string; + + /** + * Support to set photo browser background color mode + * + * @type { ?PickerColorMode } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + photoBrowserBackgroundColorMode?: PickerColorMode; + + /** + * Support to set max select number remind mode. + * + * @type { ?ReminderMode } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + maxSelectedReminderMode?: ReminderMode; + + /** + * Support to set display orientation + * + * @type { ?PickerOrientation } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + orientation?: PickerOrientation; + + /** + * Support to set select mode + * + * @type { ?SelectMode } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + selectMode?: SelectMode; + + /** + * Support to set max photo select number + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + maxPhotoSelectNumber?: number; + + /** + * Support to set max video select number + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + maxVideoSelectNumber?: number; +} + +/** + * ItemInfo + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class ItemInfo { + /** + * itemType. include CAMERA and THUMBNAIL. + * + * @type { ?ItemType } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + itemType?: ItemType; + + /** + * Uri. if the itemType is CAMERA, it will be null + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + uri?: string; + + /** + * MimeType. if the itemType is CAMERA, it will be null + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + mimeType?: string; + + /** + * Width. if the itemType is CAMERA, it will be null + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + width?: number; + + /** + * Height. if the itemType is CAMERA, it will be null + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + height?: number; + + /** + * Size. if the itemType is CAMERA, it will be null + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + size?: number; + + /** + * Duration. if the itemType is CAMERA, it will be null; if photos, return -1 + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + duration?: number; +} + +/** + * PhotoBrowserInfo + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class PhotoBrowserInfo { + /** + * AnimatorParams. include duration and curve + * + * @type { ?AnimatorParams } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + animatorParams?: AnimatorParams; +} + +/** + * AnimatorParams + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class AnimatorParams { + /** + * Animate duration + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + duration?: number; + + /** + * Animate curve + * + * @type { ?Curve | ICurve | string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + curve?: Curve | ICurve | string; +} + +/** + * MaxSelected + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare class MaxSelected { + /** + * data. support to set max_total_count, max_photo_count and max_video_count. + * + * @type { ?Map } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + data?: Map; } /** @@ -156,5 +423,237 @@ export declare enum DataType { * @atomicservice * @since 12 */ - SET_SELECTED_URIS = 1 + SET_SELECTED_URIS = 1, + + /** + * SET_ALBUM_URI. set selected album uri to picker component + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + SET_ALBUM_URI = 2 } + +/** + * ItemType. include CAMERA and THUMBNAIL + * + * @enum { number } ItemType + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum ItemType { + /** + * THUMBNAIL. photos or videos item + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + THUMBNAIL = 0, + + /** + * CAMERA. camera item + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + CAMERA = 1 +} + +/** + * ClickType. include SELECTED and DESELECTED + * + * @enum { number } ClickType + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum ClickType { + /** + * SELECTED. click to select photos or videos, if click camera item, the clickType is SELECTED. + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + SELECTED = 0, + + /** + * DESELECTED. click to deselect photos or videos + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + DESELECTED = 1 +} + +/** + * PickerOrientation. include VERTICAL and HORIZONTAL + * + * @enum { number } PickerOrientation + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum PickerOrientation { + /** + * VERTICAL. vertical display + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + VERTICAL = 0, + + /** + * HORIZONTAL. horizontal display + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + HORIZONTAL = 1 +} + +/** + * SelectMode. include SINGLE_SELECT and MULTI_SELECT + * + * @enum { number } SelectMode + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum SelectMode { + /** + * SINGLE_SELECT. single select + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + SINGLE_SELECT = 0, + + /** + * MULTI_SELECT. multi select + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + MULTI_SELECT = 1 +} + +/** + * PickerColorMode. include AUTO, LIGHT and DARK + * + * @enum { number } PickerColorMode + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum PickerColorMode { + /** + * AUTO. follow system color + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + AUTO = 0, + + /** + * LIGHT. light color + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + LIGHT = 1, + + /** + * DARK. dark color + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + DARK = 2 +} + +/** + * ReminderMode, include NONE, TOAST and MASK + * + * @enum { number } ReminderMode + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum ReminderMode { + /** + * NONE. no need to remind + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + NONE = 0, + + /** + * TOAST. remind by toast + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + TOAST = 1, + + /** + * MASK. remind by mask + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + MASK = 2 +} + +/** + * MaxCountType. include TOTAL_MAX_COUNT, PHOTO_MAX_COUNT and VIDEO_MAX_COUNT + * + * @enum { number } MaxCountType + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ +export declare enum MaxCountType { + /** + * TOTAL_MAX_COUNT. total max count + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + TOTAL_MAX_COUNT = 0, + + /** + * PHOTO_MAX_COUNT. photo max count + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + PHOTO_MAX_COUNT = 1, + + /** + * VIDEO_MAX_COUNT. video max count + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 12 + */ + VIDEO_MAX_COUNT = 2 +} \ No newline at end of file diff --git a/api/@ohos.file.cloudSync.d.ts b/api/@ohos.file.cloudSync.d.ts index bddc6ce68e66556bddf46d7237fbbca0cab8a48e..f6cf4b50ce608605f9ff512228af10f57d38d31f 100644 --- a/api/@ohos.file.cloudSync.d.ts +++ b/api/@ohos.file.cloudSync.d.ts @@ -160,7 +160,7 @@ declare namespace cloudSync { * @since 12 */ DEVICE_TEMPERATURE_TOO_HIGH, - + } /** @@ -216,7 +216,8 @@ declare namespace cloudSync { * @param { function } callback - callback function with a `SyncProgress` argument. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -231,7 +232,8 @@ declare namespace cloudSync { * @param { function } callback - callback function with a `SyncProgress` argument. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -245,7 +247,8 @@ declare namespace cloudSync { * @param { 'progress' } evt - event type. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -259,7 +262,7 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 22400001 - Cloud status not ready. * @throws { BusinessError } 22400002 - Network unavailable. * @throws { BusinessError } 22400003 - Battery level warning. @@ -275,7 +278,8 @@ declare namespace cloudSync { * @param { AsyncCallback } [callback] - Callback function. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 22400001 - Cloud status not ready. * @throws { BusinessError } 22400002 - Network unavailable. * @throws { BusinessError } 22400003 - Battery level warning. @@ -291,7 +295,7 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 10 @@ -304,7 +308,8 @@ declare namespace cloudSync { * @param { AsyncCallback } [callback] - Callback function. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 10 @@ -476,7 +481,8 @@ declare namespace cloudSync { * @param { function } callback - callback function with a `DownloadProgress` argument. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -491,7 +497,8 @@ declare namespace cloudSync { * @param { function } callback - callback function with a `DownloadProgress` argument. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -505,7 +512,8 @@ declare namespace cloudSync { * @param { 'progress' } evt - event type. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -520,7 +528,8 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900025 - No space left on device. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core @@ -536,7 +545,8 @@ declare namespace cloudSync { * @param { AsyncCallback } [callback] - Callback function. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900025 - No space left on device. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core @@ -552,7 +562,8 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 10 @@ -566,7 +577,8 @@ declare namespace cloudSync { * @param { AsyncCallback } [callback] - Callback function. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 10 @@ -586,7 +598,7 @@ declare namespace cloudSync { * A constructor used to create a FileSync object. * * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 11 @@ -597,7 +609,8 @@ declare namespace cloudSync { * * @param { string } bundleName - Name of the bundle that need to synchronize and subscribe the sync progress event. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi * @since 12 @@ -611,7 +624,8 @@ declare namespace cloudSync { * @param { Callback } callback - callback function with a `SyncProgress` argument. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -626,7 +640,7 @@ declare namespace cloudSync { * @param { Callback } [callback] - callback function with a `SyncProgress` argument. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -640,7 +654,7 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 22400001 - Cloud status not ready. * @throws { BusinessError } 22400002 - Network unavailable. @@ -657,7 +671,7 @@ declare namespace cloudSync { * @param { AsyncCallback } callback - Callback function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 22400001 - Cloud status not ready. * @throws { BusinessError } 22400002 - Network unavailable. @@ -674,7 +688,7 @@ declare namespace cloudSync { * @returns { Promise } - Return Promise. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -688,7 +702,8 @@ declare namespace cloudSync { * @param { AsyncCallback } callback - Callback function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -702,7 +717,7 @@ declare namespace cloudSync { * @returns { Promise } - Return the date of last synchronization. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -716,7 +731,8 @@ declare namespace cloudSync { * @param { AsyncCallback } callback - Callback function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -734,7 +750,7 @@ declare namespace cloudSync { /** * A constructor used to create a CloudFileCache object. * - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @since 11 */ @@ -744,7 +760,8 @@ declare namespace cloudSync { * * @param { 'progress' } event - event type. * @param { Callback } callback - callback function with a `DownloadProgress` argument. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @since 11 @@ -755,7 +772,8 @@ declare namespace cloudSync { * * @param { 'progress' } event - event type. * @param { Callback } [callback] - callback function with a `DownloadProgress` argument. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @since 11 @@ -767,7 +785,8 @@ declare namespace cloudSync { * * @param { string } uri - uri of file. * @returns { Promise } - Return Promise. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900025 - No space left on device. @@ -781,7 +800,8 @@ declare namespace cloudSync { * * @param { string } uri - uri of file. * @param { AsyncCallback } callback - Callback function. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900025 - No space left on device. @@ -795,7 +815,8 @@ declare namespace cloudSync { * * @param { string } uri - uri of file. * @returns { Promise } - Return Promise. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -808,7 +829,8 @@ declare namespace cloudSync { * @param { string } uri - uri of file. * @param { boolean } [needClean] - whether to delete the file that already downloaded. * @returns { Promise } - Return Promise. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -821,7 +843,8 @@ declare namespace cloudSync { * * @param { string } uri - uri of file. * @param { AsyncCallback } callback - Callback function. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -836,7 +859,8 @@ declare namespace cloudSync { * @param { string } uri - uri of file. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -922,7 +946,8 @@ declare namespace cloudSync { * @returns { Promise> } - Return the sync state of given files. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -939,7 +964,8 @@ declare namespace cloudSync { * @param { AsyncCallback> } callback - The callback is used to return the sync state of given files. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid uri. @@ -954,13 +980,14 @@ declare namespace cloudSync { * @param { string } uri - uri of file. * @returns { FileSyncState } - return the sync state of given files. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900004 - Interrupted system call * @throws { BusinessError } 13900010 - Try again * @throws { BusinessError } 13900012 - Permission denied by the file system * @throws { BusinessError } 13900031 - Function not implemented - * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 14000002 - Invalid uri. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -974,7 +1001,8 @@ declare namespace cloudSync { * @param { boolean } recursion - Whether to monitor the child files. * @param { Callback } callback - Returns the changed data. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900001 - Operation not permitted * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900012 - Permission denied @@ -989,7 +1017,8 @@ declare namespace cloudSync { * * @param { string } uri - uri of file. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900001 - Operation not permitted * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 13900012 - Permission denied @@ -1043,9 +1072,9 @@ declare namespace cloudSync { NOTIFY_RENAMED } - /** + /** * Defines the change data - * + * * @interface ChangeData * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -1054,7 +1083,7 @@ declare namespace cloudSync { interface ChangeData { /** * The notify type of the change. - * + * * @type {NotifyType} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -1063,7 +1092,7 @@ declare namespace cloudSync { type: NotifyType; /** * Indicates whether the changed uri is directory. - * + * * @type {Array} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi @@ -1072,7 +1101,7 @@ declare namespace cloudSync { isDirectory: Array; /** * The changed uris. - * + * * @type {Array} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi diff --git a/api/@ohos.file.cloudSyncManager.d.ts b/api/@ohos.file.cloudSyncManager.d.ts index 878a9838f05785a234c611df01f2b3c4a638ec6d..4cdda3e50e05438e3b4110124f204b6d3a03bf2e 100644 --- a/api/@ohos.file.cloudSyncManager.d.ts +++ b/api/@ohos.file.cloudSyncManager.d.ts @@ -37,7 +37,8 @@ declare namespace cloudSyncManager { * @returns { Promise } - Return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -53,7 +54,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } [callback] - Callback function * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -73,7 +75,8 @@ declare namespace cloudSyncManager { * @returns { Promise } Return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -88,7 +91,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } [callback] - Callback function * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -104,7 +108,8 @@ declare namespace cloudSyncManager { * @returns { Promise } Return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -120,7 +125,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } [callback] - Callback function * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -135,7 +141,8 @@ declare namespace cloudSyncManager { * @returns { Promise } Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -150,7 +157,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } callback - Callback function * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -197,7 +205,8 @@ declare namespace cloudSyncManager { * @returns { Promise } Return Promise. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -213,7 +222,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } callback - Callback function * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi * @since 10 @@ -229,7 +239,8 @@ declare namespace cloudSyncManager { * @returns { Promise } Return Promise * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi @@ -246,7 +257,8 @@ declare namespace cloudSyncManager { * @param { AsyncCallback } callback - Callback function * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi diff --git a/api/@ohos.file.fileExtensionInfo.d.ts b/api/@ohos.file.fileExtensionInfo.d.ts index c1ba37fd96a72c76ce6f146b67356f97c5e8fb7f..95474594a42b794fe2f16b4e1733ba0210a2e58c 100644 --- a/api/@ohos.file.fileExtensionInfo.d.ts +++ b/api/@ohos.file.fileExtensionInfo.d.ts @@ -33,7 +33,7 @@ declare namespace fileExtensionInfo { * @enum { number } * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ enum DeviceType { @@ -42,7 +42,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_LOCAL_DISK = 1, @@ -52,7 +52,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_SHARED_DISK, @@ -62,7 +62,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_SHARED_TERMINAL, @@ -72,7 +72,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_NETWORK_NEIGHBORHOODS, @@ -82,7 +82,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_EXTERNAL_MTP, @@ -92,7 +92,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_EXTERNAL_USB, @@ -102,7 +102,7 @@ declare namespace fileExtensionInfo { * * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ DEVICE_EXTERNAL_CLOUD @@ -114,7 +114,7 @@ declare namespace fileExtensionInfo { * @namespace DeviceFlag * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ namespace DeviceFlag { @@ -124,7 +124,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const SUPPORTS_READ = 0b1; @@ -135,7 +135,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const SUPPORTS_WRITE = 0b10; @@ -147,7 +147,7 @@ declare namespace fileExtensionInfo { * @namespace DocumentFlag * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ namespace DocumentFlag { @@ -157,7 +157,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const REPRESENTS_FILE = 0b1; @@ -168,7 +168,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const REPRESENTS_DIR = 0b10; @@ -179,7 +179,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const SUPPORTS_READ = 0b100; @@ -190,7 +190,7 @@ declare namespace fileExtensionInfo { * @constant * @syscap SystemCapability.FileManagement.UserFileService * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 9 */ const SUPPORTS_WRITE = 0b1000; diff --git a/api/@ohos.file.fileuri.d.ts b/api/@ohos.file.fileuri.d.ts index 1580f0fe3d588b76cffcc22a86102827e3c6c11c..d201672208be7b2207cc921e2aed27640676c0a3 100644 --- a/api/@ohos.file.fileuri.d.ts +++ b/api/@ohos.file.fileuri.d.ts @@ -83,13 +83,14 @@ declare namespace fileUri { */ isRemoteUri(): boolean; } - + /** * Get the uri from the path of file in app sandbox * * @param { string } path the path of file in app sandbox * @returns { string } Return the file uri - * @throws { BusinessError } 401 - The input parameter is invalid + * @throws { BusinessError } 401 - The input parameter is invalidPossible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.AppFileService * @since 9 */ diff --git a/api/@ohos.file.fs.d.ts b/api/@ohos.file.fs.d.ts index 121a25bd7104cefb528ab385d6723779be74fc39..8533468b8a8e21327cf5e6e517e80da62462e136 100644 --- a/api/@ohos.file.fs.d.ts +++ b/api/@ohos.file.fs.d.ts @@ -113,9 +113,12 @@ declare namespace fileIo { export { Stream }; export { Watcher }; export { WhenceType }; + export { connectDfs }; + export { disconnectDfs }; export type { Progress }; export type { CopyOptions }; export type { ProgressListener }; + export type { DfsListeners }; /** * Mode Indicates the open flags. @@ -746,7 +749,8 @@ declare function closeSync(file: number | File): void; * @param { string } destUri - dest uri. * @param { CopyOptions } [options] - options. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900001 - Operation not permitted * @throws { BusinessError } 13900002 - No such file or directory * @throws { BusinessError } 13900004 - Interrupted system call @@ -782,7 +786,8 @@ declare function copy(srcUri: string, destUri: string, options?: CopyOptions): P * @param { string } srcUri - src uri. * @param { string } destUri - dest uri. * @param { AsyncCallback } callback - Return the callback function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900001 - Operation not permitted * @throws { BusinessError } 13900002 - No such file or directory * @throws { BusinessError } 13900004 - Interrupted system call @@ -819,7 +824,8 @@ declare function copy(srcUri: string, destUri: string, callback: AsyncCallback } callback - Return the callback function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13900001 - Operation not permitted * @throws { BusinessError } 13900002 - No such file or directory * @throws { BusinessError } 13900004 - Interrupted system call @@ -5740,6 +5746,35 @@ declare function writeSync( options?: WriteOptions ): number; +/** + * Connect Distributed File System. + * + * @param { string } networkId - The networkId of device. + * @param { DfsListeners } listeners - The listeners of Distributed File System. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - The parameter check failed.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900045 - Connection failed. + * @throws { BusinessError } 13900046 - Software caused connection abort. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 12 + */ +declare function connectDfs(networkId: string, listeners: DfsListeners): Promise; + +/** + * Disconnect Distributed File System. + * + * @param { string } networkId - The networkId of device. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - The parameter check failed.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 12 + */ +declare function disconnectDfs(networkId: string): Promise; + /** * Progress data of copyFile * @@ -7587,6 +7622,25 @@ export interface ListFileOptions { filter?: Filter; } +/** + * The listeners of Distributed File System. + * + * @typedef DfsListeners + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 12 + */ +interface DfsListeners { + /** + * The Listener of Distributed File System status + * + * @param { string } networkId - The networkId of device. + * @param { number } status - The status code of Distributed File System. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 12 + */ + onStatus(networkId: string, status: number): void; +} + /** * Enumeration of different types of whence. * diff --git a/api/@ohos.file.photoAccessHelper.d.ts b/api/@ohos.file.photoAccessHelper.d.ts index 30e665cc25a2bcd070e0d25c1c7bf05fc6381753..cb13050b3f41d77b96da5415b473eb3882b518b7 100644 --- a/api/@ohos.file.photoAccessHelper.d.ts +++ b/api/@ohos.file.photoAccessHelper.d.ts @@ -313,6 +313,7 @@ declare namespace photoAccessHelper { * * @enum { number } RecommendationType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice * @since 11 */ enum RecommendationType { @@ -675,6 +676,14 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ + /** + * Defines the photo asset + * + * @interface PhotoAsset + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 11 + */ interface PhotoAsset { /** * uri of the asset. diff --git a/api/@ohos.file.picker.d.ts b/api/@ohos.file.picker.d.ts index 6e155b860763c56c15da0b47def2e9a8a0403756..a9afd0421cf947fa14e6f656da36b563a0230da9 100644 --- a/api/@ohos.file.picker.d.ts +++ b/api/@ohos.file.picker.d.ts @@ -19,6 +19,7 @@ */ import { AsyncCallback, Callback } from './@ohos.base'; +import Context from './application/Context'; /** * Provide the capabilities to use different pickers. @@ -227,6 +228,23 @@ declare namespace picker { * @since 11 */ class PhotoViewPicker { + /** + * The constructor used to create a PhotoViewPicker object. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(); + + /** + * The constructor used to create a PhotoViewPicker object. + * + * @param { Context } context - represents the context. + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(context: Context); + /** * Pull up the photo picker based on the selection mode. * @@ -586,6 +604,23 @@ declare namespace picker { * @since 12 */ class DocumentViewPicker { + /** + * The constructor used to create a DocumentViewPicker object. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(); + + /** + * The constructor used to create a DocumentViewPicker object. + * + * @param { Context } context - represents the context. + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(context: Context); + /** * Pull up the document picker based on the selection mode. * @@ -745,6 +780,23 @@ declare namespace picker { * @since 9 */ class AudioViewPicker { + /** + * The constructor used to create a AudioViewPicker object. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(); + + /** + * The constructor used to create a AudioViewPicker object. + * + * @param { Context } context - represents the context. + * @syscap SystemCapability.FileManagement.UserFileService + * @since 12 + */ + constructor(context: Context); + /** * Pull up the audio picker based on the selection mode. * diff --git a/api/@ohos.file.storageStatistics.d.ts b/api/@ohos.file.storageStatistics.d.ts index 291b930d02c075d58a8e5ca8271479ad0f897c0b..602ac21df12ee4213013c79a67a56a678dc028ce 100644 --- a/api/@ohos.file.storageStatistics.d.ts +++ b/api/@ohos.file.storageStatistics.d.ts @@ -36,7 +36,9 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -54,7 +56,9 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -71,7 +75,9 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -89,7 +95,9 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -139,7 +147,9 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -157,7 +167,9 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -171,7 +183,8 @@ declare namespace storageStatistics { * Get the current bundle statistics. * * @param { AsyncCallback } callback - callback - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -183,7 +196,8 @@ declare namespace storageStatistics { * Get the current bundle statistics. * * @returns { Promise } return Promise - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -198,7 +212,8 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -214,7 +229,8 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -294,7 +310,9 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -310,7 +328,9 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -327,7 +347,9 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600009 - User if out of range. * @throws { BusinessError } 13900042 - Unknown error. @@ -345,7 +367,9 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600009 - User if out of range. * @throws { BusinessError } 13900042 - Unknown error. @@ -362,7 +386,8 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -378,7 +403,8 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -394,7 +420,8 @@ declare namespace storageStatistics { * @returns { number } return the total size * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -410,7 +437,8 @@ declare namespace storageStatistics { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -426,7 +454,8 @@ declare namespace storageStatistics { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics @@ -442,7 +471,8 @@ declare namespace storageStatistics { * @returns { number } return the free size * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics diff --git a/api/@ohos.file.volumeManager.d.ts b/api/@ohos.file.volumeManager.d.ts index e952d5a4f5dd4585bd672c82d10dc14a242440ef..613cd2ff2768835a7fbda84559223b99b35a059e 100644 --- a/api/@ohos.file.volumeManager.d.ts +++ b/api/@ohos.file.volumeManager.d.ts @@ -108,7 +108,8 @@ declare namespace volumeManager { * @param { AsyncCallback> } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume @@ -124,7 +125,8 @@ declare namespace volumeManager { * @returns { Promise> } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Mandatory +parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume @@ -141,7 +143,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600003 - Failed to mount. @@ -162,7 +166,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600003 - Failed to mount. @@ -183,7 +189,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600004 - Failed to unmount. @@ -204,7 +212,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600004 - Failed to unmount. @@ -225,7 +235,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -243,7 +255,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -261,7 +275,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -279,7 +295,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -298,7 +316,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600005 - Incorrect volume state. @@ -319,7 +339,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600005 - Incorrect volume state. @@ -340,7 +362,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600005 - Incorrect volume state. @@ -361,7 +385,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600002 - Not supported filesystem. * @throws { BusinessError } 13600005 - Incorrect volume state. @@ -382,7 +408,9 @@ declare namespace volumeManager { * @param { AsyncCallback } callback - callback * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. @@ -401,7 +429,9 @@ declare namespace volumeManager { * @returns { Promise } return Promise * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - The input parameter is invalid. + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory +parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13600008 - No such object. * @throws { BusinessError } 13900042 - Unknown error. diff --git a/api/@ohos.filemanagement.userFileManager.d.ts b/api/@ohos.filemanagement.userFileManager.d.ts index c4c0bafae565e2907ffb0e1685049a42e11e037a..cb99e25b2c90dd57d0a76f59d9ee5e685b5e2551 100644 --- a/api/@ohos.filemanagement.userFileManager.d.ts +++ b/api/@ohos.filemanagement.userFileManager.d.ts @@ -374,7 +374,8 @@ declare namespace userFileManager { * @param { string } userComment - user comment info * @param { AsyncCallback } callback - Returns void. * @throws { BusinessError } 202 - Called by non-system application. - * @throws { BusinessError } 401 - if parameter is invalid + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi * @since 10 @@ -387,7 +388,8 @@ declare namespace userFileManager { * @param { string } userComment - user comment info * @returns { Promise } Returns void * @throws { BusinessError } 202 - Called by non-system application. - * @throws { BusinessError } 401 - if parameter is invalid + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi * @since 10 @@ -1554,7 +1556,8 @@ declare namespace userFileManager { * @param { string } albumUri - The album uri. * @param { FetchOptions } options - fetch options * @param { AsyncCallback } callback - Returns the index of the asset in the album - * @throws { BusinessError } 401 - if parameter is invalid + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi * @since 10 @@ -1568,7 +1571,8 @@ declare namespace userFileManager { * @param { string } albumUri - The album uri. * @param { FetchOptions } options - fetch options * @returns { Promise } - Returns the index of the asset in the album - * @throws { BusinessError } 401 - if parameter is invalid + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi * @since 10 diff --git a/api/@ohos.fileshare.d.ts b/api/@ohos.fileshare.d.ts index 5975a604d570d0ebc69868608ea7cce98d3d8652..7fd0eade63fea0b79b4241bc6bcc14f7751a3087 100644 --- a/api/@ohos.fileshare.d.ts +++ b/api/@ohos.fileshare.d.ts @@ -167,7 +167,8 @@ declare namespace fileShare { * @param { AsyncCallback } callback * @throws { BusinessError } 201 - Permission verification failed * @throws { BusinessError } 202 - The caller is not a system application - * @throws { BusinessError } 401 - The input parameter is invalid + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 143000001 - IPC error * @syscap SystemCapability.FileManagement.AppFileService * @systemapi @@ -190,7 +191,8 @@ declare namespace fileShare { * @returns { Promise } no callback return Promise otherwise return void * @throws { BusinessError } 201 - Permission verification failed * @throws { BusinessError } 202 - The caller is not a system application - * @throws { BusinessError } 401 - The input parameter is invalid + * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 143000001 - IPC error * @syscap SystemCapability.FileManagement.AppFileService * @systemapi @@ -205,7 +207,8 @@ declare namespace fileShare { * @param { Array } policies - Policy information to grant permission on URIs. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error @@ -221,7 +224,8 @@ declare namespace fileShare { * @param { Array } policies - Policy information to grant permission on URIs. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error @@ -237,7 +241,8 @@ declare namespace fileShare { * @param { Array } policies - Policy information to grant permission on URIs. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error @@ -253,7 +258,8 @@ declare namespace fileShare { * @param { Array } policies - Policy information to grant permission on URIs. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error @@ -269,7 +275,8 @@ declare namespace fileShare { * @param { Array } policies - Policy information to grant permission on URIs. * @returns { Promise> } Returns the persistent state of uri permissions. * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization diff --git a/api/@ohos.geoLocationManager.d.ts b/api/@ohos.geoLocationManager.d.ts index fcacb8994d03945257c5f249549208d3f239c17b..b3048369823edaab053a9bfd46ef29f7ec2b46b8 100644 --- a/api/@ohos.geoLocationManager.d.ts +++ b/api/@ohos.geoLocationManager.d.ts @@ -45,10 +45,10 @@ declare namespace geoLocationManager { * @param { 'locationChange' } type - Indicates the location service event to be subscribed to. * @param { LocationRequest } request - Indicates the location request parameters. * @param { Callback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -61,10 +61,10 @@ declare namespace geoLocationManager { * @param { 'locationChange' } type - Indicates the location service event to be subscribed to. * @param { LocationRequest } request - Indicates the location request parameters. * @param { Callback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -78,10 +78,10 @@ declare namespace geoLocationManager { * @param { 'locationChange' } type - Indicates the location service event to be subscribed to. * @param { LocationRequest | ContinuousLocationRequest } request - Indicates the location request parameters. * @param { Callback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -97,10 +97,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'locationChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -112,10 +112,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'locationChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -130,10 +130,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'locationError' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting the continuous location error. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationError')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @atomicservice * @since 12 @@ -146,10 +146,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'locationError' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the continuous location error. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationError')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @atomicservice * @since 12 @@ -161,9 +161,9 @@ declare namespace geoLocationManager { * * @param { 'locationEnabledChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting the location switch status. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationEnabledChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -174,9 +174,9 @@ declare namespace geoLocationManager { * * @param { 'locationEnabledChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the location switch status. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationEnabledChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -189,10 +189,10 @@ declare namespace geoLocationManager { * @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to. * @param { CachedGnssLocationsRequest } request - Indicates the cached GNSS locations request parameters. * @param { Callback> } callback - Indicates the callback for reporting the cached GNSS locations. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('cachedGnssLocationsChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Gnss @@ -206,10 +206,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to. * @param { Callback> } [callback] - Indicates the callback for reporting the cached gnss locations. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('cachedGnssLocationsChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Gnss @@ -223,10 +223,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'satelliteStatusChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting the satellite status. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('satelliteStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -239,10 +239,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { 'satelliteStatusChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the satellite status. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('satelliteStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -255,10 +255,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { 'nmeaMessage' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting the nmea message. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('nmeaMessage')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -271,10 +271,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { 'nmeaMessage' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the nmea message. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('nmeaMessage')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -288,10 +288,10 @@ declare namespace geoLocationManager { * @param { 'gnssFenceStatusChange' } type - Indicates the location service event to be subscribed to. * @param { GeofenceRequest } request - Indicates the Geofence configuration parameters. * @param { WantAgent } want - Indicates which ability to start when the geofence event is triggered. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('gnssFenceStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301600 - Failed to operate the geofence. * @syscap SystemCapability.Location.Location.Geofence @@ -306,10 +306,10 @@ declare namespace geoLocationManager { * @param { 'gnssFenceStatusChange' } type - Indicates the location service event to be subscribed to. * @param { GeofenceRequest } request - Indicates the Geofence configuration parameters. * @param { WantAgent } want - Indicates which ability to start when the geofence event is triggered. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('gnssFenceStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301600 - Failed to operate the geofence. * @syscap SystemCapability.Location.Location.Geofence @@ -322,9 +322,9 @@ declare namespace geoLocationManager { * * @param { 'countryCodeChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting country code changes. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('countryCodeChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301500 - Failed to query the area information. * @syscap SystemCapability.Location.Location.Core * @since 9 @@ -336,9 +336,9 @@ declare namespace geoLocationManager { * * @param { 'countryCodeChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting country code changes. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('countryCodeChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301500 - Failed to query the area information. * @syscap SystemCapability.Location.Location.Core * @since 9 @@ -353,9 +353,9 @@ declare namespace geoLocationManager { * @param { 'locatingRequiredDataChange' } type - Indicates the location service event to be subscribed to. * @param { LocatingRequiredDataConfig } config - Indicates the locating required data configuration parameters. * @param { Callback> } [callback] - Indicates the callback for reporting WiFi/BT scan info. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. - * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locatingRequiredDataChange')} due to limited device capabilities. * @throws { BusinessError } 3301800 - Failed to start WiFi or Bluetooth scanning. * @syscap SystemCapability.Location.Location.Core * @systemapi @@ -369,9 +369,9 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { 'locatingRequiredDataChange' } type - Indicates the location service event to be subscribed to. * @param { Callback> } [callback] - Indicates the callback for reporting WiFi/BT scan info. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. - * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locatingRequiredDataChange')} due to limited device capabilities. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 10 @@ -383,9 +383,9 @@ declare namespace geoLocationManager { * * @param { 'locationIconStatusChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } callback - Indicates the callback for reporting the location icon status. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationIconStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 12 @@ -397,9 +397,9 @@ declare namespace geoLocationManager { * * @param { 'locationIconStatusChange' } type - Indicates the location service event to be subscribed to. * @param { Callback } [callback] - Indicates the callback for reporting the location icon status. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationIconStatusChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 12 @@ -412,10 +412,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest } request - Indicates the location request parameters. * @param { AsyncCallback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -427,10 +427,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest } request - Indicates the location request parameters. * @param { AsyncCallback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -443,10 +443,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest | SingleLocationRequest } request - Indicates the location request parameters. * @param { AsyncCallback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -461,10 +461,10 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { AsyncCallback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -475,10 +475,10 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { AsyncCallback } callback - Indicates the callback for reporting the location result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -493,10 +493,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest } [request] - Indicates the location request parameters. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -508,10 +508,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest } [request] - Indicates the location request parameters. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -524,10 +524,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { CurrentLocationRequest | SingleLocationRequest } [request] - Indicates the location request parameters. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -542,9 +542,9 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @returns { Location } The last known location information. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLastLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -555,9 +555,9 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @returns { Location } The last known location information. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLastLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core @@ -570,8 +570,8 @@ declare namespace geoLocationManager { * Obtain current location switch status. * * @returns { boolean } Returns {@code true} if the location switch on, returns {@code false} otherwise. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationEnabled} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -579,8 +579,8 @@ declare namespace geoLocationManager { * Obtain current location switch status. * * @returns { boolean } Returns {@code true} if the location switch on, returns {@code false} otherwise. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationEnabled} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @atomicservice * @since 11 @@ -592,11 +592,11 @@ declare namespace geoLocationManager { * * @permission ohos.permission.MANAGE_SECURE_SETTINGS * @param { AsyncCallback } callback - Indicates the callback for reporting the error message. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -608,10 +608,10 @@ declare namespace geoLocationManager { * * @permission ohos.permission.MANAGE_SECURE_SETTINGS * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -622,10 +622,10 @@ declare namespace geoLocationManager { * Disable location switch. * * @permission ohos.permission.MANAGE_SECURE_SETTINGS - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -637,9 +637,9 @@ declare namespace geoLocationManager { * * @param { ReverseGeoCodeRequest } request - Indicates the reverse geocode query parameters. * @param { AsyncCallback> } callback - Indicates the callback for reporting the address info. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301300 - Reverse geocoding query failed. * @syscap SystemCapability.Location.Location.Geocoder * @since 9 @@ -651,9 +651,9 @@ declare namespace geoLocationManager { * * @param { ReverseGeoCodeRequest } request - Indicates the reverse geocode query parameters. * @returns { Promise> } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301300 - Reverse geocoding query failed. * @syscap SystemCapability.Location.Location.Geocoder * @since 9 @@ -665,9 +665,9 @@ declare namespace geoLocationManager { * * @param { GeoCodeRequest } request - Indicates the geocode query parameters. * @param { AsyncCallback> } callback - Indicates the callback for reporting the latitude and longitude result. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301400 - Geocoding query failed. * @syscap SystemCapability.Location.Location.Geocoder * @since 9 @@ -679,9 +679,9 @@ declare namespace geoLocationManager { * * @param { GeoCodeRequest } request - Indicates the geocode query parameters. * @returns { Promise> } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301400 - Geocoding query failed. * @syscap SystemCapability.Location.Location.Geocoder * @since 9 @@ -692,8 +692,8 @@ declare namespace geoLocationManager { * Obtain geocoding service status. * * @returns { boolean } Returns {@code true} if geocoding service is available, returns {@code false} otherwise. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isGeocoderAvailable} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Geocoder * @since 9 */ @@ -704,10 +704,10 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @param { AsyncCallback } callback - Indicates the callback for reporting the cached GNSS locations size. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -719,9 +719,9 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Gnss * @since 9 @@ -736,10 +736,10 @@ declare namespace geoLocationManager { * @param { AsyncCallback } callback - Indicates the callback for reporting the error message. * If the function fails to execute, the error message will be carried in the first parameter err of AsyncCallback, * If the function executes successfully, execute the callback function only, no data will be returned. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Gnss @@ -753,9 +753,9 @@ declare namespace geoLocationManager { * * @permission ohos.permission.APPROXIMATELY_LOCATION * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Gnss @@ -770,9 +770,9 @@ declare namespace geoLocationManager { * @param { AsyncCallback } callback - Indicates the callback for reporting the error message. * If the function fails to execute, the error message will be carried in the first parameter err of AsyncCallback, * If the function executes successfully, execute the callback function only, no data will be returned. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -783,9 +783,9 @@ declare namespace geoLocationManager { * * @param { LocationCommand } command - Indicates the extended command message body. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -795,9 +795,9 @@ declare namespace geoLocationManager { * Obtain the current country code. * * @param { AsyncCallback } callback - Indicates the callback for reporting the country code. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301500 - Failed to query the area information. * @syscap SystemCapability.Location.Location.Core * @since 9 @@ -808,8 +808,8 @@ declare namespace geoLocationManager { * Obtain the current country code. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301500 - Failed to query the area information. * @syscap SystemCapability.Location.Location.Core * @since 9 @@ -819,9 +819,9 @@ declare namespace geoLocationManager { /** * Enable the geographical location simulation function. * - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocationMock} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Core * @systemapi @@ -832,9 +832,9 @@ declare namespace geoLocationManager { /** * Disable the geographical location simulation function. * - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocationMock} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Core * @systemapi @@ -847,9 +847,9 @@ declare namespace geoLocationManager { * * @param { LocationMockConfig } config - Indicates the configuration parameters for location simulation. * Contains the array of locations and reporting intervals that need to be simulated. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setMockedLocations} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @syscap SystemCapability.Location.Location.Core * @systemapi @@ -860,9 +860,9 @@ declare namespace geoLocationManager { /** * Enable the reverse geocoding simulation function. * - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableReverseGeocodingMock} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -872,9 +872,9 @@ declare namespace geoLocationManager { /** * Disable the reverse geocoding simulation function. * - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableReverseGeocodingMock} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -885,10 +885,10 @@ declare namespace geoLocationManager { * Set the configuration parameters for simulating reverse geocoding. * * @param { Array } mockInfos - Indicates the set of locations and place names to be simulated. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setReverseGeocodingMockInfo} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -900,10 +900,10 @@ declare namespace geoLocationManager { * * @param { LocationPrivacyType } type - Indicates location privacy protocol type. * @returns { boolean } Returns {@code true} if the location privacy protocol has been confirmed, returns {@code false} otherwise. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationPrivacyConfirmed} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -916,11 +916,11 @@ declare namespace geoLocationManager { * @permission ohos.permission.MANAGE_SECURE_SETTINGS * @param { LocationPrivacyType } type - Indicates location privacy protocol type. * @param { boolean } isConfirmed - Indicates whether the location privacy protocol has been confirmed. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - System API is not allowed called by third HAP. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setLocationPrivacyConfirmStatus} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 9 @@ -933,9 +933,9 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { LocatingRequiredDataConfig } config - Indicates the request parameters for obtaining the data required for locating. * @returns { Promise> } The promise returned by the function, for reporting WiFi/BT scan info. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. - * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLocatingRequiredData} due to limited device capabilities. * @throws { BusinessError } 3301800 - Failed to start WiFi or Bluetooth scanning. * @syscap SystemCapability.Location.Location.Core * @systemapi @@ -949,10 +949,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { GnssGeofenceRequest } fenceRequest - Indicates the Geofence configuration parameters. * @returns { Promise } The promise returned by the function, for reporting the ID of geofence. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.addGnssGeofence} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301100 - The location switch is off. * @throws { BusinessError } 3301601 - The number of geofences exceeds the maximum. * @syscap SystemCapability.Location.Location.Geofence @@ -966,10 +966,10 @@ declare namespace geoLocationManager { * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION * @param { number } geofenceId - Indicates the ID of geofence. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.removeGnssGeofence} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @throws { BusinessError } 3301602 - Failed to delete a geofence due to an incorrect ID. * @syscap SystemCapability.Location.Location.Geofence * @since 12 @@ -980,8 +980,8 @@ declare namespace geoLocationManager { * Obtains the coordinate system types supported by geofence. * * @returns { Array } Return the coordinate system types supported by geofence. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getGeofenceSupportedCoordTypes} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Geofence * @since 12 */ @@ -991,8 +991,8 @@ declare namespace geoLocationManager { * Get location icon status. * * @returns { LocationIconStatus } The location icon status. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3301000 - Location service is unavailable. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLocationIconStatus} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. * @syscap SystemCapability.Location.Location.Core * @systemapi * @since 12 @@ -2100,15 +2100,6 @@ declare namespace geoLocationManager { * @systemapi * @since 9 */ - /** - * Indicates whether it is an mock location. - * - * @type { ?Boolean } - * @syscap SystemCapability.Location.Location.Core - * @systemapi - * @atomicservice - * @since 11 - */ isFromMock?: Boolean; /** diff --git a/api/@ohos.graphics.colorSpaceManager.d.ts b/api/@ohos.graphics.colorSpaceManager.d.ts index 81ec557064d2343466b0317d5690599ae2ac8da7..4bd6ccdbf23b6f69d3ee2abd6b2779540e8dde9a 100644 --- a/api/@ohos.graphics.colorSpaceManager.d.ts +++ b/api/@ohos.graphics.colorSpaceManager.d.ts @@ -18,8 +18,6 @@ * @kit ArkGraphics2D */ -import { AsyncCallback } from './@ohos.base'; - /** * Color space manager. * @@ -525,7 +523,8 @@ declare namespace colorSpaceManager { * Create a color space manager by provided color space type. * @param { ColorSpace } colorSpaceName - Indicates the type of color space * @returns { ColorSpaceManager } Returns a color space manager object created by provided type. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. * @throws { BusinessError } 18600001 - Parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @since 9 @@ -534,7 +533,8 @@ declare namespace colorSpaceManager { * Create a color space manager by provided color space type. * @param { ColorSpace } colorSpaceName - Indicates the type of color space * @returns { ColorSpaceManager } Returns a color space manager object created by provided type. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. * @throws { BusinessError } 18600001 - Parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform @@ -547,7 +547,8 @@ declare namespace colorSpaceManager { * @param { ColorSpacePrimaries } primaries - Indicates the customized color primaries * @param { number } gamma - Indicates display gamma value * @returns { ColorSpaceManager } Returns a color space manager object created by customized parameters. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. * @throws { BusinessError } 18600001 - Parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @since 9 @@ -557,7 +558,8 @@ declare namespace colorSpaceManager { * @param { ColorSpacePrimaries } primaries - Indicates the customized color primaries * @param { number } gamma - Indicates display gamma value * @returns { ColorSpaceManager } Returns a color space manager object created by customized parameters. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. * @throws { BusinessError } 18600001 - Parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform diff --git a/api/@ohos.graphics.drawing.d.ts b/api/@ohos.graphics.drawing.d.ts index 88e5b319c4a8b56251deb8056eeeecc5133e93ad..f01dd64c9298dbf3f202c8ce74da98d6916d33e7 100644 --- a/api/@ohos.graphics.drawing.d.ts +++ b/api/@ohos.graphics.drawing.d.ts @@ -142,7 +142,7 @@ declare namespace drawing { */ DARKEN = 16, /** - * Choose a lighter background and source color. + * Choose a lighter background and source color. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -166,7 +166,7 @@ declare namespace drawing { */ HARD_LIGHT = 20, /** - * Lightens or Darkens the colors, depending on the source. + * Lightens or Darkens the colors, depending on the source. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -217,7 +217,7 @@ declare namespace drawing { /** * Describes a path object. - * + * * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -226,7 +226,8 @@ declare namespace drawing { * Sets the start point of a path * @param { number } x - Indicates the x coordinate of the start point. * @param { number } y - Indicates the y coordinate of the start point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -236,7 +237,8 @@ declare namespace drawing { * Draws a line segment from the last point of a path to the target point. * @param { number } x - Indicates the x coordinate of the target point. * @param { number } y - Indicates the y coordinate of the target point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -245,7 +247,7 @@ declare namespace drawing { /** * This is done by using angle arc mode. In this mode, a rectangle that encloses an ellipse is specified first, * and then a start angle and a sweep angle are specified. - * The arc is a portion of the ellipse defined by the start angle and the sweep angle. + * The arc is a portion of the ellipse defined by the start angle and the sweep angle. * By default, a line segment from the last point of the path to the start point of the arc is also added. * @param { number } x1 - Indicates the x coordinate of the upper left corner of the rectangle. * @param { number } y1 - Indicates the y coordinate of the upper left corner of the rectangle. @@ -253,7 +255,8 @@ declare namespace drawing { * @param { number } y2 - Indicates the y coordinate of the lower right corner of the rectangle. * @param { number } startDeg - Indicates the start angle, in degrees. * @param { number } sweepDeg - Indicates the angle to sweep, in degrees. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -265,7 +268,8 @@ declare namespace drawing { * @param { number } ctrlY - Indicates the y coordinate of the control point. * @param { number } endX - Indicates the x coordinate of the target point. * @param { number } endY - Indicates the y coordinate of the target point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -279,7 +283,8 @@ declare namespace drawing { * @param { number } ctrlY2 - Indicates the y coordinate of the second control point. * @param { number } endX - Indicates the x coordinate of the target point. * @param { number } endY - Indicates the y coordinate of the target point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -337,7 +342,8 @@ declare namespace drawing { /** * Constructor for the samplingOptions with filter mode. * @param { FilterMode } filterMode - Storage filter mode. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -353,7 +359,8 @@ declare namespace drawing { /** * Constructor for the Canvas. * @param { image.PixelMap } pixelmap - PixelMap. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -363,7 +370,8 @@ declare namespace drawing { * If rectangle is stroked, use pen to stroke width describes the line thickness, * else use brush to fill the rectangle. * @param { common2D.Rect } rect - Rectangle to draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -374,8 +382,9 @@ declare namespace drawing { * stroke width describes the line thickness, else use brush to fill the circle. * @param { number } x - X coordinate of the circle center. * @param { number } y - Y coordinate of the circle center. - * @param { number } radius - Half the diameter of circle. - * @throws { BusinessError } 401 - Parameter error. + * @param { number } radius - The radius of the circle must be greater than 0. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -396,7 +405,8 @@ declare namespace drawing { * @param { number } left - Left side of image. * @param { number } top - Top side of image. * @param { SamplingOptions } samplingOptions - SamplingOptions used to describe the sampling mode. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -404,9 +414,10 @@ declare namespace drawing { /** * Fills clip with color color. Mode determines how ARGB is combined with destination. - * @param { common2D.Color } color - Color in 32-bit argb format. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. * @param { BlendMode } blendMode - Used to combine source color and destination. The default value is SRC_OVER. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -416,16 +427,18 @@ declare namespace drawing { * Draw a point. * @param { number } x - X coordinate position of the point. * @param { number } y - Y coordinate position of the point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ drawPoint(x: number, y: number): void; /** - * Path contains an array of path contour, each of which may be open or closed. + * Draws a path. * @param { Path } path - Path to draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -437,18 +450,20 @@ declare namespace drawing { * @param { number } y0 - Y coordinate of the start point of the line segment. * @param { number } x1 - X coordinate of the end point of the line segment. * @param { number } y1 - Y coordinate of the end point of the line segment. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ drawLine(x0: number, y0: number, x1: number, y1: number): void; /** - * Draws line segment from startPt to endPt. - * @param { TextBlob } blob - X coordinate of the start point of the line segment. + * Draws a textBlob + * @param { TextBlob } blob - TextBlob to draw. * @param { number } x - X coordinate of the text start point. * @param { number } y - Y coordinate of the text start point. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -463,7 +478,8 @@ declare namespace drawing { * @param { number } vertOffset - Number of vert elements to skip before drawing. * @param { Array } colors - Array of colors, specifying a color at each vertex. * @param { number } colorOffset - Number of color elements to skip before drawing. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -473,7 +489,8 @@ declare namespace drawing { /** * Set pen to a canvas. * @param { Pen } pen - object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -482,7 +499,8 @@ declare namespace drawing { /** * Set brush to a canvas. * @param { Brush } brush - Object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -520,7 +538,8 @@ declare namespace drawing { /** * Restores the specific number of the canvas status (canvas matrix) saved in the stack. * @param { number } count - Depth of state stack to restore. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -538,7 +557,8 @@ declare namespace drawing { * Scales by sx on the x-axis and sy on the y-axis. * @param { number } sx - Indicates the amount to scale on x-axis. * @param { number } sy - Indicates the amount to scale on y-axis. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -548,7 +568,8 @@ declare namespace drawing { * Skews by sx on the x-axis and sy on the y-axis. * @param { number } sx - Indicates the value skew transformation on x-axis. * @param { number } sy - Indicates the value skew transformation on y-axis. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -559,7 +580,8 @@ declare namespace drawing { * @param { number } degrees - Indicates the amount to rotate, in degrees. * @param { number } sx - Indicates the x-axis value of the point to rotate about. * @param { number } sy - Indicates the y-axis value of the point to rotate about. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -569,7 +591,8 @@ declare namespace drawing { * Translates by dx along the x-axis and dy along the y-axis. * @param { number } dx - Indicates the distance to translate on x-axis. * @param { number } dy - Indicates the distance to translate on y-axis. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -581,7 +604,8 @@ declare namespace drawing { * @param { Path } path - To combine with clip. * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. * @param { boolean } doAntiAlias - True if clip is to be anti-aliased. The default value is false. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -593,7 +617,8 @@ declare namespace drawing { * @param { common2D.Rect } rect - To combine with clipping area. * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. * @param { boolean } doAntiAlias - True if clip is to be anti-aliased. The default value is false. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -688,7 +713,7 @@ declare namespace drawing { /** * Provide a description of the text - * + * * class TextBlob * @syscap SystemCapability.Graphics.Drawing * @since 11 @@ -700,7 +725,8 @@ declare namespace drawing { * @param { Font } font - Specify text size, font, text scale, etc. * @param { TextEncoding } encoding - The default value is TEXT_ENCODING_UTF8. * @returns { TextBlob } TextBlob object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @static * @syscap SystemCapability.Graphics.Drawing * @since 11 @@ -711,9 +737,10 @@ declare namespace drawing { * Creating a textblob object based on RunBuffer information * @param { Array } pos - The array of TextBlobRunBuffer. * @param { Font } font - Font used for this run. - * @param { common2D.Rect } bounds - Optional run bounding box. + * @param { common2D.Rect } bounds - Optional run bounding box. The default value is null; * @returns { TextBlob } TextBlob object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @static * @syscap SystemCapability.Graphics.Drawing * @since 11 @@ -728,10 +755,10 @@ declare namespace drawing { */ bounds(): common2D.Rect; } - + /** * The Typeface class specifies the typeface and intrinsic style of a font. - * + * * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -747,7 +774,7 @@ declare namespace drawing { /** * Font controls options applied when drawing and measuring text. - * + * * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -755,35 +782,43 @@ declare namespace drawing { /** * Requests, but does not require, that glyphs respect sub-pixel positioning. * @param { boolean } isSubpixel - Setting for sub-pixel positioning. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ enableSubpixel(isSubpixel: boolean): void; + /** * Increases stroke width when creating glyph bitmaps to approximate a bold typeface. * @param { boolean } isEmbolden - Setting for bold approximation. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ enableEmbolden(isEmbolden: boolean): void; + /** * Requests linearly scalable font and glyph metrics. * @param { boolean } isLinearMetrics - Setting for linearly scalable font and glyph metrics. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ enableLinearMetrics(isLinearMetrics: boolean): void; + /** * Sets text size in points. Has no effect if textSize is not greater than or equal to zero. - * @param { number } textSize - Typographic height of text. - * @throws { BusinessError } 401 - Parameter error. + * @param { number } textSize - Typographic height of text. The height of the text must be greater than 0. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setSize(textSize: number): void; + /** * Obtains the text size. * @returns { number } Text size. @@ -791,14 +826,17 @@ declare namespace drawing { * @since 11 */ getSize(): number; + /** * Sets Typeface to font. * @param { Typeface } typeface - Font and style used to draw text. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setTypeface(typeface: Typeface): void; + /** * Get Typeface to font. * @returns { Typeface } Typeface. @@ -806,6 +844,7 @@ declare namespace drawing { * @since 11 */ getTypeface(): Typeface; + /** * Get fontMetrics associated with typeface. * @returns { FontMetrics } The fontMetrics value returned to the caller. @@ -813,12 +852,14 @@ declare namespace drawing { * @since 11 */ getMetrics(): FontMetrics; + /** * Measure the width of text. * @param { string } text - Text Symbol Content. * @param { TextEncoding } encoding - Encoding format. * @returns { number } The width of text. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -880,7 +921,8 @@ declare namespace drawing { * @param { BlurType } blurType - Indicates the blur type. * @param { number } sigma - Indicates the standard deviation of the Gaussian blur to apply. Must be > 0. * @returns { MaskFilter } MaskFilter object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @static * @syscap SystemCapability.Graphics.Drawing * @since 12 @@ -900,7 +942,8 @@ declare namespace drawing { * with the even indices specifying the "on" intervals, and the odd indices specifying the "off" intervals. * @param { number } phase - Offset into the intervals array. * @returns { PathEffect } PathEffect object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @static * @syscap SystemCapability.Graphics.Drawing * @since 12 @@ -917,12 +960,13 @@ declare namespace drawing { /** * Makes a new ShadowLayer. * - * @param { number } blurRadius - The blur radius of the shadow. + * @param { number } blurRadius - The blur radius of the shadow. The blur radius must be greater than 0. * @param { number } x - The offset point on x-axis. * @param { number } y - The offset point on y-axis. - * @param { common2D.Color } color - The shadow color. + * @param { common2D.Color } color - The shadow color. The range of color channels must be [0, 255]. * @returns { ShadowLayer } ShadowLayer object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @static * @syscap SystemCapability.Graphics.Drawing * @since 12 @@ -932,33 +976,37 @@ declare namespace drawing { /** * ColorFilters are optional objects in the drawing pipeline. - * + * * @syscap SystemCapability.Graphics.Drawing * @since 11 */ class ColorFilter { /** * Makes a color filter with the given color and blend mode. - * @param { common2D.Color } color - Color. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. * @param { BlendMode } mode - BlendMode. * @returns { ColorFilter } Colorfilter object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @static * @syscap SystemCapability.Graphics.Drawing * @since 11 */ static createBlendModeColorFilter(color: common2D.Color, mode: BlendMode): ColorFilter; + /** * Create a color filter consisting of two filters. * @param { ColorFilter } outer - The filter is used next. * @param { ColorFilter } inner - The filter is used first. * @returns { ColorFilter } Colorfilter object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @static * @syscap SystemCapability.Graphics.Drawing * @since 11 */ static createComposeColorFilter(outer: ColorFilter, inner: ColorFilter): ColorFilter; + /** * Makes a color filter that converts between linear colors and sRGB colors. * @returns { ColorFilter } Colorfilter object. @@ -967,6 +1015,7 @@ declare namespace drawing { * @since 11 */ static createLinearToSRGBGamma(): ColorFilter; + /** * Makes a color filter that converts between sRGB colors and linear colors. * @returns { ColorFilter } Colorfilter object. @@ -975,6 +1024,7 @@ declare namespace drawing { * @since 11 */ static createSRGBGammaToLinear(): ColorFilter; + /** * Makes a color filter that multiplies the luma of its input into the alpha channel, * and sets the red, green, and blue channels to zero. @@ -1093,45 +1143,49 @@ declare namespace drawing { class Pen { /** * Set the color of the pen. - * @param { common2D.Color } color - Set colors. - * @throws { BusinessError } 401 - Parameter error. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setColor(color: common2D.Color): void; /** * Sets the thickness of the pen used by the paint to outline the shape. - * + * * @param { number } width - Zero thickness for hairline; greater than zero for pen thickness. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setStrokeWidth(width: number): void; /** - * Requests, but does not require, that edge pixels draw opaque or with - * partial transparency. - * + * Requests, but does not require, that edge pixels draw opaque or with partial transparency. + * * @param { boolean } aa - Setting for antialiasing. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setAntiAlias(aa: boolean): void; /** * Replaces alpha, leaving RGB - * - * @param { number } alpha - Alpha component of color. - * @throws { BusinessError } 401 - Parameter error. + * + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setAlpha(alpha: number): void; /** * Sets ColorFilter to pen - * + * * @param { ColorFilter } filter - ColorFilter to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -1140,7 +1194,8 @@ declare namespace drawing { * Sets MaskFilter to pen. * * @param { MaskFilter } filter - MaskFilter to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1149,7 +1204,8 @@ declare namespace drawing { * Sets PathEffect to pen. * * @param { PathEffect } effect - PathEffect to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1158,25 +1214,28 @@ declare namespace drawing { * Sets ShadowLayer to pen. * * @param { ShadowLayer } shadowLayer - ShadowLayer to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ setShadowLayer(shadowLayer: ShadowLayer): void; /** * Sets a blender that implements the specified blendmode enum. - * + * * @param { BlendMode } mode - Blendmode. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setBlendMode(mode: BlendMode): void; /** * Request color distribution error. - * + * * @param { boolean } dither - Whether the color is distributed incorrectly. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -1185,7 +1244,8 @@ declare namespace drawing { * Sets the JoinStyle for a pen. * * @param { JoinStyle } style - The JoinStyle. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1202,7 +1262,8 @@ declare namespace drawing { * Sets the CapStyle for a pen. * * @param { CapStyle } style - The CapStyle. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1225,25 +1286,27 @@ declare namespace drawing { class Brush { /** * Set the color of the brush. - * @param { common2D.Color } color - Set colors. - * @throws { BusinessError } 401 - Parameter error. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setColor(color: common2D.Color): void; /** - * Requests, but does not require, that edge pixels draw opaque or with - * partial transparency. + * Requests, but does not require, that edge pixels draw opaque or with partial transparency. * @param { boolean } aa - Setting for antialiasing. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ setAntiAlias(aa: boolean): void; /** * Replaces alpha, leaving RGB - * @param { number } alpha - Alpha component of color, value range: 0–255. - * @throws { BusinessError } 401 - Parameter error. + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -1251,7 +1314,8 @@ declare namespace drawing { /** * Sets ColorFilter to brush * @param { ColorFilter } filter - ColorFilter to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ @@ -1259,7 +1323,8 @@ declare namespace drawing { /** * Sets MaskFilter to brush. * @param { MaskFilter } filter - MaskFilter to apply to subsequent draw. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1268,7 +1333,8 @@ declare namespace drawing { * Sets ShadowLayer to brush. * * @param { ShadowLayer } shadowLayer - ShadowLayer painting. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 12 */ @@ -1276,7 +1342,8 @@ declare namespace drawing { /** * Sets a blender that implements the specified blendmode enum. * @param { BlendMode } mode - Blendmode. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 11 */ diff --git a/api/@ohos.graphics.sendableColorSpaceManager.d.ets b/api/@ohos.graphics.sendableColorSpaceManager.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..955556be3cf9febaacdb48a42730aec2f752ed6a --- /dev/null +++ b/api/@ohos.graphics.sendableColorSpaceManager.d.ets @@ -0,0 +1,110 @@ +/* +* Copyright (C) 2024 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** + * @file + * @kit ArkGraphics2D + */ + +import lang from '../arkts/@arkts.lang'; +import collections from '../arkts/@arkts.collections'; +import colorSpaceManager from '@ohos.graphics.colorSpaceManager'; + +/** + * Color space manager. + * + * @namespace sendableColorSpaceManager + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ +declare namespace sendableColorSpaceManager { + /** + * Redefines ISendable for convenience. + * + * @typedef { lang.ISendable } ISendable + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + type ISendable = lang.ISendable; + /** + * Defines a color space object and manages its key information + * @interface ColorSpaceManager + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + interface ColorSpaceManager extends ISendable { + /** + * Get the name of color space type. + * @returns { colorSpaceManager.ColorSpace } Returns the name of color space type. + * @throws { BusinessError } 18600001 - Parameter value is abnormal. + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + getColorSpaceName(): colorSpaceManager.ColorSpace; + + /** + * Get white point(x, y) of color space. + * @returns { collections.Array } Returns the white point value of color space. + * @throws { BusinessError } 18600001 - Parameter value is abnormal. + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + getWhitePoint(): collections.Array; + + /** + * Get gamma value of color space. + * @returns { number } Returns the gamma value of color space. + * @throws { BusinessError } 18600001 - Parameter value is abnormal. + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + getGamma(): number; + } + + /** + * Create a color space manager by provided color space type. + * @param { colorSpaceManager.ColorSpace } colorSpaceName - Indicates the type of color space + * @returns { ColorSpaceManager } Returns a color space manager object created by provided type. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. + * @throws { BusinessError } 18600001 - Parameter value is abnormal. + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + function create(colorSpaceName: colorSpaceManager.ColorSpace): ColorSpaceManager; + + /** + * Create a customized color space manager by its color primaries and gamma value + * @param { colorSpaceManager.ColorSpacePrimaries } primaries - Indicates the customized color primaries + * @param { number } gamma - Indicates display gamma value + * @returns { ColorSpaceManager } Returns a color space manager object created by customized parameters. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Incorrect parameter type. + * 2.Parameter verification failed. + * @throws { BusinessError } 18600001 - Parameter value is abnormal. + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @crossplatform + * @since 12 + */ + function create(primaries: colorSpaceManager.ColorSpacePrimaries, gamma: number): ColorSpaceManager; +} + +export default sendableColorSpaceManager; \ No newline at end of file diff --git a/api/@ohos.graphics.text.d.ts b/api/@ohos.graphics.text.d.ts index ef038f5d1cb55606d5a95c4dfa33113efb76a7f3..53b9bce00de1b23c7d27f1a7c34e746fce8acf59 100755 --- a/api/@ohos.graphics.text.d.ts +++ b/api/@ohos.graphics.text.d.ts @@ -567,6 +567,14 @@ declare namespace text { * @since 12 */ class FontCollection { + /** + * Get global FontCollection instance of the application. + * @returns { FontCollection } The FontCollection object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static getGlobalInstance(): FontCollection; + /** * Load font. * @param { string } name - the font name. @@ -927,7 +935,7 @@ declare namespace text { * @syscap SystemCapability.Graphics.Drawing * @since 12 */ - interface TextBox{ + interface TextBox { /** * Rect of text box. * @type { common2D.Rect } diff --git a/api/@ohos.graphics.uiEffect.d.ts b/api/@ohos.graphics.uiEffect.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..6d0035a345fc1ee2791b2000ac3f071caced7579 --- /dev/null +++ b/api/@ohos.graphics.uiEffect.d.ts @@ -0,0 +1,330 @@ +/* +* Copyright (c) 2024 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** + * @file + * @kit ArkGraphics2D + */ + +import { AsyncCallback } from './@ohos.base'; + + +/** + * @namespace uiEffect + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ +declare namespace uiEffect { + + /** + * The Filter for Component. + * @typedef Filter + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + interface Filter { + /** + * Set the edge pixel stretch effect of the Component. + * + * @param { Array } stretchSizes + * @param { TileMode } tileMode + * @returns { Filter } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + pixelStretch(stretchSizes: Array, tileMode: TileMode): Filter; + + /** + * Set blur effect of the Component. + * + * @param { number } blurRadius + * @returns { Filter } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + blur(blurRadius: number): Filter; + } + + /** + * TileMode enumeration description + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + enum TileMode { + /** + * Clamp mode. + * + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + CLAMP = 0, + + /** + * Repeat mode. + * + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + REPEAT = 1, + + /** + * Mirror mode. + * + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + MIRROR = 2, + + /** + * Decal mode. + * + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + DECAL = 3, + } + + /** + * The VisualEffect of Component. + * @typedef VisualEffect + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + interface VisualEffect { + /** + * A backgroundColorEffect effect is added to the Component. + * @param { BrightnessBlender } blender - The blender to blend backgroundColor. + * @returns { VisualEffect } VisualEffects for the current effect have been added. + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + backgroundColorBlender(blender: BrightnessBlender): VisualEffect; + } + + /** + * The Blender of backgroundColorEffect. + * @typedef BrightnessBlender + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + interface BrightnessBlender { + /** + * Defines third-order rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + cubicRate: number; + + /** + * Defines second-order rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + quadraticRate: number; + + /** + * Defines linear rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + linearRate: number; + + /** + * Defines grayscale adjustment degree. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + degree: number; + + /** + * Defines the reference saturation for brightness. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + saturation: number; + + /** + * Defines the positive adjustment coefficients in RGB channels based on the reference saturation. + * + * @type { [number, number, number] } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + positiveCoefficient: [number, number, number]; + + /** + * Defines the negative adjustment coefficients in RGB channels based on the reference saturation. + * + * @type { [number, number, number] } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + negativeCoefficient: [number, number, number]; + + /** + * Defines the blending fraction for brightness effect. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + fraction: number; + } + + /** + * Create a Filter to add multiple effects to the component. + * @returns { Filter } Returns the head node of Filter. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + function createFilter(): Filter; + + /** + * Create a VisualEffect to add multiple effects to the component. + * @returns { VisualEffect } Returns the head node of visualEffect. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + function createEffect(): VisualEffect; + + /** + * Create a BrightnessBlender to add BrightnessBlender to the component. + * @param { BrightnessBlenderParam } param - The brightness blender parameters. + * @returns { BrightnessBlender } Returns the blender. + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + function createBrightnessBlender(param: BrightnessBlenderParam): BrightnessBlender; +} + +/** + * The parameters of brightness blender. + * @typedef BrightnessBlenderParam + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ +declare interface BrightnessBlenderParam { + /** + * Defines third-order rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + cubicRate: number; + + /** + * Defines second-order rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + quadraticRate: number; + + /** + * Defines linear rate for grayscale adjustment. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + linearRate: number; + + /** + * Defines grayscale adjustment degree. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + degree: number; + + /** + * Defines the reference saturation for brightness. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + saturation: number; + + /** + * Defines the positive adjustment coefficients in RGB channels based on the reference saturation. + * + * @type { [number, number, number] } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + positiveCoefficient: [number, number, number]; + + /** + * Defines the negative adjustment coefficients in RGB channels based on the reference saturation. + * + * @type { [number, number, number] } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + negativeCoefficient: [number, number, number]; + + /** + * Defines the blending fraction for brightness effect. + * + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 12 + */ + fraction: number; +} + +export default uiEffect; \ No newline at end of file diff --git a/api/@ohos.hiSysEvent.d.ts b/api/@ohos.hiSysEvent.d.ts index 00ba59ac14e8fa5b0c220e6821c71ea993c093e1..47aaead38b120c76e16ad14f9f677dab1dd54bf1 100644 --- a/api/@ohos.hiSysEvent.d.ts +++ b/api/@ohos.hiSysEvent.d.ts @@ -119,12 +119,12 @@ declare namespace hiSysEvent { /** * The params of the event. * - * @type { object } + * @type { ?object } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 */ - params: object; + params?: object; } /** @@ -132,15 +132,18 @@ declare namespace hiSysEvent { * * @param {SysEventInfo} info - system event information to be written. * @returns {Promise} - Return Promise - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. * @throws {BusinessError} 11200001 - Invalid event domain. * @throws {BusinessError} 11200002 - Invalid event name. * @throws {BusinessError} 11200003 - Abnormal environment. - * @throws {BusinessError} 11200004 - Length of the event is over limit. + * @throws {BusinessError} 11200004 - The event length exceeds the limit. * @throws {BusinessError} 11200051 - Invalid event parameter. - * @throws {BusinessError} 11200052 - Size of the event parameter of the string type is over limit. - * @throws {BusinessError} 11200053 - Count of event parameters is over limit. - * @throws {BusinessError} 11200054 - Count of event parameter of the array type is over limit. + * @throws {BusinessError} 11200052 - The size of the event parameter of the string type exceeds the limit. + * @throws {BusinessError} 11200053 - The number of event parameters exceeds the limit. + * @throws {BusinessError} 11200054 - The number of event parameters of the array type exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 @@ -152,15 +155,18 @@ declare namespace hiSysEvent { * * @param {SysEventInfo} info - system event information to be written. * @param {AsyncCallback} callback - callback function. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. * @throws {BusinessError} 11200001 - Invalid event domain. * @throws {BusinessError} 11200002 - Invalid event name. * @throws {BusinessError} 11200003 - Abnormal environment. - * @throws {BusinessError} 11200004 - Length of the event is over limit. + * @throws {BusinessError} 11200004 - The event length exceeds the limit. * @throws {BusinessError} 11200051 - Invalid event parameter. - * @throws {BusinessError} 11200052 - Size of the event parameter of the string type is over limit. - * @throws {BusinessError} 11200053 - Count of event parameters is over limit. - * @throws {BusinessError} 11200054 - Count of event parameter of the array type is over limit. + * @throws {BusinessError} 11200052 - The size of the event parameter of the string type exceeds the limit. + * @throws {BusinessError} 11200053 - The number of event parameters exceeds the limit. + * @throws {BusinessError} 11200054 - The number of event parameters of the array type exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 @@ -236,12 +242,12 @@ declare namespace hiSysEvent { /** * The tag of the event. * - * @type { string } + * @type { ?string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 */ - tag: string; + tag?: string; /** * The rule of match system event @@ -426,9 +432,12 @@ declare namespace hiSysEvent { * @param {Watcher} watcher watch system event * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. - * @throws {BusinessError} 11200101 - Count of watchers is over limit. - * @throws {BusinessError} 11200102 - Count of watch rules is over limit. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws {BusinessError} 11200101 - The number of watchers exceeds the limit. + * @throws {BusinessError} 11200102 - The number of watch rules exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 @@ -442,7 +451,10 @@ declare namespace hiSysEvent { * @param {Watcher} watcher watch system event * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. * @throws {BusinessError} 11200201 - The watcher does not exist. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use @@ -459,11 +471,14 @@ declare namespace hiSysEvent { * @param {Querier} querier receive query result * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. - * @throws {BusinessError} 11200301 - Count of query rules is over limit. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws {BusinessError} 11200301 - The number of query rules exceeds the limit. * @throws {BusinessError} 11200302 - Invalid query rule. - * @throws {BusinessError} 11200303 - Count of concurrent queriers is over limit. - * @throws {BusinessError} 11200304 - Query frequency is over limit. + * @throws {BusinessError} 11200303 - The number of concurrent queriers exceeds the limit. + * @throws {BusinessError} 11200304 - The query frequency exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 9 @@ -479,10 +494,13 @@ declare namespace hiSysEvent { * @returns {number} return hiview receive task time. * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. - * @throws {BusinessError} 11200301 - Count of query rules is over limit. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws {BusinessError} 11200301 - The number of query rules exceeds the limit. * @throws {BusinessError} 11200302 - Invalid query rule. - * @throws {BusinessError} 11200304 – Export frequency is over limit. + * @throws {BusinessError} 11200304 – The query frequency exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 10 @@ -497,8 +515,11 @@ declare namespace hiSysEvent { * @returns {number} return hiview receive task time. * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. - * @throws {BusinessError} 11200301 - Count of query rules is over limit. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws {BusinessError} 11200301 - The number of query rules exceeds the limit. * @throws {BusinessError} 11200302 - Invalid query rule. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use @@ -512,8 +533,11 @@ declare namespace hiSysEvent { * @permission ohos.permission.READ_DFX_SYSEVENT * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. - * @throws {BusinessError} 11200305 – unsubscribe failed. + * @throws {BusinessError} 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws {BusinessError} 11200305 – Unsubscription failed. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @since 10 diff --git a/api/@ohos.hidebug.d.ts b/api/@ohos.hidebug.d.ts index b46b9c6da1b16633c6cb74a1705bb280abfbb59f..b70bc96b887e63ec19dd9bb5476495a203c2c1da 100644 --- a/api/@ohos.hidebug.d.ts +++ b/api/@ohos.hidebug.d.ts @@ -755,5 +755,30 @@ declare namespace hidebug { * @since 12 */ function stopAppTraceCapture(): void; + + /** + * Set the resource limitation of application.Please note that this function is only valid + * when the developer options switch of setting is turned on. + * + * @param { string } type - resource type. It could be pss_memory、js_heap、fd、or thread. + * @param { number } value - For different resource type, values could have different meaning: + * 1.For pss_memory, it means the baseline PSS memory size for the application, + * system memory control will be triggered if exceed the value too much. + * 2.For js_heap, it means the percentage of the used JS heap memory to the maximum limit exceed + * which heap dump will be triggered if enableDebugLog set as true, it can be set between 85 and 95. + * 3.For fd, it means the maximum fd number can be opened. + * 4.For thread, it means the maximum thread number can be created. + * @param { boolean } enableDebugLog - Whether to enable external debug log. Default is false, pls make sure set + * it as true only in gray release because collecting debug log will cost too much cpu or memory. + * @throws { BusinessError } 401 - Invalid argument, Possible causes: + * 1.The limit parameter is too small + * 2.The parameter is not in the specified type + * 3.The parameter type error or parameter order error + * @throws { BusinessError } 11400104 - Set limit failed due to remote exception + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @atomicservice + * @since 12 + */ + function setAppResourceLimit(type: string, value: number, enableDebugLog: boolean): void; } export default hidebug; diff --git a/api/@ohos.hiviewdfx.hiAppEvent.d.ts b/api/@ohos.hiviewdfx.hiAppEvent.d.ts index f260b4c6a08227fe3a6613d7dc843cb3c232793e..c2f4ce817dcea8dd5e054628e89252e670735757 100644 --- a/api/@ohos.hiviewdfx.hiAppEvent.d.ts +++ b/api/@ohos.hiviewdfx.hiAppEvent.d.ts @@ -751,8 +751,8 @@ declare namespace hiAppEvent { * * @param { number } size Threshold size. * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.The limit parameter is too small; - * 2.The parameter type error. + * 1.The limit parameter is too small; + * 2.The parameter type error. * @throws { BusinessError } 11104001 - Invalid size value. * @syscap SystemCapability.HiviewDFX.HiAppEvent * @atomicservice @@ -764,7 +764,9 @@ declare namespace hiAppEvent { * Set the number of rows per read. * * @param { number } size Row size. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.The limit parameter is too small; + * 2.The parameter type error. * @throws { BusinessError } 11104001 - Invalid size value. * @syscap SystemCapability.HiviewDFX.HiAppEvent * @atomicservice diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index 7b0c447bbdaa5e44e91f39f109801663b21043fb..cd4b0898dc4a42e74578966f9311ccae575732a9 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -142,11 +142,25 @@ declare namespace i18n { * @param { boolean } [sentenceCase] - Specifies whether the country or region name is displayed in sentence case. * @returns { string } the country or region name localized for display on a given locale. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 */ + /** + * Obtains the country or region name localized for display on a given locale. + * + * @param { string } country - The locale whose country or region name will be displayed. It must be a valid country. + * @param { string } locale - The locale used to display the country or region. It must be a valid locale. + * @param { boolean } [sentenceCase] - Specifies whether the country or region name is displayed in sentence case. + * @returns { string } the country or region name localized for display on a given locale. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string; /** @@ -182,7 +196,7 @@ declare namespace i18n { * @param { boolean } [sentenceCase] - Specifies whether the language name is displayed in sentence case. * @returns { string } the language name localized for display on a given locale. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice @@ -197,6 +211,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Obtains all languages supported by the system. + * + * @returns { Array } all languages supported by the system. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getSystemLanguages(): Array; /** @@ -205,10 +227,21 @@ declare namespace i18n { * @param { string } language - The language used to get the list of regions. It must be a valid language. * @returns { Array } all countries or regions supported by the system in the language. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Obtains all regions supported by the system in the language. + * + * @param { string } language - The language used to get the list of regions. It must be a valid language. + * @returns { Array } all countries or regions supported by the system in the language. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getSystemCountries(language: string): Array; /** @@ -218,10 +251,22 @@ declare namespace i18n { * @param { string } [region] - The region code. It must be a valid region. * @returns { boolean } whether the current language or region is recommended. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Determine whether the current language or region is recommended. + * + * @param { string } language - The language code. It must be a valid language. + * @param { string } [region] - The region code. It must be a valid region. + * @returns { boolean } whether the current language or region is recommended. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static isSuggested(language: string, region?: string): boolean; /** @@ -256,9 +301,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { string } language - The language to be used. It must be a valid language. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -280,6 +325,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Obtains the region currently used by the system. + * + * @returns { string } the region currently used by the system. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static getSystemRegion(): string; /** @@ -287,9 +341,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { string } region - The region to be used. It must be a valid region. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -327,9 +381,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { string } locale - The locale to be used. It must be a valid locale. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -360,6 +414,16 @@ declare namespace i18n { * @form * @since 11 */ + /** + * Check out whether system is 24-hour system. + * + * @returns { boolean } a boolean represent whether system is 24-hour system. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ static is24HourClock(): boolean; /** @@ -367,9 +431,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { boolean } option - represent the boolean to be set. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -382,9 +446,9 @@ declare namespace i18n { * @permission ohos.permission.UPDATE_CONFIGURATION * @param { string } language - the language to be added. It must be a valid language. * @param { number } [index] - the position of preferred language list to be inserted. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -396,9 +460,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { number } index - the position of removed language in preferred language list. - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -412,6 +476,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Access the system preferred language list. + * + * @returns { Array } a string Array represent the preferred language list. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getPreferredLanguageList(): Array; /** @@ -421,6 +493,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get the first preferred language of system. + * + * @returns { string } a string represent the first preferred language of system. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getFirstPreferredLanguage(): string; /** @@ -428,10 +508,20 @@ declare namespace i18n { * * @param { string } language - the language to be set. It must be a valid language. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Set the preferred language of App. + * + * @param { string } language - the language to be set. It must be a valid language. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static setAppPreferredLanguage(language: string): void; /** @@ -441,6 +531,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get the preferred language of App. + * + * @returns { string } a string represent the preferred language of App. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getAppPreferredLanguage(): string; /** @@ -448,9 +546,9 @@ declare namespace i18n { * * @permission ohos.permission.UPDATE_CONFIGURATION * @param { boolean } flag - a boolean variable represents whether to use local digit - * @throws { BusinessError } 201 - the application does not have permission to call this function + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 9 @@ -464,6 +562,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get whether to use local digit. + * + * @returns { boolean } a boolean represents whether to use local digit. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getUsingLocalDigit(): boolean; } @@ -507,6 +613,14 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Provides util functions. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class I18NUtil { /** * Convert from unit to unit and format according to the locale. @@ -520,6 +634,19 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Convert from unit to unit and format according to the locale. + * + * @param { UnitInfo } fromUnit - Information of the unit to be converted. + * @param { UnitInfo } toUnit - Information about the unit to be converted to. + * @param { number } value - Indicates the number to be formatted. + * @param { string } locale - The locale to be used. + * @param { string } [style] - The style of format. + * @returns { string } converted number and unit. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string; /** @@ -541,6 +668,17 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the order of year, month, day in the specified locale. Year, month, day are separated by '-'. + * 'y' stands for year, 'L' stands for month, d stands for day. + * + * @param { string } locale - Information of the locale. + * @returns { string } the string of 'y', 'L', 'd' joined by '-'. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static getDateOrder(locale: string): string; /** @@ -550,10 +688,22 @@ declare namespace i18n { * @param { string } [locale] - specified the locale. Use current app locale by default. It must be a valid locale. * @returns { string } the string of time period name. The return value may be empty string * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Get the time period name for the specified hour. + * + * @param { number } hour - the hour value. + * @param { string } [locale] - specified the locale. Use current app locale by default. It must be a valid locale. + * @returns { string } the string of time period name. The return value may be empty string + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getTimePeriodName(hour:number, locale?: string): string; /** @@ -564,9 +714,10 @@ declare namespace i18n { * @returns { string } the string of the best matched locale name. * The return value may be empty string due to none is matched. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @static * @syscap SystemCapability.Global.I18n + * @atomicservice * @since 12 */ static getBestMatchLocale(locale: string, localeList: string[]): string; @@ -577,9 +728,10 @@ declare namespace i18n { * @param { string } locale - the origin locale or language code. It must be a valid locale. * @returns { string } 3 letter language code. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @static * @syscap SystemCapability.Global.I18n + * @atomicservice * @since 12 */ static getThreeLetterLanguage(locale: string): string; @@ -590,9 +742,10 @@ declare namespace i18n { * @param { string } locale - the origin locale or region code. It must be a valid locale. * @returns { string } 3 letter region code. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @static * @syscap SystemCapability.Global.I18n + * @atomicservice * @since 12 */ static getThreeLetterRegion(locale: string): string; @@ -605,6 +758,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Provides the options of unit. + * + * @interface UnitInfo + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export interface UnitInfo { /** * Unit name. @@ -612,6 +773,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Unit name. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ unit: string; /** @@ -620,6 +788,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * The measurement system of the unit. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ measureSystem: string; } @@ -638,6 +813,15 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Provides the options of PhoneNumberFormat. + * + * @interface PhoneNumberFormatOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface PhoneNumberFormatOptions { /** * Indicates the type to format phone number. @@ -661,6 +845,15 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Indicates the type to format phone number. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ type?: string; } @@ -677,6 +870,14 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Provides the API for formatting phone number strings + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class PhoneNumberFormat { /** * A constructor used to create a PhoneNumberFormat object. @@ -695,6 +896,16 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * A constructor used to create a PhoneNumberFormat object. + * + * @param { string } country - Indicates a character string containing the country information for the PhoneNumberFormat object. + * @param { PhoneNumberFormatOptions } [options] - format types: "E164", "RFC3966", "INTERNATIONAL", "NATIONAL". + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(country: string, options?: PhoneNumberFormatOptions); /** @@ -714,6 +925,16 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Judge whether phone number is valid. + * + * @param { string } number - Indicates the input phone number. + * @returns { boolean } a boolean indicates whether the input phone number is valid. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ isValidNumber(number: string): boolean; /** @@ -733,6 +954,16 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Obtains the formatted phone number strings of number. + * + * @param { string } number - Indicates the input phone number to be formatted. + * @returns { string } the formatted phone number. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ format(number: string): string; /** @@ -744,6 +975,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Determine the location by phone number, and return it according to the specified regional language. + * + * @param { string } number - input phone number. + * @param { string } locale - locale ID. + * @returns { string } a string represents phone number's location. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getLocationName(number: string, locale: string): string; } @@ -770,11 +1011,24 @@ declare namespace i18n { * @crossplatform * @since 10 */ - export function getCalendar(locale: string, type?: string): Calendar; - - /** - * Provides the API for accessing Calendar name, time and date related information. - * + /** + * Get a Calendar instance specified by locale and type. + * + * @param { string } locale - The locale used to get calendar. + * @param { string } [type] - If type is not specified, get locale's default Calendar, else get the specified type of Calendar. + * such as buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, + * japanese, persian. + * @returns { Calendar } Calendar object + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ + export function getCalendar(locale: string, type?: string): Calendar; + + /** + * Provides the API for accessing Calendar name, time and date related information. + * * @syscap SystemCapability.Global.I18n * @since 7 */ @@ -785,6 +1039,14 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Provides the API for accessing Calendar name, time and date related information. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class Calendar { /** * set the date. @@ -801,6 +1063,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * set the date. + * + * @param { Date } date - Date object used to set the time and date. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ setTime(date: Date): void; /** @@ -818,6 +1089,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * set the time. + * + * @param { number } time - Indicates the elapsed milliseconds from 1970.1.1 00:00:00 GMT. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ setTime(time: number): void; /** @@ -845,6 +1125,20 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Set the time + * + * @param { number } year - The year field of the calendar, ranges from 0 to 9999. + * @param { number } month - The month field of the calendar, ranges from 0 to 11. + * @param { number } date - The day field of the calendar, ranges from 1 to 31. + * @param { number } hour - The hour field of the calendar, ranges from 0 to 23. + * @param { number } minute - The minute field of the calendar, ranges from 0 to 59. + * @param { number } second - the second field of the calendar, ranges from 0 to 59. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ set(year: number, month: number, date: number, hour?: number, minute?: number, second?: number): void; /** @@ -862,6 +1156,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Set the timezone of this calendar. + * + * @param { string } timezone - The id of a timezone. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ setTimeZone(timezone: string): void; /** @@ -879,6 +1182,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the timezone id of this calendar instance. + * + * @returns { string } the timezone id of this calendar. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getTimeZone(): string; /** @@ -896,6 +1208,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the start day of a week. 1 indicates Sunday, 7 indicates Saturday. + * + * @returns { number } start day of a week. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getFirstDayOfWeek(): number; /** @@ -913,6 +1234,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Set the start day of a week. 1 indicates Sunday, 7 indicates Saturday. + * + * @param { number } value - Indicates the start day of a week. 1 indicates Sunday, 7 indicates Saturday. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ setFirstDayOfWeek(value: number): void; /** @@ -930,6 +1260,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the minimal days of a week, which is needed for the first day of a year. + * + * @returns { number } the minimal days of a week. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getMinimalDaysInFirstWeek(): number; /** @@ -947,6 +1286,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Set the minimal days of a week, which is needed for the first week of a year. + * + * @param { number } value - The value to be set. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ setMinimalDaysInFirstWeek(value: number): void; /** @@ -970,6 +1318,18 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the associated value with the field. + * + * @param { string } field - Field values such as era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week + * day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, + * dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month. + * @returns { number } the associated value. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ get(field: string): number; /** @@ -980,6 +1340,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Get calendar's name localized for display in the given locale. + * + * @param { string } locale - Locale used to get the localized name for this calendar. It must be a valid locale. + * @returns { string } the localized name of this calendar. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getDisplayName(locale: string): string; /** @@ -1001,6 +1370,17 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Returns true if the given date is a weekend day. If the date is not given, + * the date object of this calendar is used. + * + * @param { Date } [date] - Date object whose attribute is desired. + * @returns { boolean } whether the date is a weekend day. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ isWeekend(date?: Date): boolean; /** @@ -1010,11 +1390,24 @@ declare namespace i18n { * day_of_week_in_month, hour, hour_of_day, minute, second, millisecond * @param { number } amount - the amount of date or time to be added to the field. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @crossplatform * @since 11 */ + /** + * Adds or subtract the specified amount of time to the given calendar field. + * + * @param { string } field - field values such as year, month, week_of_year, week_of_month, date, day_of_year, day_of_week + * day_of_week_in_month, hour, hour_of_day, minute, second, millisecond + * @param { number } amount - the amount of date or time to be added to the field. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ add(field: string, amount: number): void; /** @@ -1025,6 +1418,15 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Get the UTC milliseconds. + * + * @returns { number } the calendar time as UTC milliseconds. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getTimeInMillis(): number; /** @@ -1038,6 +1440,18 @@ declare namespace i18n { * @crossplatform * @since 11 */ + /** + * Returns days comparison result. + * + * @param { Date } date - Date object to be compared. + * @returns { number } value of of the comparison result. A positive value indicates that the date is later, + * and a negative value indicates that the date is earlier. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ compareDays(date: Date): number; } @@ -1058,6 +1472,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Judge whether the locale is RTL locale. + * + * @param { string } locale - The locale to be used. + * @returns { boolean } true representing the locale is an RTL locale + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export function isRTL(locale: string): boolean; /** @@ -1068,6 +1492,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Obtains a BreakIterator object for finding the location of break point in text. + * + * @param { string } locale - the returned BreakIterator will adapt the rule, specified by the locale, to break text. + * @returns { BreakIterator } a newly constructed BreakIterator object. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export function getLineInstance(locale: string): BreakIterator; /** @@ -1076,6 +1509,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * The BreakIterator class is used for finding the location of break point in text. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class BreakIterator { /** * Obtains the current position of the BreakIterator instance. @@ -1084,6 +1524,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Obtains the current position of the BreakIterator instance. + * + * @returns { number } the current position of the BreakIterator instance. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ current(): number; /** @@ -1094,6 +1542,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the BreakIterator's position to the first break point, the first break point is always the beginning of the + * processed text. + * + * @returns { number } the index of the first break point. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ first(): number; /** @@ -1104,6 +1561,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the BreakIterator's position to the last break point. the last break point is always the index beyond the + * last character of the processed text. + * + * @returns { number } the index of the last break point. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ last(): number; /** @@ -1114,6 +1580,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the BreakIterator's position to the nth break point from the current break point. + * + * @param { number } [index] - indicates the number of break points to advance. If index is not given, n is treated as 1. + * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ next(index?: number): number; /** @@ -1123,6 +1598,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the BreakIterator's position to the break point preceding the current break point. + * + * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ previous(): number; /** @@ -1132,6 +1615,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the text to be processed. + * + * @param { string } text - Indicates the text to be processed by the BreakIterator. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ setLineBreakText(text: string): void; /** @@ -1142,6 +1633,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Set the BreakIterator's position to the first break point following the specified offset. + * + * @param { number } offset + * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ following(offset: number): number; /** @@ -1151,8 +1651,26 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ - getLineBreakText(): string; - + /** + * Obtains the text being processed. + * + * @returns { string } the text that is processed by the BreakIterator. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ + getLineBreakText(): string; + + /** + * Returns true if the position indicated by the offset is a break point, otherwise false. The BreakIterator's + * position will be set to the position indicated by the offset if it returns true, otherwise the BreakIterator + * will be moved to the break point following the offset. + * + * @param { number } offset The offset to be checked. + * @returns { boolean } true if the offset is a break point. + * @syscap SystemCapability.Global.I18n + * @since 8 + */ /** * Returns true if the position indicated by the offset is a break point, otherwise false. The BreakIterator's * position will be set to the position indicated by the offset if it returns true, otherwise the BreakIterator @@ -1161,7 +1679,8 @@ declare namespace i18n { * @param { number } offset The offset to be checked. * @returns { boolean } true if the offset is a break point. * @syscap SystemCapability.Global.I18n - * @since 8 + * @atomicservice + * @since 12 */ isBoundary(offset: number): boolean; } @@ -1175,6 +1694,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Get IndexUtil object. + * + * @param { string } [locale] - Indicates a character string containing the locale information, including + * the language and optionally the script and region, for the NumberFormat object. + * @returns { IndexUtil } IndexUtil object. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export function getInstance(locale?: string): IndexUtil; /** @@ -1184,6 +1713,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Sequence text can be grouped under the specified area, + * and grouping index with different lengths can be specified. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class IndexUtil { /** * Get a list of labels for use as a UI index @@ -1192,6 +1729,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Get a list of labels for use as a UI index + * + * @returns { Array } a list of labels + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getIndexList(): Array; /** @@ -1201,6 +1746,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Add the index characters from a Locale to the index. + * + * @param { string } locale - The locale whose index characters are to be added. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ addLocale(locale: string): void; /** @@ -1211,6 +1764,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 8 */ + /** + * Get corresponding index of the input text. + * + * @param { string } text - input text + * @returns { string } index of the input text + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getIndex(text: string): string; } @@ -1345,6 +1907,14 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Provides the API for accessing unicode character properties. For example, determine whether a character is a number. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class Unicode { /** * Determines whether the specified code point is a digit character @@ -1363,6 +1933,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines whether the specified code point is a digit character + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a digit character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isDigit(char: string): boolean; /** @@ -1382,6 +1962,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a space character or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a space character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isSpaceChar(char: string): boolean; /** @@ -1401,6 +1991,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a whitespace character + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a whitespace character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isWhitespace(char: string): boolean; /** @@ -1420,6 +2020,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a RTL character or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a RTL character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isRTL(char: string): boolean; /** @@ -1439,6 +2049,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a Ideographic character or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a Ideographic character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isIdeograph(char: string): boolean; /** @@ -1458,6 +2078,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a Letter or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a Letter + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isLetter(char: string): boolean; /** @@ -1477,6 +2107,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a LowerCase character or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a LowerCase character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isLowerCase(char: string): boolean; /** @@ -1496,6 +2136,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Determines if the specified character is a UpperCase character or not. + * + * @param { string } char - the character to be tested + * @returns { boolean } true if the character is a UpperCase character + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static isUpperCase(char: string): boolean; /** @@ -1515,6 +2165,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the general category value of the specified character. + * + * @param { string } char - the character to be tested + * @returns { string } the general category of the specified character. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static getType(char: string): string; } @@ -1608,6 +2268,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the default TimeZone object or the TimeZone object corresponds to zoneID. + * + * @param { string } [zoneID] - TimeZone ID used to create TimeZone Object. + * @returns { TimeZone } a TimeZone object corresponds to zoneID. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export function getTimeZone(zoneID?: string): TimeZone; /** @@ -1623,6 +2293,14 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Provides the API for accessing TimeZone name, rawOffset and offset information. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class TimeZone { /** * Get the id of the TimeZone object. @@ -1639,6 +2317,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the id of the TimeZone object. + * + * @returns { string } a string represents the timezone id. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getID(): string; /** @@ -1650,6 +2337,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 7 */ + /** + * Get the displayName of the TimeZone Object under the locale. + * + * @param { string } [locale] - the locale tag use to display timezone object's name. + * @param { boolean } [isDST] - wether consider daylight saving time when display timezone object's name. + * @returns { string } a string represents the display name. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getDisplayName(locale?: string, isDST?: boolean): string; /** @@ -1667,6 +2364,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the raw offset of the TimeZone object. + * + * @returns { number } a number represents the raw offset. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getRawOffset(): number; /** @@ -1686,6 +2392,16 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get the offset of the TimeZone object. + * + * @param { number } [date] - Indicates a date use to compute offset. + * @returns { number } a number represents the offset with date. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ getOffset(date?: number): number; /** @@ -1703,6 +2419,15 @@ declare namespace i18n { * @crossplatform * @since 10 */ + /** + * Get available TimeZone ID list. + * + * @returns { Array } a string array represents the available TimeZone ID list. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ static getAvailableIDs(): Array; /** @@ -1712,6 +2437,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get available Zone City ID list. + * + * @returns { Array } a string array represents the available Zone City ID list. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getAvailableZoneCityIDs(): Array; /** @@ -1723,6 +2456,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get City display name in a certain locale. + * + * @param { string } cityID - Zone City ID. + * @param { string } locale - locale used to display city name. + * @returns { string } a string represents the display name of City in locale. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getCityDisplayName(cityID: string, locale: string): string; /** @@ -1733,6 +2476,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get TimeZone Object from city ID. + * + * @param { string } cityID - Zone City ID. + * @returns { TimeZone } a TimeZone Object from city ID. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getTimezoneFromCity(cityID: string): TimeZone; /** @@ -1742,10 +2494,23 @@ declare namespace i18n { * @param { number } latitude value * @returns { Array } Returns a TimeZone array from the specified longitude and latitude. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 10 */ + + /** + * Get the possible time zones from the specified longitude and latitude. + * + * @param { number } longitude value + * @param { number } latitude value + * @returns { Array } Returns a TimeZone array from the specified longitude and latitude. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getTimezonesByLocation(longitude: number, latitude: number): Array; } @@ -1755,13 +2520,28 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Provides the API for transliterate text from one format to another. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class Transliterator { /** * Get a string array of all available transliterator ids. * * @returns { string[] } a string array of all available transliterator ids. * @syscap SystemCapability.Global.I18n - * @since 9 + * @since 9 + */ + /** + * Get a string array of all available transliterator ids. + * + * @returns { string[] } a string array of all available transliterator ids. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 */ static getAvailableIDs(): string[]; @@ -1775,6 +2555,17 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Get a Transliterator that is specified by id name. + * + * @param { string } id - specified the type of Transliterator. id is formed by source and dest. Transliterator will transliterate + * the input string from source format to the dest format. For example, a Simplified Chinese to Latn + * Transliterator will transform the text written in Chinese to Latn characters. + * @returns { Transliterator } Transliterator that is specified by id name. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getInstance(id: string): Transliterator; /** @@ -1785,6 +2576,15 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 9 */ + /** + * Transform the input text. + * + * @param { string } text - text to be transliterated. + * @returns { string } the output text that is transliterated from source format to the dest format. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ transform(text: string): string; } @@ -1795,6 +2595,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Enumerates the Normalizer modes. + * + * @enum { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export enum NormalizerMode { /** * Normalization form C, characters are decomposed and then re-composed by canonical equivalence @@ -1802,6 +2610,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Normalization form C, characters are decomposed and then re-composed by canonical equivalence + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ NFC = 1, /** * Normalization form D, characters are decomposed by canonical equivalence @@ -1809,6 +2624,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Normalization form D, characters are decomposed by canonical equivalence + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ NFD = 2, /** * Normalization form KC, characters are decomposed by compatibility, then re-composed by canonical equivalence @@ -1816,6 +2638,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Normalization form KC, characters are decomposed by compatibility, then re-composed by canonical equivalence + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ NFKC = 3, /** * Normalization form KD, characters are decomposed by compatibility @@ -1823,6 +2652,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Normalization form KD, characters are decomposed by compatibility + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ NFKD = 4 } @@ -1832,6 +2668,13 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Provides the API for text encoding normalization. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class Normalizer { /** * Get a Normalizer that is specified by normalize mode. @@ -1842,6 +2685,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Get a Normalizer that is specified by normalize mode. + * + * @param { NormalizerMode } mode - specified the mode of Normalizer. It must be a valid mode. + * @returns { Normalizer } Transliterator that is specified by id name. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ static getInstance(mode: NormalizerMode): Normalizer; /** @@ -1853,6 +2706,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 10 */ + /** + * Get a normalized string of specified mode. + * + * @param { string } text - text to normalized. + * @returns { string } a normalized string from source. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ normalize(text: string): string; } @@ -2072,7 +2935,7 @@ declare namespace i18n { * @param { SortOptions } options - Sort options for locale item. * @returns { Array } Locale Informations sorted for specified options. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 10 @@ -2086,7 +2949,7 @@ declare namespace i18n { * @param { SortOptions } options - Sort options for locale item. * @returns { Array } Locale Informations sorted for specified options. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. * @since 10 @@ -2111,6 +2974,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Provides the informations of one holiday. + * + * @interface HolidayInfoItem + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export interface HolidayInfoItem { /** * Holiday base name. @@ -2119,6 +2990,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday base name. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ baseName: string; /** @@ -2128,6 +3007,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday start year. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ year: number; /** @@ -2137,6 +3024,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday start month. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ month: number; /** @@ -2146,6 +3041,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday start day. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ day: number; /** @@ -2155,6 +3058,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday local name array. + * + * @type { ?Array } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ localNames?: Array; } @@ -2165,6 +3076,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Provides the informations holiday locale name. + * + * @interface HolidayLocalName + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export interface HolidayLocalName { /** * Holiday locale name language id. @@ -2173,6 +3092,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday locale name language id. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ language: string; /** @@ -2182,6 +3109,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Holiday local name. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ name: string; } @@ -2191,16 +3126,33 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Provide some functions to manage holidays in a country or region. Partly follows the RFC2445 standard. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class HolidayManager { /** * A constructor used to create a HolidayManager object. * * @param { String } icsPath - the path of the iCalendar format file to create HolidayManager object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * A constructor used to create a HolidayManager object. + * + * @param { String } icsPath - the path of the iCalendar format file to create HolidayManager object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ constructor(icsPath: String); /** @@ -2213,6 +3165,17 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Returns true if the given date is a holiday. If the date is not given, + * the date object of current time is used. + * + * @param { Date } [date] - Date object whose attribute is desired. + * @returns { boolean } whether the date is a holiday day. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ isHoliday(date?: Date): boolean; /** @@ -2222,10 +3185,22 @@ declare namespace i18n { * the current year is used. * @returns { Array } holiday information array for one year. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Obtains holiday info array for a specified year + * + * @param { number } [year] - specified holiday year. If the year is not given, + * the current year is used. + * @returns { Array } holiday information array for one year. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ getHolidayInfoItemArray(year?: number): Array; } @@ -2236,6 +3211,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Provides the informations of one entity. + * + * @interface EntityInfoItem + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export interface EntityInfoItem { /** * Entity begin position. @@ -2244,6 +3227,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Entity begin position. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ begin: number; /** @@ -2253,6 +3244,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Entity end position. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ end: number; /** @@ -2262,6 +3261,14 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Entity type. Field values such as phone_number, date + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ type: string; } @@ -2271,16 +3278,33 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Provide some functions to find named entity in text. + * + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ export class EntityRecognizer { /** * A constructor used to create a EntityRecognizer object. * * @param { string } [locale] - specified the locale. Use current app locale by default. It must be a valid locale. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. - * @throws { BusinessError } 890001 - param value not valid. Possible causes: Parameter verification failed. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * A constructor used to create a EntityRecognizer object. + * + * @param { string } [locale] - specified the locale. Use current app locale by default. It must be a valid locale. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ constructor(locale?: string); /** @@ -2292,6 +3316,16 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @since 11 */ + /** + * Obtains holiday info array for a specified text + * + * @param { string } text - the text to find entities. + * @returns { Array } entity information array found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.Global.I18n + * @atomicservice + * @since 12 + */ findEntityInfo(text: string): Array; } } diff --git a/api/@ohos.inputMethod.d.ts b/api/@ohos.inputMethod.d.ts index 9ba48e1c2e9c1d75e440267975789977e6f02eb4..59e0f48614eea9ff8201f2bfaa114aff94d84f28 100644 --- a/api/@ohos.inputMethod.d.ts +++ b/api/@ohos.inputMethod.d.ts @@ -109,7 +109,7 @@ declare namespace inputMethod { * @param { AsyncCallback } callback - the callback of switchInputMethod. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -121,7 +121,7 @@ declare namespace inputMethod { * @param { InputMethodProperty } target - indicates the target input method. * @param { AsyncCallback } callback - the callback of switchInputMethod. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -137,7 +137,7 @@ declare namespace inputMethod { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -149,7 +149,7 @@ declare namespace inputMethod { * @param { InputMethodProperty } target - indicates the target input method. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -174,7 +174,7 @@ declare namespace inputMethod { * @param { AsyncCallback } callback - the callback of switchCurrentInputMethodSubtype. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -188,7 +188,7 @@ declare namespace inputMethod { * @param { AsyncCallback } callback - the callback of switchCurrentInputMethodSubtype. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -200,7 +200,7 @@ declare namespace inputMethod { * @param { InputMethodSubtype } target - indicates the target input method subtype. * @param { AsyncCallback } callback - the callback of switchCurrentInputMethodSubtype. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -216,7 +216,7 @@ declare namespace inputMethod { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -230,7 +230,7 @@ declare namespace inputMethod { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -242,7 +242,7 @@ declare namespace inputMethod { * @param { InputMethodSubtype } target - indicates the target input method subtype. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -268,7 +268,7 @@ declare namespace inputMethod { * @param { AsyncCallback } callback - the callback of switchCurrentInputMethodAndSubtype. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -281,7 +281,7 @@ declare namespace inputMethod { * @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype. * @param { AsyncCallback } callback - the callback of switchCurrentInputMethodAndSubtype. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -302,7 +302,7 @@ declare namespace inputMethod { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -315,7 +315,7 @@ declare namespace inputMethod { * @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -337,7 +337,7 @@ declare namespace inputMethod { * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 202 - not system application. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800005 - configuration persisting error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -436,7 +436,7 @@ declare namespace inputMethod { * If false, the panel being queried is hidden. * @throws { BusinessError } 202 - not system application. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi @@ -450,7 +450,7 @@ declare namespace inputMethod { * @param { InputMethodProperty } inputMethodProperty - the property of the specified inputmethod. * @param { AsyncCallback> } callback - the callback of listInputMethodSubtype. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800001 - package manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -467,7 +467,7 @@ declare namespace inputMethod { * @param { InputMethodProperty } inputMethodProperty - Indicates the specified input method. * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800001 - package manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -505,7 +505,7 @@ declare namespace inputMethod { * If false, collect disabled input methods. * @param { AsyncCallback> } callback - the callback of getInputMethods. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800001 - package manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -521,7 +521,7 @@ declare namespace inputMethod { * If false, collect disabled input methods. * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800001 - package manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -537,7 +537,7 @@ declare namespace inputMethod { * If false, collect disabled input methods. * @returns { Array } the list of inputmethod. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -648,7 +648,7 @@ declare namespace inputMethod { * @param { TextConfig } textConfig - indicates the config of the textInput. * @param { AsyncCallback } callback - the callback of attach. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -663,7 +663,7 @@ declare namespace inputMethod { * @param { TextConfig } textConfig - indicates the config of the textInput. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -748,7 +748,7 @@ declare namespace inputMethod { * @param { number } windowId - the window ID of the application currently bound to the input method. * @param { AsyncCallback } callback - the callback of setCallingWindow. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -764,7 +764,7 @@ declare namespace inputMethod { * @param { number } windowId - the window ID of the application currently bound to the input method. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -779,7 +779,7 @@ declare namespace inputMethod { * @param { CursorInfo } cursorInfo - the CursorInfo object. * @param { AsyncCallback } callback - the callback of updateCursor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -794,7 +794,7 @@ declare namespace inputMethod { * @param { CursorInfo } cursorInfo - the CursorInfo object. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -811,7 +811,7 @@ declare namespace inputMethod { * @param { number } end - end position of selected text. * @param { AsyncCallback } callback - the callback of changeSelection. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -828,7 +828,7 @@ declare namespace inputMethod { * @param { number } end - end position of selected text. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -843,7 +843,7 @@ declare namespace inputMethod { * @param { InputAttribute } attribute - the InputAttribute object. * @param { AsyncCallback } callback - the callback of updateAttribute. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -858,7 +858,7 @@ declare namespace inputMethod { * @param { InputAttribute } attribute - the InputAttribute object. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client is detached. @@ -971,7 +971,7 @@ declare namespace inputMethod { * this callback, and subscribers are expected to select corresponding text in callback according to * the range. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -997,7 +997,7 @@ declare namespace inputMethod { * for this callback, and subscribers are expected to select corresponding text in callback according to * the movement. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1021,7 +1021,7 @@ declare namespace inputMethod { * @param { function } callback - processes insertText command. The text of insert is provided for this callback. * Subscribers are expected to process the inserted text and update changes in editor by changeSelection and updateCursor as needed. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1048,7 +1048,7 @@ declare namespace inputMethod { * delete is provided for this callback. Subscribers are expected to delete specified length of text * to the left of the cursor and update changes in editor by changeSelection and updateCursor as needed. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1075,7 +1075,7 @@ declare namespace inputMethod { * delete is provided for this callback. Subscribers are expected to delete specified length of text * to the right of the cursor and update changes in editor by changeSelection and updateCursor as needed. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1100,7 +1100,7 @@ declare namespace inputMethod { * @param { function } callback - processes sendKeyboardStatus command. * The keyboardStatus is provided for this callback. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1126,7 +1126,7 @@ declare namespace inputMethod { * The functionKey is provided for this callback.Subscribers are expected to complete the * corresponding task based on the value of functionKey. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1152,7 +1152,7 @@ declare namespace inputMethod { * cursor is provided for this callback. Subscribers are expected to move the cursor and update changes * in editor by changeSelection and updateCursor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1177,7 +1177,7 @@ declare namespace inputMethod { * @param { function } callback - processes handleExtendAction command. The action code * is provided for this callback. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1202,7 +1202,7 @@ declare namespace inputMethod { * @param { function } callback - processes getLeftTextOfCursor command. The callback * must be a synchronization method and will block the input method application. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1227,7 +1227,7 @@ declare namespace inputMethod { * @param { function } callback - processes getRightTextOfCursor command. The callback * must be a synchronization method and will block the input method application. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1251,7 +1251,8 @@ declare namespace inputMethod { * @param { 'getTextIndexAtCursor' } type - event type, fixed as 'getTextIndexAtCursor'. * @param { function } callback - processes getTextIndexAtCursor command. The callback * must be a synchronization method, and should return the text index at the cursor. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client is detached. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 diff --git a/api/@ohos.inputMethodEngine.d.ts b/api/@ohos.inputMethodEngine.d.ts index f5eb544210d2746c8bf9b846075caf381f3b0083..c7f2526ade624f6c587a30966831b7b259cd8383 100644 --- a/api/@ohos.inputMethodEngine.d.ts +++ b/api/@ohos.inputMethodEngine.d.ts @@ -667,7 +667,7 @@ declare namespace inputMethodEngine { * @param { PanelInfo } info - the info of panel to be created. * @param { AsyncCallback } callback - the callback of createPanel. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; * @throws { BusinessError } 12800004 - not an input method extension. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -682,7 +682,7 @@ declare namespace inputMethodEngine { * @param { PanelInfo } info - the info of panel to be created. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; * @throws { BusinessError } 12800004 - not an input method extension. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -695,7 +695,7 @@ declare namespace inputMethodEngine { * @param { Panel } panel - to be destroyed. * @param { AsyncCallback } callback - the callback of destroyPanel. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -707,7 +707,7 @@ declare namespace inputMethodEngine { * @param { Panel } panel - to be destroyed. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -874,8 +874,8 @@ declare namespace inputMethodEngine { * * @param { number } action - action indicates the function of "enter" key. * @param { AsyncCallback } callback - the callback of sendKeyFunction. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 @@ -887,8 +887,8 @@ declare namespace inputMethodEngine { * * @param { number } action - action indicates the function of "enter" key. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 @@ -900,8 +900,8 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted forward. It can't be less than 0. * @param { AsyncCallback } callback - the callback of deleteForward. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -914,8 +914,8 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted forward. It can't be less than 0. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -928,7 +928,7 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted forward. It can't be less than 0. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800002 - input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -941,8 +941,8 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted backward. It can't be less than 0. * @param { AsyncCallback } callback - the callback of deleteBackward. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -955,8 +955,8 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted backward. It can't be less than 0. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -969,7 +969,7 @@ declare namespace inputMethodEngine { * * @param { number } length - length of text which will be deleted backward. It can't be less than 0. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800002 - input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -982,8 +982,8 @@ declare namespace inputMethodEngine { * * @param { string } text - text which will be inserted. * @param { AsyncCallback } callback - the callback of insertText. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -996,8 +996,8 @@ declare namespace inputMethodEngine { * * @param { string } text - text which will be inserted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - Input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1010,7 +1010,7 @@ declare namespace inputMethodEngine { * * @param { string } text - text which will be inserted. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800002 - input method engine error. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1023,8 +1023,8 @@ declare namespace inputMethodEngine { * * @param { number } length - the length of text which will be got. It can't be less than 0. * @param { AsyncCallback } callback - the callback of getForward. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1037,8 +1037,8 @@ declare namespace inputMethodEngine { * * @param { number } length - the length of text which will be got. It can't be less than 0. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1052,7 +1052,7 @@ declare namespace inputMethodEngine { * @param { number } length - the length of text which will be got. It can't be less than 0. * @returns { string } the text string before cursor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1065,8 +1065,8 @@ declare namespace inputMethodEngine { * * @param { number } length - the length of text which will be got.It can't be less than 0. * @param { AsyncCallback } callback - the callback of getBackward. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1079,8 +1079,8 @@ declare namespace inputMethodEngine { * * @param { number } length - the length of text which will be got.It can't be less than 0. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1094,7 +1094,7 @@ declare namespace inputMethodEngine { * @param { number } length - the length of text which will be got. It can't be less than 0. * @returns { string } the text string after cursor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1138,7 +1138,7 @@ declare namespace inputMethodEngine { * @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0. * @param { AsyncCallback } callback - the callback of moveCursor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 @@ -1151,7 +1151,7 @@ declare namespace inputMethodEngine { * @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 @@ -1163,7 +1163,7 @@ declare namespace inputMethodEngine { * * @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1176,7 +1176,7 @@ declare namespace inputMethodEngine { * @param { Range } range - indicates the range of selected text in editor. * @param { AsyncCallback } callback - the callback of selectByRange. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1189,7 +1189,7 @@ declare namespace inputMethodEngine { * @param { Range } range - indicates the range of selected text in editor. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1201,7 +1201,7 @@ declare namespace inputMethodEngine { * * @param { Range } range - indicates the range of selected text in editor. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1214,7 +1214,7 @@ declare namespace inputMethodEngine { * @param { Movement } movement - indicates the movement of cursor when selecting. * @param { AsyncCallback } callback - the callback of selectByMovement. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1227,7 +1227,7 @@ declare namespace inputMethodEngine { * @param { Movement } movement - indicates the movement of cursor when selecting. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1239,7 +1239,7 @@ declare namespace inputMethodEngine { * * @param { Movement } movement - indicates the movement of cursor when selecting. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12800003 - input method client error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 @@ -1287,7 +1287,7 @@ declare namespace inputMethodEngine { * @param { ExtendAction } action - action code which will be send. * @param { AsyncCallback } callback - the callback of sendExtendAction. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1301,7 +1301,7 @@ declare namespace inputMethodEngine { * @param { ExtendAction } action - action code which will be send. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800006 - Input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1315,7 +1315,7 @@ declare namespace inputMethodEngine { * @param { Record } commandData - command data which will be send.Max size 32KB. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800010 - not default input method configured by system. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1341,7 +1341,8 @@ declare namespace inputMethodEngine { * @param { string } text - the text to be previewed. * @param { Range } range - the range of the text to be replaced by the preview text. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800011 - text preview is not supported. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1354,7 +1355,8 @@ declare namespace inputMethodEngine { * * @param { string } text - the text to be previewed. * @param { Range } range - the range of the text to be replaced by the preview text. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800011 - text preview is not supported. * @syscap SystemCapability.MiscServices.InputMethodFramework @@ -1535,7 +1537,7 @@ declare namespace inputMethodEngine { * @param { string } path - the path of ui content. * @param { AsyncCallback } callback - the callback of setUiContent. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1548,7 +1550,7 @@ declare namespace inputMethodEngine { * @param { string } path - the path of ui content. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1562,7 +1564,7 @@ declare namespace inputMethodEngine { * @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel. * @param { AsyncCallback } callback - the callback of setUiContent. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1576,7 +1578,7 @@ declare namespace inputMethodEngine { * @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1589,7 +1591,7 @@ declare namespace inputMethodEngine { * @param { number } height - the new height of the panel. * @param { AsyncCallback } callback - the callback of resize. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1602,7 +1604,7 @@ declare namespace inputMethodEngine { * @param { number } height - the new height of the panel. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1616,7 +1618,7 @@ declare namespace inputMethodEngine { * @param { number } y - the y-coordinate of the new position. * @param { AsyncCallback } callback - the callback of moveTo. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1630,7 +1632,7 @@ declare namespace inputMethodEngine { * @param { number } y - the y-coordinate of the new position. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1688,7 +1690,8 @@ declare namespace inputMethodEngine { * * @param { 'show' } type - events type. * @param { function } [callback] - the callback to Unregister. - * @throws { BusinessError } 401 -parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1710,7 +1713,8 @@ declare namespace inputMethodEngine { * * @param { 'hide' } type - events type. * @param { function } [callback] - the callback to Unregister. - * @throws { BusinessError } 401 -parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1723,7 +1727,7 @@ declare namespace inputMethodEngine { * * @param { PanelFlag } flag - the callback of changeFlag. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 10 */ @@ -1737,11 +1741,47 @@ declare namespace inputMethodEngine { * otherwise the non-privacy mode will be set. * @throws { BusinessError } 201 - permissions check fails. * @throws { BusinessError } 401 - parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 11 */ setPrivacyMode(isPrivacyMode: boolean): void; + + /** + * Adjust the rect of soft keyboard panel for landscape and portrait orientations. + *

It's only used for SOFT_KEYBOARD panel with FLG_FIXED and FLG_FLOATING.

+ * + * @param { PanelFlag } flag - panel flag. + * @param { PanelRect } rect - panel rect. + * @throws { BusinessError } 401 - parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 12800013 - window manager service error. + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + adjustPanelRect(flag: PanelFlag, rect: PanelRect): void; + + /** + * Subscribe 'sizeChange' event. + *

It's only used for SOFT_KEYBOARD panel with FLG_FIXED and FLG_FLOATING.

+ * + * @param { 'sizeChange' } type - the type of subscribe event. + * @param { Callback } callback - the callback of on('sizeChange'). + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + on(type: 'sizeChange', callback: Callback): void; + + /** + * Unsubscribe 'sizeChange' event. + *

It's only used for SOFT_KEYBOARD panel with FLG_FIXED and FLG_FLOATING.

+ * + * @param { 'sizeChange' } type - the type of unsubscribe event. + * @param { Callback } [callback] - optional, the callback of off('sizeChange'). + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + off(type: 'sizeChange', callback?: Callback): void; } /** @@ -2060,6 +2100,33 @@ declare namespace inputMethodEngine { */ status: window.WindowStatusType; } + + /** + * Panel Rect. + * + * @interface PanelRect + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + export interface PanelRect { + /** + * Panel rect in landscape orientation. + * + * @type { window.Rect } + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + landscapeRect: window.Rect; + + /** + * Panel rect in portrait orientation. + * + * @type { window.Rect } + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 12 + */ + portraitRect: window.Rect; + } } export default inputMethodEngine; diff --git a/api/@ohos.intl.d.ts b/api/@ohos.intl.d.ts index 9075dc684e916da420bd2b5e01c4696bc4c4d7ee..2de0ef5cb708d32f24b22efb6767e635a12afdf2 100644 --- a/api/@ohos.intl.d.ts +++ b/api/@ohos.intl.d.ts @@ -42,6 +42,16 @@ * @form * @since 11 */ +/** + * Provides internationalization related APIs. + * + * @namespace intl + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ declare namespace intl { /** * Provides the options of Locale. @@ -67,6 +77,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Provides the options of Locale. + * + * @interface LocaleOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ export interface LocaleOptions { /** * Indicates the calendar. @@ -99,6 +119,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the calendar. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ calendar?: string; /** @@ -132,6 +162,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the collation. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ collation?: string; /** @@ -165,6 +205,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the hourCycle. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ hourCycle?: string; /** @@ -198,6 +248,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the numberingSystem. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ numberingSystem?: string; /** @@ -231,6 +291,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the numeric. + * + * @type { ?boolean } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ numeric?: boolean; /** @@ -264,6 +334,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the caseFirst. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ caseFirst?: string; } @@ -288,6 +368,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Provides APIs for obtaining locale information. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ export class Locale { /** * A constructor used to create a Locale object. @@ -310,6 +399,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * A constructor used to create a Locale object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ constructor(); /** @@ -342,6 +440,18 @@ declare namespace intl { * @form * @since 11 */ + /** + * A constructor used to create a Locale object. + * + * @param { string } locale - Indicates a character string containing the locale information, including + * the language and optionally the script and region. + * @param { LocaleOptions } options - Indicates Locale option object use to initialize the Locale object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ constructor(locale: string, options?: LocaleOptions); /** @@ -365,6 +475,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the language of the locale. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ language: string; /** @@ -388,6 +507,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the script of the locale. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ script: string; /** @@ -411,6 +539,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the region of the locale. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ region: string; /** @@ -437,6 +574,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the basic locale information, which is returned as a substring of + * a complete locale string. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ baseName: string; /** @@ -460,6 +607,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the case first style of the locale. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ caseFirst: string; /** @@ -483,6 +639,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the calendar. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ calendar: string; /** @@ -506,6 +671,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the collation. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ collation: string; /** @@ -529,6 +703,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the hour cycle. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ hourCycle: string; /** @@ -552,6 +735,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the numbering system. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ numberingSystem: string; /** @@ -575,6 +767,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates whether it is numeric. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ numeric: boolean; /** @@ -601,6 +802,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Convert the locale information to string. + * + * @returns { string } locale information in string form. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ toString(): string; /** @@ -627,6 +838,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Maximize the locale's base information. + * + * @returns { Locale } maximized locale. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ maximize(): Locale; /** @@ -653,6 +874,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Minimize the locale's base information. + * + * @returns { Locale } minimized locale. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ minimize(): Locale; } @@ -680,6 +911,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Provides the options of date time format. + * + * @interface DateTimeOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ export interface DateTimeOptions { /** * Indicates the locale. @@ -712,6 +953,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the locale. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ locale?: string; /** @@ -745,6 +996,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the dateStyle. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ dateStyle?: string; /** @@ -778,6 +1039,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the timeStyle. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ timeStyle?: string; /** @@ -811,6 +1082,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the hourCycle. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ hourCycle?: string; /** @@ -844,6 +1125,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the timeZone. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ timeZone?: string; /** @@ -877,6 +1168,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the numberingSystem. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ numberingSystem?: string; /** @@ -910,6 +1211,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the hour12. + * + * @type { ?boolean } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ hour12?: boolean; /** @@ -943,6 +1254,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the weekday. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ weekday?: string; /** @@ -976,7 +1297,17 @@ declare namespace intl { * @form * @since 11 */ - era?: string; + /** + * Indicates the era. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + era?: string; /** * Indicates the year. @@ -1009,6 +1340,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the year. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ year?: string; /** @@ -1042,6 +1383,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the month. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ month?: string; /** @@ -1075,6 +1426,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the day. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ day?: string; /** @@ -1108,6 +1469,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the hour. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ hour?: string; /** @@ -1141,6 +1512,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the minute. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ minute?: string; /** @@ -1174,6 +1555,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the second. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ second?: string; /** @@ -1207,6 +1598,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the timeZoneName. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ timeZoneName?: string; /** @@ -1240,6 +1641,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the dayPeriod. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ dayPeriod?: string; /** @@ -1273,6 +1684,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the localeMatcher. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ localeMatcher?: string; /** @@ -1306,6 +1727,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Indicates the formatMatcher. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ formatMatcher?: string; } @@ -1330,6 +1761,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * Provides the API for formatting date strings. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ export class DateTimeFormat { /** * A constructor used to create a DateTimeFormat object. @@ -1352,6 +1792,15 @@ declare namespace intl { * @form * @since 11 */ + /** + * A constructor used to create a DateTimeFormat object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ constructor(); /** @@ -1384,6 +1833,18 @@ declare namespace intl { * @form * @since 11 */ + /** + * A constructor used to create a DateTimeFormat object. + * + * @param { string | Array } locale - Indicates character string containing the locale information, including + * the language and optionally the script and region, for the DateTimeFormat object. + * @param { DateTimeOptions } [options] - Indicates the options used to format the date. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ constructor(locale: string | Array, options?: DateTimeOptions); /** @@ -1413,6 +1874,17 @@ declare namespace intl { * @form * @since 11 */ + /** + * Obtains the formatted date strings. + * + * @param { Date } date - Indicates the Date object to be formatted. + * @returns { string } a date string formatted based on the specified locale. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ format(date: Date): string; /** @@ -1445,6 +1917,18 @@ declare namespace intl { * @form * @since 11 */ + /** + * Obtains the formatted date strings of a date range. + * + * @param { Date } startDate - Indicates the start date of the date range. + * @param { Date } endDate - Indicates the end date of the date range. + * @returns { string } a date string formatted based on the specified locale. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ formatRange(startDate: Date, endDate: Date): string; /** @@ -1471,6 +1955,16 @@ declare namespace intl { * @form * @since 11 */ + /** + * Obtains the options of the DateTimeFormat object. + * + * @returns { DateTimeOptions } the options of the DateTimeFormat object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ resolvedOptions(): DateTimeOptions; } @@ -1489,6 +1983,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the options of number format. + * + * @interface NumberOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface NumberOptions { /** * Indicates the locale. @@ -1512,6 +2015,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the locale. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ locale?: string; /** @@ -1536,6 +2048,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the currency. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ currency?: string; /** @@ -1560,6 +2081,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the currencySign. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ currencySign?: string; /** @@ -1584,6 +2114,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the currencyDisplay. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ currencyDisplay?: string; /** @@ -1608,6 +2147,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the unit. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ unit?: string; /** @@ -1632,6 +2180,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the unitDisplay. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ unitDisplay?: string; /** @@ -1656,6 +2213,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the unitUsage. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ unitUsage?: string; /** @@ -1680,6 +2246,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the signDisplay. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ signDisplay?: string; /** @@ -1704,6 +2279,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the compactDisplay. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ compactDisplay?: string; /** @@ -1728,6 +2312,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the notation. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ notation?: string; /** @@ -1752,6 +2345,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the localeMatcher. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ localeMatcher?: string; /** @@ -1776,6 +2378,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the style. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ style?: string; /** @@ -1800,6 +2411,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the numberingSystem. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ numberingSystem?: string; /** @@ -1824,6 +2444,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the useGrouping. + * + * @type { ?boolean } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ useGrouping?: boolean; /** @@ -1848,6 +2477,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the minimumIntegerDigits. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ minimumIntegerDigits?: number; /** @@ -1872,10 +2510,19 @@ declare namespace intl { * @crossplatform * @since 10 */ - minimumFractionDigits?: number; - /** - * Indicates the maximumFractionDigits. + * Indicates the minimumFractionDigits. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ + minimumFractionDigits?: number; + + /** + * Indicates the maximumFractionDigits. * * @type { number } * @syscap SystemCapability.Global.I18n @@ -1896,6 +2543,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the maximumFractionDigits. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ maximumFractionDigits?: number; /** @@ -1920,6 +2576,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the minimumSignificantDigits. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ minimumSignificantDigits?: number; /** @@ -1944,6 +2609,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Indicates the maximumSignificantDigits. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ maximumSignificantDigits?: number; } @@ -1960,6 +2634,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the API for formatting number strings. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class NumberFormat { /** * A constructor used to create a NumberFormat object. @@ -1974,6 +2656,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create a NumberFormat object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** @@ -1995,6 +2685,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create a NumberFormat object. + * + * @param { string | Array } locale - Indicates a character string containing the locale information, including + * the language and optionally the script and region, for the NumberFormat object. + * @param { NumberOptions } [options] - Indicates the options used to format the number. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(locale: string | Array, options?: NumberOptions); /** @@ -2014,6 +2715,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Obtains the formatted number string. + * + * @param { number } number Indicates the number to be formatted. + * @returns { string } a number string formatted based on the specified locale. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ format(number: number): string; /** @@ -2031,6 +2742,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Obtains the options of the NumberFormat object. + * + * @returns { NumberOptions } the options of the NumberFormat object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ resolvedOptions(): NumberOptions; } @@ -2049,6 +2769,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the options of Collator + * + * @interface CollatorOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface CollatorOptions { /** * The locale matching algorithm to use. @@ -2075,6 +2804,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The locale matching algorithm to use. + * Possible values are "lookup" and "best fit"; the default is "best fit". + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ localeMatcher?: string; /** @@ -2102,6 +2841,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Whether the comparison is for sorting or for searching for matching strings. + * Possible values are "sort" and "search"; the default is "sort". + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ usage?: string; /** @@ -2147,6 +2896,22 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Which differences in the strings should lead to non-zero result values. + * Possible values are "base", "accent", "case", "variant". + * "base" are used when only strings that differ in base letters compare as unequal. + * "accent" are used when only strings that differ in base letters or accents and + * other diacritic marks compare as unequal. + * "case" are used when only strings that differ in base letters or case compare as unequal. + * "variant" are used when Strings that differ in base letters, accents and other diacritic marks, + * or case compare as unequal. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ sensitivity?: string; /** @@ -2171,6 +2936,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Whether punctuation should be ignored. Default value is false. + * + * @type { ?boolean } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ ignorePunctuation?: boolean; /** @@ -2195,6 +2969,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Variant collations for certain locales. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ collation?: string; /** @@ -2219,6 +3002,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Whether numeric collation should be used. Default value is false. + * + * @type { ?boolean } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ numeric?: boolean; /** @@ -2246,6 +3038,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Whether upper case or lower case should sort first. + * Possible values are "upper", "lower", or "false" (use the locale's default). + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ caseFirst?: string; } @@ -2262,6 +3064,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Enable language-sensitive string comparison. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class Collator { /** * A constructor used to create Collator object. @@ -2276,6 +3086,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create Collator object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** * A constructor used to create Collator Object; @@ -2296,6 +3114,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create Collator Object; + * + * @param { string | Array } locale - Indicates a character string containing the locale information, including + * the language and optionally the script and region, for the Collator object. + * @param { CollatorOptions } [options] - Indicates the options used to initialize Collator object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(locale: string | Array, options?: CollatorOptions); /** @@ -2323,6 +3152,20 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * compares two strings according to the sort order of this Collator object + * + * @param { string } first - The first string to compare. + * @param { string } second - The second string to compare. + * @returns { number } a number indicating how first compare to second: + * a negative value if string1 comes before string2; + * a positive value if string1 comes after string2; + * 0 if they are considered equal. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ compare(first: string, second: string): number; /** @@ -2342,6 +3185,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Returns a new object with properties that reflect the locale and collation options computed + * during initialization of the object. + * + * @returns { CollatorOptions } a CollatorOptions object with properties that reflect the properties of this object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ resolvedOptions(): CollatorOptions; } @@ -2360,6 +3213,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the options of PluralRules + * + * @interface PluralRulesOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface PluralRulesOptions { /** * The locale matching algorithm to use. @@ -2386,6 +3248,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The locale matching algorithm to use. + * Possible values are "lookup" and "best fit"; the default is "best fit". + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ localeMatcher?: string; /** @@ -2410,6 +3282,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The type to use. Possible values are: "cardinal", "ordinal" + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ type?: string; /** @@ -2437,6 +3318,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The minimum number of integer digits to use. + * Possible values are from 1 to 21; the default is 1. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ minimumIntegerDigits?: number; /** @@ -2464,6 +3355,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The minimum number of fraction digits to use. + * Possible values are from 0 to 20; the default for plain number and percent formatting is 0; + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ minimumFractionDigits?: number; /** @@ -2494,6 +3395,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The maximum number of fraction digits to use. + * Possible values are from 0 to 20; + * the default for plain number formatting is the larger of minimumFractionDigits and 3; + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ maximumFractionDigits?: number; /** @@ -2521,6 +3433,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The minimum number of significant digits to use. + * Possible values are from 1 to 21; the default is 1. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ minimumSignificantDigits?: number; /** @@ -2548,6 +3470,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The maximum number of significant digits to use. + * Possible values are from 1 to 21; the default is 21. + * + * @type { ?number } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ maximumSignificantDigits?: number; } @@ -2564,6 +3496,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Enables plural-sensitive formatting and plural-related language rules. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class PluralRules { /** * A constructor used to create PluralRules object. @@ -2578,6 +3518,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create PluralRules object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** @@ -2599,6 +3547,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create PluralRules object. + * + * @param { string | Array } locale - Indicates a character string containing the locale information, including + * the language and optionally the script and region, for the PluralRules object. + * @param { PluralRulesOptions } [options] - Indicates the options used to initialize PluralRules object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(locale: string | Array, options?: PluralRulesOptions); /** @@ -2620,6 +3579,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Returns a string indicating which plural rule to use for locale-aware formatting. + * + * @param { number } n - The number to get a plural rule for. + * @returns { string } A string representing the pluralization category of the number, + * can be one of zero, one, two, few, many or other. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ select(n: number): string; } @@ -2638,6 +3608,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the input options of RelativeTimeFormat. + * + * @interface RelativeTimeFormatInputOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface RelativeTimeFormatInputOptions { /** * The locale matching algorithm to use. @@ -2664,6 +3643,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The locale matching algorithm to use. + * Possible values are: lookup, best fit + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ localeMatcher?: string; /** @@ -2691,6 +3680,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The format of output message. + * Possible values are: always, auto + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ numeric?: string; /** @@ -2718,6 +3717,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The length of the internationalized message. + * Possible values are: long, short, narrow + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ style?: string; } @@ -2736,6 +3745,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Provides the resolved options of RelativeTimeFormat. + * + * @interface RelativeTimeFormatResolvedOptions + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export interface RelativeTimeFormatResolvedOptions { /** * The BCP 47 language tag for the locale actually used. @@ -2750,6 +3768,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The BCP 47 language tag for the locale actually used. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ locale: string; /** @@ -2767,6 +3793,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The length of the internationalized message. + * Possible values are: long, short, narrow + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ style: string; /** @@ -2784,6 +3819,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The format of output message. + * Possible values are: always, auto + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ numeric: string; /** @@ -2799,6 +3843,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * The value requested using the Unicode extension key "nu" or filled in as a default. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ numberingSystem: string; } @@ -2817,6 +3869,15 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Given a Time period length value and a unit, RelativeTimeFormat object enables + * language-sensitive relative time formatting. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ export class RelativeTimeFormat { /** * A constructor used to create RelativeTimeFormat object. @@ -2831,6 +3892,14 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create RelativeTimeFormat object. + * + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** @@ -2852,6 +3921,17 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * A constructor used to create RelativeTimeFormat object. + * + * @param { string | Array } locale - Indicates a character string containing the locale information, including + * the language and optionally the script and region, for the RelativeTimeFormat object. + * @param { RelativeTimeFormatInputOptions } [options] - Indicates the options used to initialize RelativeTimeFormat object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(locale: string | Array, options?: RelativeTimeFormatInputOptions); /** @@ -2875,6 +3955,18 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * formats a value and unit according to the locale and formatting options of this object. + * + * @param { number } value - Numeric value to use in the internationalized relative time message. + * @param { string } unit - Unit to use in the relative time internationalized message. + * Possible values are: year, quarter, month, week, day, hour, minute, second. + * @returns { string } formatted language-sensitive relative time. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ format(value: number, unit: string): string; /** @@ -2900,6 +3992,19 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * returns an Array of objects representing the relative time format in parts that can be used for + * custom locale-aware formatting + * + * @param { number } value - Numeric value to use in the internationalized relative time message. + * @param { string } unit - to use in the relative time internationalized message. + * Possible values are: year, quarter, month, week, day, hour, minute, second. + * @returns { Array } an Array of objects representing the relative time format in parts + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ formatToParts(value: number, unit: string): Array; /** @@ -2919,6 +4024,16 @@ declare namespace intl { * @crossplatform * @since 10 */ + /** + * Returns a new object with properties that reflect the locale and formatting options computed during + * initialization of the object. + * + * @returns { RelativeTimeFormatResolvedOptions } RelativeTimeFormatOptions which reflect the locale and formatting options of the object. + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 12 + */ resolvedOptions(): RelativeTimeFormatResolvedOptions; } } diff --git a/api/@ohos.measure.d.ts b/api/@ohos.measure.d.ts index 2167055c1e0df20296ca9b35cd39d8eb01f17506..0175b7f46cff7efc0914031fd2e98a5b10398e23 100644 --- a/api/@ohos.measure.d.ts +++ b/api/@ohos.measure.d.ts @@ -37,6 +37,15 @@ import { Resource } from 'GlobalResource'; * @crossplatform * @since 11 */ +/** + * Defines the options of MeasureText. + * + * @interface MeasureOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ export interface MeasureOptions { /** * Text to display. @@ -52,6 +61,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Text to display. + * + * @type { string | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ textContent: string | Resource; /** @@ -61,6 +79,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Text display area of width. + * + * @type { ?(number | string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ constraintWidth?: number | string | Resource; /** @@ -70,6 +97,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ + /** + * Font Size. + * + * @type { ?(number | string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ fontSize?: number | string | Resource; /** @@ -79,6 +115,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ + /** + * Font style. + * + * @type { ?(number | FontStyle) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ fontStyle?: number | FontStyle; /** @@ -88,6 +133,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ + /** + * Font weight. + * + * @type { ?(number | string | FontWeight) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ fontWeight?: number | string | FontWeight; /** @@ -97,6 +151,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ + /** + * Font list of text. + * + * @type { ?(string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ fontFamily?: string | Resource; /** @@ -106,6 +169,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ + /** + * Distance between text fonts. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ letterSpacing?: number | string; /** @@ -115,6 +187,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Alignment of text. + * + * @type { ?(number | TextAlign) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ textAlign?: number | TextAlign; /** @@ -124,6 +205,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Overflow mode of the font. + * + * @type { ?(number | TextOverflow) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ overflow?: number | TextOverflow; /** @@ -133,6 +223,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Maximum number of lines of text. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ maxLines?: number; /** @@ -142,6 +241,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Vertical center mode of the font. + * + * @type { ?(number | string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ lineHeight?: number | string | Resource; /** @@ -151,6 +259,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Baseline offset. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ baselineOffset?: number | string; /** @@ -160,6 +277,15 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ + /** + * Type of letter in the text font + * + * @type { ?(number | TextCase) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ textCase?: number | TextCase; /** @@ -207,6 +333,14 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ +/** + * Defines the Measure interface. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ export default class MeasureText { /** * Displays the textWidth. @@ -225,6 +359,16 @@ export default class MeasureText { * @crossplatform * @since 11 */ + /** + * Displays the textWidth. + * + * @param { MeasureOptions } options - Options. + * @returns { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static measureText(options: MeasureOptions): number; /** @@ -244,5 +388,15 @@ export default class MeasureText { * @crossplatform * @since 11 */ + /** + * Displays the text width and height. + * + * @param { MeasureOptions } options - Options of measure area occupied by text. + * @returns { SizeOptions } width and height for text to display \ + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ static measureTextSize(options: MeasureOptions): SizeOptions; } diff --git a/api/@ohos.multimedia.audio.d.ts b/api/@ohos.multimedia.audio.d.ts index 20b813c124d58dbe149604494d49b5090b5bd885..d035149dc76e332ab01e11df2955b3011b73669e 100644 --- a/api/@ohos.multimedia.audio.d.ts +++ b/api/@ohos.multimedia.audio.d.ts @@ -24,6 +24,11 @@ import { ErrorCallback, AsyncCallback, Callback } from './@ohos.base'; * @namespace audio * @since 7 */ +/** + * @namespace audio + * @atomicservice + * @since 12 + */ declare namespace audio { /** * Enumerates audio errors. @@ -388,18 +393,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Enumerates device roles. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ enum DeviceRole { /** * Input role. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Input role. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ INPUT_DEVICE = 1, /** * Output role. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Output role. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ OUTPUT_DEVICE = 2, } @@ -409,70 +433,133 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Enumerates device types. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ enum DeviceType { /** * Invalid device. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Invalid device. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ INVALID = 0, /** * Built-in earpiece. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Built-in earpiece. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ EARPIECE = 1, /** * Built-in speaker. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Built-in speaker. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ SPEAKER = 2, /** * Wired headset, which is a combination of a pair of earpieces and a microphone. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Wired headset, which is a combination of a pair of earpieces and a microphone. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ WIRED_HEADSET = 3, /** * A pair of wired headphones. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * A pair of wired headphones. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ WIRED_HEADPHONES = 4, /** * Bluetooth device using the synchronous connection oriented link (SCO). * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Bluetooth device using the synchronous connection oriented link (SCO). + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ BLUETOOTH_SCO = 7, /** * Bluetooth device using advanced audio distribution profile (A2DP). * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Bluetooth device using advanced audio distribution profile (A2DP). + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ BLUETOOTH_A2DP = 8, /** * Built-in microphone. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Built-in microphone. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ MIC = 15, /** * USB audio headset. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * USB audio headset. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ USB_HEADSET = 22, /** * Display port device. * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice * @since 12 */ DISPLAY_PORT = 23, /** * Device type for rerouting audio to other remote devices by system application * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice * @since 12 */ REMOTE_CAST = 24, @@ -481,6 +568,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Default device type. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ DEFAULT = 1000, } @@ -783,18 +876,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * Enumerates the audio encoding type. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ enum AudioEncodingType { /** * Invalid type. * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * Invalid type. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ ENCODING_TYPE_INVALID = -1, /** * PCM encoding. * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * PCM encoding. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ ENCODING_TYPE_RAW = 0 } @@ -863,12 +975,25 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 7 */ + /** + * Enumerates the stream usage. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ enum StreamUsage { /** * Unknown usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 7 */ + /** + * Unknown usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_UNKNOWN = 0, /** * Media usage. @@ -886,30 +1011,60 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Music usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_MUSIC = 1, /** * Voice communication usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 7 */ + /** + * Voice communication usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_VOICE_COMMUNICATION = 2, /** * Voice assistant broadcast usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 9 */ + /** + * Voice assistant broadcast usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_VOICE_ASSISTANT = 3, /** * Alarm usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Alarm usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_ALARM = 4, /** * Voice message usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Voice message usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_VOICE_MESSAGE = 5, /** * Notification or ringtone usage. @@ -924,18 +1079,36 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Ringtone usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_RINGTONE = 6, /** * Notification usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Notification usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_NOTIFICATION = 7, /** * Accessibility usage, such as screen reader. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Accessibility usage, such as screen reader. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_ACCESSIBILITY = 8, /** * System usage, such as screen lock or key click. @@ -949,24 +1122,48 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Movie or video usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_MOVIE = 10, /** * Game sound effect usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Game sound effect usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_GAME = 11, /** * Audiobook usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Audiobook usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_AUDIOBOOK = 12, /** * Navigation usage. * @syscap SystemCapability.Multimedia.Audio.Core * @since 10 */ + /** + * Navigation usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ STREAM_USAGE_NAVIGATION = 13, /** * DTMF dial tone usage. @@ -992,6 +1189,7 @@ declare namespace audio { /** * Video call usage. * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice * @since 12 */ STREAM_USAGE_VIDEO_COMMUNICATION = 17, @@ -1078,6 +1276,13 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * Describes audio renderer information. + * @typedef AudioRendererInfo + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ interface AudioRendererInfo { /** * Content type. @@ -1099,12 +1304,24 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * Stream usage. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ usage: StreamUsage; /** * Audio renderer flags. * @syscap SystemCapability.Multimedia.Audio.Core * @since 8 */ + /** + * Audio renderer flags. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ rendererFlags: number; } @@ -1194,18 +1411,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 9 */ + /** + * Enumerates the interrupt modes. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Interrupt + * @atomicservice + * @since 12 + */ enum InterruptMode { /** * Mode that different stream share one interrupt unit. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 9 */ + /** + * Mode that different stream share one interrupt unit. + * @syscap SystemCapability.Multimedia.Audio.Interrupt + * @atomicservice + * @since 12 + */ SHARE_MODE = 0, /** * Mode that each stream has independent interrupt unit. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 9 */ + /** + * Mode that each stream has independent interrupt unit. + * @syscap SystemCapability.Multimedia.Audio.Interrupt + * @atomicservice + * @since 12 + */ INDEPENDENT_MODE = 1 } @@ -1242,12 +1478,25 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Enumerates the interrupt types. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ enum InterruptType { /** * Audio playback interruption started. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Audio playback interruption started. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_TYPE_BEGIN = 1, /** @@ -1255,6 +1504,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Audio playback interruption ended. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_TYPE_END = 2 } @@ -1264,18 +1519,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Enumerates the interrupt hints. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ enum InterruptHint { /** * None. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 8 */ + /** + * None. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_NONE = 0, /** * Resume the playback. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Resume the playback. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_RESUME = 1, /** @@ -1283,6 +1557,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Paused/Pause the playback. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_PAUSE = 2, /** @@ -1290,6 +1570,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Stopped/Stop the playback. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_STOP = 3, /** @@ -1297,6 +1583,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 7 */ + /** + * Ducked the playback. (In ducking, the audio volume is reduced, but not silenced.) + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_DUCK = 4, /** @@ -1304,6 +1596,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 8 */ + /** + * Unducked the playback. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_HINT_UNDUCK = 5, } @@ -1313,18 +1611,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Enumerates the interrupt force types. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ enum InterruptForceType { /** * Forced action taken by system. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Forced action taken by system. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_FORCE = 0, /** * Share type, application can choose to take action or ignore. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Share type, application can choose to take action or ignore. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ INTERRUPT_SHARE = 1 } @@ -1334,12 +1651,25 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Describes the interrupt event received by the app when playback is interrupted. + * @typedef InterruptEvent + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ interface InterruptEvent { /** * Indicates whether the interruption has started or finished. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Indicates whether the interruption has started or finished. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ eventType: InterruptType; /** @@ -1347,6 +1677,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Indicates whether the action is taken by system or to be taken by the app. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ forceType: InterruptForceType; /** @@ -1354,6 +1690,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ + /** + * Indicates the kind of action. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ hintType: InterruptHint; } @@ -1779,8 +2121,10 @@ declare namespace audio { * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi * @since 11 @@ -1793,8 +2137,10 @@ declare namespace audio { * @param { Array } subKeys - Sub keys of the audio parameters to get. * @returns { Promise> } Promise used to return the key-value pairs. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi * @since 11 @@ -2078,8 +2424,10 @@ declare namespace audio { * Obtains the audio devices with a specific flag. * @param { DeviceFlag } deviceFlag - Audio device flag. * @returns { AudioDeviceDescriptors } The device list. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2091,8 +2439,10 @@ declare namespace audio { * @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported. * @param { DeviceFlag } deviceFlag - Audio device flag. * @param { Callback } callback - Callback used to obtain the device update details. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ @@ -2102,8 +2452,10 @@ declare namespace audio { * UnSubscribes to device change events. * @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported. * @param { Callback } callback - Callback used to obtain the device update details. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ @@ -2114,8 +2466,10 @@ declare namespace audio { * @param { DeviceUsage } deviceUsage - Audio device usage. * @returns { AudioDeviceDescriptors } The device list. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi * @since 11 @@ -2129,8 +2483,10 @@ declare namespace audio { * @param { DeviceUsage } deviceUsage - Audio device usage. * @param { Callback } callback - Callback used to obtain the device update details. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi * @since 11 @@ -2142,8 +2498,10 @@ declare namespace audio { * @param { 'availableDeviceChange' } type - Type of the event to listen for. Only the availableDeviceChange event is supported. * @param { Callback } callback - Callback used to obtain the device update details. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi * @since 11 @@ -2191,8 +2549,10 @@ declare namespace audio { * Checks whether a device is active. * @param { CommunicationDeviceType } deviceType - Audio device type. * @returns { boolean } The active status of the device. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Communication * @since 10 */ @@ -2261,8 +2621,10 @@ declare namespace audio { * Get output device for target audio renderer info. * @param { AudioRendererInfo } rendererInfo - Audio renderer information * @param { AsyncCallback } callback - Callback used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @throws { BusinessError } 6800301 - System error. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 @@ -2272,8 +2634,10 @@ declare namespace audio { * Get output device for target audio renderer info. * @param { AudioRendererInfo } rendererInfo - Audio renderer information. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 @@ -2284,8 +2648,10 @@ declare namespace audio { * Gets preferred output device for target audio renderer info. * @param { AudioRendererInfo } rendererInfo - Audio renderer information. * @returns { AudioDeviceDescriptors } The preferred devices. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2298,8 +2664,10 @@ declare namespace audio { * preferOutputDeviceChangeForRendererInfo event is supported. * @param { AudioRendererInfo } rendererInfo - Audio renderer information. * @param { Callback } callback - Callback used to obtain the changed prefer devices information. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2309,8 +2677,10 @@ declare namespace audio { * @param { 'preferOutputDeviceChangeForRendererInfo' } type - Type of the event to listen for. Only the * preferOutputDeviceChangeForRendererInfo event is supported. * @param { Callback } callback - Callback used to obtain the changed prefer devices in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2320,8 +2690,10 @@ declare namespace audio { * Get input device for target audio capturer info. * @param { AudioCapturerInfo } capturerInfo - Audio capturer information. * @param { AsyncCallback } callback - Callback used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @throws { BusinessError } 6800301 - System error. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 @@ -2331,8 +2703,10 @@ declare namespace audio { * Get input device for target audio capturer info. * @param { AudioCapturerInfo } capturerInfo - Audio capturer information. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 @@ -2345,8 +2719,10 @@ declare namespace audio { * @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for. * @param { AudioCapturerInfo } capturerInfo - Audio capturer information. * @param { Callback } callback - Callback used to obtain the changed preferred devices information. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2355,8 +2731,10 @@ declare namespace audio { * Unsubscribes to preferred input device change events. * @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to obtain the changed preferred devices in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2366,8 +2744,10 @@ declare namespace audio { * Gets preferred input device for target audio capturer info. * @param { AudioCapturerInfo } capturerInfo - Audio capturer information. * @returns { AudioDeviceDescriptors } The preferred devices. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -2433,8 +2813,10 @@ declare namespace audio { * Gets information of audio effects. * @param { StreamUsage } usage - Stream usage. * @param { AsyncCallback } callback - Callback used to return the information of audio effects. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -2443,8 +2825,10 @@ declare namespace audio { * Gets information of audio effects. * @param { StreamUsage } usage - Stream usage. * @returns { Promise } Promise used to return the information of audio effects. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -2453,8 +2837,10 @@ declare namespace audio { * Gets information of audio effects. * @param { StreamUsage } usage - Stream usage. * @returns { AudioEffectInfoArray } The information of audio effects. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -2465,8 +2851,10 @@ declare namespace audio { * registered clients will receive the callback. * @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported. * @param { Callback } callback - Callback invoked for the audio renderer change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ @@ -2475,8 +2863,10 @@ declare namespace audio { /** * UnSubscribes to audio renderer change events. * @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ @@ -2487,8 +2877,10 @@ declare namespace audio { * registered clients will receive the callback. * @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported. * @param { Callback } callback - Callback invoked for the audio capturer change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 9 */ @@ -2497,8 +2889,10 @@ declare namespace audio { /** * UnSubscribes to audio capturer change events. * @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 9 */ @@ -2526,8 +2920,10 @@ declare namespace audio { * Checks whether a stream is active. * @param { AudioVolumeType } volumeType - Audio stream type. * @returns { boolean } The active status of the stream. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -2563,8 +2959,10 @@ declare namespace audio { * Get the volume group list for a networkId. * @param { string } networkId - Distributed deice net work id * @returns { VolumeGroupInfos } Volume group info list. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi * @since 10 @@ -2591,8 +2989,10 @@ declare namespace audio { * Obtains an AudioVolumeGroupManager instance. * @param { number } groupId - volume group id, use LOCAL_VOLUME_GROUP_ID in default * @returns { AudioVolumeGroupManager } The audio volume group manager instance. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -2602,8 +3002,10 @@ declare namespace audio { * Listens for system volume change events. This method uses a callback to get volume change events. * @param { 'volumeChange' } type - Type of the event to listen for. Only the volumeChange event is supported. * @param { Callback } callback - Callback used to get the system volume change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 9 */ @@ -2675,8 +3077,10 @@ declare namespace audio { * Obtains the volume of a stream. * @param { AudioVolumeType } volumeType - Audio stream type. * @returns { number } Current system volume level. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -2702,8 +3106,10 @@ declare namespace audio { * Obtains the minimum volume allowed for a stream. * @param { AudioVolumeType } volumeType - Audio stream type. * @returns { number } Min volume level. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -2729,8 +3135,10 @@ declare namespace audio { * Obtains the maximum volume allowed for a stream. * @param { AudioVolumeType } volumeType - Audio stream type. * @returns { number } Max volume level. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -2782,8 +3190,10 @@ declare namespace audio { * @param { AudioVolumeType } volumeType - Audio stream type. * @returns { boolean } The mute status of the stream. The value true * means that the stream is muted, and false means the opposite. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -2836,8 +3246,10 @@ declare namespace audio { * Listens for ringer mode change events. This method uses a callback to get ringer mode changes. * @param { 'ringerModeChange' } type - Type of the event to listen for. Only the ringerModeChange event is supported. * @param { Callback } callback - Callback used to get the updated ringer mode. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 9 */ @@ -2873,8 +3285,10 @@ declare namespace audio { * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi * @since 11 @@ -2910,8 +3324,10 @@ declare namespace audio { * Listens for system microphone state change events. This method uses a callback to get microphone change events. * @param { 'micStateChange' } type - Type of the event to listen for. Only the micStateChange event is supported. * @param { Callback } callback - Callback used to get the system microphone state change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 9 */ @@ -2932,8 +3348,10 @@ declare namespace audio { * @param { VolumeAdjustType } adjustType - Volume adjustment type. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @throws { BusinessError } 6800301 - System error. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi @@ -2947,8 +3365,10 @@ declare namespace audio { * @param { VolumeAdjustType } adjustType - Volume adjustment type. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi @@ -2964,8 +3384,10 @@ declare namespace audio { * @param { VolumeAdjustType } adjustType - Volume adjustment type. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @throws { BusinessError } 6800301 - System error. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi @@ -2980,8 +3402,10 @@ declare namespace audio { * @param { VolumeAdjustType } adjustType - Volume adjustment type. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi @@ -2996,8 +3420,10 @@ declare namespace audio { * @param { number } volumeLevel - Volume level to set. * @param { DeviceType } device - Output device type. * @param { AsyncCallback } callback - Callback used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @throws { BusinessError } 6800301 - System error. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 @@ -3010,8 +3436,10 @@ declare namespace audio { * @param { number } volumeLevel - Volume level to set. * @param { DeviceType } device - Output device type. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 @@ -3023,8 +3451,10 @@ declare namespace audio { * @param { number } volumeLevel - Volume level to set. * @param { DeviceType } device - Output device type. * @returns { number } The system volume in dB. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 10 */ @@ -3035,8 +3465,10 @@ declare namespace audio { * This method uses a promise to return the result. * @param { AudioDeviceDescriptor } inputDevice - the target device. * @returns { Promise } Promise used to return the max amplitude value. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 12 @@ -3047,8 +3479,10 @@ declare namespace audio { * This method uses a promise to return the result. * @param { AudioDeviceDescriptor } outputDevice - the target device. * @returns { Promise } Promise used to return the max amplitude value. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @throws { BusinessError } 6800301 - System error. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 12 @@ -3079,8 +3513,10 @@ declare namespace audio { * @param { AudioDeviceDescriptor } deviceDescriptor - Audio device description. * @returns { boolean } Whether spatialization is supported by the specified device. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3102,8 +3538,10 @@ declare namespace audio { * @param { AudioDeviceDescriptor } deviceDescriptor - Audio device description. * @returns { boolean } Whether head tracking is supported by the specified device. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3117,8 +3555,10 @@ declare namespace audio { * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. Return by callback. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3131,7 +3571,9 @@ declare namespace audio { * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. Return by promise. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3154,8 +3596,10 @@ declare namespace audio { * @param { 'spatializationEnabledChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the spatialization enable state. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3167,8 +3611,10 @@ declare namespace audio { * @param { 'spatializationEnabledChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the spatialization enable state. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3182,8 +3628,10 @@ declare namespace audio { * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 201 - Permission denied. Return by callback. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3196,7 +3644,9 @@ declare namespace audio { * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. Return by promise. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3219,8 +3669,10 @@ declare namespace audio { * @param { 'headTrackingEnabledChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the head tracking enable state. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3232,8 +3684,10 @@ declare namespace audio { * @param { 'headTrackingEnabledChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the head tracking enable state. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3246,8 +3700,10 @@ declare namespace audio { * @param { AudioSpatialDeviceState } spatialDeviceState - Spatial device state. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 11 @@ -3260,8 +3716,10 @@ declare namespace audio { * @param { AudioSpatializationSceneType } spatializationSceneType - Spatialization scene type. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi * @since 12 @@ -3355,6 +3813,7 @@ declare namespace audio { /** * Array of VolumeGroupInfos, which is read-only. + * @typedef { Array> } VolumeGroupInfos * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi * @since 9 @@ -3363,6 +3822,7 @@ declare namespace audio { /** * Array of AudioRendererChangeInfo, which is read-only. + * @typedef { Array> } AudioRendererChangeInfoArray * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 9 */ @@ -3415,6 +3875,7 @@ declare namespace audio { /** * Array of AudioCapturerChangeInfo, which is read-only. + * @typedef { Array> } AudioCapturerChangeInfoArray * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 9 */ @@ -3478,12 +3939,25 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Describes an audio device. + * @typedef AudioDeviceDescriptor + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ interface AudioDeviceDescriptor { /** * Audio device role. * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Audio device role. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly deviceRole: DeviceRole; /** @@ -3491,6 +3965,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Audio device type. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly deviceType: DeviceType; /** @@ -3498,6 +3978,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Audio device id. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly id: number; /** @@ -3505,6 +3991,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Audio device name. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly name: string; /** @@ -3512,6 +4004,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Audio device address. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly address: string; /** @@ -3519,6 +4017,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Supported sampling rates. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly sampleRates: Array; /** @@ -3526,6 +4030,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Supported channel counts. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly channelCounts: Array; /** @@ -3533,6 +4043,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 9 */ + /** + * Supported channel masks. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly channelMasks: Array; /** * Device network id @@ -3560,6 +4076,12 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ + /** + * Name used to display, considering distributed device situation. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ readonly displayName: string; /** @@ -3567,14 +4089,28 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @since 11 */ + /** + * Supported encoding types. + * @syscap SystemCapability.Multimedia.Audio.Core + * @atomicservice + * @since 12 + */ readonly encodingTypes?: Array; } /** * Array of AudioDeviceDescriptors, which is read-only. + * @typedef { Array> } AudioDeviceDescriptors * @syscap SystemCapability.Multimedia.Audio.Device * @since 7 */ + /** + * Array of AudioDeviceDescriptors, which is read-only. + * @typedef { Array> } AudioDeviceDescriptors + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ type AudioDeviceDescriptors = Array>; /** @@ -3774,18 +4310,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Enumerates audio stream device change reason. + * @enum {number} + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ enum AudioStreamDeviceChangeReason { /** * Unknown. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Unknown. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ REASON_UNKNOWN = 0, /** * New device available. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * New device available. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ REASON_NEW_DEVICE_AVAILABLE = 1, /** * Old device unavailable. Applications should consider to pause the audio playback when this reason is @@ -3793,12 +4348,25 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Old device unavailable. Applications should consider to pause the audio playback when this reason is + * reported. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ REASON_OLD_DEVICE_UNAVAILABLE = 2, /** * Overrode by user or system. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Overrode by user or system. + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ REASON_OVERRODE = 3, } /** @@ -3807,6 +4375,13 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Audio stream device change info. + * @typedef AudioStreamDeviceChangeInfo + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ interface AudioStreamDeviceChangeInfo { /** * Audio device descriptors after change. @@ -3814,6 +4389,13 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Audio device descriptors after change. + * @type {AudioDeviceDescriptors} + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ devices: AudioDeviceDescriptors; /** * Audio stream device change reason. @@ -3821,6 +4403,13 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ + /** + * Audio stream device change reason. + * @type {AudioStreamDeviceChangeReason} + * @syscap SystemCapability.Multimedia.Audio.Device + * @atomicservice + * @since 12 + */ changeReason: AudioStreamDeviceChangeReason; } @@ -3925,8 +4514,10 @@ declare namespace audio { * Sets the current audio effect mode. This method uses an asynchronous callback to return the result. * @param { AudioEffectMode } mode - Audio effect mode. * @param { AsyncCallback } callback - Callback used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by callback. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -3935,8 +4526,10 @@ declare namespace audio { * Sets the current audio effect mode. This method uses a promise to return the result. * @param { AudioEffectMode } mode - Audio effect mode. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. Return by promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -4121,8 +4714,10 @@ declare namespace audio { /** * Sets the playback speed. * @param { number } speed - Audio playback speed. The value type is float, form 0.25 to 4.0. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 11 */ @@ -4185,8 +4780,10 @@ declare namespace audio { /** * Set interrupt mode. * @param { InterruptMode } mode - The interrupt mode. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 10 */ @@ -4221,8 +4818,10 @@ declare namespace audio { * Changes the volume with ramp for a duration. * @param { number } volume - Volume to set. The value type is float, form 0.0 to 1.0. * @param { number } duration - Duration for volume ramp, in millisecond. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 11 */ @@ -4321,8 +4920,10 @@ declare namespace audio { /** * Sets channel blend mode for this stream. * @param { ChannelBlendMode } mode - Target channel blend mode. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @throws { BusinessError } 6800103 - Operation not permit at current state. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 11 @@ -4334,8 +4935,10 @@ declare namespace audio { * triggered when audio playback is interrupted. * @param { 'audioInterrupt' } type - Type of the event to listen for. Only the audioInterrupt event is supported. * @param { Callback } callback - Callback used to listen for interrupt callback. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 9 */ @@ -4391,8 +4994,10 @@ declare namespace audio { * The event is triggered when output device change for this stream. * @param { 'outputDeviceChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen device change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -4403,8 +5008,10 @@ declare namespace audio { * The event is triggered when output device change for this stream. * @param { 'outputDeviceChangeWithInfo' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen device change event. - * @throws { BusinessError } 401 - if input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - if input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ @@ -4414,8 +5021,10 @@ declare namespace audio { * Unsubscribes output device change event callback. * @param { 'outputDeviceChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 10 */ @@ -4425,8 +5034,10 @@ declare namespace audio { * Unsubscribes output device change event callback. * @param { 'outputDeviceChangeWithInfo' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - if input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - if input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ @@ -4437,8 +5048,10 @@ declare namespace audio { * The event is triggered when audio buffer is available for writing more data. * @param { 'writeData' } type - Type of the event to listen for. * @param { Callback } callback - Callback with buffer to write. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 11 */ @@ -4448,8 +5061,10 @@ declare namespace audio { * Unsubscribes audio data callback. * @param { 'writeData' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 11 */ @@ -4896,8 +5511,10 @@ declare namespace audio { * triggered when audio recording is interrupted. * @param { 'audioInterrupt' } type - Type of the event to listen for. Only the audioInterrupt event is supported. * @param { Callback } callback - Callback used to listen for interrupt callback. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 10 */ @@ -4906,8 +5523,10 @@ declare namespace audio { /** * UnSubscribes to audio interrupt events. * @param { 'audioInterrupt' } type - Type of the event to listen for. Only the audioInterrupt event is supported. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Invalid parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 10 */ @@ -4918,8 +5537,10 @@ declare namespace audio { * The event is triggered when input device change for this stream. * @param { 'inputDeviceChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen device change event. - * @throws { BusinessError } 401 - if input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - if input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ @@ -4928,8 +5549,10 @@ declare namespace audio { * Unsubscribes input device change event callback. * @param { 'inputDeviceChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @since 11 */ @@ -4940,8 +5563,10 @@ declare namespace audio { * The event is triggered when input device change for this stream. * @param { 'audioCapturerChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen device change event. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 11 */ @@ -4950,8 +5575,10 @@ declare namespace audio { * Unsubscribes audio capturer info change event callback. * @param { 'audioCapturerChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 11 */ @@ -4962,8 +5589,10 @@ declare namespace audio { * The event is triggered when audio buffer is available for reading more data. * @param { 'readData' } type - Type of the event to listen for. * @param { Callback } callback - Callback with the buffer to read. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 11 */ @@ -4973,8 +5602,10 @@ declare namespace audio { * Unsubscribes audio data callback. * @param { 'readData' } type - Type of the event to listen for. * @param { Callback } callback - Callback used in subscribe. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 11 */ @@ -5056,8 +5687,10 @@ declare namespace audio { * @param { AsrAecMode } mode - ASR AEC Mode. * @returns { boolean } Indicates whether the mode has been successfully set. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @throws { BusinessError } 6800104 - Operation not allowed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @systemapi @@ -5081,8 +5714,10 @@ declare namespace audio { * @param { AsrNoiseSuppressionMode } mode - ASR noise suppression mode. * @returns { boolean } Indicates whether the mode has been successfully set. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @throws { BusinessError } 6800104 - Operation not allowed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @systemapi @@ -5119,8 +5754,10 @@ declare namespace audio { * of this capturer must be {@link SourceType#SOURCE_TYPE_VOICE_RECOGNITION}. * @returns { AsrProcessingController } ASR Processing Controller. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - Input parameter type or number mismatch. - * @throws { BusinessError } 6800101 - Input parameter value error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @throws { BusinessError } 6800104 - Operation not allowed. e.g. the source type of the input audio capturer is not * {@link SourceType#SOURCE_TYPE_VOICE_RECOGNITION} or {@link SourceType#SOURCE_TYPE_WAKEUP}, or this audio capturer * is already released. @@ -5410,6 +6047,7 @@ declare namespace audio { /** * Array of AudioEffectMode, which is read-only. + * @typedef { Array> } AudioEffectInfoArray * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ @@ -5421,18 +6059,37 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ + /** + * Describes an audio effect mode group. + * @enum { number } + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ enum AudioEffectMode { /** * Audio Effect Mode effect none. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ + /** + * Audio Effect Mode effect none. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ EFFECT_NONE = 0, /** * Audio Effect Mode effect default. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 10 */ + /** + * Audio Effect Mode effect default. + * @syscap SystemCapability.Multimedia.Audio.Renderer + * @atomicservice + * @since 12 + */ EFFECT_DEFAULT = 1, } diff --git a/api/@ohos.multimedia.audioHaptic.d.ts b/api/@ohos.multimedia.audioHaptic.d.ts index dd5200847bb20938f2bb702f90a04a878affdb5c..b768b4f5dc02ab080a23445578692e2d04b8ceb1 100644 --- a/api/@ohos.multimedia.audioHaptic.d.ts +++ b/api/@ohos.multimedia.audioHaptic.d.ts @@ -97,7 +97,9 @@ declare namespace audioHaptic { * @param { string } audioUri - Audio file uri. * @param { string } hapticUri - Haptic file uri. * @returns { Promise } Promise used to return the source id. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AudioHaptic.Core * @since 11 */ @@ -107,7 +109,9 @@ declare namespace audioHaptic { * Unregister source. This method uses a promise to return the result. * @param { number } id source id. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AudioHaptic.Core * @since 11 */ @@ -117,7 +121,9 @@ declare namespace audioHaptic { * Set the audio latency mode of one source. * @param { number } id - Source id. * @param { AudioLatencyMode } latencyMode - Audio latency mode. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400102 - Operation not allowed. * @syscap SystemCapability.Multimedia.AudioHaptic.Core * @since 11 @@ -128,7 +134,10 @@ declare namespace audioHaptic { * Set the stream usage of one source. * @param { number } id - Source id. * @param { audio.StreamUsage } usage - Stream usage. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types; + * 3.Parameter verification failed. * @throws { BusinessError } 5400102 - Operation not allowed. * @syscap SystemCapability.Multimedia.AudioHaptic.Core * @since 11 @@ -143,7 +152,9 @@ declare namespace audioHaptic { * @param { AudioHapticPlayerOptions } options - Options when creating audio haptic player. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400102 - Operation not allowed. * @throws { BusinessError } 5400103 - I/O error. * @throws { BusinessError } 5400106 - Unsupport format. @@ -186,7 +197,9 @@ declare namespace audioHaptic { * Is muted for one AudioHapticType * @param { AudioHapticType } type - Indicates the type to query. * @returns { boolean } - Is muted. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Parameter verification failed. * @syscap SystemCapability.Multimedia.AudioHaptic.Core * @since 11 */ diff --git a/api/@ohos.multimedia.avCastPicker.d.ets b/api/@ohos.multimedia.avCastPicker.d.ets index fc5944d20d601fd9f440865568b56954388a0b5c..07eafbd26a53b3ebcefbd0b004e2669057607dbb 100644 --- a/api/@ohos.multimedia.avCastPicker.d.ets +++ b/api/@ohos.multimedia.avCastPicker.d.ets @@ -102,6 +102,17 @@ declare struct AVCastPicker { @Prop sessionType?: string; + /** + * Set the custom builder for the picker appearance. + * If not set, system will show the default appearance for different device type. + * @type { ? CustomBuilder } + * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice + * @since 12 + */ + @Prop + customPicker?: CustomBuilder; + /** * Picker state change callback. * @type { ?function } diff --git a/api/@ohos.multimedia.avsession.d.ts b/api/@ohos.multimedia.avsession.d.ts index 7a8944ec670edf9e5b1600e31d0388d0de069ec3..b80ffd748645629325476c013bbbc215f2a5f0ac 100644 --- a/api/@ohos.multimedia.avsession.d.ts +++ b/api/@ohos.multimedia.avsession.d.ts @@ -46,7 +46,8 @@ declare namespace avSession { * @param { string } tag - A user-defined name for this session * @param { AVSessionType } type - The type of session {@link AVSessionType} * @param { AsyncCallback } callback - async callback for AVSession. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @since 10 @@ -59,7 +60,8 @@ declare namespace avSession { * @param { string } tag - A user-defined name for this session * @param { AVSessionType } type - The type of session {@link AVSessionType} * @returns { Promise } Promise for AVSession - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @since 10 @@ -70,7 +72,8 @@ declare namespace avSession { * @param { string } tag - A user-defined name for this session * @param { AVSessionType } type - The type of session {@link AVSessionType} * @returns { Promise } Promise for AVSession - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice @@ -108,7 +111,8 @@ declare namespace avSession { * @param { number } maxSize - Specifies the maximum size of the returned value array. * @param { AsyncCallback>> } callback - async callback for an array of AVSessionDescriptors. * If provided '0' or not provided, the maximum value is determined by the system. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi Hide this for inner system use @@ -122,7 +126,8 @@ declare namespace avSession { * @param { number } maxSize - Specifies the maximum size of the returned value array. * If provided '0' or not provided, the maximum value is determined by the system. * @returns { Promise>> } Promise for an array of AVSessionDescriptors - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi Hide this for inner system use @@ -139,7 +144,8 @@ declare namespace avSession { * If provided '0' or not provided, the maximum value is determined by the system. * @throws { BusinessError } 201 - permission denied * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi Hide this for inner system use @@ -153,7 +159,8 @@ declare namespace avSession { * @param { number } maxSize - Specifies the maximum size of the returned value array. * @param { number } maxAppSize - Specifies the maximum app size of the returned value array. * @returns { Promise>> } Promise for an array of AVQueueInfo - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi Hide this for inner system use @@ -168,7 +175,8 @@ declare namespace avSession { * @param { AsyncCallback } callback - async callback for AVSessionController. * If provided 'default', the system will create a default controller, Used to control the system default session * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Manager @@ -184,7 +192,8 @@ declare namespace avSession { * If provided 'default', the system will create a default controller, Used to control the system default session * @returns { Promise } Promise for AVSessionController * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Manager @@ -201,7 +210,8 @@ declare namespace avSession { * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully * 'all' means cast all the media audio of this device to remote. * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600104 - The remote session connection failed. @@ -219,7 +229,8 @@ declare namespace avSession { * @returns { Promise } void promise when executed successfully * 'all' means cast all the media audio of this device to remote. * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600104 - The remote session connection failed. @@ -237,7 +248,8 @@ declare namespace avSession { * @returns { Promise } void promise when executed successfully * @throws { BusinessError } 201 - permission denied * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -291,7 +303,8 @@ declare namespace avSession { * @param { 'sessionCreate' } type - Registration Type, 'sessionCreate' * @param { function } callback - Used to handle ('sessionCreate' command) * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -305,7 +318,8 @@ declare namespace avSession { * @param { 'sessionDestroy' } type - Registration Type, 'sessionDestroy' * @param { function } callback - Used to handle ('sessionDestroy' command) * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -319,7 +333,8 @@ declare namespace avSession { * @param { 'topSessionChange' } type - Registration Type, top priority session change, 'topSessionChange' * @param { function } callback - Used to handle ('topSessionChange' command) * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -333,7 +348,8 @@ declare namespace avSession { * @param { 'sessionCreate' } type - Registration Type, session creation, 'sessionCreate' * @param { function } callback - Used to unregister listener for ('sessionCreate') command * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -347,7 +363,8 @@ declare namespace avSession { * @param { 'sessionDestroy' } type - Registration Type, session deletion, 'sessionDestroy' * @param { function } callback - Used to unregister listener for ('sessionDestroy') command * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -361,7 +378,8 @@ declare namespace avSession { * @param { 'topSessionChange' } type - Registration Type, top priority session change, 'topSessionChange' * @param { function } callback - Used to unregister listener for ('topSessionChange') command * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -374,7 +392,8 @@ declare namespace avSession { * @param { 'sessionServiceDie' } type - Registration Type, 'sessionServiceDie' * @param { function } callback - Used to handle ('sessionServiceDie') command. * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @systemapi @@ -387,7 +406,8 @@ declare namespace avSession { * @param { 'sessionServiceDie' } type - Registration Type, 'sessionServiceDie' * @param { function } callback - Used to unregister listener for ('sessionServiceDie') command. * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @systemapi @@ -401,7 +421,8 @@ declare namespace avSession { * @param { KeyEvent } event - The key event to be sent * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600105 - Invalid session command. * @syscap SystemCapability.Multimedia.AVSession.Manager @@ -416,7 +437,8 @@ declare namespace avSession { * @param { KeyEvent } event - The key event to be sent * @returns { Promise } void promise when executed successfully * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600105 - Invalid session command. * @syscap SystemCapability.Multimedia.AVSession.Manager @@ -431,7 +453,8 @@ declare namespace avSession { * @param { AVControlCommand } command - The command to be sent. See {@link AVControlCommand} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600105 - Invalid session command. * @throws { BusinessError } 6600107 - Too many commands or events. @@ -447,7 +470,8 @@ declare namespace avSession { * @param { AVControlCommand } command - The command to be sent. See {@link AVControlCommand} * @returns { Promise } void promise when executed successfully * @throws { BusinessError } 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600105 - Invalid session command. * @throws { BusinessError } 6600107 - Too many commands or events. @@ -500,12 +524,20 @@ declare namespace avSession { * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 11 */ + /** + * The Cast+ Stream indicating the media is presenting on a different device + * the application need get an AVCastController to control remote playback. + * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice + * @since 12 + */ TYPE_CAST_PLUS_STREAM = 2, /** * The DLNA type indicates the device supports DLNA protocol, * the application needs to get an AVCastController to control remote playback. * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice * @since 12 */ TYPE_DLNA = 4, @@ -524,7 +556,8 @@ declare namespace avSession { * Start device discovery. * @param { number } filter device filter when discovering, can be an union of {@link ProtocolType} * @param { AsyncCallback } callback a callback function - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -535,7 +568,8 @@ declare namespace avSession { * Start device discovery. * @param { number } filter device filter when discovering, can be an union of {@link ProtocolType} * @returns { Promise } Promise for the result - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -547,7 +581,8 @@ declare namespace avSession { * It is effective when protocol type is TYPE_CAST_PLUS_STREAM. * @returns { Promise } Promise for the result * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 12 @@ -576,7 +611,8 @@ declare namespace avSession { * Enable or disable device to be discoverable, used at sink side. * @param { boolean } enable true: can be discoverable, false: cannot be discoverable. * @param { AsyncCallback } callback a callback function - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -587,7 +623,8 @@ declare namespace avSession { * Enable or disable device to be discoverable, used at sink side. * @param { boolean } enable true: can be discoverable, false: cannot be discoverable. * @returns { Promise } Promise for the result - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -599,7 +636,8 @@ declare namespace avSession { * @param { 'deviceAvailable' } type Registration Type * @param { function } callback Used to returns the device info * @throws {BusinessError} 201 - permission denied - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -611,7 +649,8 @@ declare namespace avSession { * @param { 'deviceAvailable' } type Registration Type * @param { function } callback Used to returns the device info * @throws {BusinessError} 201 - permission denied - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 10 @@ -623,7 +662,8 @@ declare namespace avSession { * @param { 'deviceOffline' } type - Registration Type * @param { function } callback - Used to returns the device info * @throws {BusinessError} 201 - permission denied - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 11 @@ -637,7 +677,8 @@ declare namespace avSession { * @param { function } callback - Used to returns the device info * @throws {BusinessError} 201 - permission denied * @throws {BusinessError} 202 - Not System App. - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi * @since 11 @@ -651,7 +692,8 @@ declare namespace avSession { * @param { string } sessionId Specifies the sessionId to get controller. * @param { AsyncCallback } callback - async callback for the AVCastController. * @throws {BusinessError} 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600102 - session does not exist * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -667,7 +709,8 @@ declare namespace avSession { * @param { string } sessionId Specifies the sessionId to get controller. * @returns { Promise } Promise for the AVCastController * @throws {BusinessError} 201 - permission denied - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - server exception * @throws {BusinessError} 6600102 - session does not exist * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -683,7 +726,8 @@ declare namespace avSession { * @param { OutputDeviceInfo } device Specifies the device to cast. * @param { AsyncCallback } callback A callback instance used to return when start casting. * @throws {BusinessError} 201 - permission denied - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600108 - Device connecting failed * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -699,7 +743,8 @@ declare namespace avSession { * @param { OutputDeviceInfo } device Specifies the device to cast. * @returns { Promise } Promise for the result * @throws {BusinessError} 201 - permission denied - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600108 - Device connecting failed * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -712,7 +757,8 @@ declare namespace avSession { * Stop current cast and disconnect device connection. * @param { SessionToken } session Specifies the sessionId which is to be stopped. * @param { AsyncCallback } callback A callback instance used to return when cast stopped completed. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -724,7 +770,8 @@ declare namespace avSession { * Stop current cast and disconnect device connection. * @param { SessionToken } session Specifies the sessionId which is to be stopped. * @returns { Promise } Promise for the result - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -795,7 +842,8 @@ declare namespace avSession { * In addition to the required properties, users can fill in partially supported properties * @param { AVMetadata } data {@link AVMetadata} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -808,7 +856,8 @@ declare namespace avSession { * In addition to the required properties, users can fill in partially supported properties * @param { AVMetadata } data {@link AVMetadata} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -819,7 +868,8 @@ declare namespace avSession { * In addition to the required properties, users can fill in partially supported properties * @param { AVMetadata } data {@link AVMetadata} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -832,7 +882,8 @@ declare namespace avSession { * Set the metadata related with current call. * @param { CallMetadata } data - {@link CallMetadata} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -844,7 +895,8 @@ declare namespace avSession { * Set the metadata related with current call. * @param { CallMetadata } data - {@link CallMetadata} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -856,7 +908,8 @@ declare namespace avSession { * Set the playback state of this session. * @param { AVPlaybackState } state {@link AVPlaybackState} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -868,7 +921,8 @@ declare namespace avSession { * Set the playback state of this session. * @param { AVPlaybackState } state {@link AVPlaybackState} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -878,7 +932,8 @@ declare namespace avSession { * Set the playback state of this session. * @param { AVPlaybackState } state {@link AVPlaybackState} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -891,7 +946,8 @@ declare namespace avSession { * Set the call state of this session. * @param { AVCallState } state - {@link AVCallState} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -903,7 +959,8 @@ declare namespace avSession { * Set the call state of this session. * @param { AVCallState } state - {@link AVCallState} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -915,7 +972,8 @@ declare namespace avSession { * Set the ability to start the session corresponding to * @param { WantAgent } ability - The WantAgent for launch the ability * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -927,7 +985,8 @@ declare namespace avSession { * Set the ability to start the session corresponding to * @param { WantAgent } ability - The WantAgent for launch the ability * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -940,7 +999,8 @@ declare namespace avSession { * @param { string } event - Session event name to dispatch * @param { object } args - The parameters of session event * @param { AsyncCallback} callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -953,7 +1013,8 @@ declare namespace avSession { * @param { string } event - Session event name to dispatch * @param { object } args - The parameters of session event * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -965,7 +1026,8 @@ declare namespace avSession { * Set the playlist of queueItem. Identifies the content of the playlist presented by this session. * @param { Array } items - An array of the AVQueueItem * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -977,7 +1039,8 @@ declare namespace avSession { * Set the playlist of queueItem. Identifies the content of the playlist presented by this session. * @param { Array } items - An array of the AVQueueItem * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -989,7 +1052,8 @@ declare namespace avSession { * Set the name of the playlist presented by this session. * @param { string } title - The name of the playlist * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1001,7 +1065,8 @@ declare namespace avSession { * Set the name of the playlist presented by this session. * @param { string } title - The name of the playlist * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1013,7 +1078,8 @@ declare namespace avSession { * Set the custom media packets for this session. * @param { object } extras - The custom media packets * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1025,7 +1091,8 @@ declare namespace avSession { * Set the custom media packets for this session. * @param { object } extras - The custom media packets * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1143,7 +1210,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'play' } type - Command to register 'play'. * @param { function } callback - Used to handle ('play') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1160,7 +1228,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'pause' } type - Command to register 'pause'. * @param { function } callback - Used to handle ('pause') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1177,7 +1246,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'stop' } type - Command to register 'stop'. * @param { function } callback - Used to handle ('stop') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1194,7 +1264,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'playNext' } type - Command to register 'playNext'. * @param { function } callback - Used to handle ('playNext') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1211,7 +1282,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'playPrevious' } type - Command to register 'playPrevious'. * @param { function } callback - Used to handle ('playPrevious') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1228,7 +1300,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'fastForward' } type - Command to register 'fastForward'. * @param { function } callback - Used to handle ('fastForward') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1245,7 +1318,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'rewind' } type - Command to register 'rewind'. * @param { function } callback - Used to handle ('rewind') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1258,7 +1332,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'play' } type - Command to register 'play'. * @param { function } callback - Used to handle ('play') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1271,7 +1346,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'pause' } type - Command to register 'pause'. * @param { function } callback - Used to handle ('pause') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1284,7 +1360,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'stop' } type - Command to register 'stop'. * @param { function } callback - Used to handle ('stop') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1297,7 +1374,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'playNext' } type - Command to register 'playNext'. * @param { function } callback - Used to handle ('playNext') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1310,7 +1388,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'playPrevious' } type - Command to register 'playPrevious'. * @param { function } callback - Used to handle ('playPrevious') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1323,7 +1402,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'fastForward' } type - Command to register 'fastForward'. * @param { function } callback - Used to handle ('fastForward') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1336,7 +1416,8 @@ declare namespace avSession { * When canceling the callback, need to update the supported commands list. * @param { 'rewind' } type - Command to register 'rewind'. * @param { function } callback - Used to handle ('rewind') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1353,7 +1434,8 @@ declare namespace avSession { * and the new callback will replace the previous one. * @param { 'playFromAssetId' } type - Command to register 'playFromAssetId'. * @param { function } callback - Used to handle ('playFromAssetId') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1365,7 +1447,8 @@ declare namespace avSession { * Unregister playFromAssetId command callback. * @param { 'playFromAssetId' } type - Command to register 'playFromAssetId'. * @param { function } callback - Used to handle ('playFromAssetId') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1377,7 +1460,8 @@ declare namespace avSession { * Register seek command callback * @param { 'seek' } type - Registration Type 'seek' * @param { function } callback - Used to handle seek command.The callback provides the seek time(ms) - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1389,7 +1473,8 @@ declare namespace avSession { * Unregister seek command callback * @param { 'seek' } type - Registration Type 'seek' * @param { function } callback - Used to handle seek command.The callback provides the seek time(ms) - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1401,7 +1486,8 @@ declare namespace avSession { * Register setSpeed command callback * @param { 'setSpeed' } type - Registration Type 'setSpeed' * @param { function } callback - Used to handle setSpeed command.The callback provides the speed value - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1413,7 +1499,8 @@ declare namespace avSession { * Unregister setSpeed command callback * @param { 'setSpeed' } type - Registration Type 'setSpeed' * @param { function } callback - Used to handle setSpeed command.The callback provides the speed value - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1425,7 +1512,8 @@ declare namespace avSession { * Register setLoopMode command callback * @param { 'setLoopMode' } type - Registration Type 'setLoopMode' * @param { function } callback - Used to handle setLoopMode command.The callback provides the {@link LoopMode} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1437,7 +1525,8 @@ declare namespace avSession { * Unregister setLoopMode command callback * @param { 'setLoopMode' } type - Registration Type 'setLoopMode' * @param { function } callback - Used to handle setLoopMode command.The callback provides the {@link LoopMode} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1450,7 +1539,8 @@ declare namespace avSession { * @param { 'toggleFavorite' } type - Registration Type 'toggleFavorite' * @param { function } callback - Used to handle toggleFavorite command.The callback provides * the assetId for which the favorite status needs to be switched. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1463,7 +1553,8 @@ declare namespace avSession { * @param { 'toggleFavorite' } type - Registration Type 'toggleFavorite' * @param { function } callback - Used to handle toggleFavorite command.The callback provides * the assetId for which the favorite status needs to be switched. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1475,7 +1566,8 @@ declare namespace avSession { * Register media key handling callback * @param { 'handleKeyEvent' } type - Registration Type 'handleKeyEvent' * @param { function } callback - Used to handle key events.The callback provides the KeyEvent - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1487,7 +1579,8 @@ declare namespace avSession { * Unregister media key handling callback * @param { 'handleKeyEvent' } type - Registration Type 'handleKeyEvent' * @param { function } callback - Used to handle key events.The callback provides the KeyEvent - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1500,7 +1593,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1511,7 +1605,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1525,7 +1620,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1536,7 +1632,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1550,7 +1647,8 @@ declare namespace avSession { * @param { 'commonCommand' } type - Registration Type 'commonCommand' * @param { function } callback - Used to handle event when the common command is received * The callback provide the command name and command args - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1563,7 +1661,8 @@ declare namespace avSession { * @param { 'commonCommand' } type - Registration Type 'commonCommand' * @param { function } callback - Used to cancel a specific listener * The callback provide the command name and command args - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1576,7 +1675,8 @@ declare namespace avSession { * @param { 'skipToQueueItem' } type - Registration Type 'skipToQueueItem' * @param { function } callback - Used to handle the item to be played. * The callback provide the new device info {@link OutputDeviceInfo} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1589,7 +1689,8 @@ declare namespace avSession { * @param { 'skipToQueueItem' } type - Registration Type 'skipToQueueItem' * @param { function } callback - Used to handle the item to be played. * The callback provide the new device info {@link OutputDeviceInfo} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1603,7 +1704,8 @@ declare namespace avSession { * If you cancel the callback, you need to call off {@link off} * @param { 'answer' } type - Command to register 'answer'. * @param { Callback } callback - Used to handle ('answer') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1615,7 +1717,8 @@ declare namespace avSession { * Unregister answer command callback. * @param { 'answer' } type - Command to register 'answer'. * @param { Callback } callback - Used to handle ('answer') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1629,7 +1732,8 @@ declare namespace avSession { * If you cancel the callback, you need to call off {@link off} * @param { 'hangUp' } type - Command to register 'hangUp'. * @param { Callback } callback - Used to handle ('hangUp') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1641,7 +1745,8 @@ declare namespace avSession { * Unregister hangUp command callback. * @param { 'hangUp' } type - Command to register 'hangUp'. * @param { Callback } callback - Used to handle ('hangUp') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1655,7 +1760,8 @@ declare namespace avSession { * If you cancel the callback, you need to call off {@link off} * @param { 'toggleCallMute' } type - Command to register 'toggleCallMute'. * @param { Callback } callback - Used to handle ('toggleCallMute') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1667,7 +1773,7 @@ declare namespace avSession { * Unregister toggleCallMute command callback. * @param { 'toggleCallMute' } type - Command to register 'toggleCallMute'. * @param { Callback } callback - Used to handle ('toggleCallMute') command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified.2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -1679,7 +1785,8 @@ declare namespace avSession { * Register listener for cast display information changed. * @param { 'castDisplayChange' } type - Type of the 'castDisplayChange' to listen for. * @param { Callback } callback - Callback used to return cast display information. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast @@ -1691,7 +1798,8 @@ declare namespace avSession { * Unregister listener for cast display information changed. * @param { 'castDisplayChange' } type - Type of the 'castDisplayChange' to listen for. * @param { Callback } callback - Callback used to return cast display information. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast @@ -1898,7 +2006,8 @@ declare namespace avSession { * Set a surface instance to display playing view, used at sink side. * @param { string } surfaceId - surface id, video player will use this id get a surface instance. * @param { AsyncCallback } callback - A callback instance used to return when set surface completed. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -1910,7 +2019,8 @@ declare namespace avSession { * Set a surface instance to display playing view, used at sink side. * @param { string } surfaceId - surface id, video player will use this id get a surface instance. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -1948,7 +2058,8 @@ declare namespace avSession { * Send control commands to remote player * @param { AVCastControlCommand } command The command to be send. * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600105 - Invalid session command * @throws { BusinessError } 6600109 - The remote connection is not established @@ -1961,7 +2072,8 @@ declare namespace avSession { * Send control commands to remote player * @param { AVCastControlCommand } command The command to be send. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600105 - Invalid session command * @throws { BusinessError } 6600109 - The remote connection is not established @@ -1972,7 +2084,8 @@ declare namespace avSession { * Send control commands to remote player * @param { AVCastControlCommand } command The command to be send. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600105 - Invalid session command * @throws { BusinessError } 6600109 - The remote connection is not established @@ -1986,7 +2099,8 @@ declare namespace avSession { * Play the current item, should contain mediaUri otherwise the playback will fail. * @param { AVQueueItem } item media item info. * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -1998,7 +2112,8 @@ declare namespace avSession { * Play the current item, should contain mediaUri otherwise the playback will fail. * @param { AVQueueItem } item media item info. * @returns { Promise } Promise used to return the result. - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2008,7 +2123,8 @@ declare namespace avSession { * Play the current item, should contain mediaUri otherwise the playback will fail. * @param { AVQueueItem } item media item info. * @returns { Promise } Promise used to return the result. - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2021,7 +2137,8 @@ declare namespace avSession { * Load the current item and mediaUri can be null, this is needed for sink media information displaying * @param { AVQueueItem } item media item info. * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2033,7 +2150,8 @@ declare namespace avSession { * Load the current item and mediaUri can be null, this is needed for sink media information displaying * @param { AVQueueItem } item media item info. * @returns { Promise } Promise used to return the result. - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2043,7 +2161,8 @@ declare namespace avSession { * Load the current item and mediaUri can be null, this is needed for sink media information displaying * @param { AVQueueItem } item media item info. * @returns { Promise } Promise used to return the result. - * @throws {BusinessError} 401 - parameter check failed + * @throws {BusinessError} 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws {BusinessError} 6600101 - Session service exception * @throws {BusinessError} 6600109 - The remote connection is not established * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2101,9 +2220,11 @@ declare namespace avSession { * @param { string } assetId - The assetId of resource which provides the response. * @param { Uint8Array } response - Response corresponding to the request. * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice * @since 12 */ processMediaKeyResponse(assetId: string, response: Uint8Array): Promise; @@ -2140,7 +2261,8 @@ declare namespace avSession { * @param { Array | 'all' } filter - The properties of {@link AVPlaybackState} that you cared about * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2151,7 +2273,8 @@ declare namespace avSession { * @param { Array | 'all' } filter - The properties of {@link AVPlaybackState} that you cared about * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2164,7 +2287,8 @@ declare namespace avSession { * @param { 'playbackStateChange' } type * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2174,7 +2298,8 @@ declare namespace avSession { * @param { 'playbackStateChange' } type * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2186,7 +2311,8 @@ declare namespace avSession { * Register listener for current media item playback events. * @param { 'mediaItemChange' } type Type of the playback event to listen for. * @param { Callback } callback Callback used to listen for current item changed. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2195,7 +2321,8 @@ declare namespace avSession { * Register listener for current media item playback events. * @param { 'mediaItemChange' } type Type of the playback event to listen for. * @param { Callback } callback Callback used to listen for current item changed. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2206,7 +2333,8 @@ declare namespace avSession { /** * Unregister listener for current media item playback events. * @param { 'mediaItemChange' } type Type of the playback event to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2214,7 +2342,8 @@ declare namespace avSession { /** * Unregister listener for current media item playback events. * @param { 'mediaItemChange' } type Type of the playback event to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2227,7 +2356,8 @@ declare namespace avSession { * Application needs update the new media resource when receive these commands by using playItem. * @param { 'playNext' } type - Type of the 'playNext' event to listen for. * @param { Callback } callback - Used to handle 'playNext' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2237,7 +2367,8 @@ declare namespace avSession { * Application needs update the new media resource when receive these commands by using playItem. * @param { 'playNext' } type - Type of the 'playNext' event to listen for. * @param { Callback } callback - Used to handle 'playNext' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2249,7 +2380,8 @@ declare namespace avSession { * Unregister playback command callback sent by remote side or media center. * When canceling the callback, need to update the supported commands list. * @param { 'playNext' } type - Type of the 'playNext' event to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2258,7 +2390,8 @@ declare namespace avSession { * Unregister playback command callback sent by remote side or media center. * When canceling the callback, need to update the supported commands list. * @param { 'playNext' } type - Type of the 'playNext' event to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2271,7 +2404,8 @@ declare namespace avSession { * Application needs update the new media resource when receive these commands by using playItem. * @param { 'playPrevious' } type - Type of the 'playPrevious' to listen for. * @param { Callback } callback - Used to handle 'playPrevious' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2281,7 +2415,8 @@ declare namespace avSession { * Application needs update the new media resource when receive these commands by using playItem. * @param { 'playPrevious' } type - Type of the 'playPrevious' to listen for. * @param { Callback } callback - Used to handle 'playPrevious' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2293,7 +2428,8 @@ declare namespace avSession { * Unregister playback command callback sent by remote side or media center. * When canceling the callback, need to update the supported commands list. * @param { 'playPrevious' } type - Type of the 'playPrevious' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2302,7 +2438,8 @@ declare namespace avSession { * Unregister playback command callback sent by remote side or media center. * When canceling the callback, need to update the supported commands list. * @param { 'playPrevious' } type - Type of the 'playPrevious' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2315,7 +2452,8 @@ declare namespace avSession { * The AVQueueItem may include the requested assetId, starting position and other configurations. * @param { 'requestPlay' } type - Type of the 'requestPlay' to listen for. * @param { Callback } callback - Used to handle 'requestPlay' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 11 @@ -2326,7 +2464,8 @@ declare namespace avSession { * Unregister requested playback command callback sent by remote side or media center. * @param { 'requestPlay' } type - Type of the 'requestPlay' to listen for. * @param { Callback } callback - Used to handle 'requestPlay' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 11 @@ -2338,7 +2477,8 @@ declare namespace avSession { * Application needs update the new media resource when receive these commands by using playItem. * @param { 'endOfStream' } type - Type of the 'endOfStream' to listen for. * @param { Callback } callback - Used to handle 'endOfStream' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 11 @@ -2349,7 +2489,8 @@ declare namespace avSession { * Unregister endOfStream state callback. * @param { 'endOfStream' } type - Type of the 'endOfStream' to listen for. * @param { Callback } callback - Used to handle 'endOfStream' command - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 11 @@ -2360,7 +2501,8 @@ declare namespace avSession { * Register listens for playback events. * @param { 'seekDone' } type - Type of the 'seekDone' to listen for. * @param { Callback } callback - Callback used to listen for the playback seekDone event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2369,7 +2511,8 @@ declare namespace avSession { * Register listens for playback events. * @param { 'seekDone' } type - Type of the 'seekDone' to listen for. * @param { Callback } callback - Callback used to listen for the playback seekDone event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2380,7 +2523,8 @@ declare namespace avSession { /** * Unregister listens for playback events. * @param { 'seekDone' } type - Type of the 'seekDone' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @since 10 @@ -2388,7 +2532,8 @@ declare namespace avSession { /** * Unregister listens for playback events. * @param { 'seekDone' } type - Type of the 'seekDone' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2401,7 +2546,8 @@ declare namespace avSession { * @param { 'validCommandChange' } type - 'validCommandChange' * @param { Callback> } callback - The callback used to handle the changes. * The callback function provides an array of AVCastControlCommandType. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2414,7 +2560,8 @@ declare namespace avSession { * @param { 'validCommandChange' } type - 'validCommandChange' * @param { Callback> } callback - The callback used to handle the changes. * The callback function provides an array of AVCastControlCommandType. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.AVCast @@ -2426,7 +2573,8 @@ declare namespace avSession { * Register listener for video size change event, used at remote side. * @param { 'videoSizeChange' } type - Type of the 'videoSizeChange' to listen for. * @param { function } callback - Callback used to return video size. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -2437,7 +2585,8 @@ declare namespace avSession { /** * Unregister listener for video size change event, used at remote side. * @param { 'videoSizeChange' } type - Type of the 'videoSizeChange' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @systemapi @@ -2449,7 +2598,8 @@ declare namespace avSession { * Register listeners for playback error events. * @param { 'error' } type Type of the 'error' to listen for. * @param { ErrorCallback } callback Callback used to listen for the playback error event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 5400101 - No memory. * @throws { BusinessError } 5400102 - Operation not allowed. * @throws { BusinessError } 5400103 - I/O error. @@ -2464,7 +2614,8 @@ declare namespace avSession { * Register listeners for playback error events. * @param { 'error' } type Type of the 'error' to listen for. * @param { ErrorCallback } callback Callback used to listen for the playback error event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 5400101 - No memory. * @throws { BusinessError } 5400102 - Operation not allowed. * @throws { BusinessError } 5400103 - I/O error. @@ -2481,7 +2632,8 @@ declare namespace avSession { /** * Unregister listens for playback error events. * @param { 'error' } type Type of the 'error' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 5400101 - No memory. * @throws { BusinessError } 5400102 - Operation not allowed. * @throws { BusinessError } 5400103 - I/O error. @@ -2495,7 +2647,8 @@ declare namespace avSession { /** * Unregister listens for playback error events. * @param { 'error' } type Type of the 'error' to listen for. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 5400101 - No memory. * @throws { BusinessError } 5400102 - Operation not allowed. * @throws { BusinessError } 5400103 - I/O error. @@ -2513,7 +2666,8 @@ declare namespace avSession { * Register listener for drm key request. * @param { 'keyRequest' } type - Type of the 'keyRequest' to listen for. * @param { KeyRequestCallback } callback - Callback used to request drm key. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2525,7 +2679,8 @@ declare namespace avSession { * Unregister listener for drm key request. * @param { 'keyRequest' } type - Type of the 'keyRequest' to listen for. * @param { KeyRequestCallback } callback - Callback used to request drm key. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice @@ -2541,6 +2696,7 @@ declare namespace avSession { * @param { string } assetId - request key for current assetId * @param { Uint8Array } requestData - media key request data sent to media key server * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice * @since 12 */ type KeyRequestCallback = (assetId: string, requestData: Uint8Array) => void; @@ -3977,6 +4133,7 @@ declare namespace avSession { * The drm capability supported by current device, each drm is represented by uuid. * @type { ?Array } * @syscap SystemCapability.Multimedia.AVSession.AVCast + * @atomicservice * @since 12 */ supportedDrmCapabilities?: Array; @@ -4565,7 +4722,8 @@ declare namespace avSession { * Set the item in the playlist to be played * @param { number } itemId - The serial number of the item to be played * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4578,7 +4736,8 @@ declare namespace avSession { * Set the item in the playlist to be played * @param { number } itemId - The serial number of the item to be played * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4621,7 +4780,8 @@ declare namespace avSession { * Send media key event to this session * @param { KeyEvent } event - The KeyEvent * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 600101 - Session service exception. * @throws { BusinessError } 600102 - The session does not exist. * @throws { BusinessError } 600103 - The session controller does not exist. @@ -4636,7 +4796,8 @@ declare namespace avSession { * Send media key event to this session * @param { KeyEvent } event - The KeyEvent * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 600101 - Session service exception. * @throws { BusinessError } 600102 - The session does not exist. * @throws { BusinessError } 600103 - The session controller does not exist. @@ -4770,7 +4931,8 @@ declare namespace avSession { * Send control commands to this session * @param { AVControlCommand } command - The command to be sent. See {@link AVControlCommand} * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4786,7 +4948,8 @@ declare namespace avSession { * Send control commands to this session * @param { AVControlCommand } command - The command to be sent. See {@link AVControlCommand} * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4803,7 +4966,8 @@ declare namespace avSession { * @param { string } command - The command name to be sent. * @param { object } args - The parameters of session event * @param { AsyncCallback } callback - The asyncCallback triggered when the command is executed successfully. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4820,7 +4984,8 @@ declare namespace avSession { * @param { string } command - The command name to be sent. * @param { object } args - The parameters of session event * @returns { Promise } void promise when executed successfully - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4835,7 +5000,8 @@ declare namespace avSession { /** * Get custom media packets provided by the corresponding session * @param { AsyncCallback<{[key: string]: Object}> } callback - The triggered asyncCallback when (getExtras). - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4849,7 +5015,8 @@ declare namespace avSession { /** * Get custom media packets provided by the corresponding session * @returns { Promise<{[key: string]: Object}> } the parameters of extras - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -4867,7 +5034,8 @@ declare namespace avSession { * @param { function } callback - The callback used to handle metadata changed event. * The callback function provides the {@link AVMetadata} parameter. * It only contains the properties set in the filter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4881,7 +5049,8 @@ declare namespace avSession { * @param { function } callback - The callback used to handle metadata changed event. * The callback function provides the {@link AVMetadata} parameter. * It only contains the properties set in the filter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4895,7 +5064,8 @@ declare namespace avSession { * @param { Array | 'all' } filter - The properties of {@link AVPlaybackState} that you cared about * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4908,7 +5078,8 @@ declare namespace avSession { * @param { 'playbackStateChange' } type * @param { function } callback - The callback used to handle playback state changed event. * The callback function provides the {@link AVPlaybackState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4923,7 +5094,8 @@ declare namespace avSession { * @param { Callback } callback - The callback used to handle call metadata changed event. * The callback function provides the {@link CallMetadata} parameter. * It only contains the properties set in the filter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4937,7 +5109,8 @@ declare namespace avSession { * @param { Callback } callback - The callback used to handle call metadata changed event. * The callback function provides the {@link CallMetadata} parameter. * It only contains the properties set in the filter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4951,7 +5124,8 @@ declare namespace avSession { * @param { Array | 'all' } filter - The properties of {@link AVCallState} that you cared about * @param { Callback } callback - The callback used to handle call state changed event. * The callback function provides the {@link AVCallState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4964,7 +5138,8 @@ declare namespace avSession { * @param { 'callStateChange' } type - 'callStateChange' * @param { Callback } callback - The callback used to handle call state changed event. * The callback function provides the {@link AVCallState} parameter. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4976,7 +5151,8 @@ declare namespace avSession { * Register current session destroyed callback * @param { 'sessionDestroy' } type * @param { function } callback - The callback used to handle current session destroyed event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -4988,7 +5164,8 @@ declare namespace avSession { * Unregister current session destroyed callback * @param { 'sessionDestroy' } type - 'sessionDestroy' * @param { function } callback - The callback used to handle current session destroyed event. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5001,7 +5178,8 @@ declare namespace avSession { * @param { 'activeStateChange' } type - 'activeStateChange' * @param { function } callback - The callback used to handle the active state of this session changed event. * The callback function provides the changed session state. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5014,7 +5192,8 @@ declare namespace avSession { * @param { 'activeStateChange' } type - 'activeStateChange' * @param { function } callback - The callback used to handle the active state of this session changed event. * The callback function provides the changed session state. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5027,7 +5206,8 @@ declare namespace avSession { * @param { 'validCommandChange' } type - 'validCommandChange' * @param { function } callback - The callback used to handle the changes. * The callback function provides an array of AVControlCommandType. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5040,7 +5220,8 @@ declare namespace avSession { * @param { 'validCommandChange' } type - 'validCommandChange' * @param { function } callback - The callback used to handle the changes. * The callback function provides an array of AVControlCommandType. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5053,7 +5234,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600103 - The session controller does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5066,7 +5248,8 @@ declare namespace avSession { * @param { 'outputDeviceChange' } type - Registration Type 'outputDeviceChange' * @param { function } callback - Used to handle output device changed. * The callback provide the new device info {@link OutputDeviceInfo} and related connection state {@link ConnectionState}. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception * @throws { BusinessError } 6600103 - The session controller does not exist * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5079,7 +5262,8 @@ declare namespace avSession { * @param { 'sessionEvent' } type - 'sessionEvent' * @param { function } callback - The callback used to handle session event changed event. * The callback function provides the event string and key-value pair parameters. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5092,7 +5276,8 @@ declare namespace avSession { * @param { 'sessionEvent' } type - 'sessionEvent' * @param { function } callback - Used to cancel a specific listener * The callback function provides the event string and key-value pair parameters. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5105,7 +5290,8 @@ declare namespace avSession { * @param { 'queueItemsChange' } type - Registration Type 'queueItemsChange' * @param { function } callback - Used to handle playlist changed. * The callback provides the new array of AVQueueItem {@link AVQueueItem} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5118,7 +5304,8 @@ declare namespace avSession { * @param { 'queueItemsChange' } type - Registration Type 'queueItemsChange' * @param { function } callback - Used to handle playlist changed. * The callback provides the new array of AVQueueItem {@link AVQueueItem} - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5131,7 +5318,8 @@ declare namespace avSession { * @param { 'queueTitleChange' } type - Registration Type 'queueTitleChange' * @param { function } callback - Used to handle name of playlist changed. * The callback provides the new name. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5144,7 +5332,8 @@ declare namespace avSession { * @param { 'queueTitleChange' } type - Registration Type 'queueTitleChange' * @param { function } callback - Used to handle name of playlist changed. * The callback provides the new name. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5157,7 +5346,8 @@ declare namespace avSession { * @param { 'extrasChange' } type - Registration Type 'extrasChange' * @param { function } callback - Used to handle custom media packets changed. * The callback provides the new media packets. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core @@ -5170,7 +5360,8 @@ declare namespace avSession { * @param { 'extrasChange' } type - Registration Type 'extrasChange' * @param { function } callback - Used to handle custom media packets changed. * The callback provides the new media packets. - * @throws { BusinessError } 401 - parameter check failed + * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600103 - The session controller does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core diff --git a/api/@ohos.multimedia.camera.d.ts b/api/@ohos.multimedia.camera.d.ts index af9beb2554fec5e1d6669396e72c27f505a34866..ada413724ec50e437d34583311f764164704756b 100644 --- a/api/@ohos.multimedia.camera.d.ts +++ b/api/@ohos.multimedia.camera.d.ts @@ -22,6 +22,7 @@ import { ErrorCallback, AsyncCallback } from './@ohos.base'; import type Context from './application/BaseContext'; import image from './@ohos.multimedia.image'; import type colorSpaceManager from './@ohos.graphics.colorSpaceManager'; +import photoAccessHelper from './@ohos.file.photoAccessHelper'; /** * @namespace camera @@ -294,6 +295,14 @@ declare namespace camera { */ DEVICE_PREEMPTED = 7400109, + /** + * Unresolved conflicts with current configurations. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + UNRESOLVED_CONFLICTS_WITH_CURRENT_CONFIGURATIONS = 7400110, + /** * Camera service fatal error. * @@ -553,7 +562,7 @@ declare namespace camera { * @returns { CameraInput } The CameraInput instance. * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400102 - Operation not allowed. - * @throws { BusinessError } 7400201 - Camera service fatal error. + * @throws { BusinessError } 7400201 - Camera service fatal error. * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ @@ -1273,6 +1282,16 @@ declare namespace camera { * @since 10 */ readonly hostDeviceType: HostDeviceType; + + /** + * Camera sensor orientation attribute. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + readonly cameraOrientation: number; } /** @@ -1361,6 +1380,19 @@ declare namespace camera { */ open(): Promise; + /** + * Open camera. + * + * @param { boolean } isSecureEnabled - Enable secure camera. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 7400107 - Can not use camera cause of conflict. + * @throws { BusinessError } 7400108 - Camera disabled cause of security reason. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + open(isSecureEnabled: boolean): Promise; + /** * Close camera. * @@ -1444,7 +1476,51 @@ declare namespace camera { * @systemapi * @since 11 */ - NIGHT_PHOTO = 4 + NIGHT_PHOTO = 4, + + /** + * Professional photo mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + PROFESSIONAL_PHOTO = 5, + + /** + * Professional video mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + PROFESSIONAL_VIDEO = 6, + + /** + * Slow motion video mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + SLOW_MOTION_VIDEO = 7, + + /** + * High resolution mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + HIGH_RESOLUTION_PHOTO = 11, + + /** + * Secure camera mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + SECURE_PHOTO = 12 } /** @@ -1463,6 +1539,15 @@ declare namespace camera { */ CAMERA_FORMAT_RGBA_8888 = 3, + /** + * Digital negative Format. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + CAMERA_FORMAT_DNG = 4, + /** * YUV 420 Format. * @@ -1538,13 +1623,43 @@ declare namespace camera { } /** - * Flash object. + * LCD Flash Status. * - * @interface Flash + * @typedef LcdFlashStatus * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @systemapi + * @since 12 + */ + interface LcdFlashStatus { + /** + * Check whether lcd flash is needed. + * + * @type { boolean } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly isLcdFlashNeeded: boolean; + + /** + * Compensate value for lcd flash. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly lcdCompensation: number; + } + + /** + * Flash Query object. + * + * @interface FlashQuery + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 */ - interface Flash { + interface FlashQuery { /** * Check if device has flash light. * @@ -1553,6 +1668,15 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ + /** + * Check if device has flash light. + * Move to FlashQuery interface from Flash since 12. + * + * @returns { boolean } The flash light support status. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ hasFlash(): boolean; /** @@ -1564,8 +1688,39 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ + /** + * Checks whether a specified flash mode is supported. + * Move to FlashQuery interface from Flash since 12. + * + * @param { FlashMode } flashMode - Flash mode + * @returns { boolean } Is the flash mode supported. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ isFlashModeSupported(flashMode: FlashMode): boolean; + /** + * Checks whether lcd flash is supported. + * + * @returns { boolean } Is lcd flash supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isLcdFlashSupported(): boolean; + } + + /** + * Flash object. + * + * @interface Flash + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + interface Flash extends FlashQuery { /** * Gets current flash mode. * @@ -1617,17 +1772,63 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 10 */ - EXPOSURE_MODE_CONTINUOUS_AUTO = 2 + EXPOSURE_MODE_CONTINUOUS_AUTO = 2, + + /** + * Manual exposure mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + EXPOSURE_MODE_MANUAL = 3 } /** - * AutoExposure object. + * Enum for exposure metering mode. * - * @interface AutoExposure + * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @systemapi + * @since 12 + */ + enum ExposureMeteringMode { + /** + * Matrix metering. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + MATRIX = 0, + + /** + * Center metering. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + CENTER = 1, + + /** + * Spot metering. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + SPOT = 2 + } + + /** + * AutoExposureQuery object. + * + * @interface AutoExposureQuery + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 */ - interface AutoExposure { + interface AutoExposureQuery { /** * Checks whether a specified exposure mode is supported. * @@ -1637,8 +1838,60 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ + /** + * Checks whether a specified exposure mode is supported. + * Move to AutoExposureQuery interface from AutoExposure interface since 12. + * + * @param { ExposureMode } aeMode - Exposure mode + * @returns { boolean } Is the exposure mode supported. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ isExposureModeSupported(aeMode: ExposureMode): boolean; + /** + * Query the exposure compensation range. + * + * @returns { Array } The array of compensation range. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + /** + * Query the exposure compensation range. + * Move to AutoExposureQuery interface from AutoExposure interface since 12. + * + * @returns { Array } The array of compensation range. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getExposureBiasRange(): Array; + + /** + * Checks whether a specified exposure metering mode is supported. + * + * @param { ExposureMeteringMode } aeMeteringMode - Exposure metering mode + * @returns { boolean } Is the exposure metering mode supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isExposureMeteringModeSupported(aeMeteringMode: ExposureMeteringMode): boolean; + } + + /** + * AutoExposure object. + * + * @interface AutoExposure + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + interface AutoExposure extends AutoExposureQuery { /** * Gets current exposure mode. * @@ -1717,6 +1970,31 @@ declare namespace camera { * @since 11 */ getExposureValue(): number; + + /** + * Gets current exposure metering mode. + * + * @returns { ExposureMeteringMode } The current exposure metering mode. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getExposureMeteringMode(): ExposureMeteringMode; + + /** + * Sets exposure metering mode. + * + * @param { ExposureMeteringMode } aeMeteringMode - Exposure metering mode + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setExposureMeteringMode(aeMeteringMode: ExposureMeteringMode): void; } /** @@ -1794,13 +2072,13 @@ declare namespace camera { } /** - * Focus object. + * Focus Query object. * - * @interface Focus + * @interface FocusQuery * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since 12 */ - interface Focus { + interface FocusQuery { /** * Checks whether a specified focus mode is supported. * @@ -1810,25 +2088,56 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ - isFocusModeSupported(afMode: FocusMode): boolean; - /** - * Gets current focus mode. + * Checks whether a specified focus mode is supported. + * Move to FocusQuery interface from Focus interface since 12. * - * @returns { FocusMode } The current focus mode. - * @throws { BusinessError } 7400103 - Session not config. + * @param { FocusMode } afMode - Focus mode. + * @returns { boolean } Is the focus mode supported. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since 12 */ - getFocusMode(): FocusMode; + isFocusModeSupported(afMode: FocusMode): boolean; /** - * Sets focus mode. + * Checks whether a focus assist is supported. * - * @param { FocusMode } afMode - Target focus mode. - * @throws { BusinessError } 7400103 - Session not config. + * @returns { boolean } Is the focus assist supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @systemapi + * @since 12 + */ + isFocusAssistSupported(): boolean; + } + + /** + * Focus object. + * + * @interface Focus + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + interface Focus extends FocusQuery { + /** + * Gets current focus mode. + * + * @returns { FocusMode } The current focus mode. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + getFocusMode(): FocusMode; + + /** + * Sets focus mode. + * + * @param { FocusMode } afMode - Target focus mode. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 */ setFocusMode(afMode: FocusMode): void; @@ -1861,6 +2170,295 @@ declare namespace camera { * @since 11 */ getFocalLength(): number; + + /** + * Gets current focus assist. + * + * @returns { boolean } The current focus assist. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getFocusAssist(): boolean; + + /** + * Sets focus assist. + * + * @param { boolean } enabled - Enable focus assist if TRUE. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setFocusAssist(enabled: boolean): void; + } + + /** + * ManualFocus object. + * + * @interface ManualFocus + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ManualFocus { + /** + * Gets current focus distance. + * + * @returns { number } The current focus distance. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getFocusDistance(): number; + + /** + * Sets focus distance. + * + * @param { number } distance - Focus distance + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setFocusDistance(distance: number): void; + } + + /** + * Enumerates the camera white balance modes. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enum WhiteBalanceMode { + /** + * Auto white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + AUTO = 0, + + /** + * Cloudy white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + CLOUDY = 1, + + /** + * Incandescent white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + INCANDESCENT = 2, + + /** + * Fluorescent white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + FLUORESCENT = 3, + + /** + * Daylight white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + DAYLIGHT = 4, + + /** + * Manual white balance mode. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + MANUAL = 5 + } + + /** + * White Balance Query object. + * + * @interface WhiteBalanceQuery + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface WhiteBalanceQuery { + /** + * Checks whether a specified white balance mode is supported. + * + * @param { WhiteBalanceMode } mode - White balance mode. + * @returns { boolean } Is the white balance mode supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isWhiteBalanceModeSupported(mode: WhiteBalanceMode): boolean; + + /** + * Query the white balance mode range. + * + * @returns { Array } The array of white balance mode range. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getWhiteBalanceRange(): Array; + } + + /** + * WhiteBalance object. + * + * @interface WhiteBalance + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface WhiteBalance extends WhiteBalanceQuery { + /** + * Gets current white balance mode. + * + * @returns { WhiteBalanceMode } The current white balance mode. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getWhiteBalanceMode(): WhiteBalanceMode; + + /** + * Sets white balance mode. + * + * @param { WhiteBalanceMode } mode - Target white balance mode. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setWhiteBalanceMode(mode: WhiteBalanceMode): void; + + /** + * Gets current white balance. + * + * @returns { number } The current white balance. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getWhiteBalance(): number; + + /** + * Sets white balance. + * + * @param { number } whiteBalance - White balance. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setWhiteBalance(whiteBalance: number): void; + } + + /** + * Manual ISO Query object. + * + * @interface ManualIsoQuery + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ManualIsoQuery { + /** + * Checks whether ISO is supported. + * + * @returns { boolean } Is the ISO supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isManualIsoSupported(): boolean; + + /** + * Get the ISO range. + * + * @returns { Array } The array of ISO range. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getIsoRange(): Array; + } + + /** + * ManualIso object. + * + * @interface ManualIso + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ManualIso extends ManualIsoQuery { + /** + * Gets current ISO. + * + * @returns { number } The current ISO. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + getIso(): number; + + /** + * Sets ISO. + * + * @param { number } iso - ISO + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setIso(iso: number): void; } /** @@ -2091,13 +2689,13 @@ declare namespace camera { } /** - * Stabilization object. + * Stabilization Query object. * - * @interface Stabilization + * @interface StabilizationQuery * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since 12 */ - interface Stabilization { + interface StabilizationQuery { /** * Check whether the specified video stabilization mode is supported. * @@ -2107,14 +2705,33 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ - isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode): boolean; - /** - * Query the video stabilization mode currently in use. + * Check whether the specified video stabilization mode is supported. + * Move to StabilizationQuery interface from Stabilization since 12. * - * @returns { VideoStabilizationMode } The current video stabilization mode. - * @throws { BusinessError } 7400103 - Session not config. - * @syscap SystemCapability.Multimedia.Camera.Core + * @param { VideoStabilizationMode } vsMode - Video Stabilization mode. + * @returns { boolean } Is flash mode supported. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode): boolean; + } + + /** + * Stabilization object. + * + * @interface Stabilization + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 11 + */ + interface Stabilization extends StabilizationQuery { + /** + * Query the video stabilization mode currently in use. + * + * @returns { VideoStabilizationMode } The current video stabilization mode. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ getActiveVideoStabilizationMode(): VideoStabilizationMode; @@ -2177,14 +2794,14 @@ declare namespace camera { } /** - * Beauty object. + * Beauty Query object. * - * @interface Beauty + * @interface BeautyQuery * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface Beauty { + interface BeautyQuery { /** * Gets supported beauty effect types. * @@ -2195,6 +2812,17 @@ declare namespace camera { * @systemapi * @since 11 */ + /** + * Gets supported beauty effect types. + * Move to BeautyQuery from Beauty since 12. + * + * @returns { Array } List of beauty effect types. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ getSupportedBeautyTypes(): Array; /** @@ -2208,8 +2836,30 @@ declare namespace camera { * @systemapi * @since 11 */ + /** + * Gets the specific beauty effect type range. + * Move to BeautyQuery from Beauty since 12. + * + * @param { BeautyType } type - The type of beauty effect. + * @returns { Array } The array of the specific beauty effect range. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ getSupportedBeautyRange(type: BeautyType): Array; + } + /** + * Beauty object. + * + * @interface Beauty + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface Beauty extends BeautyQuery { /** * Gets the beauty effect in use. * @@ -2271,18 +2921,27 @@ declare namespace camera { * @systemapi * @since 11 */ - SOFT = 2 + SOFT = 2, + + /** + * Black white color effect type. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + BLACK_WHITE = 3 } - /** - * Color effect object. + /** + * Color Effect Query object. * - * @interface ColorEffect + * @interface ColorEffectQuery * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface ColorEffect { + interface ColorEffectQuery { /** * Gets supported color effect types. * @@ -2293,8 +2952,29 @@ declare namespace camera { * @systemapi * @since 11 */ + /** + * Gets supported color effect types. + * Move to ColorEffectQuery from ColorEffect since 12. + * + * @returns { Array } List of color effect types. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ getSupportedColorEffects(): Array; + } + /** + * Color effect object. + * + * @interface ColorEffect + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface ColorEffect extends ColorEffectQuery { /** * Gets the specific color effect type. * @@ -2372,14 +3052,14 @@ declare namespace camera { } /** - * Macro object. + * Macro Query object. * - * @interface Macro + * @interface MacroQuery * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface Macro { + interface MacroQuery { /** * Determine whether camera macro is supported. * @@ -2389,8 +3069,28 @@ declare namespace camera { * @systemapi * @since 11 */ + /** + * Determine whether camera macro is supported. + * Move to MacroQuery interface from Macro since 12. + * + * @returns { boolean } Is camera macro supported. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ isMacroSupported(): boolean; + } + /** + * Macro object. + * + * @interface Macro + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface Macro extends MacroQuery { /** * Enable macro for camera. * @@ -3236,6 +3936,103 @@ declare namespace camera { setBeauty(type: BeautyType, value: number): void; } + /** + * Enum for feature type used in scene detection. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enum SceneFeatureType { + /** + * Feature for boost moon capture. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + MOON_CAPTURE_BOOST = 0 + } + + /** + * Feature Detection Result. + * + * @typedef SceneFeatureDetectionResult + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface SceneFeatureDetectionResult { + /** + * Detected feature type. + * + * @type { SceneFeatureType } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly featureType: SceneFeatureType; + + /** + * Check whether feature is detected. + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly detected: boolean; + } + + /** + * Scene detection query. + * + * @interface SceneDetectionQuery + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface SceneDetectionQuery { + /** + * Check whether specified feature is supported. + * + * @param { SceneFeatureType } type - Specified feature type. + * @returns { boolean } - Is specified feature supported. + * @throws { BusinessError } 202 - Not System Application, only throw in session usage. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isSceneFeatureSupported(type: SceneFeatureType): boolean; + } + + /** + * Scene detection. + * + * @interface SceneDetection + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface SceneDetection extends SceneDetectionQuery { + /** + * Enable specified feature. + * + * @param { SceneFeatureType } type - Specified feature type. + * @param { boolean } enabled - Target feature status. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enableSceneFeature(type: SceneFeatureType, enabled: boolean): void; + } + /** * Photo session object for system hap. * @@ -3244,7 +4041,7 @@ declare namespace camera { * @systemapi * @since 11 */ - interface PhotoSessionForSys extends PhotoSession, Beauty, ColorEffect, ColorManagement, Macro { + interface PhotoSessionForSys extends PhotoSession, Beauty, ColorEffect, ColorManagement, Macro, SceneDetection { } /** @@ -3338,6 +4135,32 @@ declare namespace camera { * @since 11 */ off(type: 'macroStatusChanged', callback?: AsyncCallback): void; + + /** + * Subscribes to feature detection results. + * + * @param { 'featureDetection' } type - Event type. + * @param { SceneFeatureType } featureType - Feature type. + * @param { AsyncCallback } callback - Callback used to get the detection result. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'featureDetection', featureType: SceneFeatureType, callback: AsyncCallback): void; + + /** + * Unsubscribes from feature detection result. + * + * @param { 'featureDetection' } type - Event type. + * @param { SceneFeatureType } featureType - Feature type. + * @param { AsyncCallback } callback - Callback used to get the detection result. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'featureDetection', featureType: SceneFeatureType, callback?: AsyncCallback): void; } /** @@ -3509,14 +4332,14 @@ declare namespace camera { } /** - * Portrait object. + * Portrait Query object. * - * @interface Portrait + * @interface PortraitQuery * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface Portrait { + interface PortraitQuery { /** * Gets supported portrait effect. * @@ -3537,8 +4360,29 @@ declare namespace camera { * @systemapi * @since 11 */ + /** + * Gets supported portrait effect. + * Move to PortraitQuery interface from Portrait interface since 12. + * + * @returns { Array } List of portrait effect. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ getSupportedPortraitEffects(): Array; + } + /** + * Portrait object. + * + * @interface Portrait + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface Portrait extends PortraitQuery { /** * Gets the portrait effect in use. * @@ -3647,14 +4491,14 @@ declare namespace camera { } /** - * Aperture object. + * Aperture Query object. * - * @interface Aperture + * @interface ApertureQuery * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface Aperture { + interface ApertureQuery { /** * Gets the supported virtual apertures. * @@ -3665,46 +4509,78 @@ declare namespace camera { * @systemapi * @since 11 */ - getSupportedVirtualApertures(): Array; - /** - * Gets current virtual aperture value. + * Gets the supported virtual apertures. + * Move to ApertureQuery interface from Aperture since 12. * - * @returns { number } The current virtual aperture value. + * @returns { Array } The array of supported virtual apertures. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400103 - Session not config. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - getVirtualAperture(): number; + getSupportedVirtualApertures(): Array; /** - * Sets virtual aperture value. + * Gets the supported physical apertures. * - * @param { number } aperture - virtual aperture value + * @returns { Array } The array of supported physical apertures. * @throws { BusinessError } 202 - Not System Application. * @throws { BusinessError } 7400103 - Session not config. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi * @since 11 */ - setVirtualAperture(aperture: number): void; - - /** + /** * Gets the supported physical apertures. + * Move to ApertureQuery interface from Aperture since 12. * * @returns { Array } The array of supported physical apertures. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400103 - Session not config. + * @throws { BusinessError } 7400103 - Session not config, only throw in session usage. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ getSupportedPhysicalApertures(): Array; + } + /** + * Aperture object. + * + * @interface Aperture + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface Aperture extends ApertureQuery { /** - * Gets current physical aperture value. + * Gets current virtual aperture value. + * + * @returns { number } The current virtual aperture value. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + getVirtualAperture(): number; + + /** + * Sets virtual aperture value. + * + * @param { number } aperture - virtual aperture value + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + setVirtualAperture(aperture: number): void; + + /** + * Gets current physical aperture value. * * @returns { number } The current physical aperture value. * @throws { BusinessError } 202 - Not System Application. @@ -3875,42 +4751,909 @@ declare namespace camera { * * @param { number } exposure - Exposure value * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400103 - Session not config. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + /** + * Sets Exposure value. + * + * @param { number } exposure - Exposure value + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setExposure(exposure: number): void; + } + + /** + * Night photo session object. + * + * @interface NightPhotoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + interface NightPhotoSession extends Session, Flash, AutoExposure, Focus, Zoom, ColorEffect, Beauty, ColorManagement, ManualExposure { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + + /** + * Subscribes zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; + + /** + * Unsubscribes from zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 11 + */ + off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; + + /** + * Subscribes to lcd flash status. + * + * @param { 'lcdFlashStatus' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lcd flash status. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'lcdFlashStatus', callback: AsyncCallback): void; + + /** + * Unsubscribes from lcd flash status. + * + * @param { 'lcdFlashStatus' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lcd flash status. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'lcdFlashStatus', callback?: AsyncCallback): void; + } + + /** + * ISO info object + * + * @typedef IsoInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface IsoInfo { + /** + * ISO value. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly iso?: number; + } + + /** + * Exposure info object + * + * @typedef ExposureInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ExposureInfo { + /** + * Exposure time value. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly exposureTime?: number; + } + + /** + * Aperture info object + * + * @typedef ApertureInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ApertureInfo { + /** + * Aperture value. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly aperture?: number; + } + + /** + * Lumination info object + * + * @typedef LuminationInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface LuminationInfo { + /** + * Lumination value. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + readonly lumination?: number; + } + + /** + * Professional photo session object. + * + * @interface ProfessionalPhotoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ProfessionalPhotoSession extends Session, AutoExposure, ManualExposure, Focus, ManualFocus, WhiteBalance, ManualIso, Flash, Zoom, ColorEffect, Aperture { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + + /** + * Subscribes zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; + + /** + * Unsubscribes from zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; + + /** + * Subscribes ISO info event callback. + * + * @param { 'isoInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the ISO info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'isoInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from ISO info event callback. + * + * @param { 'isoInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the ISO info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'isoInfo', callback?: AsyncCallback): void; + + /** + * Subscribes exposure info event callback. + * + * @param { 'exposureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the exposure info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'exposureInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from exposure info event callback. + * + * @param { 'exposureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the exposure info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'exposureInfo', callback?: AsyncCallback): void; + + /** + * Subscribes aperture info event callback. + * + * @param { 'apertureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the aperture info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'apertureInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from aperture info event callback. + * + * @param { 'apertureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the aperture info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'apertureInfo', callback?: AsyncCallback): void; + + /** + * Subscribes lumination info event callback. + * + * @param { 'luminationInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lumination info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'luminationInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from lumination info event callback. + * + * @param { 'luminationInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lumination info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'luminationInfo', callback?: AsyncCallback): void; + } + + /** + * Professional video session object. + * + * @interface ProfessionalVideoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface ProfessionalVideoSession extends Session, AutoExposure, ManualExposure, Focus, ManualFocus, WhiteBalance, ManualIso, Flash, Zoom, ColorEffect, Aperture { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + + /** + * Subscribes zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; + + /** + * Unsubscribes from zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; + + /** + * Subscribes ISO info event callback. + * + * @param { 'isoInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the ISO info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'isoInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from ISO info event callback. + * + * @param { 'isoInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the ISO info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'isoInfo', callback?: AsyncCallback): void; + + /** + * Subscribes exposure info event callback. + * + * @param { 'exposureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the exposure info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'exposureInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from exposure info event callback. + * + * @param { 'exposureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the exposure info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'exposureInfo', callback?: AsyncCallback): void; + + /** + * Subscribes aperture info event callback. + * + * @param { 'apertureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the aperture info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'apertureInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from aperture info event callback. + * + * @param { 'apertureInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the aperture info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'apertureInfo', callback?: AsyncCallback): void; + + /** + * Subscribes lumination info event callback. + * + * @param { 'luminationInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lumination info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'luminationInfo', callback: AsyncCallback): void; + + /** + * Unsubscribes from lumination info event callback. + * + * @param { 'luminationInfo' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the lumination info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'luminationInfo', callback?: AsyncCallback): void; + } + + /** + * Enum for slow motion status. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enum SlowMotionStatus { + /** + * Slow motion disabled. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + DISABLED = 0, + + /** + * Slow motion ready. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + READY = 1, + + /** + * Slow motion video start. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + VIDEO_START = 2, + + /** + * Slow motion video done. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + VIDEO_DONE = 3, + + /** + * Slow motion finished. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + FINISHED = 4 + } + + /** + * Slow motion video session object. + * + * @interface SlowMotionVideoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface SlowMotionVideoSession extends Session, Flash, AutoExposure, Focus, Zoom, ColorEffect { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + + /** + * Subscribes zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; + + /** + * Unsubscribes from zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; + + /** + * Determine whether camera slow motion detection is supported. + * + * @returns { boolean } Is camera slow motion detection supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isSlowMotionDetectionSupported(): boolean; + + /** + * Set slow motion detection area. + * + * @param { Rect } area - Detection area. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + setSlowMotionDetectionArea(area: Rect): void; + + /** + * Subscribes slow motion status callback. + * + * @param { 'slowMotionStatus' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the slow motion status. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'slowMotionStatus', callback: AsyncCallback): void; + + /** + * Unsubscribes slow motion status callback. + * + * @param { 'slowMotionStatus' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the slow motion status. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'slowMotionStatus', callback?: AsyncCallback): void; + } + + /** + * High resolution session object. + * + * @interface HighResolutionPhotoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface HighResolutionPhotoSession extends Session, AutoExposure, Focus { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + } + + /** + * Macro photo session object. + * + * @interface MacroPhotoSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + interface MacroPhotoSession extends Session, Flash, AutoExposure, Focus, Zoom, ColorEffect, ManualFocus { + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus state change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + + /** + * Subscribes zoom info event callback. + * + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ + on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; + /** - * Sets Exposure value. + * Unsubscribes from zoom info event callback. * - * @param { number } exposure - Exposure value + * @param { 'smoothZoomInfoAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the zoom info. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400102 - Operation not allowed. - * @throws { BusinessError } 7400103 - Session not config. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi * @since 12 */ - setExposure(exposure: number): void; + off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; } /** - * Night photo session object. + * Macro video session object. * - * @interface NightPhotoSession + * @interface MacroVideoSession * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ - interface NightPhotoSession extends Session, Flash, AutoExposure, Focus, Zoom, ColorEffect, ColorManagement, ManualExposure { + interface MacroVideoSession extends Session, Flash, AutoExposure, Focus, Zoom, ColorEffect, ManualFocus { /** * Subscribes to error events. * * @param { 'error' } type - Event type. * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ on(type: 'error', callback: ErrorCallback): void; @@ -3919,9 +5662,10 @@ declare namespace camera { * * @param { 'error' } type - Event type. * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ off(type: 'error', callback?: ErrorCallback): void; @@ -3930,9 +5674,10 @@ declare namespace camera { * * @param { 'focusStateChange' } type - Event type. * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ on(type: 'focusStateChange', callback: AsyncCallback): void; @@ -3941,9 +5686,10 @@ declare namespace camera { * * @param { 'focusStateChange' } type - Event type. * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ off(type: 'focusStateChange', callback?: AsyncCallback): void; @@ -3952,9 +5698,10 @@ declare namespace camera { * * @param { 'smoothZoomInfoAvailable' } type - Event type. * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ on(type: 'smoothZoomInfoAvailable', callback: AsyncCallback): void; @@ -3963,13 +5710,75 @@ declare namespace camera { * * @param { 'smoothZoomInfoAvailable' } type - Event type. * @param { AsyncCallback } callback - Callback used to get the zoom info. + * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since 12 */ off(type: 'smoothZoomInfoAvailable', callback?: AsyncCallback): void; } + /** + * Secure camera session object. + * + * @interface SecureSession + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + interface SecureSession extends Session, Flash, AutoExposure, Focus, Zoom { + /** + * Add Secure output for camera. + * + * @param { PreviewOutput } previewOutput - Specify the output as a secure flow. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + addSecureOutput(previewOutput: PreviewOutput): void; + + /** + * Subscribes to error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Unsubscribes from error events. + * + * @param { 'error' } type - Event type. + * @param { ErrorCallback } callback - Callback used to get the capture session errors. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'error', callback?: ErrorCallback): void; + + /** + * Subscribes focus status change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'focusStateChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from focus status change event callback. + * + * @param { 'focusStateChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the focus state change. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'focusStateChange', callback?: AsyncCallback): void; + } + /** * Camera output object. * @@ -4144,6 +5953,36 @@ declare namespace camera { */ off(type: 'error', callback?: ErrorCallback): void; + /** + * Get supported frame rates which can be set during session running. + * + * @returns { Array } The array of supported frame rate range. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getSupportedFrameRates(): Array + + /** + * Set a frame rate range. + * + * @param { number } minFps - Minimum frame rate per second. + * @param { number } maxFps - Maximum frame rate per second. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400110 - Unresolved conflicts with current configurations. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + setFrameRate(minFps: number, maxFps: number): void + + /** + * Get active frame rate range which has been set before. + * + * @returns { FrameRateRange } The active frame rate range. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getActiveFrameRate(): FrameRateRange; + /** * Adds a deferred surface. * @@ -4460,6 +6299,16 @@ declare namespace camera { */ main: image.Image; + /** + * Raw image. + * + * @type { ?image.Image } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + raw?: image.Image; + /** * Release Photo object. * @@ -4671,6 +6520,26 @@ declare namespace camera { */ off(type: 'deferredPhotoProxyAvailable', callback?: AsyncCallback): void; + /** + * Subscribes photo asset event callback. + * + * @param { 'photoAssetAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the asset. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'photoAssetAvailable', callback: AsyncCallback): void; + + /** + * Unsubscribes photo asset event callback. + * + * @param { 'photoAssetAvailable' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the asset. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'photoAssetAvailable', callback?: AsyncCallback): void; + /** * Check whether to support mirror photo. * @@ -4744,6 +6613,26 @@ declare namespace camera { */ off(type: 'frameShutter', callback?: AsyncCallback): void; + /** + * Subscribes frame shutter end event callback. + * + * @param { 'frameShutterEnd' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the frame shutter end information. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'frameShutterEnd', callback: AsyncCallback): void; + + /** + * Unsubscribes from frame shutter end event callback. + * + * @param { 'frameShutterEnd' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the frame shutter end information. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'frameShutterEnd', callback?: AsyncCallback): void; + /** * Subscribes capture end event callback. * @@ -4764,6 +6653,46 @@ declare namespace camera { */ off(type: 'captureEnd', callback?: AsyncCallback): void; + /** + * Subscribes capture ready event callback. After receiving the callback, can proceed to the next capture + * + * @param { 'captureReady' } type - Event type. + * @param { AsyncCallback } callback - Callback used to notice capture ready. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'captureReady', callback: AsyncCallback): void; + + /** + * Unsubscribes from capture ready event callback. + * + * @param { 'captureReady' } type - Event type. + * @param { AsyncCallback } callback - Callback used to notice capture ready. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'captureReady', callback?: AsyncCallback): void; + + /** + * Subscribes estimated capture duration event callback. + * + * @param { 'estimatedCaptureDuration' } type - Event type. + * @param { AsyncCallback } callback - Callback used to notify the estimated capture duration (in milliseconds). + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + on(type: 'estimatedCaptureDuration', callback: AsyncCallback): void; + + /** + * Unsubscribes from estimated capture duration event callback. + * + * @param { 'estimatedCaptureDuration' } type - Event type. + * @param { AsyncCallback } callback - Callback used to notify the estimated capture duration (in milliseconds). + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + off(type: 'estimatedCaptureDuration', callback?: AsyncCallback): void; + /** * Subscribes to error events. * @@ -4812,7 +6741,7 @@ declare namespace camera { * The method must be called after Session.addInput() and Session.addOutput(photoOutput) are called. * To avoid stream reconfiguration and performance loss, * you are advised to call the method before Session.commitConfig(). - * + * * @param { boolean } enabled - The value TRUE means to enable quick thumbnail, and FALSE means the opposite. * @throws { BusinessError } 7400104 - session is not running. * @syscap SystemCapability.Multimedia.Camera.Core @@ -4824,7 +6753,7 @@ declare namespace camera { * The method must be called after Session.addInput() and Session.addOutput(photoOutput) are called. * To avoid stream reconfiguration and performance loss, * you are advised to call the method before Session.commitConfig(). - * + * * @param { boolean } enabled - The value TRUE means to enable quick thumbnail, and FALSE means the opposite. * @throws { BusinessError } 202 - Not System Application. * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. @@ -4859,6 +6788,56 @@ declare namespace camera { * @since 10 */ off(type: 'quickThumbnail', callback?: AsyncCallback): void; + + /** + * Confirm if the auto high quality photo supported. + * + * @returns { boolean } TRUE if the auto high quality photo is supported. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400104 - session is not running. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isAutoHighQualityPhotoSupported(): boolean; + + /** + * Enable auto high quality photo. + * + * @param { boolean } enabled - Target state for auto high quality photo. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400104 - session is not running. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enableAutoHighQualityPhoto(enabled: boolean): void; + + /** + * Confirm if moving photo supported. + * + * @returns { boolean } TRUE if the moving photo is supported. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + isMovingPhotoSupported(): boolean; + + /** + * Enable moving photo. + * + * @permission ohos.permission.MICROPHONE + * @param { boolean } enabled - Target state for moving photo. + * @throws { BusinessError } 201 - permission denied. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + enableMovingPhoto(enabled: boolean): void; } /** @@ -4887,6 +6866,24 @@ declare namespace camera { timestamp: number; } + /** + * Frame shutter end callback info. + * + * @typedef FrameShutterEndInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + interface FrameShutterEndInfo { + /** + * Capture id. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + captureId: number; + } + /** * Capture start info. * @@ -4904,7 +6901,7 @@ declare namespace camera { */ captureId: number; /** - * Time(in milliseconds) which after the value can obtain the photo. + * Time(in milliseconds) is the shutter time for the photo. * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core @@ -4987,6 +6984,60 @@ declare namespace camera { */ stop(): Promise; + /** + * Determine whether video mirror is supported. + * + * @returns { boolean } Is video mirror supported. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + isMirrorSupported(): boolean; + + /** + * Enable mirror for video capture. + * + * @param { boolean } enabled - enable video mirror if TRUE. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400103 - Session not config. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 12 + */ + enableMirror(enabled: boolean): void; + + /** + * Get supported frame rates which can be set during session running. + * + * @returns { Array } The array of supported frame rate range. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getSupportedFrameRates(): Array + + /** + * Set a frame rate range. + * + * @param { number } minFps - Minimum frame rate per second. + * @param { number } maxFps - Maximum frame rate per second. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400110 - Unresolved conflicts with current configurations. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + setFrameRate(minFps: number, maxFps: number): void + + /** + * Get active frame rate range which has been set before. + * + * @returns { FrameRateRange } The active frame rate range. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getActiveFrameRate(): FrameRateRange; + /** * Subscribes frame start event callback. * diff --git a/api/@ohos.multimedia.drm.d.ts b/api/@ohos.multimedia.drm.d.ts index 42c17091f9c0d94c93acfa939246a9156efd53f0..4476e4dd8235480c093c6802be0ea5eb2e8281ec 100644 --- a/api/@ohos.multimedia.drm.d.ts +++ b/api/@ohos.multimedia.drm.d.ts @@ -24,6 +24,13 @@ * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ +/** + * This module provides the DRM capability to multimedia player. + * @namespace drm + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ declare namespace drm { /** * Enumerates drm error code. @@ -202,42 +209,85 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Enumerates media key request types. + * @enum { number } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ enum MediaKeyRequestType { /** * Media key request type unknown. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type unknown. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_UNKNOWN = 0, /** * Media key request type initial. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type initial. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_INITIAL = 1, /** * Media key request type renewal. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type renewal. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_RENEWAL = 2, /** * Media key request type release. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type release. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_RELEASE = 3, /** * Media key request type none. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type none. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_NONE = 4, /** * Media key request type update. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type update. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ MEDIA_KEY_REQUEST_TYPE_UPDATE = 5, } @@ -247,36 +297,73 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Enumerates content protection level. + * @enum { number } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ enum ContentProtectionLevel { /** * Device decrypt and decode type unknown. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Device decrypt and decode type unknown. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ CONTENT_PROTECTION_LEVEL_UNKNOWN = 0, /** * Device using software level. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Device using software level. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ CONTENT_PROTECTION_LEVEL_SW_CRYPTO, /** * Device using hardware level. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Device using hardware level. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ CONTENT_PROTECTION_LEVEL_HW_CRYPTO, /** * Device using enhanced hardware level. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Device using enhanced hardware level. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ CONTENT_PROTECTION_LEVEL_ENHANCED_HW, /** * Max mode. * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Max mode. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ CONTENT_PROTECTION_LEVEL_MAX, } @@ -309,6 +396,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Provides the drm media key request info optional data. + * @interface OptionsData + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface OptionsData { /** * App defined optional data name. @@ -316,6 +410,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * App defined optional data name. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ name: string; /** * App defined optional data value. @@ -323,6 +424,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * App defined optional data value. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ value: string; } @@ -332,6 +440,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Provides the drm media key request definitions. + * @interface MediaKeyRequest + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface MediaKeyRequest { /** * Media key request type. @@ -339,6 +454,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request type. + * @type { MediaKeyRequestType } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ mediaKeyRequestType: MediaKeyRequestType; /** * Media key request data sent to media key server. @@ -346,6 +468,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key request data sent to media key server. + * @type { Uint8Array } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ data: Uint8Array; /** * Media key server URL. @@ -353,6 +482,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key server URL. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ defaultURL: string; } @@ -362,6 +498,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Used to indicates the event info attached to specific event type. + * @interface EventInfo + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface EventInfo { /** * Event info. @@ -369,6 +512,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Event info. + * @type { Uint8Array } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ info: Uint8Array; /** * Event extra info. @@ -376,6 +526,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Event extra info. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ extraInfo: string; } @@ -408,6 +565,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Used to indicates the media key status. + * @interface MediaKeyStatus + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface MediaKeyStatus { /** * Media key Id in string. @@ -415,6 +579,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key Id in string. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ name: string; /** * Media key status description. @@ -422,6 +593,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Media key status description. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ value: string; } @@ -431,6 +609,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Used to indicates the media key status with a key and its value. + * @interface KeysInfo + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface KeysInfo { /** * Keys Id in media key. @@ -438,6 +623,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Keys Id in media key. + * @type { Uint8Array } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ keyId: Uint8Array; /** * Keys status description. @@ -445,6 +637,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Keys status description. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ value: string; } @@ -454,6 +653,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Used to indicates the media key system info of media source. + * @interface MediaKeySystemInfo + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface MediaKeySystemInfo { /** * Drm system ID. @@ -461,6 +667,13 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Drm system ID. + * @type { string } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ uuid: string; /** * PSSH(protection scheme specific header) contain drm info. @@ -468,9 +681,16 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * PSSH(protection scheme specific header) contain drm info. + * @type { Uint8Array } + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ pssh: Uint8Array; } - + /** * Name and UUID of DRM plugin. * @interface MediaKeySystemDescription @@ -498,7 +718,8 @@ declare namespace drm { * Get a MediaKeySystem's UUID. * @param { string } name - The Digital Right Management solution name. * @returns { string } The MediaKeySystem uuid. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed.Possibly because: + *
1.Mandatory parameters are left unspecified. 2.Parameter verification failed. * @throws { BusinessError } 24700101 - All unknown errors. * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. * @syscap SystemCapability.Multimedia.Drm.Core @@ -586,7 +807,7 @@ declare namespace drm { interface MediaKeySystem { /** * Get the specified configuration. - * @param { string } - configName - Used to specify the config name. + * @param { string } configName - Used to specify the config name. * @returns { string } The config value string. * @throws { BusinessError } 401 - The parameter check failed. Possibly because: * 1.Mandatory parameters are left unspecified. 2.Parameter verification failed, @@ -797,6 +1018,14 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Provide functions and keep a decrypt module. Before calling an MediaKeySession method, we must + * use MediaKeySystem's createMediaKeySession to get a MediaKeySession instance. + * @interface MediaKeySession + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ interface MediaKeySession { /** @@ -814,6 +1043,22 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Generate the media key request. + * @param { string } mimeType - Media type. + * @param { Uint8Array } initData - PSSH info. + * @param { number } mediaKeyType - Offline or online. + * @param { OptionsData[] } options - Optional data the application set to drm framework. + * @returns { Promise } Promise with MediaKeyRequest used to return the result. + * @throws { BusinessError } 401 -The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ generateMediaKeyRequest(mimeType: string, initData: Uint8Array, mediaKeyType: number, options?: OptionsData[]): Promise; /** @@ -828,6 +1073,19 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Process the response corresponding to the media key request obtained by the application. + * @param { Uint8Array } response - The response. + * @returns { Promise } Promise with media key identifier in Uint8ARRY used to return the result. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ processMediaKeyResponse(response: Uint8Array): Promise; /** @@ -838,6 +1096,15 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Check the media key status + * @returns { MediaKeyStatus[] } A list of media key status description pairs. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ checkMediaKeyStatus(): MediaKeyStatus[]; /** @@ -847,6 +1114,14 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Remove media key. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ clearMediaKeys(): void; /** @@ -862,6 +1137,20 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Generate offline media key request. + * @param { Uint8Array } mediaKeyId - The mediaKeyId specifies which media content's media key request + * should be generated. + * @returns { Promise } Promise with media key request in Uint8Array used to return the result. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ generateOfflineReleaseRequest(mediaKeyId: Uint8Array): Promise; /** @@ -877,6 +1166,20 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Process offline media key response. + * @param { Uint8Array } mediaKeyId - The mediaKeyId specifies which media content's media key it is. + * @param { Uint8Array } response - The offline media key. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ processOfflineReleaseResponse(mediaKeyId: Uint8Array, response: Uint8Array): Promise; /** @@ -891,6 +1194,19 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Restore offline media key. + * @param { Uint8Array } mediaKeyId - The mediaKeyId specifies which media key should be restore. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ restoreOfflineMediaKeys(mediaKeyId: Uint8Array): Promise; /** @@ -901,6 +1217,15 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Get content protection level. + * @returns { ContentProtectionLevel } MediaKeySession content protection level. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ getContentProtectionLevel(): ContentProtectionLevel; /** @@ -915,6 +1240,19 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Whether the encrypted content require a secure decoder or not. + * @param { string } mimeType - The media type. + * @returns { boolean } Whether secure decoder is required. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ requireSecureDecoderModule(mimeType: string): boolean; /** @@ -928,6 +1266,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Register keyRequired event. + * @param { 'keyRequired' } type - Type of the drm event to listen for. + * @param { function } callback used to listen for the key required event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ on(type: 'keyRequired', callback: (eventInfo: EventInfo) => void): void; /** @@ -941,6 +1291,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Unregister keyRequired event. + * @param { 'keyRequired' } type - Type of the drm event to listen for. + * @param { function } callback used to listen for the key required event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ off(type: 'keyRequired', callback?: (eventInfo: EventInfo) => void): void; /** @@ -954,6 +1316,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Register keyExpired event. + * @param { 'keyExpired' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for the key required event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ on(type: 'keyExpired', callback: (eventInfo: EventInfo) => void): void; /** @@ -967,6 +1341,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Unregister keyExpired event. + * @param { 'keyExpired' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for the key required event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ off(type: 'keyExpired', callback?: (eventInfo: EventInfo) => void): void; /** @@ -980,6 +1366,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Register vendorDefined event. + * @param { 'vendorDefined' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for the vendor defined event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ on(type: 'vendorDefined', callback: (eventInfo: EventInfo) => void): void; /** @@ -993,6 +1391,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Unregister vendorDefined event. + * @param { 'vendorDefined' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for the vendor defined event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ off(type: 'vendorDefined', callback?: (eventInfo: EventInfo) => void): void; /** @@ -1006,6 +1416,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Register expirationUpdate event. + * @param { 'expirationUpdate' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for expiration update event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ on(type: 'expirationUpdate', callback: (eventInfo: EventInfo) => void): void; /** @@ -1019,6 +1441,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Unregister expirationUpdate event. + * @param { 'expirationUpdate' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for expiration update event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ off(type: 'expirationUpdate', callback?: (eventInfo: EventInfo) => void): void; /** @@ -1032,6 +1466,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Register keysChange event. + * @param { 'keysChange' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for keys change event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ on(type: 'keysChange', callback: (keyInfo: KeysInfo[], newKeyAvailable: boolean) => void): void; /** @@ -1045,6 +1491,18 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Unregister keysChange event. + * @param { 'keysChange' } type - Type of the drm event to listen for. + * @param { function } callback - Used to listen for keys change event. + * @throws { BusinessError } 401 - The parameter check failed. Possibly because: + * 1.Mandatory parameters are left unspecified or too many parameters. 2.Incorrect parameter types. + * 3.Parameter verification failed. + * @throws { BusinessError } 24700101 - All unknown errors. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ off(type: 'keysChange', callback?: (keyInfo: KeysInfo[], newKeyAvailable: boolean) => void): void; /** @@ -1054,6 +1512,14 @@ declare namespace drm { * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 */ + /** + * Release the resource before the session gonna be unused. + * @throws { BusinessError } 24700101 - All unknown errors. + * @throws { BusinessError } 24700201 - Service fatal error e.g. service died. + * @syscap SystemCapability.Multimedia.Drm.Core + * @atomicservice + * @since 12 + */ destroy(): void; } diff --git a/api/@ohos.multimedia.image.d.ts b/api/@ohos.multimedia.image.d.ts index 74b03dab48a28a573c92ee2de3ec964455404fa7..a8c96dd802372a5e586b5f1d27b566653c699f26 100644 --- a/api/@ohos.multimedia.image.d.ts +++ b/api/@ohos.multimedia.image.d.ts @@ -2157,7 +2157,17 @@ declare namespace image { * @crossplatform * @since 12 */ - SCENE_VERSION = 'HwMnoteSceneVersion' + SCENE_VERSION = 'HwMnoteSceneVersion', + + /** + * GIF LOOP COUNT + * If infinite loop returns 0, other values represent the number of loops + * + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + GIF_LOOP_COUNT = 'GIFLoopCount' } /** @@ -4196,6 +4206,21 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; + /** + * Creates a PixelMap object from surface id. + * + * @param { string } surfaceId - surface id. + * @param { Region } region - The region to surface. + * @returns { PixelMap } Returns the instance if the operation is successful;Otherwise, an exception will be thrown. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 62980105 - Failed to get the data. + * @throws { BusinessError } 62980178 - Failed to create the PixelMap. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + function createPixelMapFromSurfaceSync(surfaceId: string, region: Region): PixelMap; + /** * Creates an ImageSource instance based on the URI. * @@ -4529,7 +4554,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } A Promise instance used to return the PixelMap array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980099 - The shared memory data is abnormal. * @throws { BusinessError } 62980101 - The image data is abnormal. @@ -6439,7 +6463,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } callback Callback used to return the PixelMap array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980099 - The shared memory data is abnormal. * @throws { BusinessError } 62980101 - The image data is abnormal. @@ -6469,7 +6492,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } callback Callback used to return the PixelMap array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980099 - The shared memory data is abnormal. * @throws { BusinessError } 62980101 - The image data is abnormal. @@ -6497,7 +6519,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } A Promise instance used to return the array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -6519,7 +6540,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } callback Callback used to return the array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -6541,7 +6561,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } A Promise instance used to return the array. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980101 - The image data is abnormal. * @throws { BusinessError } 62980137 - Invalid media operation. @@ -6556,7 +6575,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the number. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -6577,7 +6595,6 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the number. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -6601,7 +6618,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the property value. If the operation fails, the default value is returned. - * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed; + * @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types;3.Parameter verification failed; * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980103 - The image data is not supported. * @throws { BusinessError } 62980110 - The image source data is incorrect. @@ -6706,7 +6723,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } key - Name of the properties whose value is to be obtained. * @returns { Promise> } Array of Records instance used to return the * property values. If the operation fails, the null is returned. - * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed; + * @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed; * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980113 - Unknown image format. @@ -6724,7 +6741,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the property value. - * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types; + * @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; * @throws { BusinessError } 62980123 - Images in EXIF format are not supported. * @throws { BusinessError } 62980133 - The EXIF data is out of range. * @throws { BusinessError } 62980135 - The EXIF value is invalid. @@ -6796,7 +6813,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. If the operation fails, an * error message is returned. - * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed; + * @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed; * @throws { BusinessError } 62980123 - Images in EXIF format are not supported. * @throws { BusinessError } 62980133 - The EXIF data is out of range. * @throws { BusinessError } 62980135 - The EXIF value is invalid. diff --git a/api/@ohos.multimedia.media.d.ts b/api/@ohos.multimedia.media.d.ts index 34f9e7be1b043e0877a16a474e2cd99c813ca21c..03ced659a6088b6e78ea0486628428e5e5524577 100755 --- a/api/@ohos.multimedia.media.d.ts +++ b/api/@ohos.multimedia.media.d.ts @@ -1319,6 +1319,13 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Sets the volume. + * @param { number } volume - Relative volume. The value ranges from 0.00 to 1.00. The value 1 indicates the maximum volume (100%). + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ setVolume(volume: number): void; /** @@ -1355,28 +1362,6 @@ declare namespace media { */ getTrackDescription(): Promise>; - /** - * Select specific track to play. - * @param { number } index : Track index returned by getTrackDescription#MD_KEY_TRACK_INDEX - * @returns { Promise } A Promise instance used to return when select track completed. - * @throws { BusinessError } 401 - The parameter check failed. Return by promise. - * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. - * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 12 - */ - selectTrack(index: number): Promise; - - /** - * Deselect specific track to play. - * @param { number } index : Track index returned by getTrackDescription#MD_KEY_TRACK_INDEX - * @returns { Promise } A Promise instance used to return when deselect track completed. - * @throws { BusinessError } 401 - The parameter check failed. Return by promise. - * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. - * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 12 - */ - deselectTrack(index: number): Promise; - /** * Set MediaSource to AVPlayer, this interface is exclusive with fd/url/dataSrc assign. * @param { MediaSource } src : MediaSource instance to be set to the avplayer instance. @@ -1386,6 +1371,7 @@ declare namespace media { *
2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice * @since 12 */ setMediaSource(src: MediaSource, strategy?: PlaybackStrategy): Promise; @@ -1436,6 +1422,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Whether to loop media playback. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ loop: boolean; /** @@ -1445,6 +1437,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Describes audio interrupt mode, refer to {@link #audio.InterruptMode}. If it is not + * set, the default mode will be used. Set it before calling the {@link #play()} in the + * first time in order for the interrupt mode to become effective thereafter. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ audioInterruptMode?: audio.InterruptMode; /** @@ -1454,6 +1454,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 10 */ + /** + * Describes audio renderer info, refer to {@link #audio.AudioRendererInfo}. Set it before + * calling the {@link #prepare()} in the first time in order for the audio renderer info to + * become effective thereafter. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ audioRendererInfo?: audio.AudioRendererInfo; /** @@ -1461,6 +1469,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 10 */ + /** + * Obtains the current audio effect mode, refer to {@link #audio.AudioEffectMode}. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ audioEffectMode ?: audio.AudioEffectMode; /** @@ -1468,6 +1482,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Current playback position. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ readonly currentTime: number; /** @@ -1488,6 +1508,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Playback state. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ readonly state: AVPlayerState; /** @@ -1508,6 +1534,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Video width, valid after prepared. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ readonly width: number; /** @@ -1515,6 +1547,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Video height, valid after prepared. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ readonly height: number; /** @@ -1523,6 +1561,13 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Video scale type. By default, the {@link #VIDEO_SCALE_TYPE_FIT} will be used, for more + * information, refer to {@link #VideoScaleType} . + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ videoScaleType?: VideoScaleType; /** @@ -1531,6 +1576,13 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Set payback speed. + * @param { PlaybackSpeed } speed - playback speed, see @PlaybackSpeed . + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ setSpeed(speed: PlaybackSpeed): void; /** @@ -1543,6 +1595,17 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * select a specified bitrate to playback, only valid for HLS protocol network stream. By default, the + * player will select the appropriate bitrate according to the network connection speed. The + * available bitrate list reported by {@link #on('availableBitrates')}. Set it to select + * a specified bitrate. If the specified bitrate is not in the list of available bitrate, the player + * will select the minimal and closest one from the available bitrate list. + * @param { number } bitrate - the playback bitrate must be expressed in bits per second. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ setBitrate(bitrate: number): void; /** @@ -1554,6 +1617,16 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Set decryption session to codec module. + * @param { drm.MediaKeySession } mediaKeySession - Handle of MediaKeySession to decrypt encrypted media. + * @param { boolean } secureVideoPath - Secure video path required or not. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ setDecryptionConfig(mediaKeySession: drm.MediaKeySession, secureVideoPath: boolean): void; /** @@ -1562,6 +1635,13 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Get media key system info from media source. + * @returns { Array } MediaKeySystemInfo with PSSH. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ getMediaKeySystemInfos(): Array; /** @@ -1571,6 +1651,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Register listens for mediaKeySystemInfoUpdate events. + * @param { 'mediaKeySystemInfoUpdate' } type - Type of the event to listen for. + * @param { function } callback - Callback used to listen for the mediaKeySystemInfoUpdate event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'mediaKeySystemInfoUpdate', callback: (mediaKeySystemInfo: Array) => void): void; /** @@ -1580,6 +1668,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Unregister listens for mediaKeySystemInfoUpdate events. + * @param { 'mediaKeySystemInfoUpdate' } type - Type of the event to listen for. + * @param { function } callback - Callback for event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ off(type: 'mediaKeySystemInfoUpdate', callback?: (mediaKeySystemInfo: Array) => void): void; /** @@ -1619,6 +1715,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for media playback volumeChange event. + * @param { 'volumeChange' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback volume event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'volumeChange', callback: Callback): void; /** * Unregister listens for media playback volumeChange event. @@ -1634,6 +1738,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for media playback endOfStream event. + * @param { 'endOfStream' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback end of stream. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'endOfStream', callback: Callback): void; /** * Unregister listens for media playback endOfStream event. @@ -1679,6 +1791,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for media playback speedDone event. + * @param { 'speedDone' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback speedDone event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'speedDone', callback: Callback): void; /** * Unregister listens for media playback speedDone event. @@ -1694,6 +1814,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for media playback setBitrateDone event. + * @param { 'bitrateDone' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'bitrateDone', callback: Callback): void; /** * Unregister listens for media playback setBitrateDone event. @@ -1739,6 +1867,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for media playback durationUpdate event. + * @param { 'durationUpdate' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'durationUpdate', callback: Callback): void; /** * Unregister listens for media playback durationUpdate event. @@ -1755,6 +1891,15 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for video playback buffering events. + * @param { 'bufferingUpdate' } type - Type of the playback buffering update event to listen for. + * @param { function } callback - Callback used to listen for the buffering update event, + * return BufferingInfoType and the value. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void; /** * Unregister listens for video playback buffering events. @@ -1771,6 +1916,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for start render video frame events. + * @param { 'startRenderFrame' } type - Type of the playback event to listen for. + * @param { Callback } callback - Callback used to listen for the playback event return . + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'startRenderFrame', callback: Callback): void; /** * Unregister listens for start render video frame events. @@ -1786,6 +1939,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for video size change event. + * @param { 'videoSizeChange' } type - Type of the playback event to listen for. + * @param { function } callback - Callback used to listen for the playback event return video size. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'videoSizeChange', callback: (width: number, height: number) => void): void; /** * Unregister listens for video size change event. @@ -1801,6 +1962,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for audio interrupt event, refer to {@link #audio.InterruptEvent} + * @param { 'audioInterrupt' } type - Type of the playback event to listen for. + * @param { function } callback - Callback used to listen for the playback event return audio interrupt info. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void; /** * Unregister listens for audio interrupt event, refer to {@link #audio.InterruptEvent} @@ -1817,6 +1986,15 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ + /** + * Register listens for available bitrate list collect completed events for HLS protocol stream playback. + * This event will be reported after the {@link #prepare} called. + * @param { 'availableBitrates' } type - Type of the playback event to listen for. + * @param { function } callback - Callback used to listen for the playback event return available bitrate list. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'availableBitrates', callback: (bitrates: Array) => void): void; /** * Unregister listens for available bitrate list collect completed events for HLS protocol stream playback. @@ -1886,6 +2064,17 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Subscribes output device change event callback. + * The event is triggered when output device change for this stream. + * @param { 'audioOutputDeviceChangeWithInfo' } type - Type of the event to listen for. + * @param { Callback } callback - Callback used to listen device change event. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ on(type: 'audioOutputDeviceChangeWithInfo', callback: Callback): void; /** @@ -1897,6 +2086,16 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 11 */ + /** + * Unsubscribes output device change event callback. + * @param { 'audioOutputDeviceChangeWithInfo' } type - Type of the event to listen for. + * @param { Callback } callback - Callback used to listen device change event. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ off(type: 'audioOutputDeviceChangeWithInfo', callback?: Callback): void; } @@ -2008,12 +2207,26 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @since 8 */ + /** + * Enumerates buffering info type, for network playback. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ enum BufferingInfoType { /** * begin to buffering * @syscap SystemCapability.Multimedia.Media.Core * @since 8 */ + /** + * begin to buffering + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ BUFFERING_START = 1, /** @@ -2021,6 +2234,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @since 8 */ + /** + * end to buffering + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ BUFFERING_END = 2, /** @@ -2028,6 +2247,12 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @since 8 */ + /** + * buffering percent + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ BUFFERING_PERCENT = 3, /** @@ -2035,17 +2260,48 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @since 8 */ + /** + * cached duration in milliseconds + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ CACHED_DURATION = 4, } /** * Media source descriptor. User can set media data information - * @typedef MediaSource * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ interface MediaSource { + /** + * Set Media Mime Type to help player handle extended Media source. + * @param { AVMimeTypes } mimeType - for MediaSource define. see @ AVMimeTypes. + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ + setMimeType(mimeType: AVMimeTypes): void; + } + + /** + * Enumerates Media Mime types, used for MediaSource define; + * @enum { string } + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ + enum AVMimeTypes { + /** + * Indicate current file is index file for hls Media. + * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice + * @since 12 + */ + APPLICATION_M3U8 = 'application/m3u8', } /** @@ -2053,24 +2309,28 @@ declare namespace media { * * @typedef PlaybackStrategy * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ interface PlaybackStrategy { /** * Choose a stream with width close to it. * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ preferredWidth?: number; /** * Choose a stream with height close to it. * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ preferredHeight?: number; /** * Choose a preferred buffer duration. * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ preferredBufferDuration?: number; @@ -2078,6 +2338,7 @@ declare namespace media { /** * If true, the player should choose HDR stream if exist. * @syscap SystemCapability.Multimedia.Media.Core + * @atomicservice * @since 12 */ preferredHdr?: boolean; @@ -3493,49 +3754,123 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * Enumerates playback speed. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ enum PlaybackSpeed { /** * playback at 0.75x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * playback at 0.75x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_0_75_X = 0, /** * playback at normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * playback at normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_1_00_X = 1, /** * playback at 1.25x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * playback at 1.25x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_1_25_X = 2, /** * playback at 1.75x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * playback at 1.75x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_1_75_X = 3, /** * playback at 2.0x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 */ + /** + * playback at 2.0x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_2_00_X = 4, /** * playback at 0.5x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 12 */ + /** + * playback at 0.5x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_0_50_X = 5, /** * playback at 1.5x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 12 */ + /** + * playback at 1.5x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ SPEED_FORWARD_1_50_X = 6, + /** + * playback at 0.25x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @since 12 + */ + /** + * playback at 0.25x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ + SPEED_FORWARD_0_25_X = 8, + /** + * playback at 0.125x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @since 12 + */ + /** + * playback at 0.125x normal speed + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ + SPEED_FORWARD_0_125_X = 9, } /** @@ -3943,6 +4278,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 9 */ + /** + * Enumerates video scale type. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ enum VideoScaleType { /** * The content is stretched to the fit the display surface rendering area. When @@ -3951,6 +4294,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 9 */ + /** + * The content is stretched to the fit the display surface rendering area. When + * the aspect ratio of the content is not same as the display surface, the aspect + * of the content is not maintained. This is the default scale type. + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ VIDEO_SCALE_TYPE_FIT = 0, /** @@ -3960,6 +4311,14 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 9 */ + /** + * The content is stretched to the fit the display surface rendering area. When + * the aspect ratio of the content is not the same as the display surface, content's + * aspect ratio is maintained and the content is cropped to fit the display surface. + * @syscap SystemCapability.Multimedia.Media.VideoPlayer + * @atomicservice + * @since 12 + */ VIDEO_SCALE_TYPE_FIT_CROP = 1, } diff --git a/api/@ohos.multimedia.sendableImage.d.ets b/api/@ohos.multimedia.sendableImage.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..148498fec1f26cf138aaec00b899eb74a497e33b --- /dev/null +++ b/api/@ohos.multimedia.sendableImage.d.ets @@ -0,0 +1,932 @@ +/* + * Copyright (C) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ImageKit + */ + +import { AsyncCallback } from './@ohos.base'; +import type colorSpaceManager from './@ohos.graphics.colorSpaceManager'; +import type image from './@ohos.multimedia.image'; +import type resourceManager from './@ohos.resourceManager'; +import type rpc from './@ohos.rpc'; +import lang from '../arkts/@arkts.lang'; +import collections from '../arkts/@arkts.collections'; + /** + * This module provides the capability of image codec and access + * @namespace sendableImage + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ +declare namespace sendableImage { + + /** + * Describes the size of an image. + * + * @typedef Size + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + interface Size extends lang.ISendable { + /** + * Height + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + height: number; + + /** + * Width + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + width: number; +} + +/** + * Describes region information. + * + * @typedef Region + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ +interface Region extends lang.ISendable { + /** + * Image size. + * + * @type { Size } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + size: Size; + + /** + * x-coordinate at the upper left corner of the image. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + x: number; + + /** + * y-coordinate at the upper left corner of the image. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + y: number; +} + + /** + * Creates an ImageSource instance based on the URI. + * + * @param { string } uri Image source URI. + * @returns { ImageSource } returns the ImageSource instance if the operation is successful; returns null otherwise. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @atomicservice + * @since 12 + */ + function createImageSource(uri: string): ImageSource; + + /** + * Creates an ImageSource instance based on the file descriptor. + * + * @param { number } fd ID of a file descriptor. + * @returns { ImageSource } Returns the ImageSource instance if the operation is successful; returns null otherwise. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @atomicservice + * @since 12 + */ + function createImageSource(fd: number): ImageSource; + + /** + * Creates an ImageSource instance based on the buffer. + * + * @param { ArrayBuffer } buf The buffer of the image. + * @returns { ImageSource } Returns the ImageSource instance if the operation is successful; returns null otherwise. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + function createImageSource(buf: ArrayBuffer): ImageSource; + + /** + * Creates an ImageReceiver instance. + * + * @param { Size } size - The default {@link Size} in pixels of the Images that this receiver will produce. + * @param { ImageFormat } format - The format of the Image that this receiver will produce. This must be one of the + * {@link ImageFormat} constants. + * @param { number } capacity - The maximum number of images the user will want to access simultaneously. + * @returns { ImageReceiver } Returns the ImageReceiver instance if the operation is successful; returns null otherwise. + * @throws { BusinessError } 401 - The parameter check failed. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + function createImageReceiver(size: image.Size, format: image.ImageFormat, capacity: number): ImageReceiver; + + type ISendable = lang.ISendable; + + /** + * Create PixelMap by data buffer. + * + * @param { ArrayBuffer } colors The image color buffer. + * @param { InitializationOptions } options Initialization options for PixelMap. + * @returns { Promise } A Promise instance used to return the PixelMap object. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + function createPixelMap(colors: ArrayBuffer, options: image.InitializationOptions): Promise; + + /** + * Create PixelMap by data buffer. + * + * @param { ArrayBuffer } colors The image color buffer. + * @param { InitializationOptions } options Initialization options for PixelMap. + * @returns { PixelMap } Returns the instance if the operation is successful;Otherwise, return undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + function createPixelMapSync(colors: ArrayBuffer, options: image.InitializationOptions): PixelMap; + + /** + * Creates a PixelMap object based on MessageSequence parameter. + * + * @param { rpc.MessageSequence } sequence - rpc.MessageSequence parameter. + * @returns { PixelMap } Returns the instance if the operation is successful. + * Otherwise, an exception will be thrown. + * @throws { BusinessError } 62980096 - Operation failed. + * @throws { BusinessError } 62980097 - IPC error. + * @throws { BusinessError } 62980115 - Invalid input parameter. + * @throws { BusinessError } 62980105 - Failed to get the data. + * @throws { BusinessError } 62980177 - Abnormal API environment. + * @throws { BusinessError } 62980178 - Failed to create the PixelMap. + * @throws { BusinessError } 62980179 - Abnormal buffer size. + * @throws { BusinessError } 62980180 - FD mapping failed. + * @throws { BusinessError } 62980246 - Failed to read the PixelMap. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + function createPixelMapFromParcel(sequence: rpc.MessageSequence): PixelMap; + + /** + * Creates a PixelMap object from surface id. + * + * @param { string } surfaceId - surface id. + * @param { Region } region - The region to surface. + * @returns { Promise } Returns the instance if the operation is successful. + * Otherwise, an exception will be thrown. + * @throws { BusinessError } 62980115 - If the image parameter invalid. + * @throws { BusinessError } 62980105 - Failed to get the data. + * @throws { BusinessError } 62980178 - Failed to create the PixelMap. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + function createPixelMapFromSurface(surfaceId: string, region: image.Region): Promise; + + /** + * Creates a sendable image PixelMap from image PixelMap. + * + * @param { image.PixelMap } pixelmap - the src pixelmap. + * @returns { PixelMap } Returns the instance if the operation is successful. + * Otherwise, an exception will be thrown. + * @throws { BusinessError } 401 - If the image parameter invalid. Possible causes: + * 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 62980104 - Failed to initialize the internal object. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + function convertFromPixelMap(pixelmap: image.PixelMap): PixelMap; + + /** + * Creates a image PixelMap from sendable image PixelMap. + * + * @param { PixelMap } pixelmap - the src pixelmap. + * @returns { image.PixelMap } Returns the instance if the operation is successful. + * Otherwise, an exception will be thrown. + * @throws { BusinessError } 401 - If the image parameter invalid. Possible causes: + * 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 62980104 - Failed to initialize the internal object. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + function convertToPixelMap(pixelmap: PixelMap): image.PixelMap; + + /** + * Sendable PixelMap instance. + * + * @typedef PixelMap + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + interface PixelMap extends ISendable { + /** + * Whether the image pixelmap can be edited. + * + * @type { boolean } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + readonly isEditable: boolean; + + /** + * Reads image pixelmap data and writes the data to an ArrayBuffer. This method uses + * a promise to return the result. + * + * @param { ArrayBuffer } dst A buffer to which the image pixelmap data will be written. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + readPixelsToBuffer(dst: ArrayBuffer): Promise; + + /** + * Reads image pixelmap data and writes the data to an ArrayBuffer. + * + * @param { ArrayBuffer } dst A buffer to which the image pixelmap data will be written. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + readPixelsToBufferSync(dst: ArrayBuffer): void; + + /** + * Reads image pixelmap data in an area. This method uses a promise to return the data read. + * + * @param { PositionArea } area Area from which the image pixelmap data will be read. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + readPixels(area: image.PositionArea): Promise; + + /** + * Reads image pixelmap data in an area. + * + * @param { PositionArea } area Area from which the image pixelmap data will be read. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + readPixelsSync(area: image.PositionArea): void; + + /** + * Writes image pixelmap data to the specified area. This method uses a promise to return + * the operation result. + * + * @param { PositionArea } area Area to which the image pixelmap data will be written. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + writePixels(area: image.PositionArea): Promise; + + /** + * Writes image pixelmap data to the specified area. + * + * @param { PositionArea } area Area to which the image pixelmap data will be written. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + writePixelsSync(area: image.PositionArea): void; + + /** + * Reads image data in an ArrayBuffer and writes the data to a PixelMap object. This method + * uses a promise to return the result. + * + * @param { ArrayBuffer } src A buffer from which the image data will be read. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + writeBufferToPixels(src: ArrayBuffer): Promise; + + /** + * Reads image data in an ArrayBuffer and writes the data to a PixelMap object. + * + * @param { ArrayBuffer } src A buffer from which the image data will be read. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + writeBufferToPixelsSync(src: ArrayBuffer): void; + + /** + * Obtains pixelmap information about this image. This method uses a promise to return the information. + * + * @returns { Promise } A Promise instance used to return the image pixelmap information. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + getImageInfo(): Promise; + + /** + * Get image information from image source. + * + * @returns { ImageInfo } the image information. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @atomicservice + * @since 12 + */ + getImageInfoSync(): image.ImageInfo; + + /** + * Obtains the number of bytes in each line of the image pixelmap. + * + * @returns { number } Number of bytes in each line. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + getBytesNumberPerRow(): number; + + /** + * Obtains the total number of bytes of the image pixelmap. + * + * @returns { number } Total number of bytes. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + getPixelBytesNumber(): number; + + /** + * Obtains the density of the image pixelmap. + * + * @returns { number } The number of density. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + getDensity(): number; + + /** + * Set the transparent rate of pixelmap. This method uses a promise to return the result. + * + * @param { number } rate The value of transparent rate. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + opacity(rate: number): Promise; + + /** + * Set the transparent rate of pixelmap. + * + * @param { number } rate The value of transparent rate. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + opacitySync(rate: number): void; + + /** + * Obtains new pixelmap with alpha information. This method uses a promise to return the information. + * + * @returns { Promise } A Promise instance used to return the new image pixelmap. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + createAlphaPixelmap(): Promise; + + /** + * Obtains new pixelmap with alpha information. + * + * @returns { PixelMap } return the new image pixelmap. + * If the operation fails, an error message is returned. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + createAlphaPixelmapSync(): PixelMap; + + /** + * Image zoom in width and height. This method uses a promise to return the result. + * + * @param { number } x The zoom value of width. + * @param { number } y The zoom value of height. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + scale(x: number, y: number): Promise; + + /** + * Image zoom in width and height. + * + * @param { number } x The zoom value of width. + * @param { number } y The zoom value of height. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + scaleSync(x: number, y: number): void; + + /** + * Image position transformation. This method uses a promise to return the result. + * + * @param { number } x The position value of width. + * @param { number } y The position value of height. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + translate(x: number, y: number): Promise; + + /** + * Image position transformation. + * + * @param { number } x The position value of width. + * @param { number } y The position value of height. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + translateSync(x: number, y: number): void; + + /** + * Image rotation. This method uses a promise to return the result. + * + * @param { number } angle The rotation angle. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + rotate(angle: number): Promise; + + /** + * Image rotation. + * + * @param { number } angle The rotation angle. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + rotateSync(angle: number): void; + + /** + * Image flipping. This method uses a promise to return the result. + * + * @param { boolean } horizontal Is flip in horizontal. + * @param { boolean } vertical Is flip in vertical. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + flip(horizontal: boolean, vertical: boolean): Promise; + + /** + * Image flipping. + * + * @param { boolean } horizontal Is flip in horizontal. + * @param { boolean } vertical Is flip in vertical. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + flipSync(horizontal: boolean, vertical: boolean): void; + + /** + * Crop the image. This method uses a promise to return the result. + * + * @param { Region } region The region to crop. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + crop(region: image.Region): Promise; + + /** + * Crop the image. + * + * @param { Region } region The region to crop. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 501 - Resource Unavailable. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + cropSync(region: image.Region): void; + + /** + * Get color space of pixelmap. + * + * @returns { colorSpaceManager.ColorSpaceManager } If the operation fails, an error message is returned. + * @throws { BusinessError } 62980101 - If the image data abnormal. + * @throws { BusinessError } 62980103 - If the image data unsupport. + * @throws { BusinessError } 62980115 - If the image parameter invalid. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + getColorSpace(): colorSpaceManager.ColorSpaceManager; + + /** + * Set color space of pixelmap. + * + * This method is only used to set the colorspace property of PixelMap, + * while all pixel data remains the same after calling this method. + * If you want to change colorspace for all pixels, use method + * {@Link #applyColorSpace(colorSpaceManager.ColorSpaceManager)}. + * + * @param { colorSpaceManager.ColorSpaceManager } colorSpace The color space for pixelmap. + * @throws { BusinessError } 62980111 - If the operation invalid. + * @throws { BusinessError } 62980115 - If the image parameter invalid. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + setColorSpace(colorSpace: colorSpaceManager.ColorSpaceManager): void; + + /** + * Is it stride Alignment + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + readonly isStrideAlignment: boolean; + + /** + * Apply color space of pixelmap, the pixels will be changed by input color space. + * This method uses a promise to return the result. + * + * This method is used to change color space of PixelMap. + * Pixel data will be changed by calling this method. + * If you want to set the colorspace property of PixelMap only, + * use method {@Link #setColorSpace(colorSpaceManager.ColorSpaceManager)}. + * + * @param { colorSpaceManager.ColorSpaceManager } targetColorSpace - The color space for pixelmap. + * @returns { Promise } A Promise instance used to return the operation result. + * If the operation fails, an error message is returned. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + * 2.Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 62980104 - Failed to initialize the internal object. + * @throws { BusinessError } 62980108 - Failed to convert the color space. + * @throws { BusinessError } 62980115 - Invalid image parameter. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @since 12 + */ + applyColorSpace(targetColorSpace: colorSpaceManager.ColorSpaceManager): Promise; + + /** + * Releases this PixelMap object. This method uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the instance release result. + * If the operation fails, an error message is returned. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @atomicservice + * @since 12 + */ + release(): Promise; + + /** + * Marshalling PixelMap and write into MessageSequence. + * + * @param { rpc.MessageSequence } sequence rpc.MessageSequence parameter. + * @throws { BusinessError } 62980115 - Invalid image parameter. + * @throws { BusinessError } 62980097 - IPC error. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + marshalling(sequence: rpc.MessageSequence): void; + + /** + * Creates a PixelMap object based on MessageSequence parameter. + * + * @param { rpc.MessageSequence } sequence rpc.MessageSequence parameter. + * @returns { Promise } A Promise instance used to return the PixelMap object. + * @throws { BusinessError } 62980115 - Invalid image parameter. + * @throws { BusinessError } 62980097 - IPC error. + * @throws { BusinessError } 62980096 - The operation failed. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + unmarshalling(sequence: rpc.MessageSequence): Promise; + } + + /** + * ImageSource instance. + * + * @typedef ImageSource + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + interface ImageSource { + /** + * Creates a PixelMap object based on image decoding parameters. This method uses a promise to + * return the object. + * + * @param { DecodingOptions } options Image decoding parameters. + * @returns { Promise } A Promise instance used to return the PixelMap object. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + createPixelMap(options?: image.DecodingOptions): Promise; + + /** + * Releases an ImageSource instance and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the operation result. + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @crossplatform + * @since 12 + */ + release(): Promise; + } + + /** + * Provides basic image operations, including obtaining image information, and reading and writing image data. + * + * @typedef Image + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + interface Image extends lang.ISendable { + /** + * Sets or gets the image area to crop, default is size. + * + * @type { Region } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + clipRect: Region; + + /** + * Image size. + * + * @type { Size } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + readonly size: Size; + + /** + * Image format. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + readonly format: number; + + /** + * Image timestamp. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + readonly timestamp: number; + + /** + * Get component buffer from image and uses a promise to return the result. + * + * @param { ComponentType } componentType The component type of image. + * @returns { Promise } A Promise instance used to return the component buffer. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + getComponent(componentType: image.ComponentType): Promise; + + /** + * Release current image to receive another and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the operation result. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 12 + */ + release(): Promise; + } + + /** + * Image receiver object. + * + * @typedef ImageReceiver + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + interface ImageReceiver { + /** + * Image size. + * + * @type { Size } + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + readonly size: image.Size; + + /** + * Image capacity. + * + * @type { number } + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + readonly capacity: number; + + /** + * Image format. + * + * @type { ImageFormat } + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + readonly format: image.ImageFormat; + + /** + * Get an id which indicates a surface and can be used to set to Camera or other component can receive a surface + * and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the surface id. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + getReceivingSurfaceId(): Promise; + + /** + * Get lasted image from receiver and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the latest image. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + readLatestImage(): Promise; + + /** + * Get next image from receiver and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the next image. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + readNextImage(): Promise; + + /** + * Subscribe callback when receiving an image + * + * @param { 'imageArrival' } type Callback used to return the next image. + * @param { AsyncCallback } callback Callback used to return image. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + on(type: 'imageArrival', callback: AsyncCallback): void; + + /** + * Release image receiver instance and uses a promise to return the result. + * + * @returns { Promise } A Promise instance used to return the operation result. + * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @since 12 + */ + release(): Promise; + } + +} + +export default sendableImage; \ No newline at end of file diff --git a/api/@ohos.multimedia.systemSoundManager.d.ts b/api/@ohos.multimedia.systemSoundManager.d.ts index dfe0dc01fec0cacb5e0d96104d1e77fc50425784..134f2877c244a2a2bd30992fdb50c330c8921554 100644 --- a/api/@ohos.multimedia.systemSoundManager.d.ts +++ b/api/@ohos.multimedia.systemSoundManager.d.ts @@ -165,7 +165,9 @@ declare namespace systemSoundManager { * @param { RingtoneType } type - Ringtone type to set. * @returns { Promise } Promise used to return the set uri result. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400103 - I/O error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -205,7 +207,9 @@ declare namespace systemSoundManager { * @param { RingtoneType } type - Ringtone type to get. * @returns { Promise } Promise used to return the ringtone uri maintained in system. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400103 - I/O error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -245,7 +249,9 @@ declare namespace systemSoundManager { * @param { RingtoneType } type - Ringtone type to get. * @returns { Promise } Promise used to return a ringtone player instance. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 11 @@ -259,7 +265,9 @@ declare namespace systemSoundManager { * @param { SystemToneType } type - System tone type to set. * @returns { Promise } Promise used to return the result of set system tone uri. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400103 - I/O error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -273,7 +281,9 @@ declare namespace systemSoundManager { * @param { SystemToneType } type - System tone type to get. * @returns { Promise } Promise used to return the system tone maintained in system. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400103 - I/O error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -287,7 +297,9 @@ declare namespace systemSoundManager { * @param { SystemToneType } type - System tone type to get. * @returns { Promise } Promise used to return the SystemTonePlayer. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 11 @@ -297,6 +309,7 @@ declare namespace systemSoundManager { /** * Ringtone player object. + * @typedef { _RingtonePlayer } RingtonePlayer * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 10 @@ -305,6 +318,7 @@ declare namespace systemSoundManager { /** * SystemTone player object. + * @typedef { _SystemTonePlayer } SystemTonePlayer * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 11 @@ -313,6 +327,7 @@ declare namespace systemSoundManager { /** * Interface for ringtone options. + * @typedef { _RingtoneOptions } RingtoneOptions * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 10 @@ -321,6 +336,7 @@ declare namespace systemSoundManager { /** * System tone options. + * @typedef { _SystemToneOptions } SystemToneOptions * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 11 diff --git a/api/@ohos.multimodalInput.infraredEmitter.d.ts b/api/@ohos.multimodalInput.infraredEmitter.d.ts index 7c3e7dfe7c4c391c5559ee8213c89efd9faa1e29..e5f5346a81c69aaa601b0fbc19fd272d8867f061 100644 --- a/api/@ohos.multimodalInput.infraredEmitter.d.ts +++ b/api/@ohos.multimodalInput.infraredEmitter.d.ts @@ -13,6 +13,11 @@ * limitations under the License. */ +/** + * @file + * @kit InputKit + */ + /** * Declares the APIs for configuring attributes of the IR emitter. * diff --git a/api/@ohos.multimodalInput.intentionCode.d.ts b/api/@ohos.multimodalInput.intentionCode.d.ts index 317fe16641f22b8a2706e64546f5626a62b425b1..79445f8cc2a961ba785b56c8d962f5ff9ba2d96f 100644 --- a/api/@ohos.multimodalInput.intentionCode.d.ts +++ b/api/@ohos.multimodalInput.intentionCode.d.ts @@ -25,6 +25,14 @@ * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ +/** + * IntentionCode + * + * @enum { number } + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ export declare enum IntentionCode { /** * INTENTION_UNKNOWN @@ -32,6 +40,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_UNKNOWN + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_UNKNOWN = -1, /** @@ -40,6 +55,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_UP + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_UP = 1, /** @@ -48,6 +70,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_DOWN + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_DOWN = 2, /** @@ -56,6 +85,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_LEFT + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_LEFT = 3, /** @@ -64,6 +100,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_RIGHT + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_RIGHT = 4, /** @@ -72,6 +115,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_SELECT + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_SELECT = 5, /** @@ -80,6 +130,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_ESCAPE + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_ESCAPE = 6, /** @@ -88,6 +145,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_BACK + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_BACK = 7, /** @@ -96,6 +160,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_FORWARD + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_FORWARD = 8, /** @@ -104,6 +175,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_MENU + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_MENU = 9, /** @@ -112,6 +190,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_PAGE_UP + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_PAGE_UP = 11, /** @@ -120,6 +205,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_PAGE_DOWN + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_PAGE_DOWN = 12, /** @@ -128,6 +220,13 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_ZOOM_OUT + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_ZOOM_OUT = 13, /** @@ -136,5 +235,12 @@ export declare enum IntentionCode { * @syscap SystemCapability.MultimodalInput.Input.Core * @since 10 */ + /** + * INTENTION_ZOOM_IN + * + * @syscap SystemCapability.MultimodalInput.Input.Core + * @atomicservice + * @since 12 + */ INTENTION_ZOOM_IN = 14 } diff --git a/api/@ohos.multimodalInput.pointer.d.ts b/api/@ohos.multimodalInput.pointer.d.ts index 4cabe33e42f04fa87aac68261bed9231b1260e05..b7cf5dd2d2707561ae3941357ea8aa61113833aa 100644 --- a/api/@ohos.multimodalInput.pointer.d.ts +++ b/api/@ohos.multimodalInput.pointer.d.ts @@ -28,6 +28,14 @@ import type image from './@ohos.multimedia.image'; * @syscap SystemCapability.MultimodalInput.Input.Pointer * @since 9 */ +/** + * Declares interfaces related to mouse pointer attributes. + * + * @namespace pointer + * @syscap SystemCapability.MultimodalInput.Input.Pointer + * @atomicservice + * @since 12 + */ declare namespace pointer { /** * Pointer style. @@ -36,6 +44,14 @@ declare namespace pointer { * @syscap SystemCapability.MultimodalInput.Input.Pointer * @since 9 */ + /** + * Pointer style. + * + * @enum { number } + * @syscap SystemCapability.MultimodalInput.Input.Pointer + * @atomicservice + * @since 12 + */ enum PointerStyle { /** * Default @@ -379,6 +395,13 @@ declare namespace pointer { * @syscap SystemCapability.MultimodalInput.Input.Pointer * @since 10 */ + /** + * Loading state with dynamic cursor + * + * @syscap SystemCapability.MultimodalInput.Input.Pointer + * @atomicservice + * @since 12 + */ LOADING, /** @@ -387,6 +410,13 @@ declare namespace pointer { * @syscap SystemCapability.MultimodalInput.Input.Pointer * @since 10 */ + /** + * Running state with dynamic cursor + * + * @syscap SystemCapability.MultimodalInput.Input.Pointer + * @atomicservice + * @since 12 + */ RUNNING } diff --git a/api/@ohos.net.connection.d.ts b/api/@ohos.net.connection.d.ts index 7f8d5ebe606006fd5506f1b43aeef149dc7fe6ea..7fead88e60aea9eb59b0a2ac39590eed12db6d87 100644 --- a/api/@ohos.net.connection.d.ts +++ b/api/@ohos.net.connection.d.ts @@ -129,7 +129,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of getDefaultNet. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -141,7 +141,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of getDefaultNet. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -156,7 +156,7 @@ declare namespace connection { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -167,7 +167,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -182,7 +182,7 @@ declare namespace connection { * @returns { NetHandle } if the default network is not activated. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -193,7 +193,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { NetHandle } if the default network is not activated. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -208,7 +208,7 @@ declare namespace connection { * @param { AsyncCallback> } callback - the callback of getAllNets. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -221,7 +221,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -234,7 +234,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { Array } Returns data networks that are activated. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -250,7 +250,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -266,7 +266,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -282,7 +282,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -298,7 +298,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -312,7 +312,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -329,7 +329,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -343,7 +343,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -360,7 +360,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -374,7 +374,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice @@ -389,7 +389,7 @@ declare namespace connection { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -401,7 +401,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -413,7 +413,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { boolean } Returns true if the current network is metered, else returns false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -427,7 +427,7 @@ declare namespace connection { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -439,7 +439,7 @@ declare namespace connection { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform @@ -453,7 +453,7 @@ declare namespace connection { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -463,7 +463,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform @@ -476,7 +476,7 @@ declare namespace connection { * @permission ohos.permission.GET_NETWORK_INFO * @returns { boolean } Returns true if the default data network is activated, else returns false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -491,7 +491,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. @@ -506,7 +506,7 @@ declare namespace connection { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. @@ -522,7 +522,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. @@ -537,7 +537,7 @@ declare namespace connection { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. @@ -553,7 +553,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -568,7 +568,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -583,7 +583,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -598,7 +598,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -613,7 +613,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -628,7 +628,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -640,7 +640,7 @@ declare namespace connection { * @param { AsyncCallback } callback - Returns the {@link NetHandle} bound to the process; * returns {@code null} if no {@link NetHandle} is bound to the process.For details, see {@link NetHandle}. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -650,7 +650,7 @@ declare namespace connection { /** * Obtains the {@link NetHandle} bound to a process using {@link setAppNet}. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -660,7 +660,7 @@ declare namespace connection { /** * Obtains the {@link NetHandle} bound to a process using {@link setAppNet}. * @returns { NetHandle } Returns the {@link NetHandle} bound to a process using {@link setAppNet}. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -677,7 +677,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -694,7 +694,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -710,7 +710,7 @@ declare namespace connection { * In other cases, the proxy settings of default network are returned. * * @param { AsyncCallback } callback - Returns the default {@link HttpProxy} settings. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -726,7 +726,7 @@ declare namespace connection { * In other cases, the proxy settings of default network are returned. * * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 @@ -738,7 +738,7 @@ declare namespace connection { * @param { AsyncCallback } callback - Returns the proxy settings. For details, see {@link HttpProxy}. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -750,7 +750,7 @@ declare namespace connection { * Obtains the network independent global {@link HttpProxy} proxy settings. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -777,7 +777,7 @@ declare namespace connection { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -794,7 +794,7 @@ declare namespace connection { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -811,7 +811,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -827,7 +827,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -842,7 +842,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -857,7 +857,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -871,7 +871,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -884,7 +884,7 @@ declare namespace connection { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -899,7 +899,7 @@ declare namespace connection { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. @@ -1071,10 +1071,10 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of register. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2101008 - The same callback exists. - * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum. + * @throws { BusinessError } 2101008 - The callback does not exist. + * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum allowed. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 */ @@ -1084,10 +1084,10 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of register. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2101008 - The same callback exists. - * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum. + * @throws { BusinessError } 2101008 - The callback does not exist. + * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum allowed. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @since 10 @@ -1098,10 +1098,10 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of register. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2101008 - The same callback exists. - * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum. + * @throws { BusinessError } 2101008 - The callback does not exist. + * @throws { BusinessError } 2101022 - The number of requests exceeded the maximum allowed. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice @@ -1114,7 +1114,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of unregister. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2101007 - The callback is not exists. * @syscap SystemCapability.Communication.NetManager.Core @@ -1125,7 +1125,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of unregister. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2101007 - The callback is not exists. * @syscap SystemCapability.Communication.NetManager.Core @@ -1137,7 +1137,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of unregister. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2101007 - The callback is not exists. * @syscap SystemCapability.Communication.NetManager.Core @@ -1149,7 +1149,7 @@ declare namespace connection { * Cancels listening for network status changes. * @param { AsyncCallback } callback - the callback of unregister. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2101007 - The callback is not exists. * @syscap SystemCapability.Communication.NetManager.Core @@ -1309,7 +1309,7 @@ declare namespace connection { * @param { AsyncCallback } callback - the callback of bindSocket. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -1324,7 +1324,7 @@ declare namespace connection { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 9 @@ -1339,7 +1339,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -1354,7 +1354,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -1369,7 +1369,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 @@ -1384,7 +1384,7 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 8 diff --git a/api/@ohos.net.ethernet.d.ts b/api/@ohos.net.ethernet.d.ts index 84cc39812f7e6d2cba58a185dbf35d422396bdfe..e3a0de3c68ade68ab379bda85624815a303bacbd 100644 --- a/api/@ohos.net.ethernet.d.ts +++ b/api/@ohos.net.ethernet.d.ts @@ -43,7 +43,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201005 - Device information does not exist. * @syscap SystemCapability.Communication.NetManager.Ethernet @@ -61,7 +61,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201005 - Device information does not exist. * @syscap SystemCapability.Communication.NetManager.Ethernet @@ -80,7 +80,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201004 - Invalid Ethernet profile. * @throws { BusinessError } 2201005 - Device information does not exist. @@ -102,7 +102,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201004 - Invalid Ethernet profile. * @throws { BusinessError } 2201005 - Device information does not exist. @@ -123,7 +123,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201005 - Device information does not exist. * @syscap SystemCapability.Communication.NetManager.Ethernet @@ -141,7 +141,7 @@ declare namespace ethernet { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2201005 - Device information does not exist. * @syscap SystemCapability.Communication.NetManager.Ethernet @@ -156,7 +156,7 @@ declare namespace ethernet { * @param { AsyncCallback> } callback - the callback of getAllActiveIfaces. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Ethernet * @systemapi Hide this for inner system use. @@ -170,7 +170,7 @@ declare namespace ethernet { * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Ethernet * @systemapi Hide this for inner system use. diff --git a/api/@ohos.net.http.d.ts b/api/@ohos.net.http.d.ts index 534329e298272f1c6a25ef730a08ed1357266ca6..57e560b119090d4af5dd09161057e03cabc1b27a 100644 --- a/api/@ohos.net.http.d.ts +++ b/api/@ohos.net.http.d.ts @@ -563,34 +563,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 6 */ @@ -602,34 +602,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 @@ -642,34 +642,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice @@ -686,34 +686,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 6 */ @@ -726,34 +726,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 @@ -767,34 +767,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice @@ -811,34 +811,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 6 */ @@ -851,34 +851,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 @@ -892,34 +892,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice @@ -936,34 +936,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 10 */ @@ -978,34 +978,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 10 */ @@ -1020,34 +1020,34 @@ declare namespace http { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. - * @throws { BusinessError } 2300003 - URL using bad/illegal format or missing URL. - * @throws { BusinessError } 2300005 - Couldn't resolve proxy name. - * @throws { BusinessError } 2300006 - Couldn't resolve host name. - * @throws { BusinessError } 2300007 - Couldn't connect to server. - * @throws { BusinessError } 2300008 - Weird server reply. - * @throws { BusinessError } 2300009 - Access denied to remote resource. + * @throws { BusinessError } 2300003 - Invalid URL format or missing URL. + * @throws { BusinessError } 2300005 - Failed to resolve the proxy name. + * @throws { BusinessError } 2300006 - Failed to resolve the host name. + * @throws { BusinessError } 2300007 - Failed to connect to the server. + * @throws { BusinessError } 2300008 - Invalid server response. + * @throws { BusinessError } 2300009 - Access to the remote resource denied. * @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer. * @throws { BusinessError } 2300018 - Transferred a partial file. - * @throws { BusinessError } 2300023 - Failed writing received data to disk/application. + * @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application. * @throws { BusinessError } 2300025 - Upload failed. - * @throws { BusinessError } 2300026 - Failed to open/read local data from file/application. + * @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application. * @throws { BusinessError } 2300027 - Out of memory. - * @throws { BusinessError } 2300028 - Timeout was reached. - * @throws { BusinessError } 2300047 - Number of redirects hit maximum amount. - * @throws { BusinessError } 2300052 - Server returned nothing (no headers, no data). - * @throws { BusinessError } 2300055 - Failed sending data to the peer. - * @throws { BusinessError } 2300056 - Failure when receiving data from the peer. - * @throws { BusinessError } 2300058 - Problem with the local SSL certificate. - * @throws { BusinessError } 2300059 - Couldn't use specified SSL cipher. - * @throws { BusinessError } 2300060 - SSL peer certificate or SSH remote key was not OK. - * @throws { BusinessError } 2300061 - Unrecognized or bad HTTP Content or Transfer-Encoding. + * @throws { BusinessError } 2300028 - Operation timeout. + * @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed. + * @throws { BusinessError } 2300052 - The server returned nothing (no header or data). + * @throws { BusinessError } 2300055 - Failed to send data to the peer. + * @throws { BusinessError } 2300056 - Failed to receive data from the peer. + * @throws { BusinessError } 2300058 - Local SSL certificate error. + * @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used. + * @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key. + * @throws { BusinessError } 2300061 - Invalid HTTP encoding format. * @throws { BusinessError } 2300063 - Maximum file size exceeded. - * @throws { BusinessError } 2300070 - Disk full or allocation exceeded. + * @throws { BusinessError } 2300070 - Remote disk full. * @throws { BusinessError } 2300073 - Remote file already exists. - * @throws { BusinessError } 2300077 - Problem with the SSL CA cert (path? access rights?). + * @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is unaccessible. * @throws { BusinessError } 2300078 - Remote file not found. - * @throws { BusinessError } 2300094 - An authentication function returned an error. - * @throws { BusinessError } 2300999 - Unknown Other Error. + * @throws { BusinessError } 2300094 - Authentication error. + * @throws { BusinessError } 2300999 - Unknown error. * @syscap SystemCapability.Communication.NetStack * @since 10 */ diff --git a/api/@ohos.net.mdns.d.ts b/api/@ohos.net.mdns.d.ts index c638668d3ffcea912d97017532c883c4bb05acff..934229cd7202d01889cf5f510d2d42916ebc187a 100644 --- a/api/@ohos.net.mdns.d.ts +++ b/api/@ohos.net.mdns.d.ts @@ -49,11 +49,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of addLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. - * @throws { BusinessError } 2204008 - Service instance duplicated. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -63,11 +63,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of addLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. - * @throws { BusinessError } 2204008 - Service instance duplicated. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 @@ -81,11 +81,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. - * @throws { BusinessError } 2204008 - Service instance duplicated. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -95,11 +95,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. - * @throws { BusinessError } 2204008 - Service instance duplicated. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 @@ -112,11 +112,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of removeLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204002 - Callback not found. - * @throws { BusinessError } 2204008 - Service instance not found. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -126,11 +126,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of removeLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204002 - Callback not found. - * @throws { BusinessError } 2204008 - Service instance not found. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 @@ -144,11 +144,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204002 - Callback not found. - * @throws { BusinessError } 2204008 - Service instance not found. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -158,11 +158,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204002 - Callback not found. - * @throws { BusinessError } 2204008 - Service instance not found. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204008 - Failed to delete the service instance. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 @@ -196,11 +196,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of resolveLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. * @throws { BusinessError } 2204006 - Request timeout. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -210,11 +210,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @param { AsyncCallback } callback - the callback of resolveLocalService. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. * @throws { BusinessError } 2204006 - Request timeout. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 @@ -228,11 +228,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. * @throws { BusinessError } 2204006 - Request timeout. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @since 10 */ @@ -242,11 +242,11 @@ declare namespace mdns { * @param { LocalServiceInfo } serviceInfo - Information about the mDNS service. {@link LocalServiceInfo} * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2204003 - Callback duplicated. * @throws { BusinessError } 2204006 - Request timeout. - * @throws { BusinessError } 2204010 - Send packet failed. + * @throws { BusinessError } 2204010 - Failed to send the message. * @syscap SystemCapability.Communication.NetManager.MDNS * @atomicservice * @since 11 diff --git a/api/@ohos.net.policy.d.ts b/api/@ohos.net.policy.d.ts index 497e059aee1ebe6be7ad66e0e05f3627d39b2020..bb95e147b584b6e6a9106a8d72c6e218648659c9 100644 --- a/api/@ohos.net.policy.d.ts +++ b/api/@ohos.net.policy.d.ts @@ -44,7 +44,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -61,7 +61,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -77,7 +77,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -93,7 +93,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -110,7 +110,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -127,7 +127,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -145,7 +145,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -163,7 +163,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -180,7 +180,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -197,7 +197,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -214,7 +214,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -231,7 +231,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -249,7 +249,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -267,7 +267,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -285,7 +285,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -303,7 +303,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -320,7 +320,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -337,7 +337,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -353,7 +353,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -368,7 +368,7 @@ declare namespace policy { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -387,7 +387,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -406,7 +406,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -424,7 +424,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -442,7 +442,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -458,7 +458,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -473,7 +473,7 @@ declare namespace policy { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -491,7 +491,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -509,7 +509,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -525,7 +525,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -540,7 +540,7 @@ declare namespace policy { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -557,7 +557,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -574,7 +574,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -582,60 +582,6 @@ declare namespace policy { */ function resetPolicies(simId: string): Promise; - /** - * Set the policy to access the network of the specified application. - * - * @permission ohos.permission.MANAGE_NET_STRATEGY - * @param { number } uid - The specified UID of application. - * @param { NetworkAccessPolicy } policy - The network access policy of application. For details, see {@link NetworkAccessPolicy}. - * @param { boolean } [isReconfirmed] - Whether this operation is reconfirmed by user or not. Default false. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - function setNetworkAccessPolicy(uid: number, policy: NetworkAccessPolicy, isReconfirmed?: boolean): Promise - - /** - * Query the network access policy of the specified application. - * - * @permission ohos.permission.MANAGE_NET_STRATEGY - * @param { number } uid - The specified UID of application. - * @returns { Promise } Returns the network access policy of the application. For details, see {@link NetworkAccessPolicy}. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - function getNetworkAccessPolicy(uid: number): Promise; - - /** - * Query the network access policy of all applications. - * @permission ohos.permission.MANAGE_NET_STRATEGY - * @returns { Promise } the network access policy of all applications. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - function getNetworkAccessPolicy(): Promise; - /** * Register uid policy change listener. * @permission ohos.permission.MANAGE_NET_STRATEGY @@ -645,7 +591,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -660,7 +606,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -677,7 +623,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -692,7 +638,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -709,7 +655,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -724,7 +670,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -741,7 +687,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -756,7 +702,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -773,7 +719,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -790,7 +736,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -807,7 +753,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -824,7 +770,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -841,7 +787,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -858,7 +804,7 @@ declare namespace policy { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -1241,49 +1187,6 @@ declare namespace policy { */ NET_POLICY_REJECT_METERED_BACKGROUND = 1 << 1, } - - /** - * Network policies that limit the specified UID of application to access the network. - * @interface NetworkAccessPolicy - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - export interface NetworkAccessPolicy { - /** - * Indicate whether the application can be allowed to access the network by wifi. - * @type { ?boolean } - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - allowWiFi?: boolean; - /** - * Indicate whether the application can be allowed to access the network by cellular. - * @type { ?boolean } - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - allowCellular?: boolean; - } - - /** - * Provides the container definition for network access policy key-value pairs. - * @interface UidNetworkAccessPolicy - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - export interface UidNetworkAccessPolicy { - /** - * @type key:value pair. Key indicates the specified UID of an application. For value, see @NetworkAccessPolicy. - * @syscap SystemCapability.Communication.NetManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - [uid: number]: NetworkAccessPolicy; - } } export default policy; diff --git a/api/@ohos.net.sharing.d.ts b/api/@ohos.net.sharing.d.ts index d10cce460324924b7ea0f733077706f5c4a13b49..9681904f2ce44a20108d954892b9b107f101d6f2 100644 --- a/api/@ohos.net.sharing.d.ts +++ b/api/@ohos.net.sharing.d.ts @@ -42,7 +42,7 @@ declare namespace sharing { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing @@ -57,7 +57,7 @@ declare namespace sharing { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing @@ -73,7 +73,7 @@ declare namespace sharing { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing @@ -88,7 +88,7 @@ declare namespace sharing { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing @@ -106,12 +106,12 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202004 - Try to share an unavailable iface. * @throws { BusinessError } 2202005 - WiFi sharing failed. * @throws { BusinessError } 2202006 - Bluetooth sharing failed. - * @throws { BusinessError } 2202009 - Network share enable forwarding error. + * @throws { BusinessError } 2202009 - Failed to enable forwarding for network sharing. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -128,12 +128,12 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202004 - Try to share an unavailable iface. * @throws { BusinessError } 2202005 - WiFi sharing failed. * @throws { BusinessError } 2202006 - Bluetooth sharing failed. - * @throws { BusinessError } 2202009 - Network share enable forwarding error. + * @throws { BusinessError } 2202009 - Failed to enable forwarding for network sharing. * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -150,7 +150,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202004 - Try to share an unavailable iface. * @throws { BusinessError } 2202005 - WiFi sharing failed. @@ -171,7 +171,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @throws { BusinessError } 2202004 - Try to share an unavailable iface. * @throws { BusinessError } 2202005 - WiFi sharing failed. @@ -190,7 +190,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -205,7 +205,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -220,7 +220,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -235,7 +235,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -250,7 +250,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -265,7 +265,7 @@ declare namespace sharing { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -282,7 +282,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -299,7 +299,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -316,7 +316,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -333,7 +333,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -350,7 +350,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. @@ -367,7 +367,7 @@ declare namespace sharing { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200001 - Invalid parameter value. - * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. diff --git a/api/@ohos.net.socket.d.ts b/api/@ohos.net.socket.d.ts index 80b0fd46e44fec7908c5463696ec280df0e85d62..df89fedf0b81af49ab03e0f6937123bdb5eeb9ee 100644 --- a/api/@ohos.net.socket.d.ts +++ b/api/@ohos.net.socket.d.ts @@ -2311,7 +2311,7 @@ declare namespace socket { * Returns an object representing a local certificate. * @param { AsyncCallback } callback - the callback of getCertificate. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2320,7 +2320,7 @@ declare namespace socket { * Returns an object representing a local certificate. * @param { AsyncCallback } callback - the callback of getCertificate. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2332,7 +2332,7 @@ declare namespace socket { * Returns an object representing a local certificate. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2341,7 +2341,7 @@ declare namespace socket { * Returns an object representing a local certificate. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2401,7 +2401,7 @@ declare namespace socket { * Server sockets or disconnected client sockets will return a value of null. * @param { AsyncCallback } callback - the callback of getProtocol. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2412,7 +2412,7 @@ declare namespace socket { * Server sockets or disconnected client sockets will return a value of null. * @param { AsyncCallback } callback - the callback of getProtocol. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2426,7 +2426,7 @@ declare namespace socket { * Server sockets or disconnected client sockets will return a value of null. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2437,7 +2437,7 @@ declare namespace socket { * Server sockets or disconnected client sockets will return a value of null. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2450,8 +2450,8 @@ declare namespace socket { * For example:{"TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"} * @param { AsyncCallback> } callback - the callback of getCipherSuite. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2461,8 +2461,8 @@ declare namespace socket { * For example:{"TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"} * @param { AsyncCallback> } callback - the callback of getCipherSuite. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2475,8 +2475,8 @@ declare namespace socket { * For example:{"TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"} * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2486,8 +2486,8 @@ declare namespace socket { * For example:{"TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"} * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2545,17 +2545,17 @@ declare namespace socket { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303104 - Interrupted system call. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303188 - Socket operation on non-socket. - * @throws { BusinessError } 2303191 - Protocol wrong type for socket. + * @throws { BusinessError } 2303191 - Incorrect socket protocol type. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303210 - Connection timed out. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2568,17 +2568,17 @@ declare namespace socket { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303104 - Interrupted system call. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303188 - Socket operation on non-socket. - * @throws { BusinessError } 2303191 - Protocol wrong type for socket. + * @throws { BusinessError } 2303191 - Incorrect socket protocol type. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303210 - Connection timed out. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2594,17 +2594,17 @@ declare namespace socket { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303104 - Interrupted system call. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303188 - Socket operation on non-socket. - * @throws { BusinessError } 2303191 - Protocol wrong type for socket. + * @throws { BusinessError } 2303191 - Incorrect socket protocol type. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303210 - Connection timed out. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2617,17 +2617,17 @@ declare namespace socket { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303104 - Interrupted system call. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303188 - Socket operation on non-socket. - * @throws { BusinessError } 2303191 - Protocol wrong type for socket. + * @throws { BusinessError } 2303191 - Incorrect socket protocol type. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303210 - Connection timed out. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2641,9 +2641,9 @@ declare namespace socket { * @param { AsyncCallback } callback - the callback of send. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2654,9 +2654,9 @@ declare namespace socket { * @param { AsyncCallback } callback - the callback of send. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2668,9 +2668,9 @@ declare namespace socket { * @param { AsyncCallback } callback - the callback of send. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2684,9 +2684,9 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2697,9 +2697,9 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2711,9 +2711,9 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2726,8 +2726,8 @@ declare namespace socket { * @param { AsyncCallback } callback - the callback of close. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2737,8 +2737,8 @@ declare namespace socket { * @param { AsyncCallback } callback - the callback of close. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -2751,8 +2751,8 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 9 @@ -2762,8 +2762,8 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -3201,7 +3201,7 @@ declare namespace socket { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300002 - System internal error. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @syscap SystemCapability.Communication.NetStack @@ -3220,7 +3220,7 @@ declare namespace socket { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300002 - System internal error. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @syscap SystemCapability.Communication.NetStack @@ -3343,9 +3343,9 @@ declare namespace socket { * @param { AsyncCallback } callback - The callback of send. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3356,9 +3356,9 @@ declare namespace socket { * @param { AsyncCallback } callback - The callback of send. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 12 @@ -3371,9 +3371,9 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3384,9 +3384,9 @@ declare namespace socket { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303503 - Error in tls writing. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 12 @@ -3398,8 +3398,8 @@ declare namespace socket { * @param { AsyncCallback } callback - The callback of close. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3410,8 +3410,8 @@ declare namespace socket { * Closes a TLSSocket client connection. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3470,8 +3470,8 @@ declare namespace socket { * @param { AsyncCallback> } callback - The callback of getCipherSuite. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3483,8 +3483,8 @@ declare namespace socket { * For example:{"TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"} * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3635,14 +3635,14 @@ declare namespace socket { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300002 - System internal error. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @syscap SystemCapability.Communication.NetStack * @since 10 */ @@ -3659,14 +3659,14 @@ declare namespace socket { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300002 - System internal error. * @throws { BusinessError } 2303109 - Bad file number. - * @throws { BusinessError } 2303111 - Resource temporarily unavailable try again. + * @throws { BusinessError } 2303111 - Resource temporarily unavailable. Try again. * @throws { BusinessError } 2303198 - Address already in use. * @throws { BusinessError } 2303199 - Cannot assign requested address. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303502 - Error in tls reading. - * @throws { BusinessError } 2303503 - Error in tls writing - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. - * @throws { BusinessError } 2303506 - Error clearing tls connection. + * @throws { BusinessError } 2303502 - An error occurred when reading data on the TLS socket. + * @throws { BusinessError } 2303503 - An error occurred when writing data on the TLS socket. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. + * @throws { BusinessError } 2303506 - Failed to close the TLS connection. * @syscap SystemCapability.Communication.NetStack * @since 10 */ @@ -3722,7 +3722,7 @@ declare namespace socket { * @param { AsyncCallback } callback - The callback of getCertificate. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3733,7 +3733,7 @@ declare namespace socket { * Returns an object representing a local certificate. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303504 - Error looking up x509 + * @throws { BusinessError } 2303504 - An error occurred when verifying the X.509 certificate. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3747,7 +3747,7 @@ declare namespace socket { * @param { AsyncCallback } callback - The callback of getProtocol. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 @@ -3760,7 +3760,7 @@ declare namespace socket { * Server sockets or disconnected client sockets will return a value of null. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2303501 - SSL is null. - * @throws { BusinessError } 2303505 - Error occurred in the tls system call. + * @throws { BusinessError } 2303505 - An error occurred in the TLS system call. * @throws { BusinessError } 2300002 - System internal error. * @syscap SystemCapability.Communication.NetStack * @since 10 diff --git a/api/@ohos.net.statistics.d.ts b/api/@ohos.net.statistics.d.ts index 35a00ac281d729eabba455ab40eaaa3efb0a1c75..e3dad5b0694556a3d7eae49b9a4e379ce377252c 100644 --- a/api/@ohos.net.statistics.d.ts +++ b/api/@ohos.net.statistics.d.ts @@ -40,11 +40,11 @@ declare namespace statistics { * @param { string } nic - Network interface card. * @param { AsyncCallback } callback - Returns the data traffic received through the specified NIC. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -55,11 +55,11 @@ declare namespace statistics { * @param { string } nic - Network interface card. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -70,11 +70,11 @@ declare namespace statistics { * @param { string } nic - Network interface card. * @param { AsyncCallback } callback - Returns the data traffic sent through the specified NIC. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -85,11 +85,11 @@ declare namespace statistics { * @param { string } nic - Network interface card. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -98,11 +98,11 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) received through the cellular network. * @param { AsyncCallback } callback - Returns the data traffic received through the cellular network. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -111,11 +111,11 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) received through the cellular network. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -124,11 +124,11 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) sent through the cellular network. * @param { AsyncCallback } callback - Returns the data traffic sent through the cellular network. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -137,11 +137,11 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) sent through the cellular network. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. - * @throws { BusinessError } 2103012 - Get iface name failed. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. + * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -150,10 +150,10 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. * @param { AsyncCallback } callback - Returns the data traffic received through all NICs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -162,10 +162,10 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -174,10 +174,10 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. * @param { AsyncCallback } callback - Returns the data traffic sent through all NICs. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -186,10 +186,10 @@ declare namespace statistics { /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -200,10 +200,10 @@ declare namespace statistics { * @param { number } uid - Indicates the process ID of the application. * @param { AsyncCallback } callback - Returns the data traffic received by the specified application. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -214,10 +214,10 @@ declare namespace statistics { * @param { number } uid - Indicates the process ID of the application. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -228,10 +228,10 @@ declare namespace statistics { * @param { number } uid - Indicates the process ID of the application. * @param { AsyncCallback } callback - Returns the data traffic sent by the specified application. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -242,10 +242,10 @@ declare namespace statistics { * @param { number } uid - Indicates the process ID of the application. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103005 - Failed to read map. - * @throws { BusinessError } 2103011 - Failed to create map. + * @throws { BusinessError } 2103005 - Failed to read the system map. + * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ @@ -259,7 +259,7 @@ declare namespace statistics { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -273,7 +273,7 @@ declare namespace statistics { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -289,7 +289,7 @@ declare namespace statistics { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -303,7 +303,7 @@ declare namespace statistics { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. @@ -320,9 +320,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 10 @@ -338,9 +338,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 10 @@ -356,9 +356,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 10 @@ -374,9 +374,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 10 @@ -389,7 +389,7 @@ declare namespace statistics { * @param { AsyncCallback } callback - Returns the data traffic bytes received by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -402,7 +402,7 @@ declare namespace statistics { * @returns { Promise } Returns the data traffic bytes received by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -415,7 +415,7 @@ declare namespace statistics { * @param { AsyncCallback } callback - Returns the data traffic bytes sent by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -428,7 +428,7 @@ declare namespace statistics { * @returns { Promise } Returns the data traffic bytes sent by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @since 11 @@ -663,9 +663,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 12 @@ -681,9 +681,9 @@ declare namespace statistics { * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. - * @throws { BusinessError } 2103017 - Read data from database failed. + * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. * @since 12 diff --git a/api/@ohos.net.vpn.d.ts b/api/@ohos.net.vpn.d.ts index 9d8756213af4ef6285f72d8790177cf1a89f1a75..4a80eeef71a912264c4b92c170c6b8b5b315f3e5 100644 --- a/api/@ohos.net.vpn.d.ts +++ b/api/@ohos.net.vpn.d.ts @@ -81,8 +81,8 @@ declare namespace vpn { * @throws { BusinessError } 2200001 - Invalid parameter value. * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 2200003 - System internal error. - * @throws { BusinessError } 2203001 - VPN creation denied, please check the user type. - * @throws { BusinessError } 2203002 - VPN exist already, please execute destroy first. + * @throws { BusinessError } 2203001 - VPN creation denied. Check the user type. + * @throws { BusinessError } 2203002 - VPN already exists. * @syscap SystemCapability.Communication.NetManager.Vpn * @systemapi Hide this for inner system use. * @since 10 @@ -100,8 +100,8 @@ declare namespace vpn { * @throws { BusinessError } 2200001 - Invalid parameter value. * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 2200003 - System internal error. - * @throws { BusinessError } 2203001 - VPN creation denied, please check the user type. - * @throws { BusinessError } 2203002 - VPN exist already, please execute destroy first. + * @throws { BusinessError } 2203001 - VPN creation denied. Check the user type. + * @throws { BusinessError } 2203002 - VPN already exists. * @syscap SystemCapability.Communication.NetManager.Vpn * @systemapi Hide this for inner system use. * @since 10 diff --git a/api/@ohos.nfc.cardEmulation.d.ts b/api/@ohos.nfc.cardEmulation.d.ts index 46553120b7f081b5f1b08677cf41aea28e26cb82..185c5b06eb2915521d6d8613d0640cfc4906a640 100644 --- a/api/@ohos.nfc.cardEmulation.d.ts +++ b/api/@ohos.nfc.cardEmulation.d.ts @@ -167,7 +167,10 @@ declare namespace cardEmulation { * @param { CardType } type - The type to query, payment or other. * @returns { boolean } Returns true if the service is default, otherwise false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @since 9 @@ -180,7 +183,10 @@ declare namespace cardEmulation { * @param { CardType } type - The type to query, payment or other. * @returns { boolean } Returns true if the service is default, otherwise false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice @@ -240,7 +246,10 @@ declare namespace cardEmulation { * @param { ElementName } elementName - The element name of the service ability * @param { string[] } aidList - The aid list to be registered by this service, allowed to be empty. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -253,7 +262,10 @@ declare namespace cardEmulation { * @param { ElementName } elementName - The element name of the service ability * @param { string[] } aidList - The aid list to be registered by this service, allowed to be empty. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -280,7 +292,10 @@ declare namespace cardEmulation { * @permission ohos.permission.NFC_CARD_EMULATION * @param { ElementName } elementName - The element name of the service ability * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -292,7 +307,10 @@ declare namespace cardEmulation { * @permission ohos.permission.NFC_CARD_EMULATION * @param { ElementName } elementName - The element name of the service ability * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -342,7 +360,10 @@ declare namespace cardEmulation { * @param { number[] } response Indicates the response to send, which is a byte array. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -355,7 +376,10 @@ declare namespace cardEmulation { * @param { number[] } response Indicates the response to send, which is a byte array. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -371,7 +395,10 @@ declare namespace cardEmulation { * @param { number[] } response Indicates the response to send, which is a byte array. * @param { AsyncCallback } callback The callback * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation @@ -384,7 +411,10 @@ declare namespace cardEmulation { * @param { number[] } response Indicates the response to send, which is a byte array. * @param { AsyncCallback } callback The callback * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation diff --git a/api/@ohos.nfc.tag.d.ts b/api/@ohos.nfc.tag.d.ts index 48abec1faad3a97e3a7b86b24ef981fbb7d2a409..3a86de2c07295572fcf18a73045d27af6cf070e9 100644 --- a/api/@ohos.nfc.tag.d.ts +++ b/api/@ohos.nfc.tag.d.ts @@ -688,7 +688,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcATag } {@link NfcATag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -701,7 +704,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcATag } {@link NfcATag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -731,7 +737,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcBTag } The {@link NfcBTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -744,7 +753,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcBTag } The {@link NfcBTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -774,7 +786,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcFTag } The {@link NfcFTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -787,7 +802,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcFTag } The {@link NfcFTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -817,7 +835,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcVTag } The {@link NfcVTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -830,7 +851,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NfcVTag } The {@link NfcVTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -846,7 +870,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { IsoDepTag } The {@link IsoDepTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -859,7 +886,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { IsoDepTag } The {@link IsoDepTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -875,7 +905,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NdefTag } The {@link NdefTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -888,7 +921,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NdefTag } The {@link NdefTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -904,7 +940,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { MifareClassicTag } The {@link MifareClassicTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -917,7 +956,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { MifareClassicTag } The {@link MifareClassicTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -933,7 +975,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { MifareUltralightTag } The {@link MifareUltralightTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -946,7 +991,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { MifareUltralightTag } The {@link MifareUltralightTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -962,7 +1010,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NdefFormatableTag } The {@link NdefFormatableTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -975,7 +1026,10 @@ declare namespace tag { * * @param { TagInfo } tagInfo - Indicates the dispatched tag information. * @returns { NdefFormatableTag } The {@link NdefFormatableTag} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -989,7 +1043,10 @@ declare namespace tag { * * @param { Want } want - The want object that contains the values of TagInfo. * @returns { TagInfo } The {@link TagInfo} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -999,7 +1056,10 @@ declare namespace tag { * * @param { Want } want - The want object that contains the values of TagInfo. * @returns { TagInfo } The {@link TagInfo} object. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice @@ -1015,7 +1075,10 @@ declare namespace tag { * @param { number[] } discTech - The technologies list to set for discovering. From {@link NFC_A} to {@link MIFARE_ULTRALIGHT}. * @param { AsyncCallback } callback - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @since 10 @@ -1028,7 +1091,10 @@ declare namespace tag { * @param { number[] } discTech - The technologies list to set for discovering. From {@link NFC_A} to {@link MIFARE_ULTRALIGHT}. * @param { AsyncCallback } callback - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100202 - The element state is invalid. * @syscap SystemCapability.Communication.NFC.Tag @@ -1047,7 +1113,10 @@ declare namespace tag { * @permission ohos.permission.NFC_TAG * @param { ElementName } elementName - The element name of application, must include the bundleName and abilityName. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @since 10 @@ -1058,7 +1127,10 @@ declare namespace tag { * @permission ohos.permission.NFC_TAG * @param { ElementName } elementName - The element name of application, must include the bundleName and abilityName. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice @@ -1075,7 +1147,10 @@ declare namespace tag { * @param { number[] } discTech - The technologies list to set for discovering. From {@link NFC_A} to {@link MIFARE_ULTRALIGHT}. * @param { AsyncCallback } callback - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100202 - The element state is invalid. * @syscap SystemCapability.Communication.NFC.Tag @@ -1090,7 +1165,10 @@ declare namespace tag { * @param { number[] } discTech - The technologies list to set for discovering. From {@link NFC_A} to {@link MIFARE_ULTRALIGHT}. * @param { AsyncCallback } callback - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100202 - The element state is invalid. * @syscap SystemCapability.Communication.NFC.Tag @@ -1107,7 +1185,10 @@ declare namespace tag { * @param { ElementName } elementName - The element name of application, must include the bundleName and abilityName. * @param { AsyncCallback } [callback] - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100203 - The off() can be called only when the on() has been called. * @syscap SystemCapability.Communication.NFC.Tag @@ -1121,7 +1202,10 @@ declare namespace tag { * @param { ElementName } elementName - The element name of application, must include the bundleName and abilityName. * @param { AsyncCallback } [callback] - The callback to dispatched the TagInfo object for application. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100203 - The off() can be called only when the on() has been called. * @syscap SystemCapability.Communication.NFC.Tag @@ -1326,7 +1410,10 @@ declare namespace tag { * * @param { string } uri - Uri data for new NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1335,7 +1422,10 @@ declare namespace tag { * * @param { string } uri - Uri data for new NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1348,7 +1438,10 @@ declare namespace tag { * @param { string } text - Text data for new an NDEF record. * @param { string } locale - Language code for the NDEF record. if locale is null, use default locale. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1358,7 +1451,10 @@ declare namespace tag { * @param { string } text - Text data for new an NDEF record. * @param { string } locale - Language code for the NDEF record. if locale is null, use default locale. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1371,7 +1467,10 @@ declare namespace tag { * @param { string } mimeType type of mime data for new an NDEF record. * @param { number[] } mimeData mime data for new an NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1381,7 +1480,10 @@ declare namespace tag { * @param { string } mimeType type of mime data for new an NDEF record. * @param { number[] } mimeData mime data for new an NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1395,7 +1497,10 @@ declare namespace tag { * @param { string } type - Domain specific type of data for the external data. * @param { number[] } externalData - Data payload of an NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1406,7 +1511,10 @@ declare namespace tag { * @param { string } type - Domain specific type of data for the external data. * @param { number[] } externalData - Data payload of an NDEF record. * @returns { NdefRecord } The instance of NdefRecord. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1417,7 +1525,10 @@ declare namespace tag { * * @param { number[] } data - The raw bytes to parse NDEF message. * @returns { NdefMessage } The instance of NdefMessage. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1426,7 +1537,10 @@ declare namespace tag { * * @param { number[] } data - The raw bytes to parse NDEF message. * @returns { NdefMessage } The instance of NdefMessage. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1438,7 +1552,10 @@ declare namespace tag { * * @param { NdefRecord[] } ndefRecords - The NDEF records to parse NDEF message. * @returns { NdefMessage } The instance of NdefMessage. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1447,7 +1564,10 @@ declare namespace tag { * * @param { NdefRecord[] } ndefRecords - The NDEF records to parse NDEF message. * @returns { NdefMessage } The instance of NdefMessage. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1468,7 +1588,10 @@ declare namespace tag { * * @param { NdefMessage } ndefMessage - An NDEF message to parse. * @returns { number[] } Returns the raw bytes of an NDEF message. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 diff --git a/api/@ohos.notificationManager.d.ts b/api/@ohos.notificationManager.d.ts index 48842d9a81119cbc2ccf777e830eee74c621e24e..734dc01135c312bc57edf6d450d36f82021c34bc 100644 --- a/api/@ohos.notificationManager.d.ts +++ b/api/@ohos.notificationManager.d.ts @@ -68,13 +68,14 @@ declare namespace notificationManager { * * @param { NotificationRequest } request - notification request * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -86,22 +87,48 @@ declare namespace notificationManager { * * @param { NotificationRequest } request - notification request * @param { AsyncCallback } callback - The callback of publish. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600007 - The notification is not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. - * @throws { BusinessError } 1600014 - No relevant right. + * @throws { BusinessError } 1600014 - No permission. * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. * @throws { BusinessError } 1600016 - The notification version for this update is too low. - * @throws { BusinessError } 2300007 - Network is unreachable. + * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Publishes a notification. + *

If a notification with the same ID has been published by the current application and has not been deleted, + * this method will update the notification. + * + * @param { NotificationRequest } request - notification request + * @param { AsyncCallback } callback - The callback of publish. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. + * @throws { BusinessError } 1600012 - No memory space. + * @throws { BusinessError } 1600014 - No permission. + * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. + * @throws { BusinessError } 1600016 - The notification version for this update is too low. + * @throws { BusinessError } 2300007 - Network unreachable. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function publish(request: NotificationRequest, callback: AsyncCallback): void; /** @@ -111,13 +138,14 @@ declare namespace notificationManager { * * @param { NotificationRequest } request - notification request * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -129,22 +157,48 @@ declare namespace notificationManager { * * @param { NotificationRequest } request - notification request * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600007 - The notification is not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. - * @throws { BusinessError } 1600014 - No relevant right. + * @throws { BusinessError } 1600014 - No permission. * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. * @throws { BusinessError } 1600016 - The notification version for this update is too low. - * @throws { BusinessError } 2300007 - Network is unreachable. + * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Publishes a notification. + *

If a notification with the same ID has been published by the current application and has not been deleted, + * this method will update the notification. + * + * @param { NotificationRequest } request - notification request + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. + * @throws { BusinessError } 1600012 - No memory space. + * @throws { BusinessError } 1600014 - No permission. + * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. + * @throws { BusinessError } 1600016 - The notification version for this update is too low. + * @throws { BusinessError } 2300007 - Network unreachable. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function publish(request: NotificationRequest): Promise; /** @@ -156,14 +210,15 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -178,20 +233,21 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. - * @throws { BusinessError } 1600014 - No relevant right. + * @throws { BusinessError } 1600014 - No permission. * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. * @throws { BusinessError } 1600016 - The notification version for this update is too low. - * @throws { BusinessError } 2300007 - Network is unreachable. + * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 11 @@ -207,14 +263,15 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -229,20 +286,21 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. - * @throws { BusinessError } 1600014 - No relevant right. + * @throws { BusinessError } 1600014 - No permission. * @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations. * @throws { BusinessError } 1600016 - The notification version for this update is too low. - * @throws { BusinessError } 2300007 - Network is unreachable. + * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 11 @@ -259,14 +317,15 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of publishAsBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -289,14 +348,15 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -313,14 +373,15 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600005 - Notification slot is not enabled. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600005 - Notification slot disabled. * @throws { BusinessError } 1600008 - The user does not exist. - * @throws { BusinessError } 1600009 - Over max number notifications per second. + * @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -333,14 +394,30 @@ declare namespace notificationManager { * * @param { number } id - ID of the notification to cancel, which must be unique in the application. * @param { AsyncCallback } callback - The callback of cancel. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @since 9 */ + /** + * Cancel a notification with the specified ID. + * + * @param { number } id - ID of the notification to cancel, which must be unique in the application. + * @param { AsyncCallback } callback - The callback of cancel. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function cancel(id: number, callback: AsyncCallback): void; /** @@ -349,11 +426,12 @@ declare namespace notificationManager { * @param { number } id - ID of the notification to cancel, which must be unique in the application. * @param { string } label - Label of the notification to cancel. * @param { AsyncCallback } callback - The callback of cancel. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -365,11 +443,12 @@ declare namespace notificationManager { * @param { number } id - ID of the notification to cancel, which must be unique in the application. * @param { string } [label] - Label of the notification to cancel. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -382,11 +461,12 @@ declare namespace notificationManager { * @param { number } id - ID of the notification to cancel, which must be unique in the application. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration. * @syscap SystemCapability.Notification.Notification @@ -405,11 +485,12 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of cancelAsBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -432,11 +513,12 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -453,11 +535,12 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification @@ -470,26 +553,54 @@ declare namespace notificationManager { * Cancel all notifications of the current application. * * @param { AsyncCallback } callback - The callback of cancelAll. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ + /** + * Cancel all notifications of the current application. + * + * @param { AsyncCallback } callback - The callback of cancelAll. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function cancelAll(callback: AsyncCallback): void; /** * Cancel all notifications of the current application. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ + /** + * Cancel all notifications of the current application. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function cancelAll(): Promise; /** @@ -500,10 +611,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of addSlot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -519,10 +631,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -535,10 +648,11 @@ declare namespace notificationManager { * * @param { SlotType } type - Slot type to add. * @param { AsyncCallback } callback - The callback of addSlot. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -550,10 +664,11 @@ declare namespace notificationManager { * * @param { SlotType } type - Slot type to add. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -568,10 +683,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of addSlots. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -587,10 +703,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -603,10 +720,11 @@ declare namespace notificationManager { * * @param { SlotType } slotType - Type of the notification slot to obtain. * @param { AsyncCallback } callback - The callback is used to return the NotificationSlot. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -617,10 +735,11 @@ declare namespace notificationManager { * * @param { SlotType } slotType - Type of the notification slot to obtain. * @returns { Promise } Returns the NotificationSlot. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -631,10 +750,11 @@ declare namespace notificationManager { * * @param { AsyncCallback> } callback - The callback is used to return all notification slots * of this application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -644,10 +764,11 @@ declare namespace notificationManager { * Obtains all NotificationSlot objects created by the current application. * * @returns { Promise> } Returns all notification slots of this application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -662,7 +783,7 @@ declare namespace notificationManager { * @throws { BusinessError } 202 - Not system application to call the interface. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 12 @@ -674,10 +795,11 @@ declare namespace notificationManager { * * @param { SlotType } slotType - Type of the NotificationSlot to remove. * @param { AsyncCallback } callback - The callback of removeSlot. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -688,10 +810,11 @@ declare namespace notificationManager { * * @param { SlotType } slotType - Type of the NotificationSlot to remove. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -701,10 +824,11 @@ declare namespace notificationManager { * Removes all NotificationSlot objects created by the current application. * * @param { AsyncCallback } callback - The callback of removeAllSlots. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -714,10 +838,11 @@ declare namespace notificationManager { * Removes all NotificationSlot objects created by the current application. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -732,10 +857,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setNotificationEnable. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -752,10 +878,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -771,10 +898,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of isNotificationEnabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -790,10 +918,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -808,10 +937,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of isNotificationEnabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -820,15 +950,31 @@ declare namespace notificationManager { * Checks whether this application allows to publish notifications. * * @param { AsyncCallback } callback - The callback of isNotificationEnabled. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Checks whether this application allows to publish notifications. + * + * @param { AsyncCallback } callback - The callback of isNotificationEnabled. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600008 - The user does not exist. + * @throws { BusinessError } 17700001 - The specified bundle name was not found. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function isNotificationEnabled(callback: AsyncCallback): void; /** @@ -838,10 +984,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -850,15 +997,31 @@ declare namespace notificationManager { * Checks whether this application allows to publish notifications. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Checks whether this application allows to publish notifications. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600008 - The user does not exist. + * @throws { BusinessError } 17700001 - The specified bundle name was not found. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function isNotificationEnabled(): Promise; /** @@ -869,10 +1032,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of isNotificationEnabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -888,10 +1052,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -908,10 +1073,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of displayBadge. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -928,10 +1094,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -947,10 +1114,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of isBadgeDisplayed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -966,10 +1134,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -986,10 +1155,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setSlotByBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1006,10 +1176,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1025,10 +1196,11 @@ declare namespace notificationManager { * @param { AsyncCallback> } callback - The callback of getSlotsByBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1045,10 +1217,11 @@ declare namespace notificationManager { * @returns { Promise } Returns the NotificationSlot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1065,10 +1238,11 @@ declare namespace notificationManager { * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1084,10 +1258,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of getSlotNumByBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1103,10 +1278,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1122,10 +1298,11 @@ declare namespace notificationManager { * @param { AsyncCallback> } callback - The callback of getAllActiveNotifications. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1140,10 +1317,11 @@ declare namespace notificationManager { * @returns { Promise> } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1154,10 +1332,11 @@ declare namespace notificationManager { * Obtains the number of all active notifications. * * @param { AsyncCallback } callback - The callback of getActiveNotificationCount. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1167,10 +1346,11 @@ declare namespace notificationManager { * Obtains the number of all active notifications. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1180,10 +1360,11 @@ declare namespace notificationManager { * Obtains an array of active notifications. * * @param { AsyncCallback> } callback - The callback of getActiveNotifications. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1193,10 +1374,11 @@ declare namespace notificationManager { * Obtains an array of active notifications. * * @returns { Promise> } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1209,8 +1391,9 @@ declare namespace notificationManager { * @permission ohos.permission.NOTIFICATION_CONTROLLER * @param { NotificationFilter } filter - The bundle, notification key and additional information filter of the live view notification. * @param { AsyncCallback } callback - The callback of getActiveNotificationByFilter. - * @throws { BusinessError } 401 - The parameter check failed. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1225,8 +1408,9 @@ declare namespace notificationManager { * @permission ohos.permission.NOTIFICATION_CONTROLLER * @param { NotificationFilter } filter - The bundle, notification key and additional information filter of the live view notification. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1239,10 +1423,11 @@ declare namespace notificationManager { * * @param { string } groupName - The name of the group. * @param { AsyncCallback } callback - The callback of cancelGroup. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1253,10 +1438,11 @@ declare namespace notificationManager { * * @param { string } groupName - The name of the group. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1271,10 +1457,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of removeGroupByBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1291,10 +1478,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1310,10 +1498,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setDoNotDisturbDate. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1329,10 +1518,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1349,10 +1539,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setDoNotDisturbDate. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification @@ -1370,10 +1561,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification @@ -1389,10 +1581,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback is used to return the Do Not Disturb date. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1407,10 +1600,11 @@ declare namespace notificationManager { * @returns { Promise } Returns the Do Not Disturb date. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1426,10 +1620,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback is used to return the Do Not Disturb date. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification @@ -1446,10 +1641,11 @@ declare namespace notificationManager { * @returns { Promise } Returns the Do Not Disturb date. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification @@ -1466,10 +1662,11 @@ declare namespace notificationManager { * mode is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1483,10 +1680,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether Do Not Disturb mode is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1498,10 +1696,11 @@ declare namespace notificationManager { * * @param { string } templateName - Name of template to be Obtained. * @param { AsyncCallback } callback - The callback is used to return whether the template is supported. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1512,10 +1711,11 @@ declare namespace notificationManager { * * @param { string } templateName - Name of template to be Obtained. * @returns { Promise } Returns whether the template is supported. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1525,10 +1725,11 @@ declare namespace notificationManager { * Request permission to send notification. * * @param { AsyncCallback } callback - The callback of requestEnableNotification. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1536,15 +1737,31 @@ declare namespace notificationManager { * Request permission to send notification. * * @param { AsyncCallback } callback - The callback of requestEnableNotification. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600013 - Enable Notification Dialog has been popping already. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Request permission to send notification. + * + * @param { AsyncCallback } callback - The callback of requestEnableNotification. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function requestEnableNotification(callback: AsyncCallback): void; /** @@ -1552,10 +1769,11 @@ declare namespace notificationManager { * * @param { UIAbilityContext } context - The context indicates the ability context you want to bind; * @param { AsyncCallback } callback - The callback of requestEnableNotification. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @since 10 @@ -1565,12 +1783,13 @@ declare namespace notificationManager { * * @param { UIAbilityContext } context - The context indicates the ability context you want to bind; * @param { AsyncCallback } callback - The callback of requestEnableNotification. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600013 - Enable Notification Dialog has been popping already. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @since 11 @@ -1581,10 +1800,11 @@ declare namespace notificationManager { * Request permission to send notification. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @since 9 */ @@ -1592,15 +1812,31 @@ declare namespace notificationManager { * Request permission to send notification. * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600013 - Enable Notification Dialog has been popping already. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. * @syscap SystemCapability.Notification.Notification * @since 11 */ + /** + * Request permission to send notification. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function requestEnableNotification(): Promise; /** @@ -1608,10 +1844,11 @@ declare namespace notificationManager { * * @param { UIAbilityContext } context - The context indicates the ability context you want to bind; * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @since 10 @@ -1621,12 +1858,13 @@ declare namespace notificationManager { * * @param { UIAbilityContext } context - The context indicates the ability context you want to bind; * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600004 - Notification is not enabled. - * @throws { BusinessError } 1600013 - Enable Notification Dialog has been popping already. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600004 - Notification disabled. + * @throws { BusinessError } 1600013 - A notification dialog box is already displayed. * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @since 11 @@ -1641,10 +1879,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setDistributedEnable. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1660,10 +1899,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1676,10 +1916,11 @@ declare namespace notificationManager { * * @param { AsyncCallback } callback - The callback is used to return whether the distributed * notification is supported. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -1690,10 +1931,11 @@ declare namespace notificationManager { * Obtains whether the device supports distributed notification. * * @returns { Promise } Returns whether the distributed notification is supported. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @since 9 @@ -1709,10 +1951,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setDistributedEnableByBundle. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1730,10 +1973,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1752,10 +1996,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. @@ -1774,10 +2019,11 @@ declare namespace notificationManager { * notification is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1794,10 +2040,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether the distributed notification is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1815,10 +2062,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether the distributed notification is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. @@ -1837,10 +2085,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. @@ -1858,10 +2107,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether the smart reminders across devices notification is supported. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. @@ -1878,10 +2128,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback is used to return the RemindType. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1895,10 +2146,11 @@ declare namespace notificationManager { * @returns { Promise } Returns the RemindType. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -1915,10 +2167,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setNotificationEnableSlot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -1934,10 +2187,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setNotificationEnableSlot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1963,10 +2217,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setNotificationEnableSlot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -1991,10 +2246,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2012,10 +2268,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification @@ -2033,10 +2290,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback is used to return whether the application slot is enabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2053,10 +2311,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether the application slot is enabled. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2073,10 +2332,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback of setSyncNotificationEnabledWithoutApp. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2093,10 +2353,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2112,10 +2373,11 @@ declare namespace notificationManager { * @param { AsyncCallback } callback - The callback is used to return whether to sync notifications to devices. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2131,10 +2393,11 @@ declare namespace notificationManager { * @returns { Promise } Returns whether to sync notifications to devices. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2147,14 +2410,30 @@ declare namespace notificationManager { * * @param { number } badgeNumber - Badge number. * @param { AsyncCallback } callback - callback - The callback of setBadgeNumber.. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 10 */ + /** + * Set badge number. + * + * @param { number } badgeNumber - Badge number. + * @param { AsyncCallback } callback - callback - The callback of setBadgeNumber.. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600012 - No memory space. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function setBadgeNumber(badgeNumber: number, callback: AsyncCallback): void; /** @@ -2162,14 +2441,30 @@ declare namespace notificationManager { * * @param { number } badgeNumber - Badge number. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @since 10 */ + /** + * Set badge number. + * + * @param { number } badgeNumber - Badge number. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600012 - No memory space. + * @syscap SystemCapability.Notification.Notification + * @crossplatform + * @since 12 + */ function setBadgeNumber(badgeNumber: number): Promise; /** @@ -2179,10 +2474,11 @@ declare namespace notificationManager { * @param { number } badgeNumber - Badge number. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration. * @throws { BusinessError } 17700001 - The specified bundle name was not found. @@ -2199,7 +2495,8 @@ declare namespace notificationManager { * @param { 'checkNotification' } type - Type of the callback to listen for. * @param { function } callback - callback - The callback of check notifications. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2216,10 +2513,11 @@ declare namespace notificationManager { * @param { function } callback - callback - The callback of check notifications. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 11 @@ -2235,7 +2533,8 @@ declare namespace notificationManager { * @param { function } [callback] - callback - The callback * of check notifications. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2256,11 +2555,12 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2274,10 +2574,11 @@ declare namespace notificationManager { * @param { SystemLiveViewSubscriber } subscriber - The system live vie notification subscriber. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2294,10 +2595,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2313,10 +2615,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2332,10 +2635,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2351,10 +2655,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -2371,10 +2676,11 @@ declare namespace notificationManager { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 12 @@ -3211,4 +3517,4 @@ declare namespace notificationManager { export type NotificationProgress = _NotificationProgress; } -export default notificationManager; +export default notificationManager; \ No newline at end of file diff --git a/api/@ohos.notificationSubscribe.d.ts b/api/@ohos.notificationSubscribe.d.ts index ad2a00221017424048370def8c2a542852944f86..3d6d6bc641d97ca933d3041126501f091d1e1206 100644 --- a/api/@ohos.notificationSubscribe.d.ts +++ b/api/@ohos.notificationSubscribe.d.ts @@ -99,10 +99,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of subscribe. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -116,10 +117,11 @@ declare namespace notificationSubscribe { * @param { NotificationSubscriber } subscriber - The notification subscriber. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -136,10 +138,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of subscribe. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -160,10 +163,11 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -179,10 +183,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of unsubscribe. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -197,10 +202,11 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -217,11 +223,12 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of remove. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -244,11 +251,12 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -265,11 +273,12 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of remove. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -286,10 +295,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of remove. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 10 @@ -305,11 +315,12 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. - * @throws { BusinessError } 1600007 - The notification is not exist. + * @throws { BusinessError } 1600003 - Failed to connect to the service. + * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -325,10 +336,11 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 10 @@ -343,10 +355,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of removeAll. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -361,10 +374,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of removeAll. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 9 @@ -379,10 +393,11 @@ declare namespace notificationSubscribe { * @param { AsyncCallback } callback - The callback of removeAll. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -398,10 +413,11 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi @@ -417,10 +433,11 @@ declare namespace notificationSubscribe { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 1600001 - Internal error. * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. - * @throws { BusinessError } 1600003 - Failed to connect service. + * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi diff --git a/api/@ohos.pasteboard.d.ts b/api/@ohos.pasteboard.d.ts index 72b48581fa0c490f2345f17176427bcdb4821e16..6b0060192bcdf54d5010fcfbe017d7b31279c940 100755 --- a/api/@ohos.pasteboard.d.ts +++ b/api/@ohos.pasteboard.d.ts @@ -1451,6 +1451,31 @@ declare namespace pasteboard { * @since 12 */ setUnifiedDataSync(data: unifiedDataChannel.UnifiedData): void; + + /** + * Sets a unified ShareOptions for your application, so that the PasteData copied from your application is applicable to this ShareOptions. + * + * @param { ShareOption } shareOptions - Scope that PasteData can be pasted. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 12900006 - Settings already exist. + * @syscap SystemCapability.MiscServices.Pasteboard + * @systemapi + * @since 12 + */ + setAppShareOptions(shareOptions: ShareOption): void; + + /** + * Removes the unified ShareOptions of your application. + * + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.MiscServices.Pasteboard + * @systemapi + * @since 12 + */ + removeAppShareOptions(): void; } } diff --git a/api/@ohos.print.d.ts b/api/@ohos.print.d.ts index cc1b44274403db0aa8387023505dacb237a52655..d08235602d52924c163516dfc3cb624dc3dcb1d4 100644 --- a/api/@ohos.print.d.ts +++ b/api/@ohos.print.d.ts @@ -43,6 +43,7 @@ declare namespace print { * @param { 'block' } type - Indicates the print task has been blocked. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -54,6 +55,7 @@ declare namespace print { * @param { 'succeed' } type - Indicates the print task succeed. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -65,6 +67,7 @@ declare namespace print { * @param { 'fail' } type - Indicates the print task has completed with failure. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -76,6 +79,7 @@ declare namespace print { * @param { 'cancel' } type - Indicates the print task has been cancelled. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -87,6 +91,7 @@ declare namespace print { * @param { 'block' } type - Indicates the print task has been blocked. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -98,6 +103,7 @@ declare namespace print { * @param { 'succeed' } type - Indicates the print task succeed. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -109,6 +115,7 @@ declare namespace print { * @param { 'fail' } type - Indicates the print task has completed with failure. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -120,6 +127,7 @@ declare namespace print { * @param { 'cancel' } type - Indicates the print task has been cancelled. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -143,6 +151,7 @@ declare namespace print { * @param { number } fd - Indicates print file fd. * @param { function } writeResultCallback - Indicates this function should execute after the file is updated. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 11 */ @@ -155,6 +164,7 @@ declare namespace print { * @param { string } jobId - Indicates print job id. * @param { PrintDocumentAdapterState } state - Indicates job changes to this state. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 11 */ @@ -167,6 +177,7 @@ declare namespace print { * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @param { AsyncCallback } callback - The callback function for print task. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -178,6 +189,7 @@ declare namespace print { * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 10 */ @@ -190,6 +202,7 @@ declare namespace print { * @param { Context } context - The ability context that initiates the call print request. * @param { AsyncCallback } callback - The callback function for print task. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 11 */ @@ -202,6 +215,7 @@ declare namespace print { * @param { Context } context - The ability context that initiates the call print request. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 11 */ @@ -216,6 +230,7 @@ declare namespace print { * @param { Context } context - The ability context that initiates the call print request. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since 11 */ @@ -1559,6 +1574,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1573,6 +1589,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1610,6 +1627,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1623,6 +1641,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1636,6 +1655,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1649,6 +1669,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1662,6 +1683,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for capability from printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1675,6 +1697,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1688,6 +1711,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1701,6 +1725,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1714,6 +1739,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1727,6 +1753,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1740,6 +1767,7 @@ declare namespace print { * @param { Callback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1753,6 +1781,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1766,6 +1795,7 @@ declare namespace print { * @param { function } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1779,6 +1809,7 @@ declare namespace print { * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1792,6 +1823,7 @@ declare namespace print { * @param { function } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1805,6 +1837,7 @@ declare namespace print { * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1818,6 +1851,7 @@ declare namespace print { * @param { function } callback - The callback function for information change of print extension. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1831,6 +1865,7 @@ declare namespace print { * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1844,6 +1879,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1857,6 +1893,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1870,6 +1907,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1883,6 +1921,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1896,6 +1935,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1909,6 +1949,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1923,6 +1964,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1937,6 +1979,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1952,6 +1995,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1967,6 +2011,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1980,6 +2025,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -1993,6 +2039,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 @@ -2058,6 +2105,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for get printJob by jobId. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 11 @@ -2071,6 +2119,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 11 @@ -2086,6 +2135,7 @@ declare namespace print { * @param { Callback } onFileStateChanged - The callback function for update the file state. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 11 @@ -2101,6 +2151,7 @@ declare namespace print { * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 11 @@ -2115,6 +2166,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 11 @@ -2140,6 +2192,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 12 @@ -2153,7 +2206,7 @@ declare namespace print { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 12 diff --git a/api/@ohos.privacyManager.d.ts b/api/@ohos.privacyManager.d.ts index b19e387b38fb56b87416935beb8b5d7f0573e350..682cdec91669639f8726318e0505bcf4303b79b6 100644 --- a/api/@ohos.privacyManager.d.ts +++ b/api/@ohos.privacyManager.d.ts @@ -39,11 +39,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -62,11 +62,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, permissionName exceeds 256 characters, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, permissionName exceeds 256 characters, * the count value is invalid, or usedType in AddPermissionUsedRecordOptions is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -92,11 +92,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, or the string size of permissionName is larger than 256, * or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -119,10 +119,10 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. the value of flag in request is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The value of flag in request is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -139,10 +139,10 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. the value of flag in request is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The value of flag in request is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -163,12 +163,12 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100004 - The interface is called repeatedly with the same input. + * @throws { BusinessError } 12100004 - The API is used repeatedly with the same input. * It means the application specified by the tokenID has been using the specified permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -186,12 +186,12 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100004 - The interface is called repeatedly with the same input. + * @throws { BusinessError } 12100004 - The API is used repeatedly with the same input. * It means the application specified by the tokenID has been using the specified permission. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -209,11 +209,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100004 - The interface is not used with "startUsingPermission". - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100004 - The API is not used in pair with 'startUsingPermission'. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -231,11 +231,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. + * @throws { BusinessError } 12100001 - Invalid Parameter. The tokenID is 0, permissionName is longer than 256 bytes, or the count value is invalid. * @throws { BusinessError } 12100002 - The specified tokenID does not exist or refer to an application process. * @throws { BusinessError } 12100003 - The specified permission does not exist or is not an user_grant permission. - * @throws { BusinessError } 12100004 - The interface is not used with "startUsingPermission". - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100004 - The API is not used in pair with 'startUsingPermission'. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -253,10 +253,11 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. - * @throws { BusinessError } 12100004 - The interface is called repeatedly with the same input. + * @throws { BusinessError } 12100001 - Invalid Parameter. The parameter is invalid. The tokenID is 0, + * or the string size of permissionName is larger than 256. + * @throws { BusinessError } 12100004 - The API is used repeatedly with the same input. * @throws { BusinessError } 12100005 - The registration time has exceeded the limitation. - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -278,9 +279,9 @@ declare namespace privacyManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The permissionNames in the list are all invalid, or the list size exceeds 1024 bytes. - * @throws { BusinessError } 12100004 - The interface is not used together with "on". - * @throws { BusinessError } 12100007 - Service is abnormal. + * @throws { BusinessError } 12100001 - Invalid Parameter. The permissionNames in the list are all invalid, or the list size exceeds 1024 bytes. + * @throws { BusinessError } 12100004 - The API is not used in pair with 'on'. + * @throws { BusinessError } 12100007 - The service is abnormal. * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi @@ -299,10 +300,10 @@ declare namespace privacyManager { * @param { number } tokenId - Token ID of the application. By default, all token IDs of the device are returned. * @param { Permissions } permissionName - Name of the permission to query. By default, all permissions of the device are returned. * @returns { Promise> } Promise used to return the information obtained. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". * @throws { BusinessError } 202 - Not system app. Interface caller is not a system app. - * @throws { BusinessError } 12100001 - The parameter is invalid. PermissionName exceeds 256 characters. + * @throws { BusinessError } 12100001 - Invalid Parameter. PermissionName exceeds 256 characters. * @throws { BusinessError } 12100002 - The input tokenId does not exist. * @throws { BusinessError } 12100003 - The input permissionName does not exist. * @syscap SystemCapability.Security.AccessToken diff --git a/api/@ohos.process.d.ts b/api/@ohos.process.d.ts index 9b8398a58047b96c001833f4c986122eda02e240..dd86976ec75ab6661d0268567211d96649e30732 100644 --- a/api/@ohos.process.d.ts +++ b/api/@ohos.process.d.ts @@ -755,6 +755,16 @@ declare namespace process { * @atomicservice * @since 11 */ + /** + * User Stored Events + * + * @typedef { function } EventListener + * @param { Object } evt - User events + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ type EventListener = (evt: Object) => void; /** diff --git a/api/@ohos.promptAction.d.ts b/api/@ohos.promptAction.d.ts index 55b1914a33e993b3a6af4011cf33038351693975..eedcf6426921958aa6cdd9e86e11c95c4b70c59f 100644 --- a/api/@ohos.promptAction.d.ts +++ b/api/@ohos.promptAction.d.ts @@ -228,7 +228,17 @@ declare namespace promptAction { * @atomicservice * @since 12 */ - TOP_MOST = 1 + TOP_MOST = 1, + + /** + * Toast shows in SYSTEM_TOAST window. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @atomicservice + * @since 12 + */ + SYSTEM_TOP_MOST = 2 } /** @@ -309,7 +319,7 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since 12 */ primary?: boolean; } @@ -1072,7 +1082,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -1084,7 +1094,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1097,7 +1107,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1114,7 +1124,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -1127,7 +1137,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1141,7 +1151,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1158,7 +1168,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -1171,7 +1181,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1185,7 +1195,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1202,7 +1212,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 @@ -1216,7 +1226,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1232,7 +1242,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 @@ -1245,7 +1255,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1262,7 +1272,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -1275,7 +1285,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1289,7 +1299,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1306,7 +1316,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -1319,7 +1329,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1333,7 +1343,7 @@ declare namespace promptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice diff --git a/api/@ohos.request.d.ts b/api/@ohos.request.d.ts index 86c82c703c847ece5594f4ac0ef496ce7319204a..531f93e499dcab00687151134663b33a371822a4 100644 --- a/api/@ohos.request.d.ts +++ b/api/@ohos.request.d.ts @@ -633,11 +633,8 @@ declare namespace request { * @param { DownloadConfig } config Download config * @param { AsyncCallback } callback Indicate the callback function to receive DownloadTask. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error * @throws { BusinessError } 13400002 - bad file path * @throws { BusinessError } 13400003 - task service ability error @@ -652,11 +649,8 @@ declare namespace request { * @param { DownloadConfig } config Download config * @param { AsyncCallback } callback Indicate the callback function to receive DownloadTask. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error * @throws { BusinessError } 13400002 - bad file path * @throws { BusinessError } 13400003 - task service ability error @@ -688,11 +682,8 @@ declare namespace request { * @param { DownloadConfig } config Download config * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error * @throws { BusinessError } 13400002 - bad file path * @throws { BusinessError } 13400003 - task service ability error @@ -707,11 +698,8 @@ declare namespace request { * @param { DownloadConfig } config Download config * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error * @throws { BusinessError } 13400002 - bad file path * @throws { BusinessError } 13400003 - task service ability error @@ -743,11 +731,8 @@ declare namespace request { * @param { UploadConfig } config Upload config * @param { AsyncCallback } callback Indicate the callback function to receive UploadTask. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400002 - bad file path * @syscap SystemCapability.MiscServices.Upload * @since 9 @@ -760,11 +745,8 @@ declare namespace request { * @param { UploadConfig } config Upload config * @param { AsyncCallback } callback Indicate the callback function to receive UploadTask. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400002 - bad file path * @syscap SystemCapability.MiscServices.Upload * @crossplatform @@ -794,11 +776,8 @@ declare namespace request { * @param { UploadConfig } config Upload config * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400002 - bad file path * @syscap SystemCapability.MiscServices.Upload * @since 9 @@ -811,11 +790,8 @@ declare namespace request { * @param { UploadConfig } config Upload config * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the permissions check fails - * @throws { BusinessError } 401 - the parameters check fails - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400002 - bad file path * @syscap SystemCapability.MiscServices.Upload * @crossplatform @@ -1251,6 +1227,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session is in process. + * + * @permission ohos.permission.INTERNET + * @param { 'progress' } type progress Indicates the download task progress. + * @param { function } callback + *
The callback function for the download progress change event + *
receivedSize the length of downloaded data, in bytes + *
totalSize he length of data expected to be downloaded, in bytes. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ on(type: 'progress', callback: (receivedSize: number, totalSize: number) => void): void; /** @@ -1278,6 +1269,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session is in process. + * + * @permission ohos.permission.INTERNET + * @param { 'progress' } type progress Indicates the download task progress. + * @param { function } [callback] + *
The callback function for the download progress change event + *
receivedSize the length of downloaded data, in bytes + *
totalSize he length of data expected to be downloaded, in bytes. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => void): void; /** @@ -1305,6 +1311,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session complete pause or remove. + * + * @permission ohos.permission.INTERNET + * @param { 'complete' | 'pause' | 'remove' } type Indicates the download session event type + *
complete: download task completed, + *
pause: download task stopped, + *
remove: download task deleted. + * @param { function } callback The callback function for the download complete pause or remove change event. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ on(type: 'complete' | 'pause' | 'remove', callback: () => void): void; /** @@ -1332,6 +1353,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session complete pause or remove. + * + * @permission ohos.permission.INTERNET + * @param { 'complete' | 'pause' | 'remove' } type Indicates the download session event type + *
complete: download task completed, + *
pause: download task stopped, + *
remove: download task deleted. + * @param { function } [callback] The callback function for the download complete pause or remove change event. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ off(type: 'complete' | 'pause' | 'remove', callback?: () => void): void; /** @@ -1355,6 +1391,19 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session fails. + * + * @permission ohos.permission.INTERNET + * @param { 'fail' } type Indicates the download session type, fail: download task has failed. + * @param { function } callback The callback function for the download fail change event + *
err The error code for download task. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ on(type: 'fail', callback: (err: number) => void): void; /** @@ -1378,6 +1427,19 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current download session fails. + * + * @permission ohos.permission.INTERNET + * @param { 'fail' } type Indicates the download session type, fail: download task has failed. + * @param { function } [callback] Indicate the callback function to receive err. + *
err The error code for download task. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ off(type: 'fail', callback?: (err: number) => void): void; /** @@ -1521,6 +1583,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Delete the download task + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ delete(callback: AsyncCallback): void; /** @@ -1544,6 +1616,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Delete the download task + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ delete(): Promise; /** @@ -1567,6 +1649,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Suspend the download task + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ suspend(callback: AsyncCallback): void; /** @@ -1590,6 +1682,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Suspend the download task + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ suspend(): Promise; /** @@ -1613,6 +1715,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Restore the download task + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ restore(callback: AsyncCallback): void; /** @@ -1636,6 +1748,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Restore the download task + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ restore(): Promise; /** @@ -1659,6 +1781,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Get the download task info + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ getTaskInfo(callback: AsyncCallback): void; /** @@ -1682,6 +1814,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Get the download task info + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ getTaskInfo(): Promise; /** @@ -1705,6 +1847,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Get mimetype of the download task + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ getTaskMimeType(callback: AsyncCallback): void; /** @@ -1728,6 +1880,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Get mimetype of the download task + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Download + * @crossplatform + * @since 12 + */ getTaskMimeType(): Promise; } @@ -2130,6 +2292,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current upload session is in process. + * + * @permission ohos.permission.INTERNET + * @param { 'progress' } type progress Indicates the upload task progress. + * @param { function } callback + *
The callback function for the upload progress change event + *
uploadedSize The length of uploaded data, in bytes + *
totalSize The length of data expected to be uploaded, in bytes. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ on(type: 'progress', callback: (uploadedSize: number, totalSize: number) => void): void; /** @@ -2157,6 +2334,21 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current upload session is in process. + * + * @permission ohos.permission.INTERNET + * @param { 'progress' } type progress Indicates the upload task progress. + * @param { function } [callback] + *
The callback function for the upload progress change event + *
uploadedSize The length of uploaded data, in bytes + *
totalSize The length of data expected to be uploaded, in bytes. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) => void): void; /** @@ -2180,6 +2372,19 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the header of the current upload session has been received. + * + * @permission ohos.permission.INTERNET + * @param { 'headerReceive' } type headerReceive Indicates the upload task headed receive. + * @param { function } callback The callback function for the HTTP Response Header event + *
header HTTP Response Header returned by the developer server. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ on(type: 'headerReceive', callback: (header: object) => void): void; /** @@ -2203,6 +2408,19 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the header of the current upload session has been received. + * + * @permission ohos.permission.INTERNET + * @param { 'headerReceive' } type headerReceive Indicates the upload task headed receive. + * @param { function } [callback] The callback function for the HTTP Response Header event + *
header HTTP Response Header returned by the developer server. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ off(type: 'headerReceive', callback?: (header: object) => void): void; /** @@ -2228,6 +2446,20 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current upload session complete or fail. + * + * @permission ohos.permission.INTERNET + * @param { 'complete' | 'fail' } type Indicates the upload session event type + *
complete: upload task completed + *
fail: upload task failed + * @param { Callback> } callback The callback function for the upload complete or fail change event. + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ on(type: 'complete' | 'fail', callback: Callback>): void; /** @@ -2253,6 +2485,20 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Called when the current upload session complete or fail. + * + * @permission ohos.permission.INTERNET + * @param { 'complete' | 'fail' } type Indicates the upload session event type + *
complete: upload task completed + *
fail: upload task failed + * @param { Callback> } [callback] + * @throws { BusinessError } 401 - the parameters check fails. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ off(type: 'complete' | 'fail', callback?: Callback>): void; /** @@ -2300,6 +2546,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Delete the upload task + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ delete(callback: AsyncCallback): void; /** @@ -2323,6 +2579,16 @@ declare namespace request { * @crossplatform * @since 10 */ + /** + * Delete the upload task + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - the permissions check fails + * @syscap SystemCapability.MiscServices.Upload + * @crossplatform + * @since 12 + */ delete(): Promise; } @@ -4233,7 +4499,8 @@ declare namespace request { * * @param { 'progress' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4243,7 +4510,8 @@ declare namespace request { * * @param { 'progress' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4255,7 +4523,8 @@ declare namespace request { * * @param { 'progress' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4265,7 +4534,8 @@ declare namespace request { * * @param { 'progress' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4277,7 +4547,8 @@ declare namespace request { * * @param { 'completed' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4287,7 +4558,8 @@ declare namespace request { * * @param { 'completed' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4299,7 +4571,8 @@ declare namespace request { * * @param { 'completed' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4309,7 +4582,8 @@ declare namespace request { * * @param { 'completed' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4321,7 +4595,8 @@ declare namespace request { * * @param { 'failed' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4331,7 +4606,8 @@ declare namespace request { * * @param { 'failed' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4343,7 +4619,8 @@ declare namespace request { * * @param { 'failed' } event event types. * @param { function } callback callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 21900005 - task mode error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4353,7 +4630,8 @@ declare namespace request { * * @param { 'failed' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform * @atomicservice @@ -4365,7 +4643,8 @@ declare namespace request { * * @param { 'pause' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4375,7 +4654,8 @@ declare namespace request { * * @param { 'pause' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4385,7 +4665,8 @@ declare namespace request { * * @param { 'resume' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4395,7 +4676,8 @@ declare namespace request { * * @param { 'resume' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4405,7 +4687,8 @@ declare namespace request { * * @param { 'remove' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4415,7 +4698,8 @@ declare namespace request { * * @param { 'remove' } event - event types. * @param { function } callback - callback function with a `Progress` argument. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @since 11 */ @@ -4425,6 +4709,8 @@ declare namespace request { * * @param { 'response' } event - event types. * @param { Callback } callback - callback function with an `HttpResponse` argument. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @atomicservice * @since 12 @@ -4435,6 +4721,8 @@ declare namespace request { * * @param { 'response' } event - event types. * @param { Callback } callback - callback function with an `HttpResponse` argument. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @syscap SystemCapability.Request.FileTransferAgent * @atomicservice * @since 12 @@ -4464,6 +4752,21 @@ declare namespace request { * @atomicservice * @since 11 */ + /** + * Starts the task. The following tasks can be started: + * 1. Tasks just created. + * 2. Download tasks that are stopped or become FAILED. + * + * @permission ohos.permission.INTERNET + * @param { AsyncCallback } callback callback function with a boolean argument indicating the calling result. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 13400003 - task service ability error. + * @throws { BusinessError } 21900007 - task state error. + * @syscap SystemCapability.Request.FileTransferAgent + * @crossplatform + * @atomicservice + * @since 12 + */ start(callback: AsyncCallback): void; /** * Starts the task. @@ -4489,6 +4792,21 @@ declare namespace request { * @atomicservice * @since 11 */ + /** + * Starts the task. The following tasks can be started: + * 1. Tasks just created. + * 2. Download tasks that are stopped or become FAILED. + * + * @permission ohos.permission.INTERNET + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 13400003 - task service ability error. + * @throws { BusinessError } 21900007 - task state error. + * @syscap SystemCapability.Request.FileTransferAgent + * @crossplatform + * @atomicservice + * @since 12 + */ start(): Promise; /** * Pauses the background task. @@ -4635,11 +4953,8 @@ declare namespace request { * @param { Config } config configurations for a task. * @param { AsyncCallback } callback indicate the callback function to receive Task. * @throws { BusinessError } 201 - permission denied. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900004 - application task queue full error. @@ -4657,11 +4972,8 @@ declare namespace request { * @param { Config } config configurations for a task. * @param { AsyncCallback } callback indicate the callback function to receive Task. * @throws { BusinessError } 201 - permission denied. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900004 - application task queue full error. @@ -4686,11 +4998,8 @@ declare namespace request { * @param { Config } config configurations for a task. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permission denied. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900004 - application task queue full error. @@ -4708,11 +5017,8 @@ declare namespace request { * @param { Config } config configurations for a task. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permission denied. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Missing mandatory parameters - * 2. Incorrect parameter type - * 3. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400001 - file operation error. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900004 - application task queue full error. @@ -4731,9 +5037,8 @@ declare namespace request { * @param { string } id - the id of the task. * @param { string } token - the token of the task, length between 8 and 2048 bytes. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4747,7 +5052,8 @@ declare namespace request { * * @param { string } id the task id. * @param { AsyncCallback } callback callback function with a boolean argument indicating success or not. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4759,7 +5065,8 @@ declare namespace request { * * @param { string } id the task id. * @param { AsyncCallback } callback callback function with a boolean argument indicating success or not. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4775,7 +5082,8 @@ declare namespace request { * * @param { string } id the task id. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4787,7 +5095,8 @@ declare namespace request { * * @param { string } id the task id. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4802,7 +5111,8 @@ declare namespace request { * * @param { string } id the task id. * @param { AsyncCallback } callback callback function with a `TaskInfo` argument for informations of the current task. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4813,7 +5123,8 @@ declare namespace request { * * @param { string } id the task id. * @param { AsyncCallback } callback callback function with a `TaskInfo` argument for informations of the current task. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4827,7 +5138,8 @@ declare namespace request { * * @param { string } id the task id. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4838,7 +5150,8 @@ declare namespace request { * * @param { string } id the task id. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4853,7 +5166,8 @@ declare namespace request { * @param { string } id the task id. * @param { string } token the in-application isolation key. * @param { AsyncCallback } callback callback function with a `TaskInfo` argument for informations of the current task. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4865,9 +5179,8 @@ declare namespace request { * @param { string } id the task id. * @param { string } token the in-application isolation key, length between 8 and 2048 bytes. * @param { AsyncCallback } callback callback function with a `TaskInfo` argument for informations of the current task. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4880,9 +5193,10 @@ declare namespace request { * Touches specified task with token. * * @param { string } id the task id. - * @param { string } token the in-application isolation key. + * @param { string } token the in-application isolation key, length between 8 and 2048 bytes. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4894,9 +5208,8 @@ declare namespace request { * @param { string } id the task id. * @param { string } token the in-application isolation key, length between 8 and 2048 bytes. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. - * Possible causes: - * 1. Parameter verification failed + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. 3. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4909,7 +5222,8 @@ declare namespace request { * Searches tasks, for system. * * @param { AsyncCallback> } callback callback function with a `Array` argument contains task ids match filter. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4918,7 +5232,8 @@ declare namespace request { * Searches tasks, for system. * * @param { AsyncCallback> } callback callback function with a `Array` argument contains task ids match filter. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform @@ -4931,7 +5246,8 @@ declare namespace request { * * @param { Filter } filter an instance of `Filter`. * @param { AsyncCallback> } callback callback function with a `Array` argument contains task ids match filter. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4941,7 +5257,8 @@ declare namespace request { * * @param { Filter } filter an instance of `Filter`. * @param { AsyncCallback> } callback callback function with a `Array` argument contains task ids match filter. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform @@ -4954,7 +5271,8 @@ declare namespace request { * * @param { Filter } filter an instance of `Filter`. * @returns { Promise> } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @since 10 @@ -4964,7 +5282,8 @@ declare namespace request { * * @param { Filter } filter an instance of `Filter`. * @returns { Promise> } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Incorrect parameter type. + *
2. Parameter verification failed. * @throws { BusinessError } 13400003 - task service ability error. * @syscap SystemCapability.Request.FileTransferAgent * @crossplatform @@ -4980,7 +5299,8 @@ declare namespace request { * @param { AsyncCallback } callback callback function with a `TaskInfo` argument for informations of the current task. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent @@ -4997,7 +5317,8 @@ declare namespace request { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - parameter error. Possible causes: 1. Missing mandatory parameters. + *
2. Incorrect parameter type. * @throws { BusinessError } 13400003 - task service ability error. * @throws { BusinessError } 21900006 - task not found error. * @syscap SystemCapability.Request.FileTransferAgent diff --git a/api/@ohos.resourceManager.d.ts b/api/@ohos.resourceManager.d.ts index 9c6812073e1fd81d227572472956deba13ec29ec..0724f0a785dbcccfac26e1d6e6d6caa8ecb4de15 100644 --- a/api/@ohos.resourceManager.d.ts +++ b/api/@ohos.resourceManager.d.ts @@ -780,7 +780,7 @@ declare namespace resourceManager { * resConfig is default value(contains resLocale, screenDensityDpi, direction, etc). * * @returns { ResourceManager } The System ResourceManager object is returned. - * @throws { BusinessError } 9001009 - If application can't access system resource + * @throws { BusinessError } 9001009 - Failed to access the system resource. * which is not mapped to application sandbox, This error code will be thrown. * @syscap SystemCapability.Global.ResourceManager * @since 10 @@ -790,7 +790,7 @@ declare namespace resourceManager { * resConfig is default value(contains resLocale, screenDensityDpi, direction, etc). * * @returns { ResourceManager } The System ResourceManager object is returned. - * @throws { BusinessError } 9001009 - If application can't access system resource + * @throws { BusinessError } 9001009 - Failed to access the system resource. * which is not mapped to application sandbox, This error code will be thrown. * @syscap SystemCapability.Global.ResourceManager * @crossplatform @@ -854,9 +854,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -867,9 +867,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -881,9 +881,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -898,9 +898,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -911,9 +911,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -925,9 +925,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -966,9 +966,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -979,9 +979,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -993,9 +993,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1010,9 +1010,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise> } The array of character strings corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1023,9 +1023,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise> } The array of character strings corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1037,9 +1037,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise> } The array of character strings corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1078,8 +1078,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1090,8 +1090,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1103,8 +1103,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1122,8 +1122,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -1137,8 +1137,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1153,8 +1153,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The content of the media file corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1165,8 +1165,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The content of the media file corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1178,8 +1178,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The content of the media file corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1197,8 +1197,8 @@ declare namespace resourceManager { * @returns { Promise } The content of the specified screen density media file corresponding to the * specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -1212,8 +1212,8 @@ declare namespace resourceManager { * @returns { Promise } The content of the specified screen density media file corresponding to the * specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1254,8 +1254,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1267,8 +1267,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1281,8 +1281,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1300,8 +1300,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -1315,8 +1315,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1331,8 +1331,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1343,8 +1343,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1356,8 +1356,8 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1374,8 +1374,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The Base64 code of the specified screen density image resource corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -1388,8 +1388,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The Base64 code of the specified screen density image resource corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1544,9 +1544,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the resource object string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1560,9 +1560,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the resource object string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1577,9 +1577,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the resource object string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1597,9 +1597,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the resource object string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -1613,9 +1613,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the resource object string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1630,9 +1630,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the resource object string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -1719,9 +1719,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1731,9 +1731,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1744,9 +1744,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1760,9 +1760,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1772,9 +1772,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1785,9 +1785,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1801,9 +1801,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1813,9 +1813,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1826,9 +1826,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1842,9 +1842,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise> } the array of character strings corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1854,9 +1854,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise> } the array of character strings corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1867,9 +1867,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise> } the array of character strings corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1883,8 +1883,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1894,8 +1894,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1906,8 +1906,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1924,8 +1924,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -1938,8 +1938,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1953,8 +1953,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The content of the media file corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -1964,8 +1964,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The content of the media file corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -1976,8 +1976,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The content of the media file corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -1994,8 +1994,8 @@ declare namespace resourceManager { * @returns { Promise } The content of the specified screen density media file corresponding to the * specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -2008,8 +2008,8 @@ declare namespace resourceManager { * @returns { Promise } The content of the specified screen density media file corresponding to the * specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2024,8 +2024,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2036,8 +2036,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2049,8 +2049,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2067,8 +2067,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -2081,8 +2081,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2096,8 +2096,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2107,8 +2107,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2119,8 +2119,8 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } The Base64 code of the image resource corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2136,8 +2136,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The Base64 code of the specified screen density image resource corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -2149,8 +2149,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The Base64 code of the specified screen density image resource corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2167,9 +2167,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the name string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2182,9 +2182,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the name string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2198,9 +2198,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the name string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2217,9 +2217,9 @@ declare namespace resourceManager { * @returns { Promise } the singular-plural character string represented by the name string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2232,9 +2232,9 @@ declare namespace resourceManager { * @returns { Promise } the singular-plural character string represented by the name string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2248,9 +2248,9 @@ declare namespace resourceManager { * @returns { Promise } the singular-plural character string represented by the name string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2264,9 +2264,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { string } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2276,9 +2276,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { string } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2289,9 +2289,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { string } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2306,10 +2306,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001007 - If the resource obtained by resId formatting error. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2321,10 +2321,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001007 - If the resource obtained by resId formatting error. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2338,9 +2338,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { string } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -2351,9 +2351,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { string } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2365,9 +2365,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { string } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2383,10 +2383,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001007 - If the resource obtained by resId formatting error. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2399,10 +2399,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001007 - If the resource obtained by resId formatting error. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2417,9 +2417,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { string } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2429,9 +2429,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { string } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2442,9 +2442,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { string } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2459,10 +2459,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001008 - If the resource obtained by resName formatting error. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001008 - Failed to format the resource obtained based on the resource Name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2474,10 +2474,10 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The character string corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. - * @throws { BusinessError } 9001008 - If the resource obtained by resName formatting error. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. + * @throws { BusinessError } 9001008 - Failed to format the resource obtained based on the resource Name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2491,9 +2491,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { boolean } The boolean resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2503,9 +2503,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { boolean } The boolean resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2516,9 +2516,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { boolean } The boolean resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2532,9 +2532,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { boolean } The boolean resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -2545,9 +2545,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { boolean } The boolean resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2559,9 +2559,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { boolean } The boolean resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2576,9 +2576,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { boolean } The boolean resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2588,9 +2588,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { boolean } The boolean resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2601,9 +2601,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { boolean } The boolean resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2617,9 +2617,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } The number resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2629,9 +2629,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } The number resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2642,9 +2642,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } The number resource corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2658,9 +2658,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } The number resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 9 @@ -2671,9 +2671,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } The number resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2685,9 +2685,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } The number resource corresponding to the resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -2702,9 +2702,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } The number resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2714,9 +2714,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } The number resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2727,9 +2727,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } The number resource corresponding to the resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2766,9 +2766,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2778,9 +2778,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2791,9 +2791,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained character string. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2807,9 +2807,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2819,9 +2819,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2832,9 +2832,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The character string corresponding to the resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2848,9 +2848,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2860,9 +2860,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2873,9 +2873,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2889,9 +2889,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise> } The array of character strings corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2901,9 +2901,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise> } The array of character strings corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2914,9 +2914,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise> } The array of character strings corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2933,9 +2933,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the ID string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2948,9 +2948,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the ID string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -2964,9 +2964,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the singular-plural character * string represented by the ID string corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -2983,9 +2983,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -2998,9 +2998,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3014,9 +3014,9 @@ declare namespace resourceManager { * @returns { Promise } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3030,8 +3030,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3041,8 +3041,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3053,8 +3053,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3071,8 +3071,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3085,8 +3085,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained * specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3100,8 +3100,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The content of the media file corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3111,8 +3111,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The content of the media file corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3123,8 +3123,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } The content of the media file corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3140,8 +3140,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The content of the specified screen density media file corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3153,8 +3153,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } The content of the specified screen density media file corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3169,8 +3169,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3181,8 +3181,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3194,8 +3194,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image * resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3212,8 +3212,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3226,8 +3226,8 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the * specified screen density image resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3241,8 +3241,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } the Base64 code of the image resource corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3252,8 +3252,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } the Base64 code of the image resource corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3264,8 +3264,8 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } the Base64 code of the image resource corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3281,8 +3281,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } the Base64 code of the specified screen density image resource corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3294,8 +3294,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Promise } the Base64 code of the specified screen density image resource corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3309,7 +3309,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3319,7 +3319,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3330,7 +3330,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3344,7 +3344,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } the raw file resource corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3354,7 +3354,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } the raw file resource corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3365,7 +3365,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } the raw file resource corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3379,7 +3379,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3389,7 +3389,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3400,7 +3400,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3414,7 +3414,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3424,7 +3424,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3435,7 +3435,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3449,7 +3449,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3459,7 +3459,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3470,7 +3470,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3484,7 +3484,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The result close raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 9 */ @@ -3494,7 +3494,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The result close raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @since 10 @@ -3505,7 +3505,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise } The result close raw file resource descriptor corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3521,8 +3521,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3536,8 +3536,8 @@ declare namespace resourceManager { * the normal media. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @atomicservice * @since 11 @@ -3552,8 +3552,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3567,8 +3567,8 @@ declare namespace resourceManager { * the normal media. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @atomicservice * @since 11 @@ -3583,8 +3583,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -3599,8 +3599,8 @@ declare namespace resourceManager { * the normal media. * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @atomicservice @@ -3614,7 +3614,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the raw file list. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3624,7 +3624,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @param { _AsyncCallback> } callback - Indicates the asynchronous callback used to return the raw file list. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3638,7 +3638,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise> } The rawfile list corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3648,7 +3648,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Promise> } The rawfile list corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3663,9 +3663,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3676,9 +3676,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3692,9 +3692,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3704,9 +3704,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3721,9 +3721,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -3735,9 +3735,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -3752,9 +3752,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -3765,9 +3765,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -3783,9 +3783,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3796,9 +3796,9 @@ declare namespace resourceManager { * @param { _AsyncCallback } callback - Indicates the asynchronous callback used to * return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3812,9 +3812,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3824,9 +3824,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Promise } Indicates return the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3840,9 +3840,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3852,9 +3852,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3868,9 +3868,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -3881,9 +3881,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -3898,9 +3898,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3910,9 +3910,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } Indicates the integer reference value representing the color data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3925,7 +3925,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the application overlay path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001010 - If the overlay path is invalid. + * @throws { BusinessError } 9001010 - Invalid overlay path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3934,7 +3934,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the application overlay path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001010 - If the overlay path is invalid. + * @throws { BusinessError } 9001010 - Invalid overlay path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3947,7 +3947,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the application overlay path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001010 - If the overlay path is invalid. + * @throws { BusinessError } 9001010 - Invalid overlay path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3956,7 +3956,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the application overlay path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001010 - If the overlay path is invalid. + * @throws { BusinessError } 9001010 - Invalid overlay path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3970,7 +3970,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { RawFileDescriptor } The raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -3980,7 +3980,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { RawFileDescriptor } The raw file resource descriptor. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -3993,7 +3993,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the resource relative path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4002,7 +4002,7 @@ declare namespace resourceManager { * * @param { string } path - Indicates the resource relative path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4016,7 +4016,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Array } The rawfile resource list. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4026,7 +4026,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Array } The rawfile resource list. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4040,7 +4040,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Uint8Array } the raw file resource corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4050,7 +4050,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the resource relative path. * @returns { Uint8Array } the raw file resource corresponding to the specified resource path. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4066,8 +4066,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } Indicates the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4079,8 +4079,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } Indicates the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4096,8 +4096,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } Indicates the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -4110,8 +4110,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } Indicates the obtained media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -4128,8 +4128,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } Indicates the obtained Base64 code of the media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4141,8 +4141,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } Indicates the obtained Base64 code of the media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4158,8 +4158,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } Indicates the obtained Base64 code of the media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -4172,8 +4172,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } Indicates the obtained Base64 code of the media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -4191,9 +4191,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4206,9 +4206,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4225,9 +4225,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -4241,9 +4241,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -4258,9 +4258,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Array } The array of character strings corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4270,9 +4270,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { Array } The array of character strings corresponding to the specified resource ID. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4286,9 +4286,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Array } The array of character strings corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @since 10 @@ -4299,9 +4299,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { Array } The array of character strings corresponding to the specified resource object. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the module resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by module resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -4319,9 +4319,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the name string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4334,9 +4334,9 @@ declare namespace resourceManager { * @returns { string } The singular-plural character string represented by the name string * corresponding to the specified number. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4352,8 +4352,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } The obtained specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4365,8 +4365,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { Uint8Array } The obtained specified screen density media file content. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4382,8 +4382,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } The obtained Base64 code of the specified screen density media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4395,8 +4395,8 @@ declare namespace resourceManager { * to use the density of current system dpi. * @returns { string } The obtained Base64 code of the specified screen density media file. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4410,9 +4410,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Array } the array of character strings corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @since 10 */ @@ -4422,9 +4422,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { Array } the array of character strings corresponding to the specified resource name. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4488,9 +4488,9 @@ declare namespace resourceManager { * @param { number } resId - Indicates the resource ID. * @returns { number } Indicates the integer reference value representing the symbol data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4504,9 +4504,9 @@ declare namespace resourceManager { * @param { Resource } resource - Indicates the resource object. * @returns { number } Indicates the integer reference value representing the symbol data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001001 - If the resId invalid. - * @throws { BusinessError } 9001002 - If the resource not found by resId. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001001 - Invalid resource ID. + * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @stagemodelonly * @crossplatform @@ -4521,9 +4521,9 @@ declare namespace resourceManager { * @param { string } resName - Indicates the resource name. * @returns { number } Indicates the integer reference value representing the symbol data. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001003 - If the resName invalid. - * @throws { BusinessError } 9001004 - If the resource not found by resName. - * @throws { BusinessError } 9001006 - If the resource re-ref too much. + * @throws { BusinessError } 9001003 - Invalid resource name. + * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. + * @throws { BusinessError } 9001006 - The resource is referenced cyclically. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4537,7 +4537,7 @@ declare namespace resourceManager { * @param { string } path - Indicates the rawfile resource relative path. * @returns { boolean } True means the file path is directory, else false. * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. - * @throws { BusinessError } 9001005 - If the resource not found by path. + * @throws { BusinessError } 9001005 - Invalid relative path. * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4598,6 +4598,7 @@ declare namespace resourceManager { /** * Contains rawFile descriptor information. * + * @typedef {_RawFileDescriptor} * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice @@ -4621,6 +4622,7 @@ declare namespace resourceManager { /** * Contains resource descriptor information. * + * @typedef {_Resource} * @syscap SystemCapability.Global.ResourceManager * @crossplatform * @atomicservice diff --git a/api/@ohos.resourceschedule.backgroundTaskManager.d.ts b/api/@ohos.resourceschedule.backgroundTaskManager.d.ts index 989089cc190b638e032bfab83934047c80dc215a..705a783bfc811be852bb176b633692fc38618960 100644 --- a/api/@ohos.resourceschedule.backgroundTaskManager.d.ts +++ b/api/@ohos.resourceschedule.backgroundTaskManager.d.ts @@ -110,7 +110,8 @@ declare namespace backgroundTaskManager { * * @param { number } requestId - The identifier of the delay request. * @param { AsyncCallback } callback - The callback of the remaining delay time. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 9800001 - Memory operation failed. * @throws { BusinessError } 9800002 - Parcel operation failed. * @throws { BusinessError } 9800003 - Inner transact failed. diff --git a/api/@ohos.resourceschedule.deviceStandby.d.ts b/api/@ohos.resourceschedule.deviceStandby.d.ts index 7dd5ef0956e038295099bd7fd765c4ba45aba632..2a1c9ad91f726046c0f4e1f1f1686e36e9391c2c 100644 --- a/api/@ohos.resourceschedule.deviceStandby.d.ts +++ b/api/@ohos.resourceschedule.deviceStandby.d.ts @@ -37,7 +37,7 @@ declare namespace deviceStandby { * @param { AsyncCallback> } callback - the callback of getExemptedApps. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 9800001 - Memory operation failed. * @throws { BusinessError } 9800002 - Parcel operation failed. * @throws { BusinessError } 9800003 - Inner transact failed. @@ -57,7 +57,7 @@ declare namespace deviceStandby { * @returns { Promise> } the promise returned by getExemptedApps. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 9800001 - Memory operation failed. * @throws { BusinessError } 9800002 - Parcel operation failed. * @throws { BusinessError } 9800003 - Inner transact failed. @@ -76,7 +76,7 @@ declare namespace deviceStandby { * @param { ResourceRequest } request - requesting or releasing resources. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 9800001 - Memory operation failed. * @throws { BusinessError } 9800002 - Parcel operation failed. * @throws { BusinessError } 9800003 - Inner transact failed. @@ -95,7 +95,7 @@ declare namespace deviceStandby { * @param { ResourceRequest } request - requesting or releasing resources. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 9800001 - Memory operation failed. * @throws { BusinessError } 9800002 - Parcel operation failed. * @throws { BusinessError } 9800003 - Inner transact failed. diff --git a/api/@ohos.resourceschedule.systemload.d.ts b/api/@ohos.resourceschedule.systemload.d.ts index 1a56944b6e7d4e0b0233f6398835d6256129eb36..53ff2a57c5d4b95b9a98e50f7c316d7b3f788cad 100644 --- a/api/@ohos.resourceschedule.systemload.d.ts +++ b/api/@ohos.resourceschedule.systemload.d.ts @@ -98,7 +98,8 @@ declare namespace systemLoad { * Register system load callback for perception system load change * @param { 'systemLoadChange' } type system load change type. * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error; + *
2. Register a exist callback type; 3. Parameter verification failed. * @syscap SystemCapability.ResourceSchedule.SystemLoad * @since 12 */ @@ -108,7 +109,8 @@ declare namespace systemLoad { * Unregister system load callback for perception system load change * @param { 'systemLoadChange' } type system load change type. * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error; + *
2. Unregister type has not register; 3. Parameter verification failed. * @syscap SystemCapability.ResourceSchedule.SystemLoad * @since 12 */ diff --git a/api/@ohos.resourceschedule.usageStatistics.d.ts b/api/@ohos.resourceschedule.usageStatistics.d.ts index 677b33a6e2ec2885beb0c1955a03f2905fc3fe6c..b07a92c86903035f813bdd0c4774692ecff88315 100644 --- a/api/@ohos.resourceschedule.usageStatistics.d.ts +++ b/api/@ohos.resourceschedule.usageStatistics.d.ts @@ -471,7 +471,8 @@ declare namespace usageStatistics { *

boolean value is true mean the application is idle in a particular period; false mean otherwise. * The time range of the particular period is defined by the system, which may be hours or days.

* @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -493,7 +494,8 @@ declare namespace usageStatistics { *

boolean value is true mean the application is idle in a particular period; false mean otherwise. * The time range of the particular period is defined by the system, which may be hours or days.

* @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -515,7 +517,8 @@ declare namespace usageStatistics { *

boolean value is true mean the application is idle in a particular period; false mean otherwise. * The time range of the particular period is defined by the system, which may be hours or days.

* @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -537,7 +540,7 @@ declare namespace usageStatistics { *

Returns the app group of the calling application.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -561,7 +564,7 @@ declare namespace usageStatistics { *

Returns the app group of the calling application.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -584,7 +587,7 @@ declare namespace usageStatistics { * @returns { number } Returns the app group of the calling application. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -610,7 +613,7 @@ declare namespace usageStatistics { *

the usage priority group of the calling application.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -636,7 +639,7 @@ declare namespace usageStatistics { *

the usage priority group of the calling application.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -661,7 +664,7 @@ declare namespace usageStatistics { * @returns { number } the usage priority group of the calling application. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -677,6 +680,7 @@ declare namespace usageStatistics { function queryAppGroupSync(bundleName: string): number; /** + * @typedef { Record } BundleStatsMap * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App * @systemapi Hide this for inner system use. * @since 9 @@ -694,7 +698,7 @@ declare namespace usageStatistics { *

the {@link BundleStatsMap} objects containing the usage information about each bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -719,7 +723,7 @@ declare namespace usageStatistics { *

the {@link BundleStatsMap} objects containing the usage information about each bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -801,7 +805,7 @@ declare namespace usageStatistics { *

the list of {@link BundleStatsInfo} objects containing the usage information about each bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -833,7 +837,7 @@ declare namespace usageStatistics { *

the list of {@link BundleStatsInfo} objects containing the usage information about each bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -861,7 +865,8 @@ declare namespace usageStatistics { *

the list of {@link BundleEvents} objects containing the state data of all bundles.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -885,7 +890,8 @@ declare namespace usageStatistics { *

the list of {@link BundleEvents} objects containing the state data of all bundles.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -908,7 +914,8 @@ declare namespace usageStatistics { *

the {@link BundleEvents} object Array containing the state data of the current bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -931,7 +938,8 @@ declare namespace usageStatistics { *

the {@link BundleEvents} object Array containing the state data of the current bundle.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -954,7 +962,8 @@ declare namespace usageStatistics { *

the {@link HapModuleInfo} object Array containing the usage data of the modules.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -977,7 +986,8 @@ declare namespace usageStatistics { *

the {@link HapModuleInfo} object Array containing the usage data of the modules.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -999,7 +1009,8 @@ declare namespace usageStatistics { *

the {@link HapModuleInfo} object Array containing the usage data of the modules.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1021,7 +1032,8 @@ declare namespace usageStatistics { *

the {@link HapModuleInfo} object Array containing the usage data of the modules.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1108,7 +1120,8 @@ declare namespace usageStatistics { * @param { AsyncCallback } callback - the callback of setAppGroup. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1131,7 +1144,8 @@ declare namespace usageStatistics { * @returns { Promise } the promise returned by setAppGroup. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1154,7 +1168,8 @@ declare namespace usageStatistics { * @param { AsyncCallback } callback - the callback of registerAppGroupCallBack. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1176,7 +1191,8 @@ declare namespace usageStatistics { * @returns { Promise } the promise returned by registerAppGroupCallBack. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1196,7 +1212,8 @@ declare namespace usageStatistics { * @param { AsyncCallback } callback - the callback of unregisterAppGroupCallBack. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1216,7 +1233,8 @@ declare namespace usageStatistics { * @returns { Promise } the promise returned by unregisterAppGroupCallBack. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1239,7 +1257,8 @@ declare namespace usageStatistics { *

the {@link DeviceEventStats} object Array containing the event states data.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1263,7 +1282,8 @@ declare namespace usageStatistics { *

the {@link DeviceEventStats} object Array containing the event states data.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1287,7 +1307,8 @@ declare namespace usageStatistics { *

the {@link DeviceEventStats} object Array containing the event states data.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. @@ -1315,7 +1336,8 @@ declare namespace usageStatistics { *

the {@link DeviceEventStats} object Array containing the event states data.

* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameters types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 10000001 - Memory operation failed. * @throws { BusinessError } 10000002 - Parcel operation failed. diff --git a/api/@ohos.router.d.ts b/api/@ohos.router.d.ts index 20cd1a675eeef9119958ddcb4a37901132066f6c..7f86083971d230f2d6b339ed2e34dda6b10c56c4 100644 --- a/api/@ohos.router.d.ts +++ b/api/@ohos.router.d.ts @@ -362,9 +362,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -377,9 +377,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -393,9 +393,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -412,9 +412,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -427,9 +427,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -443,9 +443,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -463,9 +463,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -479,9 +479,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -496,9 +496,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -516,9 +516,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -532,9 +532,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -549,9 +549,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100002 - if the uri is not exist. - * @throws { BusinessError } 100003 - if the pages are pushed too much. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -580,7 +580,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 9 */ @@ -594,7 +594,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @atomicservice * @since 11 @@ -611,7 +611,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 9 */ @@ -625,7 +625,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @atomicservice * @since 11 @@ -643,7 +643,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 9 */ @@ -658,7 +658,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @atomicservice * @since 11 @@ -676,7 +676,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 9 */ @@ -691,7 +691,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 200002 - if the uri is not exist. + * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Lite * @atomicservice * @since 11 @@ -851,7 +851,7 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ @@ -863,7 +863,7 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -876,7 +876,7 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. + * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1005,9 +1005,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1021,9 +1021,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1040,9 +1040,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1056,9 +1056,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1076,9 +1076,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1093,9 +1093,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1113,9 +1113,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1130,9 +1130,9 @@ declare namespace router { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - if UI execution context not found. - * @throws { BusinessError } 100003 - if the pages are pushed too much. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1150,7 +1150,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1165,7 +1165,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1183,7 +1183,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1198,7 +1198,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1217,7 +1217,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1233,7 +1233,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1252,7 +1252,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -1268,7 +1268,7 @@ declare namespace router { *
2. Incorrect parameters types. *
3. Parameter verification failed. * @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system. - * @throws { BusinessError } 100004 - if the named route is not exist. + * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice diff --git a/api/@ohos.rpc.d.ts b/api/@ohos.rpc.d.ts index 5d5b5d125614e24200d8fb2cba0a9104c5fb5c0d..407e36966122a14540a90ae8b38e4e71f5530583 100644 --- a/api/@ohos.rpc.d.ts +++ b/api/@ohos.rpc.d.ts @@ -2493,13 +2493,6 @@ declare namespace rpc { * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - /** - * Indicates the wait time for RPC, in seconds. It is NOT used in IPC case. - * - * @default 8 - * @syscap SystemCapability.Communication.IPC.Core - * @since 11 - */ TF_WAIT_TIME: number; /** diff --git a/api/@ohos.screenLock.d.ts b/api/@ohos.screenLock.d.ts index 2da8386387540251512d56ad6c227be8366d388b..ab363fc2dace7337176b8b0d5adc97b63d7d38bd 100644 --- a/api/@ohos.screenLock.d.ts +++ b/api/@ohos.screenLock.d.ts @@ -104,7 +104,7 @@ declare namespace screenLock { * Unlock the screen. * * @param { AsyncCallback } callback - the callback of unlock. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. * @syscap SystemCapability.MiscServices.ScreenLock @@ -115,7 +115,7 @@ declare namespace screenLock { * Unlock the screen. * * @param { AsyncCallback } callback - the callback of unlock. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. * @throws { BusinessError } 13200003 - illegal use. @@ -153,7 +153,7 @@ declare namespace screenLock { * * @permission ohos.permission.ACCESS_SCREEN_LOCK_INNER * @param { AsyncCallback } callback - the callback of lock. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. @@ -233,7 +233,7 @@ declare namespace screenLock { * @permission ohos.permission.ACCESS_SCREEN_LOCK_INNER * @param { Callback } callback - the callback of onSystemEvent. * @returns { boolean } returns true if register system event is success, returns false otherwise. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. @@ -250,7 +250,7 @@ declare namespace screenLock { * @param { String } event - event type. * @param { number } parameter - operation result of the event. * @param { AsyncCallback } callback - the callback of sendScreenLockEvent. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. @@ -267,7 +267,7 @@ declare namespace screenLock { * @param { String } event - event type. * @param { number } parameter - operation result of the event. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 13200002 - the screenlock management service is abnormal. diff --git a/api/@ohos.screenshot.d.ts b/api/@ohos.screenshot.d.ts index d3d70bfdaa5753340e7cfbc5272a44a36d186a61..64f3236163783cfe4916aac140ec37891d65ca97 100644 --- a/api/@ohos.screenshot.d.ts +++ b/api/@ohos.screenshot.d.ts @@ -98,6 +98,7 @@ declare namespace screenshot { * Takes a screenshot and picks it as a PickInfo object. * * @returns { Promise } Promise used to return a PickInfo object. + * @throws { BusinessError } 801 - Capability not supported on this device. * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 12 diff --git a/api/@ohos.secureElement.d.ts b/api/@ohos.secureElement.d.ts index 897dbf0fadcbced0f246d223fefc0467add6e58b..f9f8bc917439350f2f0bd5904f306219a69a3ea1 100644 --- a/api/@ohos.secureElement.d.ts +++ b/api/@ohos.secureElement.d.ts @@ -37,7 +37,10 @@ declare namespace omapi { * @param { 'serviceState' } type nfc serviceState * @param { Callback } callback - The callback to return the service. * @returns { SEService } The new SEService instance. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.SecureElement * @since 10 @@ -232,7 +235,10 @@ declare namespace omapi { * @param { number[] } aid - The AID of the applet to be selected on this channel, as a byte array, * or Null if no applet is to be selected. * @returns { Promise } An instance of channel if available. Null if the SE is unable to provide. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected. @@ -250,7 +256,10 @@ declare namespace omapi { * @param { number[] } aid - The AID of the applet to be selected on this channel, as a byte array, * or Null if no applet is to be selected. * @param { AsyncCallback } callback - The callback to return the Channel object. Null if the SE is unable to provide. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected. @@ -275,7 +284,10 @@ declare namespace omapi { * or Null if no applet is to be selected. * @param { number } p2 - The P2 parameter of the SELECT APDU executed on this channel. * @returns { Promise } An instance of channel if available. Null if the SE is unable to provide. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected. @@ -300,7 +312,10 @@ declare namespace omapi { * or Null if no applet is to be selected. * @param { number } p2 - The P2 parameter of the SELECT APDU executed on this channel. * @param { AsyncCallback } callback - The callback to return the Channel object. Null if the SE is unable to provide. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected. @@ -318,7 +333,10 @@ declare namespace omapi { * @param { number[] } aid - The AID of the applet to be selected on this channel, as a byte array. * @returns { Promise } An instance of channel if available. Null if the SE is unable to provide. * A new logical channel or is unable to retrieve Access Control rules due to the lack of an available logical channel. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected or @@ -337,7 +355,10 @@ declare namespace omapi { * @param { number[] } aid - The AID of the applet to be selected on this channel, as a byte array. * @param { AsyncCallback } callback - The callback to return the Channel object. Null if the SE is unable to provide. * A new logical channel or is unable to retrieve Access Control rules due to the lack of an available logical channel. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected or @@ -363,7 +384,10 @@ declare namespace omapi { * @param { number } p2 - The P2 parameter of the SELECT APDU executed on this channel. * @returns { Promise } An instance of channel if available. Null if the SE is unable to provide. * A new logical channel or is unable to retrieve Access Control rules due to the lack of an available logical channel. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected or @@ -388,7 +412,10 @@ declare namespace omapi { * @param { number[] } aid - The AID of the applet to be selected on this channel, as a byte array. * @param { number } p2 - The P2 parameter of the SELECT APDU executed on this channel. * @param { AsyncCallback } callback - The callback to return the instance of channel. Null if the SE is unable to provide. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session that has been closed. * @throws { BusinessError } 3300102 - NoSuchElementError, the AID on the SE is not available or cannot be selected or @@ -465,7 +492,10 @@ declare namespace omapi { * * @param { number[] } command - The APDU command to be transmitted, as a byte array. * @returns { Promise } The response received, as a byte array. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session or channel that has been closed. * @throws { BusinessError } 3300103 - SecurityError, the command is filtered by the security policy. @@ -480,7 +510,10 @@ declare namespace omapi { * * @param { number[] } command - The APDU command to be transmitted, as a byte array. * @param { AsyncCallback } callback - The callback to return the response received, as a byte array. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3300101 - IllegalStateError, an attempt is made to use an SE session or channel that has been closed. * @throws { BusinessError } 3300103 - SecurityError, the command is filtered by the security policy. diff --git a/api/@ohos.security.asset.d.ts b/api/@ohos.security.asset.d.ts index 75f2f8abe4830f701b7e4b0afd172f2d3eac27b3..a4eef9c2b87d528042c24c6344a2dc3599e5b8bc 100644 --- a/api/@ohos.security.asset.d.ts +++ b/api/@ohos.security.asset.d.ts @@ -32,21 +32,24 @@ declare namespace asset { * * @param { AssetMap } attributes - a map object containing attributes of the Asset to be added. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000003 - Data already exists. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000014 - File operation failed. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 201 - The caller doesn't have the permission. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000003 - The asset already exists. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000014 - The file operation failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -56,25 +59,28 @@ declare namespace asset { * Add an Asset to a specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to add an Asset. + * @param { number } userId - the user identifier to add an Asset. The user identifier cannot be lower than 100. * @param { AssetMap } attributes - a map object containing attributes of the Asset to be added. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000003 - Data already exists. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000014 - File operation failed. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000003 - The asset already exists. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000014 - The file operation failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -85,21 +91,24 @@ declare namespace asset { * Add an Asset. * * @param { AssetMap } attributes - a map object containing attributes of the Asset to be added. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000003 - Data already exists. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000014 - File operation failed. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 201 - The caller doesn't have the permission. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000003 - The asset already exists. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000014 - The file operation failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -110,16 +119,18 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be removed. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -129,21 +140,24 @@ declare namespace asset { * Remove one or more Assets that match a search query from a specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to remove one or more Assets. + * @param { number } userId - the user identifier to remove one or more Assets. The user identifier cannot be lower + * than 100. * @param { AssetMap } query - a map object containing attributes of the Asset to be removed. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -154,16 +168,18 @@ declare namespace asset { * Remove one or more Assets that match a search query. * * @param { AssetMap } query - a map object containing attributes of the Asset to be removed. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -175,19 +191,22 @@ declare namespace asset { * @param { AssetMap } query - a map object containing attributes of the Asset to be updated. * @param { AssetMap } attributesToUpdate - a map object containing attributes with new values. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -197,25 +216,28 @@ declare namespace asset { * Update an Asset that matches a search query in a specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to update an Asset. + * @param { number } userId - the user identifier to update an Asset. The user identifier cannot be lower than 100. * @param { AssetMap } query - a map object containing attributes of the Asset to be updated. * @param { AssetMap } attributesToUpdate - a map object containing attributes with new values. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -227,19 +249,22 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be updated. * @param { AssetMap } attributesToUpdate - a map object containing attributes with new values. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000015 - Get system time failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000015 - Getting the system time failed. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -250,49 +275,54 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000016 - Capacity exceeds the limit. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000016 - The cache exceeds the limit. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @since 11 */ function preQuery(query: AssetMap): Promise; /** - * Preprocessing (e.g. get challenge) for querying one or more Assets + * Preprocessing (e.g. get challenge) for querying one or more Assets * that require user authentication in a specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to pre-query one or more Assets. + * @param { number } userId - the user identifier to pre-query one or more Assets. The user identifier cannot be + * lower than 100. * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000016 - Capacity exceeds the limit. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000016 - The cache exceeds the limit. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -304,20 +334,22 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Uint8Array } the challenge value to be used when {@link querySync} is called. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000016 - Capacity exceeds the limit. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000016 - The cache exceeds the limit. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -328,20 +360,22 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Promise> } the promise object returned by the function. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. * @throws { BusinessError } 24000004 - Access denied. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -351,25 +385,28 @@ declare namespace asset { * Query one or more Assets that match a search query in a specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to query one or more Assets. + * @param { number } userId - the user identifier to query one or more Assets. The user identifier cannot be lower + * than 100. * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Promise> } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. * @throws { BusinessError } 24000004 - Access denied. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -381,20 +418,22 @@ declare namespace asset { * * @param { AssetMap } query - a map object containing attributes of the Asset to be queried. * @returns { Array } the query result. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000002 - Data not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types. + * 2. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000002 - The asset is not found. * @throws { BusinessError } 24000004 - Access denied. - * @throws { BusinessError } 24000005 - Device status mismatch. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000007 - Data corrupted. - * @throws { BusinessError } 24000008 - Database operation failed. - * @throws { BusinessError } 24000009 - Key management service is abnormal. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. - * @throws { BusinessError } 24000017 - Capability not supported. + * @throws { BusinessError } 24000005 - The screen lock status does not match. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000007 - The asset is corrupted. + * @throws { BusinessError } 24000008 - The database operation failed. + * @throws { BusinessError } 24000009 - The cryptography operation failed. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. + * @throws { BusinessError } 24000017 - The capability is not supported. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -405,35 +444,42 @@ declare namespace asset { * * @param { AssetMap } handle - a map object containing the handle returned by {@link preQuery}. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @since 11 */ function postQuery(handle: AssetMap): Promise; /** - * Post-processing (e.g. release cached resource) for querying multiple Assets that require user authentication in a + * Post-processing (e.g. release cached resource) for querying multiple Assets that require user authentication in a * specific user space. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } userId - the user identifier to post-query one or more Assets. + * @param { number } userId - the user identifier to post-query one or more Assets. The user identifier cannot be + * lower than 100. * @param { AssetMap } handle - a map object containing the handle returned by {@link preQueryAsUser}. * @returns { Promise } the promise object returned by the function. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - The caller doesn't have the permission. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @systemapi * @since 12 @@ -444,13 +490,16 @@ declare namespace asset { * Post-processing (e.g. release cached resource) for querying multiple Assets that require user authentication. * * @param { AssetMap } handle - a map object containing the handle returned by {@link preQuerySync}. - * @throws { BusinessError } 401 - Invalid argument. - * @throws { BusinessError } 24000001 - Service unavailable. - * @throws { BusinessError } 24000006 - Out of memory. - * @throws { BusinessError } 24000010 - IPC communication is abnormal. - * @throws { BusinessError } 24000011 - Bundle framework is abnormal. - * @throws { BusinessError } 24000012 - Account manager is abnormal. - * @throws { BusinessError } 24000013 - Access token manager is abnormal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * 3. Parameter verification failed. + * @throws { BusinessError } 24000001 - The ASSET service is unavailable. + * @throws { BusinessError } 24000006 - Insufficient memory. + * @throws { BusinessError } 24000010 - IPC failed. + * @throws { BusinessError } 24000011 - Calling the Bundle Manager service failed. + * @throws { BusinessError } 24000012 - Calling the OS Account service failed. + * @throws { BusinessError } 24000013 - Calling the Access Token service failed. * @syscap SystemCapability.Security.Asset * @since 12 */ @@ -459,6 +508,7 @@ declare namespace asset { /** * A Map type containing tag-value pairs that describe the attributes of an Asset. * + * @typedef { Map } * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -467,6 +517,7 @@ declare namespace asset { /** * A type that indicates the secret or attribute value of an Asset tag. * + * @typedef { boolean | number | Uint8Array } * @syscap SystemCapability.Security.Asset * @since 11 */ @@ -917,35 +968,35 @@ declare namespace asset { */ INVALID_ARGUMENT = 401, /** - * The error code indicates that the ASSET Service is unavailable. + * The error code indicates that the ASSET service is unavailable. * * @syscap SystemCapability.Security.Asset * @since 11 */ SERVICE_UNAVAILABLE = 24000001, /** - * The error code indicates that the queried Asset can not be found. + * The error code indicates that the asset is not found. * * @syscap SystemCapability.Security.Asset * @since 11 */ NOT_FOUND = 24000002, /** - * The error code indicates that the Asset already exists. + * The error code indicates that the asset already exists. * * @syscap SystemCapability.Security.Asset * @since 11 */ DUPLICATED = 24000003, /** - * The error code indicates that the access to Asset is denied. + * The error code indicates that access to the asset is denied. * * @syscap SystemCapability.Security.Asset * @since 11 */ ACCESS_DENIED = 24000004, /** - * The error code indicates that the screen lock status mismatches. + * The error code indicates that the screen lock status does not match. * * @syscap SystemCapability.Security.Asset * @since 11 @@ -959,63 +1010,63 @@ declare namespace asset { */ OUT_OF_MEMORY = 24000006, /** - * The error code indicates that the Asset is corrupted. + * The error code indicates that the asset is corrupted. * * @syscap SystemCapability.Security.Asset * @since 11 */ DATA_CORRUPTED = 24000007, /** - * The error code indicates that the database operation is failed. + * The error code indicates that the database operation failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ DATABASE_ERROR = 24000008, /** - * The error code indicates that the cryptography operation is failed. + * The error code indicates that the cryptography operation failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ CRYPTO_ERROR = 24000009, /** - * The error code indicates that the ipc communication is failed. + * The error code indicates that the ipc failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ IPC_ERROR = 24000010, /** - * The error code indicates that the operation of calling Bundle Manager Service is failed. + * The error code indicates that calling the Bundle Manager service failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ BMS_ERROR = 24000011, /** - * The error code indicates that the operation of calling OS Account Service is failed. + * The error code indicates that calling the OS Account service failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ ACCOUNT_ERROR = 24000012, /** - * The error code indicates that the operation of calling Access Token Service is failed. + * The error code indicates that calling the Access Token service failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ ACCESS_TOKEN_ERROR = 24000013, /** - * The error code indicates that the operation of file is failed. + * The error code indicates that the file operation failed. * * @syscap SystemCapability.Security.Asset * @since 11 */ FILE_OPERATION_ERROR = 24000014, /** - * The error code indicates that the operation of getting system time is failed. + * The error code indicates that getting the system time failed. * * @syscap SystemCapability.Security.Asset * @since 11 diff --git a/api/@ohos.security.cert.d.ts b/api/@ohos.security.cert.d.ts index 77fd7e4935134e0487580236bdf49265abbc94e4..af0948af7970d6da511fbe4c677f51b29062a240 100644 --- a/api/@ohos.security.cert.d.ts +++ b/api/@ohos.security.cert.d.ts @@ -1060,10 +1060,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @param { AsyncCallback } callback - the callback of verify. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 @@ -1073,10 +1071,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @param { AsyncCallback } callback - the callback of verify. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -1087,10 +1083,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @param { AsyncCallback } callback - the callback of verify. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -1104,10 +1098,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 @@ -1117,10 +1109,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -1131,10 +1121,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - public key to verify cert. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -1147,9 +1135,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1160,9 +1147,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1174,9 +1160,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1191,7 +1176,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @returns { Promise } the promise of X509 cert encoded data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1202,7 +1188,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @returns { Promise } the promise of X509 cert encoded data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1214,7 +1201,8 @@ declare namespace cert { * Get X509 cert encoded data. * * @returns { Promise } the promise of X509 cert encoded data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1261,10 +1249,8 @@ declare namespace cert { * Check the X509 cert validity with date. * * @param { string } date - indicates the cert date. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @throws { BusinessError } 19030003 - the certificate has not taken effect. @@ -1276,10 +1262,8 @@ declare namespace cert { * Check the X509 cert validity with date. * * @param { string } date - indicates the cert date. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @throws { BusinessError } 19030003 - the certificate has not taken effect. @@ -1292,10 +1276,8 @@ declare namespace cert { * Check the X509 cert validity with date. * * @param { string } date - indicates the cert date. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @throws { BusinessError } 19030003 - the certificate has not taken effect. @@ -1824,10 +1806,8 @@ declare namespace cert { * * @param { CertItemType } itemType * @returns { DataBlob } cert item value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1839,10 +1819,8 @@ declare namespace cert { * * @param { CertItemType } itemType * @returns { DataBlob } cert item value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1855,10 +1833,8 @@ declare namespace cert { * * @param { CertItemType } itemType * @returns { DataBlob } cert item value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -1874,10 +1850,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the match parameters. * @returns { boolean } true - match X509Cert, false - not match. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -1889,10 +1863,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the match parameters. * @returns { boolean } true - match X509Cert, false - not match. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -1993,10 +1965,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @param { AsyncCallback } callback - the callback of createX509Cert. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2008,10 +1978,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @param { AsyncCallback } callback - the callback of createX509Cert. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2024,10 +1992,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @param { AsyncCallback } callback - the callback of createX509Cert. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2043,10 +2009,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @returns { Promise } the promise of X509 cert instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2058,10 +2022,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @returns { Promise } the promise of X509 cert instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2074,10 +2036,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @returns { Promise } the promise of X509 cert instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2152,10 +2112,8 @@ declare namespace cert { * * @param { ExtensionOidType } valueType * @returns { DataArray } cert extension OID list value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2167,10 +2125,8 @@ declare namespace cert { * * @param { ExtensionOidType } valueType * @returns { DataArray } cert extension OID list value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2183,10 +2139,8 @@ declare namespace cert { * * @param { ExtensionOidType } valueType * @returns { DataArray } cert extension OID list value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2203,10 +2157,8 @@ declare namespace cert { * @param { ExtensionEntryType } valueType * @param { DataBlob } oid * @returns { DataBlob } cert extension entry value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2219,10 +2171,8 @@ declare namespace cert { * @param { ExtensionEntryType } valueType * @param { DataBlob } oid * @returns { DataBlob } cert extension entry value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2236,10 +2186,8 @@ declare namespace cert { * @param { ExtensionEntryType } valueType * @param { DataBlob } oid * @returns { DataBlob } cert extension entry value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2323,10 +2271,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @param { AsyncCallback } callback - the callback of of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2338,10 +2284,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @param { AsyncCallback } callback - the callback of of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2354,10 +2298,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @param { AsyncCallback } callback - the callback of of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2373,10 +2315,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @returns { Promise } the promise of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2388,10 +2328,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @returns { Promise } the promise of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2404,10 +2342,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert extensions data. * @returns { Promise } the promise of certificate extension instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -2431,9 +2367,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2448,7 +2383,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @returns { Promise } the promise of crl entry blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2521,9 +2457,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2535,9 +2470,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2552,7 +2486,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @returns { Promise } the promise of CRL entry blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2564,7 +2499,8 @@ declare namespace cert { * Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence. * * @returns { Promise } the promise of CRL entry blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2774,10 +2710,8 @@ declare namespace cert { * * @param { X509Cert } cert - input cert data. * @returns { boolean } result of Check cert is revoked or not. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Security.Cert * @since 9 * @deprecated since 11 @@ -2800,9 +2734,8 @@ declare namespace cert { * Get the der coding format. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2817,7 +2750,8 @@ declare namespace cert { * Get the der coding format. * * @returns { Promise } the promise of crl blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -2833,10 +2767,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 @@ -2850,10 +2782,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 @@ -2920,10 +2850,8 @@ declare namespace cert { * * @param { number } serialNumber - serial number of crl. * @returns { X509CrlEntry } next update of crl. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -2938,10 +2866,8 @@ declare namespace cert { * * @param { X509Cert } cert - cert of x509. * @returns { X509CrlEntry } X509CrlEntry instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -2955,9 +2881,8 @@ declare namespace cert { * Get all entries in this CRL. * * @param { AsyncCallback> } callback - the callback of getRevokedCerts. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -2971,7 +2896,8 @@ declare namespace cert { * Get all entries in this CRL. * * @returns { Promise> } the promise of X509CrlEntry instance. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3059,10 +2985,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @param { AsyncCallback } callback - the callback of createX509Crl to return x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3078,10 +3002,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @returns { Promise } the promise of x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3114,10 +3036,8 @@ declare namespace cert { * * @param { X509Cert } cert - input cert data. * @returns { boolean } result of Check cert is revoked or not. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Security.Cert * @crossplatform * @since 11 @@ -3127,10 +3047,8 @@ declare namespace cert { * * @param { X509Cert } cert - input cert data. * @returns { boolean } result of Check cert is revoked or not. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Security.Cert * @crossplatform * @atomicservice @@ -3161,9 +3079,8 @@ declare namespace cert { * Get the der coding format. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3175,9 +3092,8 @@ declare namespace cert { * Get the der coding format. * * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3192,7 +3108,8 @@ declare namespace cert { * Get the der coding format. * * @returns { Promise } the promise of CRL blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3204,7 +3121,8 @@ declare namespace cert { * Get the der coding format. * * @returns { Promise } the promise of CRL blob data. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3220,10 +3138,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -3234,10 +3150,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @param { AsyncCallback } callback - the callback of getEncoded. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -3251,10 +3165,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -3265,10 +3177,8 @@ declare namespace cert { * * @param { cryptoFramework.PubKey } key - input public Key. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -3376,10 +3286,8 @@ declare namespace cert { * * @param { bigint } serialNumber - serial number of CRL. * @returns { X509CRLEntry } next update of CRL. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3391,10 +3299,8 @@ declare namespace cert { * * @param { bigint } serialNumber - serial number of CRL. * @returns { X509CRLEntry } next update of CRL. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3409,10 +3315,8 @@ declare namespace cert { * * @param { X509Cert } cert - cert of x509. * @returns { X509CRLEntry } X509CRLEntry instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3424,10 +3328,8 @@ declare namespace cert { * * @param { X509Cert } cert - cert of x509. * @returns { X509CRLEntry } X509CRLEntry instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3441,9 +3343,8 @@ declare namespace cert { * Get all entries in this CRL. * * @param { AsyncCallback> } callback - the callback of getRevokedCerts. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3454,9 +3355,8 @@ declare namespace cert { * Get all entries in this CRL. * * @param { AsyncCallback> } callback - the callback of getRevokedCerts. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3470,7 +3370,8 @@ declare namespace cert { * Get all entries in this CRL. * * @returns { Promise> } the promise of X509CRLEntry instance. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3481,7 +3382,8 @@ declare namespace cert { * Get all entries in this CRL. * * @returns { Promise> } the promise of X509CRLEntry instance. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3648,10 +3550,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @returns { boolean } true - match X509CRL, false - not match. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3663,10 +3563,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @returns { boolean } true - match X509CRL, false - not match. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -3739,10 +3637,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @param { AsyncCallback } callback - the callback of createX509CRL to return x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3755,10 +3651,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @param { AsyncCallback } callback - the callback of createX509CRL to return x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3774,10 +3668,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @returns { Promise } the promise of x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3790,10 +3682,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicates the input CRL data. * @returns { Promise } the promise of x509 CRL instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert @@ -3833,10 +3723,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @param { AsyncCallback } callback - the callback of validate. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3854,10 +3742,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @param { AsyncCallback } callback - the callback of validate. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3876,10 +3762,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @param { AsyncCallback } callback - the callback of validate. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3901,10 +3785,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3922,10 +3804,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3944,10 +3824,8 @@ declare namespace cert { * * @param { CertChainData } certChain - indicate the cert chain validator data. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -3999,10 +3877,8 @@ declare namespace cert { * * @param { string } algorithm - indicates the cert chain validator type. * @returns { CertChainValidator } the cert chain validator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. @@ -4015,10 +3891,8 @@ declare namespace cert { * * @param { string } algorithm - indicates the cert chain validator type. * @returns { CertChainValidator } the cert chain validator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. @@ -4032,10 +3906,8 @@ declare namespace cert { * * @param { string } algorithm - indicates the cert chain validator type. * @returns { CertChainValidator } the cert chain validator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. @@ -4667,10 +4539,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object. * @returns { Promise> } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4682,10 +4552,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object. * @returns { Promise> } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4700,10 +4568,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object. * @param { AsyncCallback> } callback - the callback of select cert. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4715,10 +4581,8 @@ declare namespace cert { * * @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object. * @param { AsyncCallback> } callback - the callback of select cert. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4733,10 +4597,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @returns { Promise> } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4748,10 +4610,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @returns { Promise> } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4766,10 +4626,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @param { AsyncCallback> } callback - the callback of select CRL. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4781,10 +4639,8 @@ declare namespace cert { * * @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object. * @param { AsyncCallback> } callback - the callback of select CRL. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4801,10 +4657,8 @@ declare namespace cert { * @param { Array } certs - array of X509Cert. * @param { Array } [options] crls - array of X509CRL. * @returns { CertCRLCollection } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -4816,10 +4670,8 @@ declare namespace cert { * @param { Array } certs - array of X509Cert. * @param { Array } [options] crls - array of X509CRL. * @returns { CertCRLCollection } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @syscap SystemCapability.Security.Cert * @crossplatform @@ -4850,7 +4702,8 @@ declare namespace cert { * Get the X509 certificate list. * * @returns { Array } the X509 certificate list. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4861,7 +4714,8 @@ declare namespace cert { * Get the X509 certificate list. * * @returns { Array } the X509 certificate list. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -4876,10 +4730,8 @@ declare namespace cert { * * @param { CertChainValidationParameters } param - indicate the cert chain Validate parameters. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -4898,10 +4750,8 @@ declare namespace cert { * * @param { CertChainValidationParameters } param - indicate the cert chain Validate parameters. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -4923,10 +4773,8 @@ declare namespace cert { * * @param { CertChainValidationParameters } param - indicate the cert chain validate parameters. * @param { AsyncCallback } callback - indicate the cert chain validate result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -4945,10 +4793,8 @@ declare namespace cert { * * @param { CertChainValidationParameters } param - indicate the cert chain validate parameters. * @param { AsyncCallback } callback - indicate the cert chain validate result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5000,10 +4846,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @returns { Promise } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5016,10 +4860,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @returns { Promise } - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5035,10 +4877,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @param { AsyncCallback } callback - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5051,10 +4891,8 @@ declare namespace cert { * * @param { EncodingBlob } inStream - indicate the input cert data. * @param { AsyncCallback } callback - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5069,10 +4907,8 @@ declare namespace cert { * * @param { Array } certs - indicate the certificate array. * @returns { X509CertChain } the certificate chain object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5084,10 +4920,8 @@ declare namespace cert { * * @param { Array } certs - indicate the certificate array. * @returns { X509CertChain } the certificate chain object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert @@ -5102,10 +4936,8 @@ declare namespace cert { * * @param { CertChainBuildParameters } param - indicate the certificate chain build parameters. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5128,10 +4960,8 @@ declare namespace cert { * @param { Uint8Array } keystore - the file path of the P12. * @param { string } pwd - the password of the P12. * @returns { Promise> } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5153,10 +4983,8 @@ declare namespace cert { * * @param { string } nameStr - the string format of the Name type defined by X509. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5178,10 +5006,8 @@ declare namespace cert { * * @param { Uint8Array } nameDer - the DER format of the Name type defined by X509. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5227,10 +5053,8 @@ declare namespace cert { * * @param { string } type - the specified type name. * @returns { Array } distinguished name string. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 19020001 - memory error. * @throws { BusinessError } 19020002 - runtime error. * @throws { BusinessError } 19030001 - crypto operation error. @@ -5605,6 +5429,18 @@ declare namespace cert { * @since 12 */ options?: Array; + + /** + * The digest used to generate the ocsp cert id. + * + * @type { ?string } + * @default SHA256 + * @syscap SystemCapability.Security.Cert + * @crossplatform + * @atomicservice + * @since 12 + */ + ocspDigest?: string; } /** diff --git a/api/@ohos.security.certManager.d.ts b/api/@ohos.security.certManager.d.ts index 825eb2726e7da02d1f05de2996e9727c4431ae0e..6fbcf37404107ac956a5ec40edfecd093d90e8da 100644 --- a/api/@ohos.security.certManager.d.ts +++ b/api/@ohos.security.certManager.d.ts @@ -54,7 +54,7 @@ declare namespace certificateManager { CM_ERROR_NOT_SYSTEM_APP = 202, /** - * Indicates that the input parameters is invalid. + * Indicates that the input parameters are invalid. * * @syscap SystemCapability.Security.CertificateManager * @since 11 @@ -62,7 +62,7 @@ declare namespace certificateManager { CM_ERROR_INVALID_PARAMS = 401, /** - * Indicates that there is an internal error occurred when calling the API. + * Indicates that internal error. * * @syscap SystemCapability.Security.CertificateManager * @since 11 @@ -70,7 +70,7 @@ declare namespace certificateManager { CM_ERROR_GENERIC = 17500001, /** - * Indicates that the certificate do not exist. + * Indicates that the certificate does not exist. * * @syscap SystemCapability.Security.CertificateManager * @since 11 @@ -78,7 +78,7 @@ declare namespace certificateManager { CM_ERROR_NO_FOUND = 17500002, /** - * Indicates that the input is not valid certificate or credential. + * Indicates that the keystore is in an invalid format or the keystore password is incorrect. * * @syscap SystemCapability.Security.CertificateManager * @since 11 @@ -86,7 +86,7 @@ declare namespace certificateManager { CM_ERROR_INCORRECT_FORMAT = 17500003, /** - * Indicates that the count of certificates or credentials reach the max. + * Indicates that the number of certificates or credentials reaches the maximum allowed. * * @syscap SystemCapability.Security.CertificateManager * @since 12 @@ -94,7 +94,7 @@ declare namespace certificateManager { CM_ERROR_MAX_CERT_COUNT_REACHED = 17500004, /** - * Indicates that the application is not authorized by user. + * Indicates that the application is not authorized by the user. * * @syscap SystemCapability.Security.CertificateManager * @since 12 @@ -601,12 +601,12 @@ declare namespace certificateManager { * @param { Uint8Array } keystore - Indicates the keystore file with key pair and certificate. * @param { string } keystorePwd - Indicates the password of keystore file. * @param { string } certAlias - Indicates the certificate name inputted by the user. - * @param { AsyncCallback } callback - the callback of installPrivateCertificate. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500003 - the keystore is not valid format or keystorePwd is not correct. + * @param { AsyncCallback } callback - The callback of installPrivateCertificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500003 - The keystore is in an invalid format or the keystore password is incorrect. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -617,15 +617,16 @@ declare namespace certificateManager { * @param { Uint8Array } keystore - Indicates the keystore file with key pair and certificate. * @param { string } keystorePwd - Indicates the password of keystore file. * @param { string } certAlias - Indicates the certificate name inputted by the user. - * @param { AsyncCallback } callback - the callback of installPrivateCertificate. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500003 - the keystore is not valid format or keystorePwd is not correct. - * @throws { BusinessError } 17500004 - the number of credentials is beyond max. + * @param { AsyncCallback } callback - The callback of installPrivateCertificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500003 - The keystore is in an invalid format or the keystore password is incorrect. + * @throws { BusinessError } 17500004 - The number of certificates or credentials reaches the maximum allowed. * @syscap SystemCapability.Security.CertificateManager * @since 12 - */ + */ function installPrivateCertificate( keystore: Uint8Array, keystorePwd: string, @@ -640,12 +641,12 @@ declare namespace certificateManager { * @param { Uint8Array } keystore - Indicates the keystore file with key pair and certificate. * @param { string } keystorePwd - Indicates the password of keystore file. * @param { string } certAlias - Indicates the certificate name inputted by the user. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500003 - the keystore is not valid format or keystorePwd is not correct. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500003 - The keystore is in an invalid format or the keystore password is incorrect. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -656,15 +657,16 @@ declare namespace certificateManager { * @param { Uint8Array } keystore - Indicates the keystore file with key pair and certificate. * @param { string } keystorePwd - Indicates the password of keystore file. * @param { string } certAlias - Indicates the certificate name inputted by the user. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500003 - the keystore is not valid format or keystorePwd is not correct. - * @throws { BusinessError } 17500004 - the number of credentials is beyond max. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500003 - The keystore is in an invalid format or the keystore password is incorrect. + * @throws { BusinessError } 17500004 - The number of certificates or credentials reaches the maximum allowed. * @syscap SystemCapability.Security.CertificateManager * @since 12 - */ + */ function installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string): Promise; /** @@ -672,12 +674,12 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates key's name. - * @param { AsyncCallback } callback - the callback of uninstallPrivateCertificate. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @param { AsyncCallback } callback - The callback of uninstallPrivateCertificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -688,12 +690,12 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates key's name. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -703,12 +705,12 @@ declare namespace certificateManager { * Get a list of all applications private certificates. * * @permission ohos.permission.ACCESS_CERT_MANAGER and ohos.permission.ACCESS_CERT_MANAGER_INTERNAL - * @param { AsyncCallback } callback - the callback of getAllAppPrivateCertificates. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 202 - the application is not system app. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @param { AsyncCallback } callback - The callback of getAllAppPrivateCertificates. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @systemapi * @since 11 @@ -719,10 +721,10 @@ declare namespace certificateManager { * Get a list of all applications private certificates. * * @permission ohos.permission.ACCESS_CERT_MANAGER and ohos.permission.ACCESS_CERT_MANAGER_INTERNAL - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 202 - the application is not system app. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @systemapi * @since 11 @@ -734,12 +736,12 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates key's name. - * @param { AsyncCallback } callback - the callback of getPrivateCertificate. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @param { AsyncCallback } callback - The callback of getPrivateCertificate. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -750,12 +752,12 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates key's name. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -767,12 +769,12 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } authUri - Indicates the authorization relationship between application and application certificate. * @param { CMSignatureSpec } spec - Indicates the properties of the signature and verification. - * @param { AsyncCallback } callback - the callback of init. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @param { AsyncCallback } callback - The callback of init. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -782,13 +784,13 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } authUri - Indicates the authorization relationship between application and application certificate. * @param { CMSignatureSpec } spec - Indicates the properties of the signature and verification. - * @param { AsyncCallback } callback - the callback of init. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . - * @throws { BusinessError } 17500005 - the application is not authorized by user . + * @param { AsyncCallback } callback - The callback of init. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. + * @throws { BusinessError } 17500005 - The application is not authorized by the user. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -800,12 +802,12 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } authUri - Indicates the authorization relationship between application and application certificate. * @param { CMSignatureSpec } spec - Indicates the properties of the signature and verification. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -815,13 +817,13 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } authUri - Indicates the authorization relationship between application and application certificate. * @param { CMSignatureSpec } spec - Indicates the properties of the signature and verification. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . - * @throws { BusinessError } 17500005 - the application is not authorized by user . + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. + * @throws { BusinessError } 17500005 - The application is not authorized by the user. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -833,11 +835,11 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. * @param { Uint8Array } data - Indicates the input value. - * @param { AsyncCallback } callback - the callback of update. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @param { AsyncCallback } callback - The callback of update. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -849,11 +851,11 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. * @param { Uint8Array } data - Indicates the input value. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -864,11 +866,11 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. - * @param { AsyncCallback } callback - the callback of finish. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @param { AsyncCallback } callback - The callback of finish. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -880,11 +882,11 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. * @param { Uint8Array } signature - Indicates the sign data. - * @param { AsyncCallback } callback - the callback of finish. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @param { AsyncCallback } callback - The callback of finish. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -896,11 +898,11 @@ declare namespace certificateManager { * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. * @param { Uint8Array } [options] signature - Indicates the sign data. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -911,11 +913,11 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. - * @param { AsyncCallback } callback - the callback of abort. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @param { AsyncCallback } callback - The callback of abort. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ @@ -926,28 +928,28 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { Uint8Array } handle - Indicates the handle of the init operation. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 11 */ function abort(handle: Uint8Array): Promise; - + /** * Get the detail of public application certificate. * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates the key's name. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist . - * @throws { BusinessError } 17500005 - the application is not authorized by user . + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. + * @throws { BusinessError } 17500005 - The application is not authorized by the user. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -958,11 +960,11 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } keyUri - Indicates the key's name. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed.Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3.Parameter verification failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -972,9 +974,9 @@ declare namespace certificateManager { * Get a list of all user trusted CA certificates. * * @permission ohos.permission.ACCESS_CERT_MANAGER - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -985,11 +987,12 @@ declare namespace certificateManager { * * @permission ohos.permission.ACCESS_CERT_MANAGER * @param { string } certUri - Indicates the certificate's name. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 401 - the parameter check failed. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. - * @throws { BusinessError } 17500002 - the certificate do not exist. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17500001 - Internal error. + * @throws { BusinessError } 17500002 - The certificate does not exist. * @syscap SystemCapability.Security.CertificateManager * @since 12 */ @@ -999,10 +1002,10 @@ declare namespace certificateManager { * Get a list of all system application certificates, such as WLAN, VPN certificate. * * @permission ohos.permission.ACCESS_CERT_MANAGER - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 201 - the application has no permission to call the API. - * @throws { BusinessError } 202 - the application is not system app. - * @throws { BusinessError } 17500001 - there is an generic error occurred when calling the API. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 17500001 - Internal error. * @syscap SystemCapability.Security.CertificateManager * @systemapi * @since 12 diff --git a/api/@ohos.security.cryptoFramework.d.ts b/api/@ohos.security.cryptoFramework.d.ts index 236a9d80da819eb897e18f950ba5abfb0ecf858e..4553df75766237be244829ae895cfd478b302ba0 100644 --- a/api/@ohos.security.cryptoFramework.d.ts +++ b/api/@ohos.security.cryptoFramework.d.ts @@ -791,10 +791,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -805,10 +803,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -820,10 +816,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -838,10 +832,8 @@ declare namespace cryptoFramework { * * @param { string } format - indicates the encoding format. * @returns { DataBlob } the binary data of the key object in DER format. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -856,7 +848,8 @@ declare namespace cryptoFramework { * * @param { string } format - indicates the encoding format. * @returns { string } the string of the key object in PEM format. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -897,10 +890,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -911,10 +902,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -926,10 +915,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpecItem } itemType - indicates the specified parameters type. * @returns { bigint | string | number } the specified parameters value. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -944,10 +931,8 @@ declare namespace cryptoFramework { * * @param { string } format - indicates the encoding format. * @returns { DataBlob } the binary data of the key object in DER format. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -962,7 +947,8 @@ declare namespace cryptoFramework { * * @param { string } format - indicates the encoding format. * @returns { string } the string of the key object in PEM format. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1079,10 +1065,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @param { AsyncCallback } callback - the callback used to return random DataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1093,10 +1077,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @param { AsyncCallback } callback - the callback used to return random DataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1111,10 +1093,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @returns { Promise } the promise used to return the generated random blob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1125,10 +1105,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @returns { Promise } the promise used to return the generated random blob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1143,10 +1121,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @returns { DataBlob } return the generated random blob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1157,10 +1133,8 @@ declare namespace cryptoFramework { * * @param { number } len - indicates the length of random DataBlob. * @returns { DataBlob } return the generated random blob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1185,6 +1159,7 @@ declare namespace cryptoFramework { * @param { DataBlob } seed - indicates the seed DataBlob. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework + * @crossplatform * @atomicservice * @since 11 */ @@ -1295,7 +1270,8 @@ declare namespace cryptoFramework { * Used to generate asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1305,7 +1281,8 @@ declare namespace cryptoFramework { * Used to generate asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1316,7 +1293,8 @@ declare namespace cryptoFramework { * Used to generate asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1330,7 +1308,8 @@ declare namespace cryptoFramework { * Used to generate asymmetric keypair. * * @returns { KeyPair } return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1346,10 +1325,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1361,10 +1338,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1377,10 +1352,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1396,10 +1369,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1411,10 +1382,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1427,10 +1396,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @param { AsyncCallback } callback - the callback used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1446,10 +1413,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1461,10 +1426,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1477,10 +1440,8 @@ declare namespace cryptoFramework { * @param { DataBlob } pubKey - the public key data blob. * @param { DataBlob } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1496,10 +1457,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1511,10 +1470,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1527,10 +1484,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1546,10 +1501,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } pubKey - the public key data blob. * @param { DataBlob | null } priKey - the private key data blob. * @returns { KeyPair } return keypair. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1565,7 +1518,8 @@ declare namespace cryptoFramework { * @param { string | null } pubKey - the public key string in PEM format. * @param { string | null } priKey - the private key string in PEM format. * @returns { Promise } return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1581,7 +1535,8 @@ declare namespace cryptoFramework { * @param { string | null } pubKey - the public key string in PEM format. * @param { string | null } priKey - the private key string in PEM format. * @returns { KeyPair } return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -1721,10 +1676,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @param { AsyncCallback } callback - the callback of generateSymKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -1734,10 +1687,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @param { AsyncCallback } callback - the callback of generateSymKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1748,10 +1699,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @param { AsyncCallback } callback - the callback of generateSymKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1765,10 +1714,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -1778,10 +1725,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1792,10 +1737,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1809,10 +1752,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } key - the key data blob. * @returns { SymKey } return SymKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1856,10 +1797,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. Multiple parameters need to be concatenated by "|". * @returns { AsyKeyGenerator } the asymmetric key generator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -1870,10 +1809,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. * @returns { AsyKeyGenerator } the asymmetric key generator instance. Multiple parameters need to be concatenated by "|". - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -1885,10 +1822,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. Multiple parameters need to be concatenated by "|". * @returns { AsyKeyGenerator } the asymmetric key generator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -1903,10 +1838,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. * @returns { SymKeyGenerator } the symmetric key generator instance. Multiple parameters need to be concatenated by "|". - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -1916,10 +1849,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. Multiple parameters need to be concatenated by "|". * @returns { SymKeyGenerator } the symmetric key generator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1930,10 +1861,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name. Multiple parameters need to be concatenated by "|". * @returns { SymKeyGenerator } the symmetric key generator instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1972,10 +1901,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -1985,10 +1912,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -1999,10 +1924,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2016,10 +1939,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2029,10 +1950,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2043,10 +1962,8 @@ declare namespace cryptoFramework { * * @param { SymKey } key - indicates the SymKey. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2059,7 +1976,8 @@ declare namespace cryptoFramework { * Init hmac with given SymKey. * * @param { SymKey } key - indicates the SymKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2073,10 +1991,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2086,10 +2002,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2100,10 +2014,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2117,10 +2029,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2130,10 +2040,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2144,10 +2052,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2160,7 +2066,8 @@ declare namespace cryptoFramework { * Update hmac with DataBlob. * * @param { DataBlob } input - indicates the DataBlob. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2237,7 +2144,8 @@ declare namespace cryptoFramework { * Output the result of hmac calculation. * * @returns { DataBlob } the sync returned by the function. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -2312,10 +2220,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the mac algorithm name. * @returns { Mac } returns the created mac instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2325,10 +2231,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the mac algorithm name. * @returns { Mac } returns the created mac instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2339,10 +2243,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the mac algorithm name. * @returns { Mac } returns the created mac instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2381,10 +2283,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2394,10 +2294,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2408,10 +2306,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2425,10 +2321,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2438,10 +2332,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2452,10 +2344,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } input - indicates the DataBlob. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2468,7 +2358,8 @@ declare namespace cryptoFramework { * Update md with DataBlob. * * @param { DataBlob } input - indicates the DataBlob. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2545,7 +2436,8 @@ declare namespace cryptoFramework { * Output the result of md calculation. * * @returns { DataBlob } the sync returned by the function. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -2620,10 +2512,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the md algorithm name. * @returns { Md } returns the created md instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2633,10 +2523,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the md algorithm name. * @returns { Md } returns the created md instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2647,10 +2535,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the md algorithm name. * @returns { Md } returns the created md instance. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2987,10 +2873,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3004,10 +2888,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3022,10 +2904,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3043,10 +2923,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3060,10 +2938,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3078,10 +2954,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @param { AsyncCallback } callback - the callback of the init function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3099,10 +2973,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3116,10 +2988,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3134,10 +3004,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3155,10 +3023,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3172,10 +3038,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3190,10 +3054,8 @@ declare namespace cryptoFramework { * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3210,10 +3072,8 @@ declare namespace cryptoFramework { * @param { CryptoMode } opMode - indicates the crypto mode is encryption or decryption. * @param { Key } key - indicates the symmetric key or the asymmetric key. * @param { ParamsSpec | null } params - indicates the algorithm parameters such as IV. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3230,10 +3090,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3246,10 +3104,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3263,10 +3119,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the update function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3283,10 +3137,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3299,10 +3151,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3316,10 +3166,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3336,10 +3184,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be encrypted or decrypted. * @returns { DataBlob } cipherText when encrypted or plainText when decrypted. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3356,10 +3202,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3372,10 +3216,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3389,10 +3231,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3409,10 +3249,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3425,10 +3263,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3442,10 +3278,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @param { AsyncCallback } callback - the callback of the doFinal function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3462,10 +3296,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3478,10 +3310,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3495,10 +3325,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3515,10 +3343,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3531,10 +3357,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3548,10 +3372,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3568,10 +3390,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - indicates the data to be finally encrypted or decrypted. * @returns { DataBlob } cipherText when encrypted or plainText when decrypted. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3588,10 +3408,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @param { Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3604,10 +3422,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @param { Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3621,10 +3437,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @param { Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3641,10 +3455,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @returns { string | Uint8Array } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3657,10 +3469,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @returns { string | Uint8Array } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3674,10 +3484,8 @@ declare namespace cryptoFramework { * * @param { CipherSpecItem } itemType - indicates the specified parameter type. * @returns { string | Uint8Array } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3725,10 +3533,8 @@ declare namespace cryptoFramework { * * @param { string } transformation - indicates the description to be transformed to cipher specifications. * @returns { Cipher } the cipher object returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -3741,10 +3547,8 @@ declare namespace cryptoFramework { * * @param { string } transformation - indicates the description to be transformed to cipher specifications. * @returns { Cipher } the cipher object returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -3759,10 +3563,8 @@ declare namespace cryptoFramework { * @param { string } transformation - indicates the description to be transformed to cipher specifications. * Multiple parameters need to be concatenated by "|". * @returns { Cipher } the cipher object returned by the function. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -3802,10 +3604,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3817,10 +3617,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3833,10 +3631,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3852,10 +3648,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3867,10 +3661,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3883,10 +3675,8 @@ declare namespace cryptoFramework { * * @param { PriKey } priKey - the private key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3901,10 +3691,8 @@ declare namespace cryptoFramework { * Used to init environment. * * @param { PriKey } priKey - the private key. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3920,10 +3708,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3935,10 +3721,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3951,10 +3735,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - the call back function return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3970,10 +3752,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -3985,10 +3765,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4001,10 +3779,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4019,10 +3795,8 @@ declare namespace cryptoFramework { * Used to append the message need to be signed. * * @param { DataBlob } data - the data need to be signed. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4038,10 +3812,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4053,10 +3825,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4069,10 +3839,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4088,10 +3856,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4103,10 +3869,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4119,10 +3883,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the data need to be signed. * @param { AsyncCallback } callback - return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4138,10 +3900,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4153,10 +3913,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4169,10 +3927,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4188,10 +3944,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4203,10 +3957,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4219,10 +3971,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the private key. * @returns { Promise } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4238,10 +3988,8 @@ declare namespace cryptoFramework { * * @param { DataBlob | null } data - the private key. * @returns { DataBlob } return the signed message. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4258,10 +4006,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4274,10 +4020,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4291,10 +4035,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4311,10 +4053,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number | Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4328,10 +4068,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number | Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4348,10 +4086,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4364,10 +4100,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4381,10 +4115,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4455,10 +4187,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4470,10 +4200,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4486,10 +4214,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4505,10 +4231,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4520,10 +4244,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4536,10 +4258,8 @@ declare namespace cryptoFramework { * * @param { PubKey } pubKey - the public key. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4554,10 +4274,8 @@ declare namespace cryptoFramework { * Used to init environment. * * @param { PubKey } pubKey - the public key. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4573,10 +4291,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4588,10 +4304,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4604,10 +4318,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @param { AsyncCallback } callback - return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4623,10 +4335,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4638,10 +4348,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4654,10 +4362,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } data - the data need to be verified. * @returns { Promise } return nothing. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4672,10 +4378,8 @@ declare namespace cryptoFramework { * Used to append the message need to be verified. * * @param { DataBlob } data - the data need to be verified. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4692,10 +4396,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4708,10 +4410,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4725,10 +4425,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4745,10 +4443,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4761,10 +4457,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4778,10 +4472,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @param { AsyncCallback } callback - return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4798,10 +4490,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4814,10 +4504,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4831,10 +4519,8 @@ declare namespace cryptoFramework { * @param { DataBlob } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4851,10 +4537,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4867,10 +4551,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4884,10 +4566,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { Promise } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4904,10 +4584,8 @@ declare namespace cryptoFramework { * @param { DataBlob | null } data - the data need to be verified. * @param { DataBlob } signatureData - the signature data. * @returns { boolean } return the verify result. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4924,10 +4602,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } signatureData - the signature data. * @returns { Promise } the promise used to return the recovered data. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4944,10 +4620,8 @@ declare namespace cryptoFramework { * * @param { DataBlob } signatureData - the signature data. * @returns { DataBlob | null } return the recovered data. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4964,10 +4638,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4980,10 +4652,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -4997,10 +4667,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5017,10 +4685,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number | Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5034,10 +4700,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @param { number | Uint8Array } itemValue - the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5054,10 +4718,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5070,10 +4732,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5087,10 +4747,8 @@ declare namespace cryptoFramework { * * @param { SignSpecItem } itemType - indicates the specified parameter type. * @returns { string | number } the value of the specified parameter. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5136,10 +4794,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. * @returns { Sign } the sign class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5150,10 +4806,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. * @returns { Sign } the sign class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5165,10 +4819,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. Multiple parameters need to be concatenated by "|". * @returns { Sign } the sign class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5183,10 +4835,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and the parameters. * @returns { Verify } the verify class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5197,10 +4847,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and the parameters. * @returns { Verify } the verify class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5212,10 +4860,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and the parameters. Multiple parameters need to be concatenated by "|". * @returns { Verify } the verify class. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5256,10 +4902,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return the secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5272,10 +4916,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return the secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5289,10 +4931,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @param { AsyncCallback } callback - return the secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5309,10 +4949,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @returns { Promise } the promise used to return secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5325,10 +4963,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @returns { Promise } the promise used to return secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5342,10 +4978,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @returns { Promise } the promise used to return secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5362,10 +4996,8 @@ declare namespace cryptoFramework { * @param { PriKey } priKey - the private key. * @param { PubKey } pubKey - the public key. * @returns { DataBlob } the promise used to return secret. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -5411,10 +5043,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. * @returns { KeyAgreement } the key agreement object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5425,10 +5055,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. * @returns { KeyAgreement } the key agreement object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -5440,10 +5068,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. Multiple parameters need to be concatenated by "|". * @returns { KeyAgreement } the key agreement object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -7248,10 +6874,8 @@ declare namespace cryptoFramework { * * @param { string } curveName - indicates curve name according to the ECC elliptic curve. * @returns { ECCCommonParamsSpec } the ECC common params spec obj. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @static @@ -7264,10 +6888,8 @@ declare namespace cryptoFramework { * * @param { string } curveName - indicates curve name according to the ECC elliptic curve. * @returns { ECCCommonParamsSpec } the ECC common params spec obj. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @static @@ -7284,10 +6906,8 @@ declare namespace cryptoFramework { * @param { string } curveName - indicates curve name according to the ECC elliptic curve. * @param { Uint8Array } encodedPoint - the encoded ECC point data. * @returns { Point } the ECC point object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @static @@ -7305,10 +6925,8 @@ declare namespace cryptoFramework { * @param { Point } point - the ECC point object. * @param { string } format - indicates the format of the encoded point data. * @returns { Uint8Array } the encoded point data. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @static @@ -7608,10 +7226,8 @@ declare namespace cryptoFramework { * @param { number } pLen - indicates the byte length of the prime p. * @param { number } [skLen] - indicates the byte length of the private key. * @returns { DHCommonParamsSpec } the DH common params spec obj. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -7626,10 +7242,8 @@ declare namespace cryptoFramework { * @param { number } pLen - indicates the byte length of the prime p. * @param { number } [skLen] - indicates the byte length of the private key. * @returns { DHCommonParamsSpec } the DH common params spec obj. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -8206,7 +7820,8 @@ declare namespace cryptoFramework { * Generate an asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8216,7 +7831,8 @@ declare namespace cryptoFramework { * Generate an asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8227,7 +7843,8 @@ declare namespace cryptoFramework { * Generate an asymmetric keypair. * * @returns { Promise } the promise used to return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8241,7 +7858,8 @@ declare namespace cryptoFramework { * Generate an asymmetric keypair. * * @returns { KeyPair } return keypair. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8255,8 +7873,7 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @param { AsyncCallback } callback - the callback used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8266,8 +7883,7 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @param { AsyncCallback } callback - the callback used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8278,8 +7894,7 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @param { AsyncCallback } callback - the callback used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8293,7 +7908,8 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @returns { Promise } the promise used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8303,7 +7919,8 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @returns { Promise } the promise used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8314,7 +7931,8 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @returns { Promise } the promise used to return PriKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8328,7 +7946,8 @@ declare namespace cryptoFramework { * Generate a private key instance. * * @returns { PriKey } return PriKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8377,7 +7996,8 @@ declare namespace cryptoFramework { * Generate a public key instance. * * @returns { Promise } the promise used to return PubKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8387,7 +8007,8 @@ declare namespace cryptoFramework { * Generate a public key instance. * * @returns { Promise } the promise used to return PubKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8398,7 +8019,8 @@ declare namespace cryptoFramework { * Generate a public key instance. * * @returns { Promise } the promise used to return PubKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8412,7 +8034,8 @@ declare namespace cryptoFramework { * Generate a public key instance. * * @returns { PubKey } return PubKey. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8457,10 +8080,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpec } asyKeySpec - indicates the associated parameters of algorithm. * @returns { AsyKeyGeneratorBySpec } the generator obj create by asyKeySpec. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -8471,10 +8092,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpec } asyKeySpec - indicates the associated parameters of algorithm. * @returns { AsyKeyGeneratorBySpec } the generator obj create by asyKeySpec. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -8486,10 +8105,8 @@ declare namespace cryptoFramework { * * @param { AsyKeySpec } asyKeySpec - indicates the associated parameters of algorithm. * @returns { AsyKeyGeneratorBySpec } the generator obj create by asyKeySpec. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -8710,10 +8327,8 @@ declare namespace cryptoFramework { * * @param { KdfSpec } params - the input params of key derivation function. * @param { AsyncCallback } callback - the callback used to return dataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8725,10 +8340,8 @@ declare namespace cryptoFramework { * * @param { KdfSpec } params - the input params of key derivation function. * @param { AsyncCallback } callback - the callback used to return dataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8743,10 +8356,8 @@ declare namespace cryptoFramework { * * @param { KdfSpec } params - the input params of key derivation function. * @returns { Promise } the promise used to return dataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8758,10 +8369,8 @@ declare namespace cryptoFramework { * * @param { KdfSpec } params - the input params of key derivation function. * @returns { Promise } the promise used to return dataBlob. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -8776,7 +8385,8 @@ declare namespace cryptoFramework { * * @param { KdfSpec } params - the input params of key derivation function. * @returns { DataBlob } the sync used to return dataBlob. - * @throws { BusinessError } 401 - invalid parameters. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17620002 - runtime error. * @throws { BusinessError } 17630001 - crypto operation error. @@ -8814,10 +8424,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. * @returns { Kdf } the key derivation function object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -8829,10 +8437,8 @@ declare namespace cryptoFramework { * * @param { string } algName - indicates the algorithm name and params. Multiple parameters need to be concatenated by "|". * @returns { Kdf } the key derivation function object. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @syscap SystemCapability.Security.CryptoFramework @@ -8912,10 +8518,8 @@ declare namespace cryptoFramework { * @param { SM2CipherTextSpec } spec - indicates the specific data of SM2 ciphertext. * @param { string } [mode] - indicates the arrangement mode of the SM2 ciphertext. * @returns { DataBlob } the SM2 ciphertext in ASN.1 format. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @static @@ -8932,10 +8536,8 @@ declare namespace cryptoFramework { * @param { DataBlob } cipherText - indicates the SM2 ciphertext in ASN.1 format. * @param { string } [mode] - indicates the arrangement mode of the SM2 ciphertext. * @returns { SM2CipherTextSpec } the specific data of SM2 ciphertext. - * @throws { BusinessError } 401 - invalid parameters. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @static diff --git a/api/@ohos.security.huks.d.ts b/api/@ohos.security.huks.d.ts index f9f2c2363ccdb9fb4f9e8048f5b5af8057fefe3e..e2e4760eed19f25295ccb1a8edda67482e2b2f8f 100644 --- a/api/@ohos.security.huks.d.ts +++ b/api/@ohos.security.huks.d.ts @@ -1773,7 +1773,7 @@ declare namespace huks { function abortSession(handle: number, options: HuksOptions): Promise; /** - * Key Attestation. + * Key Attestation. This API can be called only by system applications. * * @permission ohos.permission.ATTEST_KEY * @param { string } keyAlias - keyAlias indicates the key's name. @@ -1830,7 +1830,7 @@ declare namespace huks { function attestKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise; /** - * Key Attestation. + * Key Attestation. This API can be called only by system applications. * * @permission ohos.permission.ATTEST_KEY * @param { string } keyAlias - keyAlias indicates the key's name. @@ -2881,13 +2881,13 @@ declare namespace huks { */ HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015, /** - * Device password is required but not set. + * A device password is required but not set. * * @syscap SystemCapability.Security.Huks.Extension * @since 11 */ /** - * Device password is required but not set. + * A device password is required but not set. * * @syscap SystemCapability.Security.Huks.Extension * @atomicservice diff --git a/api/@ohos.sendableResourceManager.d.ets b/api/@ohos.sendableResourceManager.d.ets new file mode 100755 index 0000000000000000000000000000000000000000..b6d533c61d68b67fcd7ee10e524774e485170aca --- /dev/null +++ b/api/@ohos.sendableResourceManager.d.ets @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit LocalizationKit + */ + +import { Resource as _Resource } from './global/resource'; +import { SendableResource as _SendableResource } from './global/sendableResource'; + +/** + * Provides sendable resource related APIs. + * + * @namespace sendableResourceManager + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ +declare namespace sendableResourceManager { + + /** + * Convert the resource object to a sendable resource object. + * + * @param { Resource } resource - The resource object. + * @returns { SendableResource } The sendable resource object is returned. + * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; + * 2.Parameter verification failed. + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + export function resourceToSendableResource(resource: Resource): SendableResource; + + /** + * Convert the sendable resource object to a resource object. + * + * @param { SendableResource } resource - The sendable resource object. + * @returns { Resource } The resource object is returned. + * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; + * 2.Parameter verification failed. + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + export function sendableResourceToResource(resource: SendableResource): Resource; + + /** + * Contains resource descriptor information. + * + * @typedef {_Resource} + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + export type Resource = _Resource; + + /** + * Contains sendable resource descriptor information. + * + * @typedef {_SendableResource} + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + export type SendableResource = _SendableResource; + +} export default sendableResourceManager; \ No newline at end of file diff --git a/api/@ohos.sensor.d.ts b/api/@ohos.sensor.d.ts index 6ebcbf4e35148e22ceea2a97427aab0307db1e44..65ec6fc5a5b286b73d27d71a01929a499d25ebd3 100644 --- a/api/@ohos.sensor.d.ts +++ b/api/@ohos.sensor.d.ts @@ -235,7 +235,8 @@ declare namespace sensor { * @param { SensorId.COLOR } type - Indicate the sensor type to listen for, {@code SensorId.COLOR}. * @param { Callback } callback - callback color data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @systemapi @@ -246,7 +247,8 @@ declare namespace sensor { * @param { SensorId.COLOR } type - Indicate the sensor type to listen for, {@code SensorId.COLOR}. * @param { Callback } callback - callback color data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @syscap SystemCapability.Sensors.Sensor @@ -260,7 +262,8 @@ declare namespace sensor { * @param { SensorId.SAR } type - Indicate the sensor type to listen for, {@code SensorId.SAR}. * @param { Callback } callback - callback sar data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @systemapi @@ -271,7 +274,8 @@ declare namespace sensor { * @param { SensorId.SAR } type - Indicate the sensor type to listen for, {@code SensorId.SAR}. * @param { Callback } callback - callback sar data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @syscap SystemCapability.Sensors.Sensor @@ -287,7 +291,8 @@ declare namespace sensor { * @param { Callback } callback - callback accelerometer data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -299,7 +304,8 @@ declare namespace sensor { * @param { Callback } callback - callback accelerometer data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @atomicservice @@ -315,7 +321,8 @@ declare namespace sensor { * @param { Callback } callback - callback uncalibrated accelerometer data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -328,7 +335,8 @@ declare namespace sensor { * @param { SensorId.AMBIENT_LIGHT } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_LIGHT}. * @param { Callback } callback - callback ambient data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -340,7 +348,8 @@ declare namespace sensor { * @param { SensorId.AMBIENT_TEMPERATURE } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_TEMPERATURE}. * @param { Callback } callback - callback temperature data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -353,7 +362,8 @@ declare namespace sensor { * @param { SensorId.BAROMETER } type - Indicate the sensor type to listen for, {@code SensorId.BAROMETER}. * @param { Callback } callback - callback barometer data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -365,7 +375,8 @@ declare namespace sensor { * @param { SensorId.GRAVITY } type - Indicate the sensor type to listen for, {@code SensorId.GRAVITY}. * @param { Callback } callback - callback gravity data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -380,7 +391,8 @@ declare namespace sensor { * @param { Callback } callback - callback gyroscope data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -392,7 +404,8 @@ declare namespace sensor { * @param { Callback } callback - callback gyroscope data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @atomicservice @@ -408,7 +421,8 @@ declare namespace sensor { * @param { Callback } callback - callback uncalibrated gyroscope data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -421,7 +435,8 @@ declare namespace sensor { * @param { SensorId.HALL } type - Indicate the sensor type to listen for, {@code SensorId.HALL}. * @param { Callback } callback - callback uncalibrated gyroscope data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -435,7 +450,8 @@ declare namespace sensor { * @param { Callback } callback - callback heart rate data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -448,7 +464,8 @@ declare namespace sensor { * @param { SensorId.HUMIDITY } type - Indicate the sensor type to listen for, {@code SensorId.HUMIDITY}. * @param { Callback } callback - callback humidity data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -463,7 +480,8 @@ declare namespace sensor { * @param { Callback } callback - callback linear acceleration data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -476,7 +494,8 @@ declare namespace sensor { * @param { SensorId.MAGNETIC_FIELD } type - Indicate the sensor type to listen for, {@code SensorId.MAGNETIC_FIELD}. * @param { Callback } callback - callback magnetic field data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -490,7 +509,8 @@ declare namespace sensor { * {@code SensorId.MAGNETIC_FIELD_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated magnetic field data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -503,7 +523,8 @@ declare namespace sensor { * @param { SensorId.ORIENTATION } type - Indicate the sensor type to listen for, {@code SensorId.ORIENTATION}. * @param { Callback } callback - callback orientation data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -513,7 +534,8 @@ declare namespace sensor { * @param { SensorId.ORIENTATION } type - Indicate the sensor type to listen for, {@code SensorId.ORIENTATION}. * @param { Callback } callback - callback orientation data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @atomicservice @@ -529,7 +551,8 @@ declare namespace sensor { * @param { Callback } callback - callback pedometer data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -543,7 +566,8 @@ declare namespace sensor { * @param { Callback } callback - callback pedometer detection data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -556,7 +580,8 @@ declare namespace sensor { * @param { SensorId.PROXIMITY } type - Indicate the sensor type to listen for, {@code SensorId.PROXIMITY}. * @param { Callback } callback - callback proximity data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -568,7 +593,8 @@ declare namespace sensor { * @param { SensorId.ROTATION_VECTOR } type - Indicate the sensor type to listen for, {@code SensorId.ROTATION_VECTOR}. * @param { Callback } callback - callback rotation vector data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -581,7 +607,8 @@ declare namespace sensor { * @param { SensorId.SIGNIFICANT_MOTION } type - Indicate the sensor type to listen for, {@code SensorId.SIGNIFICANT_MOTION}. * @param { Callback } callback - callback significant motion data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -594,7 +621,8 @@ declare namespace sensor { * @param { SensorId.WEAR_DETECTION } type - Indicate the sensor type to listen for, {@code SensorId.WEAR_DETECTION}. * @param { Callback } callback - callback wear detection data. * @param { Options } [options] - Optional parameters specifying the interval at which sensor data is reported, {@code Options}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -608,7 +636,8 @@ declare namespace sensor { * @param { SensorId.ACCELEROMETER } type - Indicate the sensor type to listen for, {@code SensorId.ACCELEROMETER}. * @param { Callback } callback - callback accelerometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -621,7 +650,8 @@ declare namespace sensor { * @param { SensorId.ACCELEROMETER_UNCALIBRATED } type - Indicate the sensor type to listen for,{@code SensorId.ACCELEROMETER_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated accelerometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -632,7 +662,8 @@ declare namespace sensor { * Subscribe to ambient light sensor data once. * @param { SensorId.AMBIENT_LIGHT } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_LIGHT}. * @param { Callback } callback - callback ambient data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -643,7 +674,8 @@ declare namespace sensor { * Subscribe to ambient temperature sensor data once. * @param { SensorId.AMBIENT_TEMPERATURE } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_TEMPERATURE}. * @param { Callback } callback - callback temperature data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -654,7 +686,8 @@ declare namespace sensor { * Subscribe to barometer sensor data once. * @param { SensorId.BAROMETER } type - Indicate the sensor type to listen for, {@code SensorId.BAROMETER}. * @param { Callback } callback - callback barometer data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -665,7 +698,8 @@ declare namespace sensor { * Subscribe to gravity sensor data once. * @param { SensorId.GRAVITY } type - Indicate the sensor type to listen for, {@code SensorId.GRAVITY}. * @param { Callback } callback - callback gravity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -678,7 +712,8 @@ declare namespace sensor { * @param { SensorId.GYROSCOPE } type - Indicate the sensor type to listen for, {@code SensorId.GYROSCOPE}. * @param { Callback } callback - callback gyroscope data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -691,7 +726,8 @@ declare namespace sensor { * @param { SensorId.GYROSCOPE_UNCALIBRATED } type - Indicate the sensor type to listen for,{@code SensorId.GYROSCOPE_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated gyroscope data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -702,7 +738,8 @@ declare namespace sensor { * Subscribe to hall sensor data once. * @param { SensorId.HALL } type - Indicate the sensor type to listen for, {@code SensorId.HALL}. * @param { Callback } callback - callback uncalibrated gyroscope data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -715,7 +752,8 @@ declare namespace sensor { * @param { SensorId.HEART_RATE } type - Indicate the sensor type to listen for, {@code SensorId.HEART_RATE}. * @param { Callback } callback - callback heart rate data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -726,7 +764,8 @@ declare namespace sensor { * Subscribe to humidity sensor data once. * @param { SensorId.HUMIDITY } type - Indicate the sensor type to listen for, {@code SensorId.HUMIDITY}. * @param { Callback } callback - callback humidity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -739,7 +778,8 @@ declare namespace sensor { * @param { SensorId.LINEAR_ACCELEROMETER } type - Indicate the sensor type to listen for, {@code SensorId.LINEAR_ACCELEROMETER}. * @param { Callback } callback - callback linear acceleration data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -750,7 +790,8 @@ declare namespace sensor { * Subscribe to magnetic field sensor data once. * @param { SensorId.MAGNETIC_FIELD } type - Indicate the sensor type to listen for, {@code SensorId.MAGNETIC_FIELD}. * @param { Callback } callback - callback magnetic field data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -762,7 +803,8 @@ declare namespace sensor { * @param { SensorId.MAGNETIC_FIELD_UNCALIBRATED } type - Indicate the sensor type to listen for, * {@code SensorId.MAGNETIC_FIELD_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated magnetic field data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -773,7 +815,8 @@ declare namespace sensor { * Subscribe to orientation sensor data once. * @param { SensorId.ORIENTATION } type - Indicate the sensor type to listen for, {@code SensorId.ORIENTATION}. * @param { Callback } callback - callback orientation data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -786,7 +829,8 @@ declare namespace sensor { * @param { SensorId.PEDOMETER } type - Indicate the sensor type to listen for, {@code SensorId.PEDOMETER}. * @param { Callback } callback - callback pedometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -799,7 +843,8 @@ declare namespace sensor { * @param { SensorId.PEDOMETER_DETECTION } type - Indicate the sensor type to listen for, {@code SensorId.PEDOMETER_DETECTION}. * @param { Callback } callback - callback pedometer detection data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -810,7 +855,8 @@ declare namespace sensor { * Subscribe to proximity sensor data once. * @param { SensorId.PROXIMITY } type - Indicate the sensor type to listen for, {@code SensorId.PROXIMITY}. * @param { Callback } callback - callback proximity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -821,7 +867,8 @@ declare namespace sensor { * Subscribe to rotation vector sensor data once. * @param { SensorId.ROTATION_VECTOR } type - Indicate the sensor type to listen for, {@code SensorId.ROTATION_VECTOR}. * @param { Callback } callback - callback rotation vector data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -832,7 +879,8 @@ declare namespace sensor { * Subscribe to significant motion sensor data once. * @param { SensorId.SIGNIFICANT_MOTION } type - Indicate the sensor type to listen for, {@code SensorId.SIGNIFICANT_MOTION}. * @param { Callback } callback - callback significant motion data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -843,7 +891,8 @@ declare namespace sensor { * Subscribe to wear detection sensor data once. * @param { SensorId.WEAR_DETECTION } type - Indicate the sensor type to listen for, {@code SensorId.WEAR_DETECTION}. * @param { Callback } callback - callback wear detection data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * * @syscap SystemCapability.Sensors.Sensor @@ -855,7 +904,8 @@ declare namespace sensor { * Unsubscribe to color sensor data. * @param { SensorId.COLOR } type - Indicate the sensor type to listen for, {@code SensorId.COLOR}. * @param { Callback } callback - callback color data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @systemapi * @since 10 @@ -864,7 +914,8 @@ declare namespace sensor { * Unsubscribe to color sensor data. * @param { SensorId.COLOR } type - Indicate the sensor type to listen for, {@code SensorId.COLOR}. * @param { Callback } callback - callback color data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @syscap SystemCapability.Sensors.Sensor * @systemapi @@ -876,7 +927,8 @@ declare namespace sensor { * Unsubscribe to sar sensor data. * @param { SensorId.SAR } type - Indicate the sensor type to listen for, {@code SensorId.SAR}. * @param { Callback } callback - callback sar data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @systemapi * @since 10 @@ -885,7 +937,8 @@ declare namespace sensor { * Unsubscribe to sar sensor data. * @param { SensorId.SAR } type - Indicate the sensor type to listen for, {@code SensorId.SAR}. * @param { Callback } callback - callback sar data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @syscap SystemCapability.Sensors.Sensor * @systemapi @@ -899,7 +952,8 @@ declare namespace sensor { * @param { SensorId.ACCELEROMETER } type - Indicate the sensor type to listen for, {@code SensorId.ACCELEROMETER}. * @param { Callback } callback - callback accelerometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -909,7 +963,8 @@ declare namespace sensor { * @param { SensorId.ACCELEROMETER } type - Indicate the sensor type to listen for, {@code SensorId.ACCELEROMETER}. * @param { Callback } callback - callback accelerometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @atomicservice * @since 11 @@ -923,7 +978,8 @@ declare namespace sensor { * {@code SensorId.ACCELEROMETER_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated accelerometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -933,7 +989,8 @@ declare namespace sensor { * Unsubscribe to ambient light sensor data. * @param { SensorId.AMBIENT_LIGHT } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_LIGHT}. * @param { Callback } callback - callback ambient data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -943,7 +1000,8 @@ declare namespace sensor { * Unsubscribe to ambient temperature sensor data. * @param { SensorId.AMBIENT_TEMPERATURE } type - Indicate the sensor type to listen for, {@code SensorId.AMBIENT_TEMPERATURE}. * @param { Callback } callback - callback temperature data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -953,7 +1011,8 @@ declare namespace sensor { * Unsubscribe to barometer sensor data. * @param { SensorId.BAROMETER } type - Indicate the sensor type to listen for, {@code SensorId.BAROMETER}. * @param { Callback } callback - callback barometer data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -963,7 +1022,8 @@ declare namespace sensor { * Unsubscribe to gravity sensor data. * @param { SensorId.GRAVITY } type - Indicate the sensor type to listen for, {@code SensorId.GRAVITY}. * @param { Callback } callback - callback gravity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -975,7 +1035,8 @@ declare namespace sensor { * @param { SensorId.GYROSCOPE } type - Indicate the sensor type to listen for, {@code SensorId.GYROSCOPE}. * @param { Callback } callback - callback gyroscope data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -985,7 +1046,8 @@ declare namespace sensor { * @param { SensorId.GYROSCOPE } type - Indicate the sensor type to listen for, {@code SensorId.GYROSCOPE}. * @param { Callback } callback - callback gyroscope data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @atomicservice * @since 11 @@ -998,7 +1060,8 @@ declare namespace sensor { * @param { SensorId.GYROSCOPE_UNCALIBRATED } type - Indicate the sensor type to listen for, {@code SensorId.GYROSCOPE_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated gyroscope data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1008,7 +1071,8 @@ declare namespace sensor { * Unsubscribe to hall sensor data. * @param { SensorId.HALL } type - Indicate the sensor type to listen for, {@code SensorId.HALL}. * @param { Callback } callback - callback uncalibrated gyroscope data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1020,7 +1084,8 @@ declare namespace sensor { * @param { SensorId.HEART_RATE } type - Indicate the sensor type to listen for, {@code SensorId.HEART_RATE}. * @param { Callback } callback - callback heart rate data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1030,7 +1095,8 @@ declare namespace sensor { * Unsubscribe to humidity sensor data. * @param { SensorId.HUMIDITY } type - Indicate the sensor type to listen for, {@code SensorId.HUMIDITY}. * @param { Callback } callback - callback humidity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1042,7 +1108,8 @@ declare namespace sensor { * @param { SensorId.LINEAR_ACCELEROMETER } type - Indicate the sensor type to listen for, {@code SensorId.LINEAR_ACCELEROMETER}. * @param { Callback } callback - callback linear acceleration data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1052,7 +1119,8 @@ declare namespace sensor { * Unsubscribe to magnetic field sensor data. * @param { SensorId.MAGNETIC_FIELD } type - Indicate the sensor type to listen for, {@code SensorId.MAGNETIC_FIELD}. * @param { Callback } callback - callback magnetic field data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1063,7 +1131,8 @@ declare namespace sensor { * @param { SensorId.MAGNETIC_FIELD_UNCALIBRATED } type - Indicate the sensor type to listen for, * {@code SensorId.MAGNETIC_FIELD_UNCALIBRATED}. * @param { Callback } callback - callback uncalibrated magnetic field data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1073,7 +1142,8 @@ declare namespace sensor { * Unsubscribe to orientation sensor data. * @param { SensorId.ORIENTATION } type - Indicate the sensor type to listen for, {@code SensorId.ORIENTATION}. * @param { Callback } callback - callback orientation data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1081,7 +1151,8 @@ declare namespace sensor { * Unsubscribe to orientation sensor data. * @param { SensorId.ORIENTATION } type - Indicate the sensor type to listen for, {@code SensorId.ORIENTATION}. * @param { Callback } callback - callback orientation data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @atomicservice * @since 11 @@ -1094,7 +1165,8 @@ declare namespace sensor { * @param { SensorId.PEDOMETER } type - Indicate the sensor type to listen for, {@code SensorId.PEDOMETER}. * @param { Callback } callback - callback pedometer data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1106,7 +1178,8 @@ declare namespace sensor { * @param { SensorId.PEDOMETER_DETECTION } type - Indicate the sensor type to listen for, {@code SensorId.PEDOMETER_DETECTION}. * @param { Callback } callback - callback pedometer detection data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1116,7 +1189,8 @@ declare namespace sensor { * Unsubscribe to proximity sensor data. * @param { SensorId.PROXIMITY } type - Indicate the sensor type to listen for, {@code SensorId.PROXIMITY}. * @param { Callback } callback - callback proximity data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1126,7 +1200,8 @@ declare namespace sensor { * Unsubscribe to rotation vector sensor data. * @param { SensorId.ROTATION_VECTOR } type - Indicate the sensor type to listen for, {@code SensorId.ROTATION_VECTOR}. * @param { Callback } callback - callback rotation vector data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1136,7 +1211,8 @@ declare namespace sensor { * Unsubscribe to significant motion sensor data. * @param { SensorId.SIGNIFICANT_MOTION } type - Indicate the sensor type to listen for, {@code SensorId.SIGNIFICANT_MOTION}. * @param { Callback } callback - callback significant motion data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -1146,7 +1222,8 @@ declare namespace sensor { * Unsubscribe to wear detection sensor data. * @param { SensorId.WEAR_DETECTION } type - Indicate the sensor type to listen for, {@code SensorId.WEAR_DETECTION}. * @param { Callback } callback - callback wear detection data. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.Sensor * @since 9 */ @@ -2066,7 +2143,8 @@ declare namespace sensor { * Obtains the sensor information of a specified type. * @param { SensorId } type - Indicate the sensor type, {@code SensorId}. * @param { AsyncCallback } callback - callback sensor info. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2075,7 +2153,8 @@ declare namespace sensor { * Obtains the sensor information of a specified type. * @param { SensorId } type - Indicate the sensor type, {@code SensorId}. * @param { AsyncCallback } callback - callback sensor info. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @throws { BusinessError } 14500102 - The sensor is not supported by the device. * @syscap SystemCapability.Sensors.Sensor @@ -2087,7 +2166,8 @@ declare namespace sensor { * Obtains the sensor information of a specified type. * @param { SensorId } type - Indicate the sensor type, {@code SensorId}. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2096,7 +2176,8 @@ declare namespace sensor { * Obtains the sensor information of a specified type. * @param { SensorId } type - Indicate the sensor type, {@code SensorId}. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @throws { BusinessError } 14500102 - The sensor is not supported by the device. * @syscap SystemCapability.Sensors.Sensor @@ -2108,7 +2189,8 @@ declare namespace sensor { * Synchronously obtains the sensor information of a specified type. * @param { SensorId } type - Indicate the sensor type, {@code SensorId}. * @returns { Sensor } Returns sensor information. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @throws { BusinessError } 14500102 - The sensor is not supported by the device. * @syscap SystemCapability.Sensors.Sensor @@ -2119,7 +2201,8 @@ declare namespace sensor { /** * Obtains all sensor information on the device. * @param { AsyncCallback> } callback - callback sensor list. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2129,7 +2212,8 @@ declare namespace sensor { /** * Obtains all sensor information on the device. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2273,7 +2357,8 @@ declare namespace sensor { * @param { number } timeMillis - timeMillis Indicates the time at which the magnetic declination is to be obtained, * in milliseconds since the Unix epoch. * @param { AsyncCallback } callback - callback geomagnetic field. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2286,7 +2371,8 @@ declare namespace sensor { * @param { number } timeMillis - timeMillis Indicates the time at which the magnetic declination is to be obtained, * in milliseconds since the Unix epoch. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2322,7 +2408,8 @@ declare namespace sensor { * @param { number } seaPressure - seaPressure Indicates the sea level pressure, in hPa. * @param { number } currentPressure - currentPressure Indicates the atmospheric pressure measured by the barometer, in hPa. * @param { AsyncCallback } callback - callback device altitude. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2334,7 +2421,8 @@ declare namespace sensor { * @param { number } seaPressure - seaPressure Indicates the sea level pressure, in hPa. * @param { number } currentPressure - currentPressure Indicates the atmospheric pressure measured by the barometer, in hPa. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2367,7 +2455,8 @@ declare namespace sensor { * Computes the geomagnetic inclination in radians from the inclination matrix. * @param { Array } inclinationMatrix - Indicates the inclination matrix. * @param { AsyncCallback } callback - callback inclination in radians. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2378,7 +2467,8 @@ declare namespace sensor { * Computes the geomagnetic inclination in radians from the inclination matrix. * @param { Array } inclinationMatrix - Indicates the inclination matrix. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2415,7 +2505,8 @@ declare namespace sensor { * @param { Array } currentRotationMatrix - currentRotationMatrix Indicates the current rotation matrix. * @param { Array } preRotationMatrix - preRotationMatrix Indicates the current rotation matrix. * @param { AsyncCallback> } callback - callback angle variation. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2428,7 +2519,8 @@ declare namespace sensor { * @param { Array } currentRotationMatrix - Indicates the current rotation matrix. * @param { Array } preRotationMatrix - preRotationMatrix Indicates the current rotation matrix. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2461,7 +2553,8 @@ declare namespace sensor { * Convert rotation vector to rotation matrix. * @param { Array } rotationVector - rotationVector Indicates the rotation vector. * @param { AsyncCallback> } callback - callback rotation matrix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2472,7 +2565,8 @@ declare namespace sensor { * Convert rotation vector to rotation matrix. * @param { Array } rotationVector - rotationVector Indicates the rotation vector. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2531,7 +2625,8 @@ declare namespace sensor { * @param { Array } inRotationVector - inRotationVector Indicates the rotation matrix to be transformed. * @param { CoordinatesOptions } coordinates - coordinates Indicates coordinate system guidance, {@code CoordinatesOptions}. * @param { AsyncCallback> } callback - callback rotation matrix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2544,7 +2639,8 @@ declare namespace sensor { * @param { Array } inRotationVector - inRotationVector Indicates the rotation matrix to be transformed. * @param { CoordinatesOptions } coordinates - coordinates Indicates coordinate system guidance, {@code CoordinatesOptions}. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2577,7 +2673,8 @@ declare namespace sensor { * convert a rotation vector to a normalized quaternion. * @param { Array } rotationVector - rotationVector Indicates the rotation vector. * @param { AsyncCallback> } callback - callback a normalized quaternion. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2588,7 +2685,8 @@ declare namespace sensor { * convert a rotation vector to a normalized quaternion. * @param { Array } rotationVector - rotationVector Indicates the rotation vector. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2621,7 +2719,8 @@ declare namespace sensor { * Computes the device's orientation based on the rotation matrix. * @param { Array } rotationMatrix - rotationMatrix Indicates the rotation matrix. * @param { AsyncCallback> } callback - callback the angle of rotation around the z, x, y axis. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2632,7 +2731,8 @@ declare namespace sensor { * Computes the device's orientation based on the rotation matrix. * @param { Array } rotationMatrix - rotationMatrix Indicates the rotation matrix. * @returns { Promise> } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2692,7 +2792,8 @@ declare namespace sensor { * @param { Array } gravity - gravity Indicates the gravity vector. * @param { Array } geomagnetic - geomagnetic Indicates the geomagnetic vector. * @param { AsyncCallback } callback - callback rotation matrix and inclination matrix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 @@ -2704,7 +2805,8 @@ declare namespace sensor { * @param { Array } gravity - gravity Indicates the gravity vector. * @param { Array } geomagnetic - geomagnetic Indicates the geomagnetic vector. * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14500101 - Service exception. * @syscap SystemCapability.Sensors.Sensor * @since 9 diff --git a/api/@ohos.systemDateTime.d.ts b/api/@ohos.systemDateTime.d.ts index 52d0760ddc88e0d0d70ef1157ec7e25bc4c0afbf..efc1be896369a300eb503b1b81b4a49e3a1c481d 100644 --- a/api/@ohos.systemDateTime.d.ts +++ b/api/@ohos.systemDateTime.d.ts @@ -65,6 +65,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getCurrentTime(isNano: boolean, callback: AsyncCallback): void; @@ -75,6 +76,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getCurrentTime(callback: AsyncCallback): void; @@ -86,6 +88,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getCurrentTime(isNano?: boolean): Promise; @@ -107,6 +110,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealActiveTime(isNano: boolean, callback: AsyncCallback): void; @@ -117,6 +121,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealActiveTime(callback: AsyncCallback): void; @@ -128,6 +133,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealActiveTime(isNano?: boolean): Promise; @@ -139,6 +145,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealTime(isNano: boolean, callback: AsyncCallback): void; @@ -149,6 +156,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealTime(callback: AsyncCallback): void; @@ -160,6 +168,7 @@ declare namespace systemDateTime { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; * @syscap SystemCapability.MiscServices.Time * @since 9 + * @deprecated since 12 */ function getRealTime(isNano?: boolean): Promise; @@ -197,6 +206,17 @@ declare namespace systemDateTime { * @syscap SystemCapability.MiscServices.Time * @since 10 */ + /** + * Obtains the number of milliseconds since the system has been running. + * + * @param { TimeType } timeType - indicates the type of get uptime. It can only be `STARTUP` or `ACTIVE`. + * @param { boolean } [ isNanoseconds ] - True if the result is in nanoseconds, otherwise in milliseconds + * @returns { number } The timestamp returned of getUpTime. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; + * 3. Parameter verification failed. This error code was added due to missing issues. + * @syscap SystemCapability.MiscServices.Time + * @since 12 + */ function getUptime(timeType: TimeType, isNanoseconds?: boolean): number; /** @@ -207,7 +227,8 @@ declare namespace systemDateTime { * @param { AsyncCallback } callback - The callback of setDate * @throws { BusinessError } 201 - Permission denied * @throws { BusinessError } 202 - Permission denied, Non system application use system APIs - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; + * 3.Parameter verification failed; * @syscap SystemCapability.MiscServices.Time * @systemapi Hide this for inner system use * @since 9 @@ -224,7 +245,8 @@ declare namespace systemDateTime { * @returns { Promise } The promise returned by the function * @throws { BusinessError } 201 - Permission denied * @throws { BusinessError } 202 - Permission denied, Non system application use system APIs - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; + * 3.Parameter verification failed; * @syscap SystemCapability.MiscServices.Time * @systemapi Hide this for inner system use * @since 9 @@ -295,6 +317,13 @@ declare namespace systemDateTime { * @syscap SystemCapability.MiscServices.Time * @since 9 */ + /** + * Obtains the system time zone. + * + * @param { AsyncCallback } callback - The callback of getTimezone + * @syscap SystemCapability.MiscServices.Time + * @since 12 + */ function getTimezone(callback: AsyncCallback): void; /** @@ -305,6 +334,13 @@ declare namespace systemDateTime { * @syscap SystemCapability.MiscServices.Time * @since 9 */ + /** + * Obtains the system time zone. + * + * @returns { Promise } The promise returned by the function + * @syscap SystemCapability.MiscServices.Time + * @since 12 + */ function getTimezone(): Promise; /** diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index d3dee31c20aad11c362a6cf5f269abbe3d6aca78..43f781779bd144df5cb2e0c76a717c9e405fb44f 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -96,7 +96,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of dialCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -118,7 +119,8 @@ declare namespace call { * @returns { Promise } The promise returned by the dialCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -139,7 +141,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of dialCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -157,7 +160,8 @@ declare namespace call { * * @param { string } phoneNumber - Indicates the called number. * @param { AsyncCallback } callback - The callback of makeCall. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -170,7 +174,8 @@ declare namespace call { * * @param { string } phoneNumber - Indicates the called number. * @param { AsyncCallback } callback - The callback of makeCall. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -186,7 +191,8 @@ declare namespace call { * * @param { string } phoneNumber - Indicates the called number. * @returns { Promise } The promise returned by the makeCall. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -199,7 +205,8 @@ declare namespace call { * * @param { string } phoneNumber - Indicates the called number. * @returns { Promise } The promise returned by the makeCall. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -290,7 +297,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of muteRinger. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -339,7 +347,8 @@ declare namespace call { * @param { EmergencyNumberOptions } options - Indicates the additional information for emergency numbers. * @param { AsyncCallback } callback - Indicates the callback for isEmergencyPhoneNumber. * Returns {@code true} if the phone number is on the emergency number list. Returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -356,7 +365,8 @@ declare namespace call { * @param { EmergencyNumberOptions } options - Indicates the additional information for emergency numbers. * @returns { Promise } Returns {@code true} if the phone number is on the emergency number list. * Returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -372,7 +382,8 @@ declare namespace call { * @param { string } phoneNumber - Indicates the phone number to check. * @param { AsyncCallback } callback - Indicates the callback for isEmergencyPhoneNumber. * Returns {@code true} if the phone number is on the emergency number list. Returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -392,7 +403,8 @@ declare namespace call { * @param { NumberFormatOptions } options - Indicates the country code option. * @param { AsyncCallback } callback - Indicates the callback to obtain a formatted phone number. * Returns an empty string if the input phone number is invalid. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -411,7 +423,8 @@ declare namespace call { * @param { string } phoneNumber - Indicates the phone number to format. * @param { NumberFormatOptions } options - Indicates the country code option. * @returns { Promise } Returns the phone number after being formatted. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -430,7 +443,8 @@ declare namespace call { * @param { string } phoneNumber - Indicates the phone number to format. * @param { AsyncCallback } callback - Indicates the callback to obtain a formatted phone number. * Returns an empty string if the input phone number is invalid. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -447,7 +461,8 @@ declare namespace call { * @param { string } countryCode - Indicates a two-digit country code defined in ISO 3166-1. * @param { AsyncCallback } callback - Returns an E.164 number. * Returns an empty string if the input phone number is invalid. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -464,7 +479,8 @@ declare namespace call { * @param { string } countryCode - Indicates a two-digit country code defined in ISO 3166-1. * @returns { Promise } Returns an E.164 number. * Returns an empty string if the input phone number is invalid. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -482,7 +498,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of answerCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -501,7 +518,8 @@ declare namespace call { * @returns { Promise } The promise returned by the answerCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -519,7 +537,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of answerCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -539,7 +558,8 @@ declare namespace call { * @returns { Promise } The promise returned by the answerCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -558,7 +578,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of hangUpCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -577,7 +598,8 @@ declare namespace call { * @returns { Promise } The promise returned by the hangUpCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -595,7 +617,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of hangUpCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -615,7 +638,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of rejectCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -635,7 +659,8 @@ declare namespace call { * @returns { Promise } The promise returned by the rejectCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -654,7 +679,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of rejectCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -672,7 +698,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of rejectCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -691,7 +718,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of rejectCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -710,7 +738,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of holdCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -729,7 +758,8 @@ declare namespace call { * @returns { Promise } The promise returned by the holdCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -748,7 +778,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of unHoldCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -767,7 +798,8 @@ declare namespace call { * @returns { Promise } The promise returned by the unHoldCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -786,7 +818,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of switchCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -805,7 +838,8 @@ declare namespace call { * @returns { Promise } The promise returned by the switchCall. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -822,7 +856,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @param { AsyncCallback } callback - The callback of combineConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -840,7 +875,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise } The promise returned by the combineConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -858,7 +894,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @param { AsyncCallback } callback - Indicates the callback for getting the main call id. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -875,7 +912,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise } Returns the main call id. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -892,7 +930,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @param { AsyncCallback> } callback - Indicates the callback for getting the list of sub call ids. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -909,7 +948,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise> } Returns the list of sub call ids. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -927,7 +967,8 @@ declare namespace call { * @param { AsyncCallback> } callback - Indicates the callback for getting * the call id list of conference calls. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -944,7 +985,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise> } Returns the call id list of conference calls. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -964,7 +1006,8 @@ declare namespace call { * @param { AsyncCallback } callback - Indicates the callback for getting the call waiting status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -984,7 +1027,8 @@ declare namespace call { * @returns { Promise } Returns the callback for getting the call waiting status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1005,7 +1049,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setCallWaiting. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1026,7 +1071,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setCallWaiting. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1044,7 +1090,8 @@ declare namespace call { * @param { string } character - Indicates the characters sent. * @param { AsyncCallback } callback - The callback of startDTMF. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1062,7 +1109,8 @@ declare namespace call { * @param { string } character - Indicates the characters sent. * @returns { Promise } The promise returned by the startDTMF. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1079,7 +1127,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @param { AsyncCallback } callback - The callback of stopDTMF. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1096,7 +1145,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise } The promise returned by the stopDTMF. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1116,7 +1166,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of postDialProceed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1136,7 +1187,8 @@ declare namespace call { * @returns { Promise } The promise returned by the postDialProceed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1155,7 +1207,8 @@ declare namespace call { * Returns {@code true} if the call is in emergency; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1190,7 +1243,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of call details. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1210,7 +1264,8 @@ declare namespace call { * the callDetailsChange event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1229,7 +1284,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the call event id. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1248,7 +1304,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback to unsubscribe from the callEventChange event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1267,7 +1324,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the call disconnection reason. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1287,7 +1345,8 @@ declare namespace call { * the registration monitoring for obtaining the call end reason. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1306,7 +1365,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of MMI code. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1325,7 +1385,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback used to cancel getting mmicode registered listening. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1344,7 +1405,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of Current AudioDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1363,7 +1425,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of Current AudioDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1382,7 +1445,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of post-dial string. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1401,7 +1465,8 @@ declare namespace call { * @param { Callback } callback - Indicates the callback for getting the result of post-dial string. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1418,7 +1483,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of isNewCallAllowed. Returns {@code true} if * the device currently allows new calls; returns {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1450,7 +1516,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @param { AsyncCallback } callback - The callback of separateConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1468,7 +1535,8 @@ declare namespace call { * @param { number } callId - Indicates the identifier of the call. * @returns { Promise } The promise returned by the separateConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1490,7 +1558,8 @@ declare namespace call { * @param { AsyncCallback } callback - Indicates the callback for getting the call restriction status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1511,7 +1580,8 @@ declare namespace call { * @returns { Promise } Returns the call restriction status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1532,7 +1602,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setCallRestriction. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1553,7 +1624,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setCallRestriction. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1575,7 +1647,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setCallRestrictionPassword. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1597,7 +1670,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setCallRestrictionPassword. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1618,7 +1692,8 @@ declare namespace call { * @param { AsyncCallback } callback - Indicates the callback for getting the call forwarding status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1639,7 +1714,8 @@ declare namespace call { * @returns { Promise } Returns the call forwarding status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1660,7 +1736,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setCallTransfer. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1681,7 +1758,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setCallTransfer. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1700,7 +1778,8 @@ declare namespace call { * Returns {@code true} if the device is ringing; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1732,7 +1811,8 @@ declare namespace call { * * @param { AsyncCallback } callback - The callback of setMuted. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1762,7 +1842,8 @@ declare namespace call { * * @param { AsyncCallback } callback - The callback of cancelMuted. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1795,7 +1876,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setAudioDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1814,7 +1896,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setAudioDevice. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1832,7 +1915,8 @@ declare namespace call { * @param { Array } callNumberList - Indicates a call list. * @param { AsyncCallback } callback - The callback of joinConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1850,7 +1934,8 @@ declare namespace call { * @param { Array } callNumberList - Indicates a call list. * @returns { Promise } The promise returned by the joinConference. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1869,7 +1954,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of kickOutFromConference. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1888,7 +1974,8 @@ declare namespace call { * @returns { Promise } The promise returned by the kickOutFromConference. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1906,7 +1993,8 @@ declare namespace call { * @param { ImsCallMode } mode - Indicates the mode of the ims call. * @param { AsyncCallback } callback - The callback of updateImsCallMode. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1924,7 +2012,8 @@ declare namespace call { * @param { ImsCallMode } mode - Indicates the mode of the ims call. * @returns { Promise } The promise returned by the updateImsCallMode. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1943,7 +2032,8 @@ declare namespace call { * @returns { Promise } The promise returned by the cancelCallUpgrade. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1963,7 +2053,8 @@ declare namespace call { * @returns { Promise } The promise returned by the controlCamera. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1983,7 +2074,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setPreviewWindow. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2003,7 +2095,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setDisplayWindow. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2023,7 +2116,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setDeviceDirection. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2043,7 +2137,8 @@ declare namespace call { * getting the result of ImsCallModeInfo details. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2063,7 +2158,8 @@ declare namespace call { * the imsCallModeChange event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2084,7 +2180,8 @@ declare namespace call { * getting the result of CallSessionEvent. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2105,7 +2202,8 @@ declare namespace call { * the CallSessionEvent event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2126,7 +2224,8 @@ declare namespace call { * getting the result of PeerDimensionsDetail details. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2147,7 +2246,8 @@ declare namespace call { * peerDimensionsChange event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2168,7 +2268,8 @@ declare namespace call { * getting the result of CameraCapabilities details. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2189,7 +2290,8 @@ declare namespace call { * cameraCapabilitiesChange event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2209,7 +2311,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of enableImsSwitch. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2229,7 +2332,8 @@ declare namespace call { * @returns { Promise } The promise returned by the enableImsSwitch. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2249,7 +2353,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of disableImsSwitch. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2269,7 +2374,8 @@ declare namespace call { * @returns { Promise } The promise returned by the disableImsSwitch. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2288,7 +2394,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of isImsSwitchEnabled. * Returns {@code true} If the ims switch is on; returns {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2306,7 +2413,8 @@ declare namespace call { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns {@code true} If the ims switch is on; returns {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2326,7 +2434,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of closeUnfinishedUssd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2346,7 +2455,8 @@ declare namespace call { * @returns { Promise } The promise returned by the closeUnfinishedUssd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2367,7 +2477,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of setVoNRState. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2388,7 +2499,8 @@ declare namespace call { * @returns { Promise } The promise returned by the setVoNRState. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2408,7 +2520,8 @@ declare namespace call { * @param { AsyncCallback } callback - Indicates the callback for getVoNRState. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2428,7 +2541,8 @@ declare namespace call { * @returns { Promise } Returns the VoNR state. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2451,7 +2565,8 @@ declare namespace call { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2474,7 +2589,8 @@ declare namespace call { * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2493,7 +2609,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of inputDialerSpecialCode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2511,7 +2628,8 @@ declare namespace call { * @returns { Promise } The promise returned by the inputDialerSpecialCode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2529,7 +2647,8 @@ declare namespace call { * @param { AsyncCallback } callback - The callback of removeMissedIncomingCallNotification. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -2565,7 +2684,8 @@ declare namespace call { * @returns { Promise } The promise returned by the sendCallUiEvent. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -3186,26 +3306,6 @@ declare namespace call { * @since 11 */ originalCallType: number; - - /** - * Indicates the location of the phone number. - * - * @type { ?string } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - numberLocation?: string; - - /** - * Indicates the mark information of the phone number. - * - * @type { ?NumberMarkInfo } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - numberMarkInfo?: NumberMarkInfo; } /** @@ -3844,24 +3944,6 @@ declare namespace call { * @since 11 */ EVENT_SPLIT_CALL_FAILED, - - /** - * Indicates show full screen. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - EVENT_SHOW_FULL_SCREEN, - - /** - * Indicates show float window. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - EVENT_SHOW_FLOAT_WINDOW, } /** @@ -5266,175 +5348,6 @@ declare namespace call { */ height: number; } - - /** - * Indicates the mark information of the phone number. - * - * @interface NumberMarkInfo - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - export interface NumberMarkInfo { - /** - * Indicates the type of number mark. - * - * @type { MarkType } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - markType: MarkType; - - /** - * Indicates the content of number mark. - * - * @type { ?string } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - markContent?: string; - - /** - * Indicates the count of number mark. - * - * @type { ?number } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - markCount?: number; - - /** - * Indicates the source of number mark. - * - * @type { ?string } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - markSource?: string; - - /** - * Indicates if this is a number mark from cloud. - * - * @type { ?boolean } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - isCloud?: boolean; - } - - /** - * Indicates the type of the number mark. - * - * @enum { number } - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - export enum MarkType { - /** - * Indicates the mark is none. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_NONE = 0, - - /** - * Indicates the mark is crank. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_CRANK = 1, - - /** - * Indicates the mark is fraud. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_FRAUD = 2, - - /** - * Indicates the mark is express. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_EXPRESS = 3, - - /** - * Indicates the mark is promote sales. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_PROMOTE_SALES = 4, - - /** - * Indicates the mark is house agent. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_HOUSE_AGENT = 5, - - /** - * Indicates the mark is insurance. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_INSURANCE = 6, - - /** - * Indicates the mark is taxi. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_TAXI = 7, - - /** - * Indicates the mark is custom. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_CUSTOM = 8, - - /** - * Indicates the mark is others. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_OTHERS = 9, - - /** - * Indicates the mark is yellow page. - * - * @syscap SystemCapability.Telephony.CallManager - * @systemapi Hide this for inner system use. - * @since 12 - */ - MARK_TYPE_YELLOW_PAGE = 10 - } } export default call; diff --git a/api/@ohos.telephony.data.d.ts b/api/@ohos.telephony.data.d.ts index 913d7147b48bf6e4a8cd93a6ee9175b4f48e4d62..e447e7915ebedb2f54268ce34b1c761b4d14dc61 100644 --- a/api/@ohos.telephony.data.d.ts +++ b/api/@ohos.telephony.data.d.ts @@ -64,7 +64,8 @@ declare namespace data { * @param { AsyncCallback } callback - The callback of setDefaultCellularDataSlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -86,7 +87,8 @@ declare namespace data { * @returns { Promise } The promise returned by the setDefaultCellularDataSlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -159,7 +161,8 @@ declare namespace data { * @param { AsyncCallback } callback - Indicates the callback for checking whether cellular data services * are enabled. Returns {@code true} if cellular data services are enabled; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -191,7 +194,8 @@ declare namespace data { * @param { AsyncCallback } callback - The callback of enableCellularData. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -225,7 +229,8 @@ declare namespace data { * @param { AsyncCallback } callback - The callback of disableCellularData. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -262,7 +267,8 @@ declare namespace data { * for cellular data services. Returns {@code true} if roaming is enabled for cellular data services; * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -281,7 +287,8 @@ declare namespace data { * @returns { Promise } Returns {@code true} if roaming is enabled for cellular data services. * Returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -300,7 +307,8 @@ declare namespace data { * @param { AsyncCallback } callback - The callback of enableCellularDataRoaming. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -320,7 +328,8 @@ declare namespace data { * @returns { Promise } The promise returned by the enableCellularDataRoaming. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -340,7 +349,8 @@ declare namespace data { * @param { AsyncCallback } callback - The callback of disableCellularDataRoaming. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -360,7 +370,8 @@ declare namespace data { * @returns { Promise } The promise returned by the disableCellularDataRoaming. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. diff --git a/api/@ohos.telephony.observer.d.ts b/api/@ohos.telephony.observer.d.ts index 3b2de4d0c042a51d2ebddf50599255e61048818c..13a982c2fcef3a60623a31d9a77b0db552600799 100644 --- a/api/@ohos.telephony.observer.d.ts +++ b/api/@ohos.telephony.observer.d.ts @@ -123,7 +123,8 @@ declare namespace observer { * @param { Callback } callback - Indicates the callback for * getting an instance of the {@code NetworkState} class. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -160,7 +161,8 @@ declare namespace observer { * @param { Callback } callback - Indicates the callback for getting * an instance of the {@code NetworkState} class. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -176,7 +178,8 @@ declare namespace observer { * @param { 'networkStateChange' } type - Event type. Indicates the networkStateChange event to unsubscribe from. * @param { Callback } callback - Indicates the callback for getting * an instance of the {@code NetworkState} class. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -192,7 +195,8 @@ declare namespace observer { * @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to be subscribed to. * @param { Callback> } callback - Indicates the callback for getting * an array of instances of the classes derived from {@link SignalInformation}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -225,7 +229,8 @@ declare namespace observer { * @param { ObserverOptions } options - Indicates the options for observer. * @param { Callback> } callback - Indicates the callback for getting * an array of instances of the classes derived from {@link SignalInformation}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -241,7 +246,8 @@ declare namespace observer { * @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to unsubscribe from. * @param { Callback> } callback - Indicates the callback to unsubscribe from * the signalInfoChange event. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -260,7 +266,8 @@ declare namespace observer { * an array of instances of the classes derived from {@link CellInformation}. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -301,7 +308,8 @@ declare namespace observer { * an array of instances of the classes derived from {@link CellInformation}. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -319,7 +327,8 @@ declare namespace observer { * @param { Callback> } callback - Indicates the callback to unsubscribe from * the cellInfoChange event. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -354,7 +363,8 @@ declare namespace observer { * @param { Callback } callback - Indicates the callback for * getting the cellular data link connection state, and networkType Indicates the radio access technology * for cellular data services. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -391,7 +401,8 @@ declare namespace observer { * @param { Callback } callback - Indicates the callback for * getting the cellular data link connection state, and networkType Indicates the radio access technology for * cellular data services. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -424,7 +435,8 @@ declare namespace observer { * event to unsubscribe from. * @param { Callback } callback - Indicates the callback to unsubscribe * from the cellularDataConnectionStateChange event. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -440,7 +452,8 @@ declare namespace observer { * * @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to be subscribed to. * @param { Callback } callback - Indicates the callback for getting the cellular data flow state. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -473,7 +486,8 @@ declare namespace observer { * @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to be subscribed to. * @param { ObserverOptions } options - Indicates the options for observer. * @param { Callback } callback - Indicates the callback for getting the cellular data flow state. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -489,7 +503,8 @@ declare namespace observer { * @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to unsubscribe from. * @param { Callback } callback - Indicates the callback to unsubscribe from * the cellularDataFlowChange event. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -519,7 +534,8 @@ declare namespace observer { * @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to be subscribed to. * @param { Callback } callback - Indicates the callback for * getting the call state and the called number. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -552,7 +568,8 @@ declare namespace observer { * @param { ObserverOptions } options - Indicates the options for observer. * @param { Callback } callback - Indicates the callback for * getting the call state and the called number. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -582,7 +599,8 @@ declare namespace observer { * @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to unsubscribe from. * @param { Callback } callback - Indicates the callback to * unsubscribe from the callStateChange event. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -598,7 +616,8 @@ declare namespace observer { * @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to be subscribed to. * @param { Callback } callback - Indicates the callback for getting the SimStateData object. * including state Indicates the sim state, and reason Indicates the cause of the change. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -629,7 +648,8 @@ declare namespace observer { * @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to be subscribed to. * @param { ObserverOptions } options - Indicates the options for observer. * @param { Callback } callback - Indicates the callback for getting the SimStateData object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -644,7 +664,8 @@ declare namespace observer { * * @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to unsubscribe from. * @param { Callback } callback - Indicates the callback to unsubscribe from the simStateChange event. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -661,7 +682,8 @@ declare namespace observer { * @param { 'iccAccountInfoChange' } type - iccAccountInfoChange * @param { Callback } callback - including state Indicates the ICC account information, * and reason Indicates the cause of the change. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -677,7 +699,8 @@ declare namespace observer { * @param { 'iccAccountInfoChange' } type - iccAccountInfoChange * @param { Callback } callback - including state Indicates the ICC account information, * and reason Indicates the cause of the change. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. diff --git a/api/@ohos.telephony.radio.d.ts b/api/@ohos.telephony.radio.d.ts index 470e36cf60d1a0dd083d930744e2af78b5e0d50d..3ff43d55a36cfb65b143e557e967dde782687b32 100644 --- a/api/@ohos.telephony.radio.d.ts +++ b/api/@ohos.telephony.radio.d.ts @@ -89,7 +89,8 @@ declare namespace radio { *
  • {@code RadioTechnology#RADIO_TECHNOLOGY_NR} * * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -157,7 +158,8 @@ declare namespace radio { *
  • {@code RadioTechnology#RADIO_TECHNOLOGY_NR} * * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -175,7 +177,8 @@ declare namespace radio { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting network registration state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -193,7 +196,8 @@ declare namespace radio { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the NetworkState object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -209,7 +213,8 @@ declare namespace radio { * @permission ohos.permission.GET_NETWORK_INFO * @param { AsyncCallback } callback - Indicates the callback for getting network registration state. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -228,7 +233,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of sendUpdateCellLocationRequest. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -248,7 +254,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the sendUpdateCellLocationRequest. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -266,7 +273,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of sendUpdateCellLocationRequest. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -286,7 +294,8 @@ declare namespace radio { * @param { AsyncCallback> } callback - Indicates the callback for getting cell information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -306,7 +315,8 @@ declare namespace radio { * @returns { Promise> } Returns the current cell information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -324,7 +334,8 @@ declare namespace radio { * @param { AsyncCallback> } callback - Indicates the callback for getting cell information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -347,7 +358,8 @@ declare namespace radio { *
  • {@link NetworkSelectionMode#NETWORK_SELECTION_AUTOMATIC} *
  • {@link NetworkSelectionMode#NETWORK_SELECTION_MANUAL} *
      - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -369,7 +381,8 @@ declare namespace radio { *
    • {@link NetworkSelectionMode#NETWORK_SELECTION_AUTOMATIC} *
    • {@link NetworkSelectionMode#NETWORK_SELECTION_MANUAL} *
        - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -387,7 +400,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of setNetworkSelectionMode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -406,7 +420,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the setNetworkSelectionMode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -427,7 +442,8 @@ declare namespace radio { * the search results of the network. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -447,7 +463,8 @@ declare namespace radio { * @returns { Promise } Returns the search results of the network. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -465,7 +482,8 @@ declare namespace radio { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the country code * defined in ISO 3166-2; returns an empty string if the device is not registered with any network. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -482,7 +500,8 @@ declare namespace radio { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the country code defined in ISO 3166-2. * Returns an empty string if the device is not registered with any network. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -511,7 +530,8 @@ declare namespace radio { * index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the selection mode of NR. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -531,7 +551,8 @@ declare namespace radio { * index number supported by the device. * @returns { Promise } Returns the selection mode of NR. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -549,7 +570,8 @@ declare namespace radio { * * @param { AsyncCallback } callback - Indicates the callback for getting the selection mode of NR. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -572,7 +594,8 @@ declare namespace radio { * Returns an empty string if the IMEI does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -592,7 +615,8 @@ declare namespace radio { * @returns { Promise } Returns the IMEI. Returns an empty string if the IMEI does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -611,7 +635,8 @@ declare namespace radio { * Returns an empty string if the IMEI does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -632,7 +657,8 @@ declare namespace radio { * Returns an empty string if the MEID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -652,7 +678,8 @@ declare namespace radio { * @returns { Promise } Returns the MEID. Returns an empty string if the MEID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -671,7 +698,8 @@ declare namespace radio { * Returns an empty string if the MEID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -696,7 +724,8 @@ declare namespace radio { * Returns an empty string if the unique device ID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -721,7 +750,8 @@ declare namespace radio { * Returns an empty string if the unique device ID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -744,7 +774,8 @@ declare namespace radio { * Returns an empty string if the unique device ID does not exist. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -762,7 +793,8 @@ declare namespace radio { * * @param { AsyncCallback } callback - Indicates the callback for getting the index number of * the primary card slot. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -795,7 +827,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of setPrimarySlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -816,7 +849,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the setPrimarySlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -835,7 +869,8 @@ declare namespace radio { * index number supported by the device. * @param { AsyncCallback> } callback - Indicates the callback for getting * the instance list of the child classes derived from {@link SignalInformation}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -852,7 +887,8 @@ declare namespace radio { * index number supported by the device. * @returns { Promise> } Returns the callback for getting the instance list of * the child classes derived from {@link SignalInformation}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -927,7 +963,8 @@ declare namespace radio { * @param { AsyncCallback } callback - Returns {@code true} If the radio service is enabled. * Returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -945,7 +982,8 @@ declare namespace radio { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns {@code true} If the radio service is enabled; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -962,7 +1000,8 @@ declare namespace radio { * @param { AsyncCallback } callback - Returns {@code true} If the radio service is enabled. * Returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -981,7 +1020,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of turnOnRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1001,7 +1041,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the turnOnRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1019,7 +1060,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of turnOnRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1039,7 +1081,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of turnOffRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1059,7 +1102,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the turnOffRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1077,7 +1121,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of turnOffRadio. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1094,7 +1139,8 @@ declare namespace radio { * @param { number } slotId - Indicates the card slot index number, * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the operator name. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1110,7 +1156,8 @@ declare namespace radio { * @param { number } slotId - Indicates the card slot index number, * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the operator name. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1141,7 +1188,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of setPreferredNetwork. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1162,7 +1210,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the setPreferredNetwork. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1183,7 +1232,8 @@ declare namespace radio { * the preferred network mode to obtain. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1203,7 +1253,8 @@ declare namespace radio { * @returns { Promise } Returns the callback for getting the preferred network mode to obtain. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1224,7 +1275,7 @@ declare namespace radio { * @param { AsyncCallback } callback - Indicates an instance of the {@link ImsRegInfo} class. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1245,7 +1296,7 @@ declare namespace radio { * @returns { Promise } Returns an instance of the {@link ImsRegInfo} class. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1269,7 +1320,7 @@ declare namespace radio { * the {@link ImsRegInfo} class. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1292,7 +1343,7 @@ declare namespace radio { * an instance of the {@link ImsRegInfo} class. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1312,7 +1363,8 @@ declare namespace radio { * @param { AsyncCallback } callback - Indicates the callback for getting the baseband version. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1332,7 +1384,8 @@ declare namespace radio { * @returns { Promise } Returns the baseband version. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1353,7 +1406,8 @@ declare namespace radio { * @param { AsyncCallback } callback - Indicates the callback for getting the option result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1374,7 +1428,8 @@ declare namespace radio { * @returns { Promise } Returns option result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1392,7 +1447,8 @@ declare namespace radio { * index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the selection mode of NR. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1410,7 +1466,8 @@ declare namespace radio { * index number supported by the device. * @returns { Promise } Returns the selection mode of NR. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1432,7 +1489,8 @@ declare namespace radio { * @param { AsyncCallback } callback - The callback of setNetworkCapability. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1455,7 +1513,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the setNetworkCapability. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1477,7 +1536,8 @@ declare namespace radio { * the network capability state. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1499,7 +1559,8 @@ declare namespace radio { * @returns { Promise } Returns the callback for getting the network capability state. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1519,7 +1580,8 @@ declare namespace radio { * @returns { Promise } The promise returned by the factoryReset. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. diff --git a/api/@ohos.telephony.sim.d.ts b/api/@ohos.telephony.sim.d.ts index 6c621e769383d95ccfcb3598936186a39be0e096..ecd2d5c828a015d27bcc298374481ac93292dd1f 100644 --- a/api/@ohos.telephony.sim.d.ts +++ b/api/@ohos.telephony.sim.d.ts @@ -96,7 +96,8 @@ declare namespace sim { * @param { AsyncCallback } callback - Indicates the callback of hasOperatorPrivileges. * Returns {@code true} if your application has been granted the operator permissions; returns {@code false} otherwise. * If no SIM card is inserted or the SIM card is deactivated will be return {@code false}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -114,7 +115,8 @@ declare namespace sim { * @returns { Promise } Returns {@code true} if your application has been granted the operator permissions; * returns {@code false} otherwise. If no SIM card is inserted or the SIM card is deactivated will be * return {@code false}. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -131,7 +133,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the country code defined * in ISO 3166-2; returns an empty string if no SIM card is inserted. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -149,7 +152,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the country code defined in ISO 3166-2; * returns an empty string if no SIM card is inserted. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -182,7 +186,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the PLMN number; * returns an empty string if no SIM card is inserted. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -202,7 +207,8 @@ declare namespace sim { * @param { number } slotId - Indicates the card slot index number, * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the PLMN number; returns an empty string if no SIM card is inserted. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -237,7 +243,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the SPN; * returns an empty string if no SIM card is inserted or no EFSPN file in the SIM card. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -258,7 +265,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the SPN; returns an empty string if no SIM card is inserted or * no EFSPN file in the SIM card. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -298,7 +306,8 @@ declare namespace sim { *
      • {@code SimState#SIM_STATE_READY} *
      • {@code SimState#SIM_STATE_LOADED} *
      - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -322,7 +331,8 @@ declare namespace sim { *
    • {@code SimState#SIM_STATE_READY} *
    • {@code SimState#SIM_STATE_LOADED} *
    - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -357,7 +367,8 @@ declare namespace sim { * @param { number } slotId - Indicates the card slot index number, * ranging from {@code 0} to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the SIM card type. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -374,7 +385,8 @@ declare namespace sim { * @param { number } slotId - Indicates the card slot index number, * ranging from {@code 0} to the maximum card slot index number supported by the device. * @returns { Promise } Returns the SIM card type. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -409,7 +421,8 @@ declare namespace sim { * returns an empty string if no SIM card is inserted. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -433,7 +446,8 @@ declare namespace sim { * @returns { Promise } Returns the ICCID; returns an empty string if no SIM card is inserted. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -455,7 +469,8 @@ declare namespace sim { * returns an empty string if no voice mailbox alpha identifier is written into the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -477,7 +492,8 @@ declare namespace sim { * returns an empty string if no voice mailbox alpha identifier is written into the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -499,7 +515,8 @@ declare namespace sim { * returns an empty string if no voice mailbox number is written into the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -521,7 +538,8 @@ declare namespace sim { * returns an empty string if no voice mailbox number is written into the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -544,7 +562,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of setVoiceMailInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -568,7 +587,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the setVoiceMailInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -593,7 +613,8 @@ declare namespace sim { * no MSISDN is recorded in the EFMSISDN file. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -616,7 +637,8 @@ declare namespace sim { * no MSISDN is recorded in the EFMSISDN file. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -639,7 +661,8 @@ declare namespace sim { * Returns an empty string if no SIM card is inserted or no GID1 in the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -662,7 +685,8 @@ declare namespace sim { * no GID1 in the SIM card. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -694,7 +718,8 @@ declare namespace sim { * the international mobile subscriber ID. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -715,7 +740,8 @@ declare namespace sim { * @returns { Promise } Returns the international mobile subscriber ID. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -735,7 +761,8 @@ declare namespace sim { * @param { OperatorSimCard } operator - Indicates the operator of sim. * @returns { boolean } Returns {@code true} if the SIM card is specified operator; return {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -754,7 +781,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for hasSimCard. * Returns {@code true} if a SIM card is inserted; return {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -770,7 +798,8 @@ declare namespace sim { * @param { number } slotId - Indicates the card slot index number, * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns {@code true} if a SIM card is inserted; return {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -800,7 +829,8 @@ declare namespace sim { * @param { AsyncCallback } callback - Indicates the callback for * getting a {@code IccAccountInfo} object. The ICCID and phone number will be null * if has no ohos.permission.GET_TELEPHONY_STATE. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -820,7 +850,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns a {@code IccAccountInfo} object. The ICCID and phone number * will be null if has no ohos.permission.GET_TELEPHONY_STATE. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -839,7 +870,8 @@ declare namespace sim { * @param { AsyncCallback> } callback - The callback is used to * return the array of {@link IccAccountInfo}. The ICCID and phone number will be null * if has no ohos.permission.GET_TELEPHONY_STATE. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -874,7 +906,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of setDefaultVoiceSlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -896,7 +929,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the setVoiceMailInfo. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -918,7 +952,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of activateSim. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -939,7 +974,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the activateSim. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -960,7 +996,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of deactivateSim. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -981,7 +1018,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the deactivateSim. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1003,7 +1041,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of setShowName. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1025,7 +1064,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the setShowName. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1046,7 +1086,8 @@ declare namespace sim { * @param { AsyncCallback } callback - Indicates the callback for getting the SIM card name. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1067,7 +1108,8 @@ declare namespace sim { * @returns { Promise } Returns the SIM card name. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1089,7 +1131,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of setShowNumber. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1111,7 +1154,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the setShowNumber. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1132,7 +1176,8 @@ declare namespace sim { * @param { AsyncCallback } callback - Indicates the callback for getting the SIM card number. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1153,7 +1198,8 @@ declare namespace sim { * @returns { Promise } Returns the SIM card number. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1176,7 +1222,8 @@ declare namespace sim { * returns empty OperatorConfig if no SIM card is inserted. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1197,7 +1244,8 @@ declare namespace sim { * returns empty OperatorConfig if no SIM card is inserted. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1219,7 +1267,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1243,7 +1292,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1268,7 +1318,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1293,7 +1344,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1318,7 +1370,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1343,7 +1396,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1367,7 +1421,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1391,7 +1446,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1415,7 +1471,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1439,7 +1496,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1464,7 +1522,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1489,7 +1548,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1514,7 +1574,8 @@ declare namespace sim { * the response to obtain the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1539,7 +1600,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1563,7 +1625,8 @@ declare namespace sim { * getting the dialing number information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1586,7 +1649,8 @@ declare namespace sim { * @returns { Promise> } Returns the dialing number information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1610,7 +1674,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of addIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1634,7 +1699,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the addIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1658,7 +1724,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of delIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1682,7 +1749,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the delIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1706,7 +1774,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of updateIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1730,7 +1799,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the updateIccDiallingNumbers. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1753,7 +1823,8 @@ declare namespace sim { * @param { AsyncCallback } callback - Indicates the callback for getting the sim card lock status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1776,7 +1847,8 @@ declare namespace sim { * @returns { Promise } Returns the sim card lock status. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1799,7 +1871,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of sendEnvelopeCmd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1821,7 +1894,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the sendEnvelopeCmd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1843,7 +1917,8 @@ declare namespace sim { * @param { AsyncCallback } callback - The callback of sendTerminalResponseCmd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1865,7 +1940,8 @@ declare namespace sim { * @returns { Promise } The promise returned by the sendTerminalResponseCmd. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1889,7 +1965,8 @@ declare namespace sim { * to obtain the SIM card lock status for the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1913,7 +1990,8 @@ declare namespace sim { * the SIM card lock status of the specified card slot. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -1933,7 +2011,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the operator key; * Returns an empty string if no SIM card is inserted or no operator key matched. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1951,7 +2030,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the operator key; * Returns an empty string if no SIM card is inserted or no operator key matched. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1981,7 +2061,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param { AsyncCallback } callback - Indicates the callback for getting the operator name; * Returns an empty string if no SIM card is inserted or no operator name matched. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -1999,7 +2080,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @returns { Promise } Returns the operator name; returns an empty string if no SIM card is inserted or * no operator name matched. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. @@ -2027,7 +2109,8 @@ declare namespace sim { * * @param { AsyncCallback } callback - Returns the SIM ID of the default voice sim * and SIM ID will increase from 1. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -2069,7 +2152,8 @@ declare namespace sim { * * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to * service. * @throws { BusinessError } 8300003 - System internal error. @@ -2094,7 +2178,8 @@ declare namespace sim { * * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to * service. * @throws { BusinessError } 8300003 - System internal error. diff --git a/api/@ohos.telephony.sms.d.ts b/api/@ohos.telephony.sms.d.ts index 8aa5df03ad89e565aa655a9e06857ac9e6e5d4b5..7401d41f6bcaedf26c19d639fd56e24a5dc67367 100644 --- a/api/@ohos.telephony.sms.d.ts +++ b/api/@ohos.telephony.sms.d.ts @@ -42,7 +42,8 @@ declare namespace sms { * Returns an empty string if no permission is granted or the short message content is {@code null}. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -65,7 +66,8 @@ declare namespace sms { * message; Returns an empty string if no permission is granted or the short message content is {@code null}. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -86,8 +88,9 @@ declare namespace sms { * @param { string } specification - Indicates the SMS protocol type. The value {@code 3gpp} indicates GSM/UMTS/LTE * SMS, and the value {@code 3gpp2} indicates CDMA/LTE SMS. * @param { AsyncCallback } callback - Indicates the callback for getting an SMS message instance; - * Returns {@code null} if {@code pdu} is empty or {@code specification} is not supported. - * @throws { BusinessError } 401 - Parameter error. + * returns {@code null} if {@code pdu} is empty or {@code specification} is not supported. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -107,8 +110,9 @@ declare namespace sms { * @param { string } specification - Indicates the SMS protocol type. The value {@code 3gpp} indicates GSM/UMTS/LTE * SMS, and the value {@code 3gpp2} indicates CDMA/LTE SMS. * @returns { Promise } Returns an SMS message instance; - * Returns {@code null} if {@code pdu} is empty or {@code specification} is not supported. - * @throws { BusinessError } 401 - Parameter error. + * returns {@code null} if {@code pdu} is empty or {@code specification} is not supported. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -127,7 +131,8 @@ declare namespace sms { * @permission ohos.permission.SEND_MESSAGES * @param { SendMessageOptions } options - Indicates the parameters and callback for sending the SMS message. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -149,7 +154,8 @@ declare namespace sms { * @param { SendMessageOptions } options - Indicates the parameters and callback for sending the SMS message. * @param { AsyncCallback } callback - The callback of sendShortMessage. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -169,7 +175,8 @@ declare namespace sms { * @param { SendMessageOptions } options - Indicates the parameters and callback for sending the SMS message. * @returns { Promise } The promise returned by the sendShortMessage. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -189,7 +196,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of setDefaultSmsSlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -211,7 +219,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the setDefaultSmsSlotId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -254,7 +263,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of setSmscAddr. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -274,7 +284,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the setSmscAddr. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -293,7 +304,8 @@ declare namespace sms { * @param { AsyncCallback } callback - Indicates the callback for getting the SMSC address. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -312,7 +324,8 @@ declare namespace sms { * @returns { Promise } Returns the SMSC address. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -341,7 +354,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of addSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -360,7 +374,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the addSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -381,7 +396,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of delSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -402,7 +418,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the delSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -421,7 +438,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of updateSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -440,7 +458,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the updateSimMessage. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -461,7 +480,8 @@ declare namespace sms { * {@code SimShortMessage} object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -481,7 +501,8 @@ declare namespace sms { * @returns { Promise> } Returns a {@code SimShortMessage} object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -500,7 +521,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of setCBConfig. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -519,7 +541,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the setCBConfig. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -540,7 +563,8 @@ declare namespace sms { * @param { AsyncCallback } callback - Indicates the callback for getting a {@code SmsSegmentsInfo} * object. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -560,7 +584,8 @@ declare namespace sms { * @param { boolean } force7bit - Indicates whether to use 7 bit encoding. * @returns { Promise } Returns a {@code SmsSegmentsInfo} object. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -579,7 +604,8 @@ declare namespace sms { * @param { AsyncCallback } callback - Indicates the callback of isImsSmsSupported. * Returns {@code true} if SMS over IMS is supported, {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -597,7 +623,8 @@ declare namespace sms { * and the value {@code 1} indicates card slot 2. * @returns { Promise } Returns {@code true} if SMS over IMS is supported, {@code false} otherwise. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -613,7 +640,8 @@ declare namespace sms { * * @param { AsyncCallback } callback - Indicates the callback for getting format, 3gpp, 3gpp2 or unknown. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -645,7 +673,8 @@ declare namespace sms { * @param { AsyncCallback } callback - Indicates the callback for getting a {@code MmsInformation} * object. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -662,7 +691,8 @@ declare namespace sms { * @param { string | Array } mmsFilePathName - Indicates the path name of the multimedia message file. * @returns { Promise } Returns a {@code MmsInformation} object. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -679,7 +709,8 @@ declare namespace sms { * @param { MmsInformation } mms - Indicates MMS messages. * @param { AsyncCallback> } callback - Indicates the callback for getting the result of MMS encoding. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -696,7 +727,8 @@ declare namespace sms { * @param { MmsInformation } mms - Indicates MMS messages. * @returns { Promise> } Returns the result of MMS encoding. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -712,7 +744,8 @@ declare namespace sms { * * @param { AsyncCallback } callback - Returns the SIM ID of the default sms sim and * SIM ID will increase from 1. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -790,7 +823,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of sendMms. For error code, see MmsFailCode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -810,7 +844,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the sendMms. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -830,7 +865,8 @@ declare namespace sms { * @param { AsyncCallback } callback - The callback of downloadMms. For error code, see MmsFailCode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. @@ -850,7 +886,8 @@ declare namespace sms { * @returns { Promise } The promise returned by the downloadMms. For error code, see MmsFailCode. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. + * Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. * @throws { BusinessError } 8300003 - System internal error. diff --git a/api/@ohos.telephony.vcard.d.ts b/api/@ohos.telephony.vcard.d.ts index 793a6f66f3d64546b296de46eee648a1cf92af7e..811b8181380c86334472aa3120aecd522c1832fc 100644 --- a/api/@ohos.telephony.vcard.d.ts +++ b/api/@ohos.telephony.vcard.d.ts @@ -46,7 +46,8 @@ declare namespace vcard { * @param { AsyncCallback } callback - The callback of the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -71,7 +72,8 @@ declare namespace vcard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -92,7 +94,8 @@ declare namespace vcard { * @param { AsyncCallback } callback - The callback of the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -112,7 +115,8 @@ declare namespace vcard { * @param { AsyncCallback } callback - Represents the address of the generated vcf file. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -133,7 +137,8 @@ declare namespace vcard { * @returns { Promise } the promise represents the address of the generated vcf file.. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. @@ -153,7 +158,8 @@ declare namespace vcard { * @param { AsyncCallback } callback - Represents the address of the generated vcf file. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws { BusinessError } 8300001 - Invalid parameter value. * @throws { BusinessError } 8300003 - System internal error. * @throws { BusinessError } 8300999 - Unknown error code. diff --git a/api/@ohos.userIAM.userAuth.d.ts b/api/@ohos.userIAM.userAuth.d.ts index 6a769ec719be6f5e825967496d3e257b4db6e45c..91d895616394d6b4ba47d7fcc225726fa868f1c8 100644 --- a/api/@ohos.userIAM.userAuth.d.ts +++ b/api/@ohos.userIAM.userAuth.d.ts @@ -921,7 +921,8 @@ declare namespace userAuth { * @param { UserAuthType } authType - Credential type for authentication. * @param { AuthTrustLevel } authTrustLevel - Trust level of authentication result. * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. * @throws { BusinessError } 12500002 - General operation error. * @throws { BusinessError } 12500005 - The authentication type is not supported. * @throws { BusinessError } 12500006 - The authentication trust level is not supported. @@ -929,22 +930,6 @@ declare namespace userAuth { * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 9 */ - /** - * Check whether the authentication capability is available. - * - * @permission ohos.permission.ACCESS_BIOMETRIC - * @param { UserAuthType } authType - Credential type for authentication. - * @param { AuthTrustLevel } authTrustLevel - Trust level of authentication result. - * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. - * @throws { BusinessError } 12500002 - General operation error. - * @throws { BusinessError } 12500005 - The authentication type is not supported. - * @throws { BusinessError } 12500006 - The authentication trust level is not supported. - * @throws { BusinessError } 12500010 - The type of credential has not been enrolled. - * @throws { BusinessError } 12500013 - Indicates that current operation failed because of PIN expired. - * @syscap SystemCapability.UserIAM.UserAuth.Core - * @since 12 - */ function getAvailableStatus(authType: UserAuthType, authTrustLevel: AuthTrustLevel): void; /** @@ -981,7 +966,8 @@ declare namespace userAuth { * @param { UserAuthType } authType - Credential type for authentication. * @returns { EnrolledState } Returns the enrolled state. * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. * @throws { BusinessError } 12500002 - General operation error. * @throws { BusinessError } 12500005 - The authentication type is not supported. * @throws { BusinessError } 12500010 - The type of credential has not been enrolled. @@ -1251,7 +1237,10 @@ declare namespace userAuth { * * @param { 'result' } type - Indicates the type of event. * @param { IAuthCallback } callback - Indicates the listener. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 10 @@ -1263,7 +1252,10 @@ declare namespace userAuth { * * @param { 'result' } type - Indicates the type of event. * @param { IAuthCallback } callback - Indicates the listener. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 10 @@ -1275,40 +1267,21 @@ declare namespace userAuth { * * @permission ohos.permission.ACCESS_BIOMETRIC * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    2. Incorrect parameter types. * @throws { BusinessError } 12500001 - Authentication failed. * @throws { BusinessError } 12500002 - General operation error. - * @throws { BusinessError } 12500003 - The operation is canceled. - * @throws { BusinessError } 12500004 - The operation is time-out. + * @throws { BusinessError } 12500003 - Authentication canceled. + * @throws { BusinessError } 12500004 - Authentication timeout. * @throws { BusinessError } 12500005 - The authentication type is not supported. * @throws { BusinessError } 12500006 - The authentication trust level is not supported. - * @throws { BusinessError } 12500007 - The authentication task is busy. - * @throws { BusinessError } 12500009 - The authenticator is locked. + * @throws { BusinessError } 12500007 - Authentication service is busy. + * @throws { BusinessError } 12500009 - Authentication is locked out. * @throws { BusinessError } 12500010 - The type of credential has not been enrolled. - * @throws { BusinessError } 12500011 - The authentication is canceled from widget's navigation button. + * @throws { BusinessError } 12500011 - Switched to the custom authentication process. * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 10 */ - /** - * Start this authentication, an instance can only perform authentication once. - * - * @permission ohos.permission.ACCESS_BIOMETRIC - * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. - * @throws { BusinessError } 12500001 - Authentication failed. - * @throws { BusinessError } 12500002 - General operation error. - * @throws { BusinessError } 12500003 - The operation is canceled. - * @throws { BusinessError } 12500004 - The operation is time-out. - * @throws { BusinessError } 12500005 - The authentication type is not supported. - * @throws { BusinessError } 12500006 - The authentication trust level is not supported. - * @throws { BusinessError } 12500007 - The authentication task is busy. - * @throws { BusinessError } 12500009 - The authenticator is locked. - * @throws { BusinessError } 12500010 - The type of credential has not been enrolled. - * @throws { BusinessError } 12500011 - The authentication is canceled from widget's navigation button. - * @throws { BusinessError } 12500013 - Indicates that current authentication failed because of PIN expired. - * @syscap SystemCapability.UserIAM.UserAuth.Core - * @since 12 - */ start(): void; /** @@ -1316,7 +1289,8 @@ declare namespace userAuth { * * @permission ohos.permission.ACCESS_BIOMETRIC * @throws { BusinessError } 201 - Permission verification failed. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    2. Incorrect parameter types. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 10 @@ -1330,7 +1304,10 @@ declare namespace userAuth { * @param { AuthParam } authParam - Auth parameter. * @param { WidgetParam } widgetParam - Widget parameter. * @returns { UserAuthInstance } Returns an authentication instance with widget. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @throws { BusinessError } 12500005 - The authentication type is not supported. * @throws { BusinessError } 12500006 - The authentication trust level is not supported. @@ -1366,7 +1343,10 @@ declare namespace userAuth { * @param { string } eventData - The event data from widget. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @systemapi Hide this for inner system use. @@ -1468,15 +1448,7 @@ declare namespace userAuth { * @syscap SystemCapability.UserIAM.UserAuth.Core * @since 10 */ - CANCELED_FROM_WIDGET = 12500011, - - /** - * Indicates that current operation failed because of PIN expired. - * - * @syscap SystemCapability.UserIAM.UserAuth.Core - * @since 12 - */ - PIN_EXPIRED = 12500013 + CANCELED_FROM_WIDGET = 12500011 } /** @@ -1493,7 +1465,10 @@ declare namespace userAuth { * * @param { 'command' } type - Indicates the type of event. * @param { IAuthWidgetCallback } callback - Indicates the listener. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @systemapi Hide this for inner system use. @@ -1506,7 +1481,10 @@ declare namespace userAuth { * * @param { 'command' } type - Indicates the type of event. * @param { IAuthWidgetCallback } callback - Indicates the listener. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + *
    3. Parameter verification failed. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @systemapi Hide this for inner system use. @@ -1523,7 +1501,9 @@ declare namespace userAuth { * @returns { UserAuthWidgetMgr } Returns an authentication manager. * @throws { BusinessError } 201 - Permission verification failed. * @throws { BusinessError } 202 - The caller is not a system application. - * @throws { BusinessError } 401 - Incorrect parameters. + * @throws { BusinessError } 401 - Incorrect parameters. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 12500002 - General operation error. * @syscap SystemCapability.UserIAM.UserAuth.Core * @systemapi Hide this for inner system use. diff --git a/api/@ohos.util.HashMap.d.ts b/api/@ohos.util.HashMap.d.ts index 7ef8da7e3669669d8b4c2a2172c527b161141122..98be2ce18bcd0a434fc6cfd27be807578703e033 100644 --- a/api/@ohos.util.HashMap.d.ts +++ b/api/@ohos.util.HashMap.d.ts @@ -33,6 +33,15 @@ * @crossplatform * @since 10 */ +/** + * HashMap is a map implemented based on the array, linked list, and red-black tree. It provides efficient data query, insertion, + * and removal. The elements in a HashMap instance are mappings of key-value pairs. Each key must be unique and have only one value. + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ declare class HashMap { /** * A constructor used to create a HashMap object. @@ -49,6 +58,15 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * A constructor used to create a HashMap object. + * + * @throws { BusinessError } 10200012 - The HashMap's constructor cannot be directly invoked. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** * Gets the element number of the hashmap. @@ -63,6 +81,14 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Gets the element number of the hashmap. + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ length: number; /** * Returns whether the Map object contains elements @@ -81,6 +107,16 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns whether the Map object contains elements + * + * @returns { boolean } the boolean type + * @throws { BusinessError } 10200011 - The isEmpty method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ isEmpty(): boolean; /** * Returns whether a key is contained in this map @@ -101,6 +137,17 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns whether a key is contained in this map + * + * @param { K } key - key key need to determine whether to include the key + * @returns { boolean } the boolean type + * @throws { BusinessError } 10200011 - The hasKey method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ hasKey(key: K): boolean; /** * Returns whether a value is contained in this map @@ -121,6 +168,17 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns whether a value is contained in this map + * + * @param { V } value - value value need to determine whether to include the value + * @returns { boolean } the boolean type + * @throws { BusinessError } 10200011 - The hasValue method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ hasValue(value: V): boolean; /** * Returns a specified element in a Map object, or undefined if there is no corresponding element @@ -141,6 +199,17 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns a specified element in a Map object, or undefined if there is no corresponding element + * + * @param { K } key - key key the index in HashMap + * @returns { V } value or undefined + * @throws { BusinessError } 10200011 - The get method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ get(key: K): V; /** * Adds all element groups in one map to another map @@ -165,6 +234,19 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Adds all element groups in one map to another map + * + * @param { HashMap } map - map map the Map object to add members + * @throws { BusinessError } 10200011 - The setAll method cannot be bound. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ setAll(map: HashMap): void; /** * Adds or updates a(new) key-value pair with a key and value specified for the Map object @@ -191,6 +273,20 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Adds or updates a(new) key-value pair with a key and value specified for the Map object + * + * @param { K } key - key key Added or updated targets + * @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 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ set(key: K, value: V): Object; /** * Remove a specified element from a Map object @@ -211,6 +307,17 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Remove a specified element from a Map object + * + * @param { K } key - key key Target to be deleted + * @returns { V } Target mapped value + * @throws { BusinessError } 10200011 - The remove method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ remove(key: K): V; /** * Clear all element groups in the map @@ -227,6 +334,15 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Clear all element groups in the map + * + * @throws { BusinessError } 10200011 - The clear method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ clear(): void; /** * Returns a new Iterator object that contains the keys contained in this map @@ -245,6 +361,16 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns a new Iterator object that contains the keys contained in this map + * + * @returns { IterableIterator } + * @throws { BusinessError } 10200011 - The keys method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ keys(): IterableIterator; /** * Returns a new Iterator object that contains the values contained in this map @@ -263,6 +389,16 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns a new Iterator object that contains the values contained in this map + * + * @returns { IterableIterator } + * @throws { BusinessError } 10200011 - The values method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ values(): IterableIterator; /** * Replace the old value by new value corresponding to the specified key @@ -285,6 +421,18 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Replace the old value by new value corresponding to the specified key + * + * @param { K } key - key key Updated targets + * @param { V } newValue - newValue newValue Updated the target mapped value + * @returns { boolean } the boolean type(Is there a target pointed to by the key) + * @throws { BusinessError } 10200011 - The replace method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ replace(key: K, newValue: V): boolean; /** * Executes the given callback function once for each real key in the map. @@ -321,6 +469,25 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Executes the given callback function once for each real key in the map. + * It does not perform functions on deleted keys + * + * @param { function } callbackFn - callbackFn + * callbackFn (required) A function that accepts up to three arguments. + * The function to be called for each element. + * @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 } 10200011 - The forEach method cannot be bound. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ forEach(callbackFn: (value?: V, key?: K, map?: HashMap) => void, thisArg?: Object): void; /** * Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order @@ -339,6 +506,16 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order + * + * @returns { IterableIterator<[K, V]> } + * @throws { BusinessError } 10200011 - The entries method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ entries(): IterableIterator<[K, V]>; /** * returns an iterator.Each item of the iterator is a Javascript Object @@ -357,6 +534,16 @@ declare class HashMap { * @crossplatform * @since 10 */ + /** + * returns an iterator.Each item of the iterator is a Javascript Object + * + * @returns { IterableIterator<[K, V]> } + * @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ [Symbol.iterator](): IterableIterator<[K, V]>; } diff --git a/api/@ohos.util.d.ts b/api/@ohos.util.d.ts index 2f645f622427cf0973d071be4bc75e044801e2f4..544bb8e9946581039b68b3fe303d523900f4f469 100644 --- a/api/@ohos.util.d.ts +++ b/api/@ohos.util.d.ts @@ -402,6 +402,14 @@ declare namespace util { * @crossplatform * @since 10 */ + /** + * The textDecoder constructor. + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ constructor(); /** @@ -1860,6 +1868,14 @@ declare namespace util { * @crossplatform * @since 10 */ + /** + * A type used to denote ScopeComparable or number. + * + * @typedef { ScopeComparable | number } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @since 12 + */ type ScopeType = ScopeComparable | number; /** diff --git a/api/@ohos.util.json.d.ts b/api/@ohos.util.json.d.ts index 8bba5ecdb21d6b4addb6e923fa01ff802807c298..921bcd5f26b8462081a603b69337a98bfe20c272 100644 --- a/api/@ohos.util.json.d.ts +++ b/api/@ohos.util.json.d.ts @@ -30,6 +30,11 @@ declare namespace json { /** * The type of conversion result function. * + * @typedef { function } Transformer + * @param { Object } this - The object to which the parsed key value pair belongs. + * @param { string } key - Attribute name. + * @param { Object } value - The value of the parsed key value pair. + * @returns { Object | undefined | null } Return the modified object or undefined or null. * @syscap SystemCapability.Utils.Lang * @since 12 */ diff --git a/api/@ohos.vibrator.d.ts b/api/@ohos.vibrator.d.ts index fadd2b0c77d77478a52287ffe8aa40c2d1e078d1..419ce5ae4f43aade819833069e9708dafbf3440b 100644 --- a/api/@ohos.vibrator.d.ts +++ b/api/@ohos.vibrator.d.ts @@ -96,7 +96,8 @@ declare namespace vibrator { * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}. * @param { AsyncCallback } callback - The callback of startVibration. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14600101 - Device operation failed. * @syscap SystemCapability.Sensors.MiscDevice @@ -110,7 +111,8 @@ declare namespace vibrator { * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute} * @param { AsyncCallback } callback - The callback of startVibration * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported * @throws { BusinessError } 14600101 - Device operation failed * @syscap SystemCapability.Sensors.MiscDevice @@ -127,7 +129,8 @@ declare namespace vibrator { * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14600101 - Device operation failed. * @syscap SystemCapability.Sensors.MiscDevice @@ -141,7 +144,8 @@ declare namespace vibrator { * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14600101 - Device operation failed. * @syscap SystemCapability.Sensors.MiscDevice @@ -157,7 +161,8 @@ declare namespace vibrator { * @param { VibratorStopMode } stopMode - Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 9 */ @@ -170,7 +175,8 @@ declare namespace vibrator { * @param { VibratorStopMode } stopMode - Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}. * @param { AsyncCallback } callback - The callback of stopVibration. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 9 */ @@ -236,7 +242,8 @@ declare namespace vibrator { * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}. * @param { AsyncCallback } callback The callback of isSupportEffect. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 10 */ @@ -248,7 +255,8 @@ declare namespace vibrator { * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 10 */ @@ -259,7 +267,8 @@ declare namespace vibrator { * * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}. * @returns { boolean } Returns whether the effect is supported. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14600101 - Device operation failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 12 @@ -292,6 +301,16 @@ declare namespace vibrator { */ function stop(stopMode: VibratorStopMode, callback?: AsyncCallback): void; + /** + * Whether the high-definition haptic is supported. + * + * @returns { boolean } Returns whether the high-definition haptic is supported. + * @throws { BusinessError } 14600101 - Device operation failed. + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + function isHdHapticSupported(): boolean; + /** * Preset vibration effect string. * @@ -309,6 +328,39 @@ declare namespace vibrator { EFFECT_CLOCK_TIMER = 'haptic.clock.timer' } + /** + * Simple and universal vibration effects. + * + * @enum { string } + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + enum HapticFeedback { + /** + * Describes the soft vibration effect of the vibrator. + * + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + EFFECT_SOFT = 'haptic.effect.soft', + + /** + * Describes the hard vibration effect of the vibrator. + * + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + EFFECT_HARD = 'haptic.effect.hard', + + /** + * Describes the sharp vibration effect of the vibrator. + * + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + EFFECT_SHARP = 'haptic.effect.sharp' + } + /** * Vibrator vibration stop mode. * @@ -502,7 +554,23 @@ declare namespace vibrator { * @syscap SystemCapability.Sensors.MiscDevice * @since 9 */ - count: number; + /** + * The number of vibration repetitions. + * + * @type { ?number } + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + count?: number; + + /** + * The intensity of vibration effect. + * + * @type { ?number } + * @syscap SystemCapability.Sensors.MiscDevice + * @since 12 + */ + intensity?: number; } /** diff --git a/api/@ohos.web.webview.d.ts b/api/@ohos.web.webview.d.ts index d9adb21b584b0296e391aadc02d71a83dc7fd25a..65cca67a98f2ab0a72ef095474cfb5b993f6d45a 100644 --- a/api/@ohos.web.webview.d.ts +++ b/api/@ohos.web.webview.d.ts @@ -21,7 +21,7 @@ /// /// -import { AsyncCallback, BusinessError } from './@ohos.base'; +import { AsyncCallback } from './@ohos.base'; import { Callback } from './@ohos.base'; import { Resource } from 'GlobalResource'; import cert from './@ohos.security.cert'; @@ -654,7 +654,8 @@ declare namespace webview { * @param {string} type Types of web event. * @param {Callback} callback Indicate callback used to receive the web event. * - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @since 9 */ @@ -664,7 +665,8 @@ declare namespace webview { * @param {string} type Types of web event. * @param {Callback} callback Indicate callback used to receive the web event. * - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -706,7 +708,8 @@ declare namespace webview { * Delete the storage data with the origin. * * @param { string } origin - The origin which to be deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @since 9 @@ -715,7 +718,8 @@ declare namespace webview { * Delete the storage data with the origin. * * @param { string } origin - The origin which to be deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -734,7 +738,8 @@ declare namespace webview { /** * Get current all the web storage origins. * @returns { Promise> } - returns all the WebStorageOrigin. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100012 - Invalid web storage origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -753,7 +758,8 @@ declare namespace webview { /** * Get current all the web storage origins. * @param { AsyncCallback> } callback - callback used to return all the WebStorageOrigin. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100012 - Invalid web storage origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -774,7 +780,8 @@ declare namespace webview { * Get the web storage quota with the origin. * @param { string } origin - The origin which to be inquired. * @returns { Promise } - the promise returned by the function - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -786,7 +793,8 @@ declare namespace webview { * Get the web storage quota with the origin. * @param { string } origin - The origin which to be inquired. * @param { AsyncCallback } callback - the callback of getOriginQuota. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @since 9 @@ -795,7 +803,8 @@ declare namespace webview { * Get the web storage quota with the origin. * @param { string } origin - The origin which to be inquired. * @param { AsyncCallback } callback - the callback of getOriginQuota. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -807,7 +816,8 @@ declare namespace webview { * Get the web amount of storage with the origin. * @param { string } origin - The origin which to be inquired. * @returns { Promise } - the promise returned by the function - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @since 9 @@ -816,7 +826,8 @@ declare namespace webview { * Get the web amount of storage with the origin. * @param { string } origin - The origin which to be inquired. * @returns { Promise } - the promise returned by the function - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -828,7 +839,8 @@ declare namespace webview { * Get the web amount of storage with the origin. * @param { string } origin - The origin which to be inquired. * @param { AsyncCallback } callback - the callback of getOriginUsage. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @since 9 @@ -837,7 +849,8 @@ declare namespace webview { * Get the web amount of storage with the origin. * @param { string } origin - The origin which to be inquired. * @param { AsyncCallback } callback - the callback of getOriginUsage. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -905,7 +918,8 @@ declare namespace webview { * @param { string } host - The host to which the credentials apply. * @param { string } realm - The realm to which the credentials apply. * @returns { Array } Return an array containing username and password. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -929,7 +943,8 @@ declare namespace webview { * @param { string } realm - The realm to which the credentials apply. * @param { string } username - The username. * @param { string } password - The password. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -963,7 +978,8 @@ declare namespace webview { * @param { string } origin - Url source. * @param { boolean } incognito - {@code true} Allow geolocation permissions for specifies source * in incognito mode; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -984,7 +1000,8 @@ declare namespace webview { * @param { string } origin - Url source. * @param { boolean } incognito - {@code true} delete geolocation permissions for specifies source * in incognito mode; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1032,7 +1049,8 @@ declare namespace webview { * true for authorization, false for access denial. Failed * to get, indicating that the permission status of the * specified source does not exist. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1065,7 +1083,8 @@ declare namespace webview { * not exist. * @param { boolean } incognito - {@code true} gets the geolocation permission status of the * specified source in incognito mode; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100011 - Invalid origin. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1088,7 +1107,8 @@ declare namespace webview { * in incognito mode; {@code false} otherwise. * @returns { Promise> } A Promise instance that gets all source information about * the stored geolocation permission state. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1109,7 +1129,8 @@ declare namespace webview { * stored geolocation permission states. * @param { boolean } incognito - {@code true} gets all stored geolocation permission url * source in incognito mode; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1137,7 +1158,8 @@ declare namespace webview { * * @param { string } url - The URL for which the cookies are requested. * @returns { string } - The cookie value for the given URL. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100002 - Invalid url. * @syscap SystemCapability.Web.Webview.Core * @since 9 @@ -1153,7 +1175,8 @@ declare namespace webview { * @param { boolean } incognito - {@code true} gets all cookies for the given URL * in incognito mode; {@code false} otherwise. * @returns { string } - The cookie value for the given URL. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1166,7 +1189,8 @@ declare namespace webview { * * @param { string } url - The URL for which the cookies are requested. * @returns { Promise } - A promise resolved after the cookies of given URL have been gotten. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @syscap SystemCapability.Web.Webview.Core * @crossplatform @@ -1180,7 +1204,8 @@ declare namespace webview { * * @param { string } url - The URL for which the cookies are requested. * @param { AsyncCallback } callback - Called after the cookies of given URL have been gotten. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @syscap SystemCapability.Web.Webview.Core * @crossplatform @@ -1194,7 +1219,8 @@ declare namespace webview { * * @param { string } url - The URL for which the cookie is to be set. * @param { string } value - The cookie as a string, using the format of the 'Set-Cookie' HTTP response header. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @throws { BusinessError } 17100005 - Invalid cookie value. * @syscap SystemCapability.Web.Webview.Core @@ -1211,7 +1237,8 @@ declare namespace webview { * @param { string } value - The cookie as a string, using the format of the 'Set-Cookie' HTTP response header. * @param { boolean } incognito - {@code true} set a single cookie (key-value pair) for the given URL * in incognito mode; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @throws { BusinessError } 17100005 - Invalid cookie value. * @syscap SystemCapability.Web.Webview.Core @@ -1226,7 +1253,8 @@ declare namespace webview { * @param { string } url - The URL for which the cookie is to be set. * @param { string } value - The cookie as a string, using the format of the 'Set-Cookie' HTTP response header. * @returns { Promise } - A promise resolved after the cookies of given URL have been set. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @throws { BusinessError } 17100005 - Invalid cookie value. * @syscap SystemCapability.Web.Webview.Core @@ -1242,7 +1270,8 @@ declare namespace webview { * @param { string } url - The URL for which the cookie is to be set. * @param { string } value - The cookie as a string, using the format of the 'Set-Cookie' HTTP response header. * @param { AsyncCallback } callback - Called after the cookies have been set. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100002 - Invalid url. * @throws { BusinessError } 17100005 - Invalid cookie value. * @syscap SystemCapability.Web.Webview.Core @@ -1255,14 +1284,16 @@ declare namespace webview { /** * Save the cookies Asynchronously. * @returns { Promise } - A promise resolved after the cookies have been saved. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @since 9 */ /** * Save the cookies Asynchronously. * @returns { Promise } - A promise resolved after the cookies have been saved. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1272,14 +1303,16 @@ declare namespace webview { /** * Save the cookies Asynchronously. * @param { AsyncCallback } callback - Called after the cookies have been saved. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @since 9 */ /** * Save the cookies Asynchronously. * @param { AsyncCallback } callback - Called after the cookies have been saved. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1317,7 +1350,8 @@ declare namespace webview { * By default this is set to be true. * * @param { boolean } accept - Whether the instance should send and accept cookies. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1346,7 +1380,8 @@ declare namespace webview { * By default this is set to be false. * * @param { boolean } accept - Whether the instance should send and accept thirdparty cookies. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @since 9 */ @@ -1355,7 +1390,8 @@ declare namespace webview { * By default this is set to be false. * * @param { boolean } accept - Whether the instance should send and accept thirdparty cookies. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1404,7 +1440,7 @@ declare namespace webview { /** * Remove all cookies Asynchronously. * @returns { Promise } - A promise resolved after the cookies have been deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -1415,7 +1451,8 @@ declare namespace webview { /** * Remove all cookies Asynchronously. * @param { AsyncCallback } callback - Called after the cookies have been deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -1443,7 +1480,7 @@ declare namespace webview { /** * Delete the session cookies Asynchronously. * @returns { Promise } - A promise resolved after the cookies have been deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1453,8 +1490,8 @@ declare namespace webview { /** * Delete the session cookies Asynchronously. * @param { AsyncCallback } callback - Called after the cookies have been deleted. - * @throws { BusinessError } 401 - Invalid input parameter. - * parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1739,8 +1776,9 @@ declare namespace webview { /** * Set the type of the web message. * @param { WebMessageType } type - set WebMessageType type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1760,8 +1798,9 @@ declare namespace webview { /** * Set the string value of the web message. * @param { string } message - set string type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1781,8 +1820,9 @@ declare namespace webview { /** * Set the number value of the web message. * @param { number } message - set number type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1802,8 +1842,9 @@ declare namespace webview { /** * Set the boolean value of the web message. * @param { boolean } message - set boolean type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1823,8 +1864,9 @@ declare namespace webview { /** * Set the array buffer value of the web message. * @param { ArrayBuffer } message - set ArrayBuffer type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1843,8 +1885,9 @@ declare namespace webview { /** * Set the array value of the web message. * @param { Array } message - set Array type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -1854,8 +1897,9 @@ declare namespace webview { /** * Set the error value of the web message. * @param { Error } message - set Error type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @since 10 @@ -1863,8 +1907,9 @@ declare namespace webview { /** * Set the error value of the web message. * @param { Error } message - set Error type data - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100014 - The type does not match with the value of the web message. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100014 - The type and value of the message do not match. * * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -1942,8 +1987,9 @@ declare namespace webview { /** * Post a message to other port. * @param { WebMessage } message - Message to send. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100010 - Can not post message using this port. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100010 - Failed to post messages through the port. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -1962,8 +2008,9 @@ declare namespace webview { /** * Receive message from other port. * @param { function } callback - Callback function for receiving messages. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100006 - Can not register message event using this port. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100006 - Failed to register a message event for the port. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -1982,8 +2029,9 @@ declare namespace webview { /** * Post a message to other port. * @param { WebMessageExt } message - Message to send. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100010 - Can not post message using this port. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100010 - Failed to post messages through the port. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -2001,8 +2049,9 @@ declare namespace webview { /** * Receive message from other port. * @param { function } callback - Callback function for receiving messages. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100006 - Can not register message event using this port. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 17100006 - Failed to register a message event for the port. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -2138,7 +2187,8 @@ declare namespace webview { * * @param { number } index Index of back forward list entry. * @returns { HistoryItem } HistoryItem at given index in back forward list. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice @@ -2526,7 +2576,7 @@ declare namespace webview { */ interface OfflineResourceMap { /** - * Url list of resource. + * Url list of resource. Url of urlList must be HTTP/HTTPS protocol and no longer than 2048. * * @type { Array } * @syscap SystemCapability.Web.Webview.Core @@ -2535,7 +2585,7 @@ declare namespace webview { urlList: Array, /** - * Arraybuffer of resource. + * Arraybuffer of resource. Size must less than 10Mb and cannot be empty. * * @type { Uint8Array } * @syscap SystemCapability.Web.Webview.Core @@ -2622,7 +2672,8 @@ declare namespace webview { * @param { SecureDnsMode } secureDnsMode - using HttpDns. * @param { string } secureDnsConfig - The configuration of the HttpDns server. * Must be https protocol and only allow one server to be configured. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -2632,14 +2683,16 @@ declare namespace webview { /** * Enables debugging of web contents. * @param { boolean } webDebuggingAccess {@code true} enables debugging of web contents; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @since 9 */ /** * Enables debugging of web contents. * @param { boolean } webDebuggingAccess {@code true} enables debugging of web contents; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -2650,7 +2703,8 @@ declare namespace webview { * Enable the ability to check website security risks. * Illegal and fraudulent websites are mandatory enabled and can't be disabled by this function. * @param { boolean } enable - {@code true} enable check the website security risks; {@code false} otherwise. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -2722,7 +2776,8 @@ declare namespace webview { * * @param { number } step - The number of steps. * @returns { boolean } True if the web page can go back else false. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -2879,7 +2934,8 @@ declare namespace webview { * @param { string } [historyUrl] - History URL. When it is not empty, it can be managed by * history records to realize the back and forth function. * This property is invalid when baseUrl is empty. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -2921,7 +2977,8 @@ declare namespace webview { * * @param { string | Resource } url - The URL to load. * @param { Array } [headers] - Additional HTTP request header for URL. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100002 - Invalid url. @@ -2981,7 +3038,8 @@ declare namespace webview { * @returns { Promise } a promise resolved after the web archive has been stored. The parameter * will either be the filename under which the file was stored, or empty * if storing the file failed. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100003 - Invalid resource path or file type. @@ -3020,7 +3078,8 @@ declare namespace webview { * @param { AsyncCallback } callback - called after the web archive has been stored. The parameter * will either be the filename under which the file was stored, * or empty if storing the file failed. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100003 - Invalid resource path or file type. @@ -3045,7 +3104,8 @@ declare namespace webview { * Let the Web zoom by. * * @param { number } factor - The zoom factor. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100004 - Function not enable. @@ -3199,7 +3259,8 @@ declare namespace webview { * Goes forward or back backOrForward in the history of the web page. * * @param { number } step - Steps to go forward or backward. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3209,7 +3270,8 @@ declare namespace webview { * Goes forward or back backOrForward in the history of the web page. * * @param { number } step - Steps to go forward or backward. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3263,7 +3325,8 @@ declare namespace webview { * @param { boolean } isExtentionType - Set whether the web message port supports extention type. * @returns { Array } An array represent 2 WebMessagePort, then can use * those ports to communication with html pages. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3291,7 +3354,8 @@ declare namespace webview { * @param { string } name - Data name information to send. * @param { Array } ports - Port number array information to send. * @param { string } uri - URI to receive this information. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3360,7 +3424,8 @@ declare namespace webview { * in the registration. * @param { Array } [asyncMethodList] - The async method of the application side JavaScript object * participating in the registration. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3385,7 +3450,8 @@ declare namespace webview { * Deletes a registered JavaScript object with given name. * * @param { string } name - The name of a registered JavaScript object to be deleted. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100008 - Cannot delete JavaScriptProxy. @@ -3400,7 +3466,8 @@ declare namespace webview { * result will be notify through callback onSearchResultReceive. * * @param { string } searchString - String to be search. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3411,7 +3478,8 @@ declare namespace webview { * result will be notify through callback onSearchResultReceive. * * @param { string } searchString - String to be search. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3453,7 +3521,8 @@ declare namespace webview { * Highlights and scrolls to the next match search. * * @param { boolean } forward - Step of search is back or forward. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3522,7 +3591,8 @@ declare namespace webview { * This parameter will be the result of JavaScript script execution. * If the JavaScript script fails to execute or has no return value, * null will be returned. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3548,7 +3618,8 @@ declare namespace webview { * * @param { string } script - JavaScript Script. * @param { AsyncCallback } callback - Callbacks execute JavaScript script results. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3595,7 +3666,8 @@ declare namespace webview { * This parameter will be the result of JavaScript script execution. * If the JavaScript script fails to execute or has no return value, * a none type value will be returned. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3632,7 +3704,8 @@ declare namespace webview { * * @param { string | ArrayBuffer } script - JavaScript Script. * @param { AsyncCallback } callback - Callbacks execute JavaScript script results. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3679,7 +3752,8 @@ declare namespace webview { * @param { boolean } top - Whether to jump to the top of the page, if set to false, * the page content will scroll up half the size of the viewframe, * and when set to true, it will jump to the top of the page. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3706,7 +3780,8 @@ declare namespace webview { * @param { boolean } bottom - Whether to jump to the top of the page, if set to false, * the page content will scroll up half the size of the viewframe, * and when set to true, it will jump to the top of the page. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3767,7 +3842,8 @@ declare namespace webview { * Put network state for web. Which is used to set window.navigator.onLine property in * JavaScript. * @param { boolean } enable - Whether enable window.navigator.onLine. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3790,7 +3866,7 @@ declare namespace webview { * Query if current document has image. * * @returns { Promise } A promise resolved after query image has finished. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3813,7 +3889,8 @@ declare namespace webview { * Query if current document has image. * * @param { AsyncCallback } callback - Called after query image has finished. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3860,7 +3937,8 @@ declare namespace webview { * * @param { boolean } clearRom - Remove cache in both rom and ram if true. Otherwise only clear cache * in ram. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3886,7 +3964,8 @@ declare namespace webview { * * @param { number } x - the x of the position. * @param { number } y - the y of the position. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3912,7 +3991,8 @@ declare namespace webview { * * @param { number } deltaX - the delta x of the position. * @param { number } deltaY - the delta y of the position. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3938,7 +4018,8 @@ declare namespace webview { * * @param { number } vx - the x speed of the speed. * @param { number } vy - the y speed of the speed. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -3978,7 +4059,8 @@ declare namespace webview { /** * Restoring the web access stack, that is, the history of access. * @param { Uint8Array } state - Web access stack after serialization. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4005,8 +4087,9 @@ declare namespace webview { /** * Register Web custom schemes. * @param { Array } schemes - Configuration of web custom scheme. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100020 - Register custom schemes failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. + * @throws { BusinessError } 17100020 - Failed to register custom schemes. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4035,7 +4118,8 @@ declare namespace webview { /** * Get certificate for the current website. * @param {AsyncCallback>} callback - the callback of getCertificate. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a web component. * @syscap SystemCapability.Web.Webview.Core @@ -4044,7 +4128,8 @@ declare namespace webview { /** * Get certificate for the current website. * @param {AsyncCallback>} callback - the callback of getCertificate. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a web component. * @syscap SystemCapability.Web.Webview.Core @@ -4065,7 +4150,8 @@ declare namespace webview { /** * Set audio muted. * @param { boolean } mute - Set the audio muted or not. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4132,7 +4218,8 @@ declare namespace webview { /** * Set custom user agent. * @param { string } userAgent - User custom agent information. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4165,7 +4252,8 @@ declare namespace webview { /** * Set web engine socket connection timeout. * @param { number } timeout - Socket connection timeout. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -4201,7 +4289,8 @@ declare namespace webview { * * @param { string } url - Request the URL use "POST" method. * @param { ArrayBuffer } postData - This data will passed to "POST" request. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @throws { BusinessError } 17100002 - Invalid url. @@ -4215,7 +4304,8 @@ declare namespace webview { * Create the Web Print Document Adapter. * @param { string } jobName - The name of the currently printed document. * @returns { print.PrintDocumentAdapter } Return the Print Document Adapter. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4251,7 +4341,8 @@ declare namespace webview { * Set whether scroll is allowed * * @param { boolean } enable - Set whether scrolling is allowed - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4275,7 +4366,8 @@ declare namespace webview { * Set whether print web page background. * * @param { boolean } enable - Set whether print web page background - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4306,7 +4398,7 @@ declare namespace webview { * @atomicservice * @since 12 */ - getLastJavascriptProxyCallingFrameUrl(): string + getLastJavascriptProxyCallingFrameUrl(): string; /** * Start current camera. @@ -4424,7 +4516,7 @@ declare namespace webview { * * @param { string } scheme - String value for url scheme. * @param { WebSchemeHandler } handler - Web scheme handler. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4447,7 +4539,7 @@ declare namespace webview { * Set web scheme handler for specific scheme. This is used for service worker. * @param { string } scheme - String value for url scheme. * @param { WebSchemeHandler } handler - Web scheme handler. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4468,7 +4560,8 @@ declare namespace webview { * @param { boolean } enable {@code true} enable Intelligent Tracking Prevention; {@code false} otherwise. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4491,7 +4584,8 @@ declare namespace webview { * Add bypassing hosts for Intelligent Tracking Prevention. * * @param { Array } hostList - Hosts that bypass the Intelligent Tracking Prevention. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4502,7 +4596,8 @@ declare namespace webview { * Remove bypassing hosts for Intelligent Tracking Prevention. * * @param { Array } hostList - Hosts needs to remove from bypass list. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4526,7 +4621,7 @@ declare namespace webview { * @atomicservice * @since 12 */ - onCreateNativeMediaPlayer(callback: CreateNativeMediaPlayerCallback): void + onCreateNativeMediaPlayer(callback: CreateNativeMediaPlayerCallback): void; /** * Set enable overall web caching @@ -4557,9 +4652,12 @@ declare namespace webview { * @param { RequestInfo } request - The information of the request. * @param { Array } [additionalHeaders] - Additional HTTP request header of the request. * @param { string } [cacheKey] - The key for memory cache. Default value is the url of the request. + * Only support number and letters. * @param { number } [cacheValidTime] - The valid time of the cache for request, ranges greater than 0. - * The unit is second. Default value is 300s. - * @throws { BusinessError } 401 - Invalid input parameter. + * The unit is second. Default value is 300s. + * The value of cacheValidTime must between 1 and 2147483647. + * @throws { BusinessError } 401 - Invalid input parameter.Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 17100002 - Invalid url. * @syscap SystemCapability.Web.Webview.Core * @atomicservice @@ -4571,6 +4669,7 @@ declare namespace webview { /** * Clear the resource that you prefetch to the memory cache using API{@link prefetchResource}. * @param { Array } cacheKeyList - The keys for memory cache. + * The key in cacheKeyList only support number and letters. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4581,7 +4680,8 @@ declare namespace webview { * Set render process mode of the ArkWeb. * * @param { RenderProcessMode } mode - The render process mode for the ArkWeb. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4612,12 +4712,14 @@ declare namespace webview { /** * Compile javascript and generate code cache. - * @param { string } url - Url of the javascript. - * @param { string | Uint8Array } script - javascript source code. - * @param { CacheOptions } cacheOptions - generate code cache option. - * @returns { Promise } - the promise returned by the function. - * 0 means generate code cache successfully, -1 means internal error. + * @param { string } url - Url of the javascript. Only support HTTP/HTTPS protocol and length no longer than 2048. + * @param { string | Uint8Array } script - Javascript source code. script must not be empty. + * @param { CacheOptions } cacheOptions - Generate code cache option. + * @returns { Promise } - The promise returned by the function. + * 0 means generate code cache successfully, -1 means internal error. * @throws { BusinessError } 401 - Invalid input parameter. + * Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4631,7 +4733,8 @@ declare namespace webview { * @param { string } hostName - Which host name to be resolved. * @param { string } address - Resolved IP address. * @param { number } aliveTime - The validity seconds for resolve cache. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4642,7 +4745,8 @@ declare namespace webview { * Clear the host name IP address. * * @param { string } hostName - Which host name to be cleared. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -4663,10 +4767,21 @@ declare namespace webview { * Inject offline resources into cache. * * @param { Array } resourceMaps - array of offline resource info maps. + * The count of array must between 1 and 30. * @syscap SystemCapability.Web.Webview.Core * @since 12 */ injectOfflineResources(resourceMaps: Array): void; + + /** + * Get the ID of the surface created by ArkWeb. This ID can be used for web page screenshots. + * + * @returns { string } The ID of the surface created by ArkWeb. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 12 + */ + getSurfaceId(): string; } /** @@ -5068,7 +5183,8 @@ declare namespace webview { * Start the web download. * Used in onBeforeDownload, If you want to start the current download, call this function. * @param { string } downloadPath - The content will be downloaded to this file. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. + *
    2. Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -5134,7 +5250,8 @@ declare namespace webview { * Deserialize web download from typed array. * @param { Uint8Array } serializedData - The serialized data. * @returns { WebDownloadItem } - Deserialize the serialized data into a WebDownloadItem. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. + *
    2. Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 @@ -5225,7 +5342,7 @@ declare namespace webview { * Initialize data stream. * * @returns { Promise } The promise of data stream is initialized. - * @throws { BusinessError } 17100022 - The http body stream init failed. + * @throws { BusinessError } 17100022 - Data stream init failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5236,7 +5353,8 @@ declare namespace webview { * * @param { number } size - Read size. * @returns { Promise } Read array buffer of result. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5291,6 +5409,174 @@ declare namespace webview { isInMemory(): boolean; } + /** + * Defines the resource type of request. + * @enum {number} + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + enum WebResourceType { + /** + * Top level page. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + MAIN_FRAME = 0, + + /** + * Frame or Iframe. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + SUB_FRAME = 1, + + /** + * CSS stylesheet. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + STYLE_SHEET = 2, + + /** + * External script. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + SCRIPT = 3, + + /** + * Image (jpg/gif/png/etc). + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + IMAGE = 4, + + /** + * Font. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + FONT_RESOURCE = 5, + + /** + * Some other subresource. This is the default type if the actual type is unknown. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + SUB_RESOURCE = 6, + + /** + * Object (or embed) tag for a plugin, or a resource that a plugin requested. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + OBJECT = 7, + + /** + * Media resource. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + MEDIA = 8, + + /** + * Main resource of a dedicated worker. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + WORKER = 9, + + /** + * Main resource of a shared worker. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + SHARED_WORKER = 10, + + /** + * Explicitly requested prefetch. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + PREFETCH = 11, + + /** + * Favicon. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + FAVICON = 12, + + /** + * XMLHttpRequest. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + XHR = 13, + + /** + * Ping request for /sendBeacon. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + PING = 14, + + /** + * The main resource of a service worker. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + SERVICE_WORKER = 15, + + /** + * Report of Content Security Policy violations. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + CSP_REPORT = 16, + + /** + * Resource that a plugin requested. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + PLUGIN_RESOURCE = 17, + + /** + * A main-frame service worker navigation preload request. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + NAVIGATION_PRELOAD_MAIN_FRAME = 19, + + /** + * A sub-frame service worker navigation preload request. + * + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + NAVIGATION_PRELOAD_SUB_FRAME = 20, + } + /** * Defines the Web resource request used for scheme handler. * @@ -5362,6 +5648,22 @@ declare namespace webview { * @since 12 */ getHttpBodyStream(): WebHttpBodyStream | null; + /** + * Get request's resource type. + * + * @returns { WebResourceType } Return the request's resource type. + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + getRequestResourceType(): WebResourceType; + /** + * Gets the URL of frame which trigger this request. + * + * @returns { string } Return the URL of frame which trigger this request. + * @syscap SystemCapability.Web.Webview.Core + * @since 12 + */ + getFrameUrl(): string; } /** @@ -5384,7 +5686,7 @@ declare namespace webview { * Set the resolved URL after redirects or changed as a result of HSTS. * * @param { string } url - Set response url for redirects. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5402,7 +5704,8 @@ declare namespace webview { /** * Set net error code. * @param { WebNetErrorList } code - Set net error code. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5421,7 +5724,7 @@ declare namespace webview { * Set http status code. * * @param { number } code - Http status code. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5440,7 +5743,7 @@ declare namespace webview { * Set status text. * * @param { string } text - Status text. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5459,7 +5762,7 @@ declare namespace webview { * Set mime type. * * @param { string } type - Mime type. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5478,7 +5781,7 @@ declare namespace webview { * Set the response encoding. * * @param { string } type - Encoding. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5499,7 +5802,8 @@ declare namespace webview { * @param { string } name - Header name. * @param { string } value - Header value. * @param { boolean } name - Whether to overwrite. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5530,8 +5834,8 @@ declare namespace webview { * Pass response headers to intercepted requests. * * @param { WebSchemeHandlerResponse } response - Set response header to intercept. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100021 - Resource handler is invalid. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * @throws { BusinessError } 17100021 - The resource handler is invalid. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5541,8 +5845,8 @@ declare namespace webview { * Pass response body data to intercepted requests. * * @param { ArrayBuffer } data - Set response body to intercept. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100021 - Resource handler is invalid. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * @throws { BusinessError } 17100021 - The resource handler is invalid. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5551,7 +5855,7 @@ declare namespace webview { /** * Notify that this request should be finished and there is no more data available. * - * @throws { BusinessError } 17100021 - Resource handler is invalid. + * @throws { BusinessError } 17100021 - Resource handler process failed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5561,8 +5865,8 @@ declare namespace webview { * Notify that this request should be failed. * * @param { WebNetErrorList } code - Set response error code to intercept. - * @throws { BusinessError } 401 - Invalid input parameter. - * @throws { BusinessError } 17100021 - Resource handler is invalid. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. + * @throws { BusinessError } 17100021 - The resource handler is invalid. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -5583,7 +5887,8 @@ declare namespace webview { * * @param { function } callback - Callback of handling the request. If callback return false, * it means no interception. - * @throws { BusinessError } 401 - Invalid input parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 12 @@ -6254,7 +6559,7 @@ declare namespace webview { * @since 12 */ type CreateNativeMediaPlayerCallback = - (handler: NativeMediaPlayerHandler, mediaInfo: MediaInfo) => NativeMediaPlayerBridge + (handler: NativeMediaPlayerHandler, mediaInfo: MediaInfo) => NativeMediaPlayerBridge; } export default webview; diff --git a/api/@ohos.wifiManager.d.ts b/api/@ohos.wifiManager.d.ts index a10d34a1bee3a6afcd4a726468c7151d9fccac94..92346d1004e46d444e239f8b93b0a114477b1ec8 100644 --- a/api/@ohos.wifiManager.d.ts +++ b/api/@ohos.wifiManager.d.ts @@ -67,6 +67,20 @@ declare namespace wifiManager { */ function disableWifi(): void; + /** + * Enable semi - Wifi. + * @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION + * @throws {BusinessError} 201 - Permission denied. + * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. + * @throws {BusinessError} 801 - Capability not supported. + * @throws {BusinessError} 2501000 - Operation failed. + * @throws {BusinessError} 2501004 - Failed for wifi is opening. + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + function enableSemiWifi(): void; + /** * Query the Wi-Fi status * @permission ohos.permission.GET_WIFI_INFO @@ -143,6 +157,19 @@ declare namespace wifiManager { */ function getScanResults(): Promise>; + /** + * Obtains information about a Wi-Fi detail state. + * @permission ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION + * @returns { WifiDetailState } Returns information about wifi state. + * @throws {BusinessError} 201 - Permission denied. + * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. + * @throws {BusinessError} 801 - Capability not supported. + * @throws {BusinessError} 2501000 - Operation failed. + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + function getWifiDetailState(): WifiDetailState; /** * Obtain the scanned sta list. @@ -204,7 +231,7 @@ declare namespace wifiManager { * @param { boolean } isScanAlwaysAllowed - true for allow trigger scan, otherwise don't allow trigger scan when Wi-Fi is disabled. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -234,7 +261,8 @@ declare namespace wifiManager { * @returns { Promise } Returns {@code networkId} if the configuration is added; returns {@code -1} otherwise. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -250,7 +278,8 @@ declare namespace wifiManager { * @param { AsyncCallback } callback - Indicates call back of addDeviceConfig. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -267,7 +296,8 @@ declare namespace wifiManager { * @param { WifiDeviceConfig } config - candidate config. * @returns { Promise } Returns {@code networkId} if the configuration is added; returns {@code -1} otherwise. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -282,7 +312,8 @@ declare namespace wifiManager { * @param { WifiDeviceConfig } config - candidate config. * @returns { Promise } Returns {@code networkId} if the configuration is added; returns {@code -1} otherwise. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -299,7 +330,8 @@ declare namespace wifiManager { * @param { WifiDeviceConfig } config - candidate config. * @param { AsyncCallback } callback - Indicates call back of addCandidateConfig. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -314,7 +346,8 @@ declare namespace wifiManager { * @param { number } networkId - Network ID which will be removed. * @returns { Promise } Return results. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -328,7 +361,8 @@ declare namespace wifiManager { * @param { number } networkId - Network ID which will be removed. * @returns { Promise } Return results. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -344,7 +378,8 @@ declare namespace wifiManager { * @param { number } networkId - Network ID which will be removed. * @param { AsyncCallback } callback - Indicates call back of removeCandidateConfig. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -393,9 +428,10 @@ declare namespace wifiManager { * Connect to a specified candidate hotspot by networkId, only the configuration which is added by ourself * is allowed to be connected. This method connect to a configuration at a time. * @permission ohos.permission.SET_WIFI_INFO - * @param { number } networkId - Network ID which will be connected. + * @param { number } networkId - Network ID which will be connected. The value of networkId cannot be less than 0. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @throws {BusinessError} 2501001 - Wifi is closed. @@ -407,9 +443,10 @@ declare namespace wifiManager { * Connect to a specified candidate hotspot by networkId, only the configuration which is added by ourself * is allowed to be connected. This method connect to a configuration at a time. * @permission ohos.permission.SET_WIFI_INFO - * @param { number } networkId - Network ID which will be connected. + * @param { number } networkId - Network ID which will be connected. The value of networkId cannot be less than 0. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @throws {BusinessError} 2501001 - Wifi is closed. @@ -422,10 +459,11 @@ declare namespace wifiManager { /** * Connect to Wi-Fi hotspot by networkId. * @permission ohos.permission.MANAGE_WIFI_CONNECTION - * @param { number } networkId - ID of the connected network. + * @param { number } networkId - ID of the connected network. The value of networkId cannot be less than 0. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @throws {BusinessError} 2501001 - Wifi is closed. @@ -442,7 +480,8 @@ declare namespace wifiManager { * @param { WifiDeviceConfig } config - Indicates the device configuration for connection to the Wi-Fi hotspot. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @throws {BusinessError} 2501001 - Wifi is closed. @@ -472,7 +511,8 @@ declare namespace wifiManager { * @param { number } band - Indicates the Wi-Fi frequency band. * @returns { number } Returns Wi-Fi signal level ranging from 0 to 4. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -584,7 +624,8 @@ declare namespace wifiManager { * @param { number } featureId Indicates the ID of the feature. * @returns { boolean } Returns {@code true} if this device supports the specified feature, returns {@code false} otherwise. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2401000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.Core @@ -708,7 +749,8 @@ declare namespace wifiManager { * returns {@code -1} if the specified Wi-Fi configuration is not contained in the list. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -721,10 +763,11 @@ declare namespace wifiManager { * Disable the specified DeviceConfig by networkId. * The disabled DeviceConfig will not be associated with again. * @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION - * @param { number } netId Identifies the network to disable. + * @param { number } netId Identifies the network to disable. The value of networkId cannot be less than 0. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -752,10 +795,11 @@ declare namespace wifiManager { * If the Wi-Fi DeviceConfig is being connected, the connection will be interrupted. * The application can only delete Wi-Fi DeviceConfig it has created. * @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION - * @param { number } id - Indicate the ID of the Wi-Fi DeviceConfig. + * @param { number } id - Indicate the ID of the Wi-Fi DeviceConfig. The value of networkId cannot be less than 0. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -922,7 +966,8 @@ declare namespace wifiManager { * If {@code securityType} is not {@code open}, {@code preSharedKey} must be available and correct. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Incorrect parameter types. + * 2.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -979,7 +1024,8 @@ declare namespace wifiManager { * @param { StationInfo } stationInfo - station which will be added in the block list. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1.Incorrect parameter types. + * 2.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -994,7 +1040,8 @@ declare namespace wifiManager { * @param { StationInfo } stationInfo - station which will be deleted in the block list. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1.Incorrect parameter types. + * 2.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1009,7 +1056,7 @@ declare namespace wifiManager { * @returns { Array } stations in the block list. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1187,7 +1234,8 @@ declare namespace wifiManager { * @permission ohos.permission.GET_WIFI_INFO * @param { WifiP2PConfig } config - Indicates the configuration for a group. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1.Incorrect parameter types. + * 2.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1222,7 +1270,8 @@ declare namespace wifiManager { * @permission ohos.permission.GET_WIFI_INFO * @param { WifiP2PConfig } config - Indicates the configuration for connecting to a specific group. * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1.Incorrect parameter types. + * 2.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1278,7 +1327,7 @@ declare namespace wifiManager { * @param { number } netId - Indicates the network ID of the group to be deleted. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1.Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1345,7 +1394,8 @@ declare namespace wifiManager { * @param { string } devName - Indicate the name to be set. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3.Parameter verification failed. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1360,7 +1410,8 @@ declare namespace wifiManager { * @param { 'wifiStateChange' } type - event name. * @param { Callback } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1373,7 +1424,8 @@ declare namespace wifiManager { * @param { 'wifiStateChange' } type - event name. * @param { Callback } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1391,7 +1443,8 @@ declare namespace wifiManager { * @param { 'wifiStateChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1406,7 +1459,8 @@ declare namespace wifiManager { * @param { 'wifiStateChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1422,7 +1476,8 @@ declare namespace wifiManager { * @param { 'wifiConnectionChange' } type - event name. * @param { Callback } callback - the callback of on, 0: disconnected, 1: connected * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1435,7 +1490,8 @@ declare namespace wifiManager { * @param { 'wifiConnectionChange' } type - event name. * @param { Callback } callback - the callback of on, 0: disconnected, 1: connected * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1452,7 +1508,8 @@ declare namespace wifiManager { * @param { 'wifiConnectionChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1466,7 +1523,8 @@ declare namespace wifiManager { * @param { 'wifiConnectionChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1482,7 +1540,8 @@ declare namespace wifiManager { * @param { 'wifiScanStateChange' } type - event name. * @param { Callback } callback - the callback of on, 0: scan fail, 1: scan success * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1495,7 +1554,8 @@ declare namespace wifiManager { * @param { 'wifiScanStateChange' } type - event name. * @param { Callback } callback - the callback of on, 0: scan fail, 1: scan success * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1511,7 +1571,8 @@ declare namespace wifiManager { * @param { 'wifiScanStateChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1525,7 +1586,8 @@ declare namespace wifiManager { * @param { 'wifiScanStateChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1540,7 +1602,8 @@ declare namespace wifiManager { * @param { 'wifiRssiChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1555,7 +1618,8 @@ declare namespace wifiManager { * @param { 'wifiRssiChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1570,7 +1634,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of on, 1: stream down, 2: stream up, 3: stream bidirectional * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1587,7 +1652,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1603,7 +1669,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of on, 0: config is added, 1: config is changed, 2: config is removed. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1619,7 +1686,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of off, 0: config is added, 1: config is changed, 2: config is removed. * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2501000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.STA @@ -1635,7 +1703,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1651,7 +1720,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1666,7 +1736,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1683,7 +1754,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1699,7 +1771,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1716,7 +1789,8 @@ declare namespace wifiManager { * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. * @throws {BusinessError} 202 - System API is not allowed called by Non-system application. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2601000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.AP.Core @@ -1731,7 +1805,8 @@ declare namespace wifiManager { * @param { 'p2pStateChange' } type - event name. * @param { Callback } callback - the callback of on, 1: idle, 2: starting, 3:started, 4: closing, 5: closed * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1745,7 +1820,8 @@ declare namespace wifiManager { * @param { 'p2pStateChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1759,7 +1835,8 @@ declare namespace wifiManager { * @param { 'p2pConnectionChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1773,7 +1850,8 @@ declare namespace wifiManager { * @param { 'p2pConnectionChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1787,7 +1865,8 @@ declare namespace wifiManager { * @param { 'p2pDeviceChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1799,7 +1878,8 @@ declare namespace wifiManager { * @param { 'p2pDeviceChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1813,7 +1893,8 @@ declare namespace wifiManager { * @param { 'p2pDeviceChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1824,7 +1905,8 @@ declare namespace wifiManager { * @param { 'p2pDeviceChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1838,7 +1920,8 @@ declare namespace wifiManager { * @param { 'p2pPeerDeviceChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1850,7 +1933,8 @@ declare namespace wifiManager { * @param { 'p2pPeerDeviceChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1864,7 +1948,8 @@ declare namespace wifiManager { * @param { 'p2pPeerDeviceChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1875,7 +1960,8 @@ declare namespace wifiManager { * @param { 'p2pPeerDeviceChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1889,7 +1975,8 @@ declare namespace wifiManager { * @param { 'p2pPersistentGroupChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1903,7 +1990,8 @@ declare namespace wifiManager { * @param { 'p2pPersistentGroupChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1917,7 +2005,8 @@ declare namespace wifiManager { * @param { 'p2pDiscoveryChange' } type - event name. * @param { Callback } callback - the callback of on * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -1931,7 +2020,8 @@ declare namespace wifiManager { * @param { 'p2pDiscoveryChange' } type - event name. * @param { Callback } callback - the callback of off * @throws {BusinessError} 201 - Permission denied. - * @throws {BusinessError} 401 - Invalid parameters. + * @throws {BusinessError} 401 - Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. * @throws {BusinessError} 801 - Capability not supported. * @throws {BusinessError} 2801000 - Operation failed. * @syscap SystemCapability.Communication.WiFi.P2P @@ -2114,6 +2204,71 @@ declare namespace wifiManager { DISC_REASON_CONNECTION_FULL = 2 } + /** + * Wi-Fi detail state. + * @enum { number } WifiDetailState + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + enum WifiDetailState { + /** + * state is unknown + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + UNKNOWN = -1, + + /** + * wifi is closed + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + INACTIVE = 0, + + /** + * wifi is opened + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + ACTIVATED = 1, + + /** + * wifi is opening + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + ACTIVATING = 2, + + /** + * wifi is closing + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + DEACTIVATING = 3, + + /** + * wifi sta is entering semi active + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + SEMI_ACTIVATING = 4, + + /** + * wifi sta is semi active + * @syscap SystemCapability.Communication.WiFi.STA + * @systemapi Hide this for inner system use. + * @since 12 + */ + SEMI_ACTIVE = 5, + } + /** * Wi-Fi Proxy method. * @enum { number } diff --git a/api/@ohos.window.d.ts b/api/@ohos.window.d.ts index b0eeb290fef9ba5f87f8d3e323465bdbaf366569..5f1ea135133a976ee589c299159998d3152b862c 100644 --- a/api/@ohos.window.d.ts +++ b/api/@ohos.window.d.ts @@ -1597,6 +1597,24 @@ declare namespace window { * @since 9 */ parentId?: number; + + /** + * Indicates whether enable window decor, only support dialog, The default value is false. + * + * @type { ?boolean } + * @syscap SystemCapability.Window.SessionManager + * @since 12 + */ + decorEnabled?: boolean; + + /** + * Indicates dialog window title when decor enabled. + * + * @type { ?string } + * @syscap SystemCapability.Window.SessionManager + * @since 12 + */ + title?: string; } /** @@ -1606,6 +1624,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Limits of window. + * + * @interface WindowLimits + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ interface WindowLimits { /** @@ -1615,6 +1641,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The maximum width of the window. + * + * @type { ?number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ maxWidth?: number; /** @@ -1624,6 +1658,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The maximum height of the window. + * + * @type { ?number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ maxHeight?: number; /** @@ -1633,6 +1675,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The minimum width of the window. + * + * @type { ?number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ minWidth?: number; /** @@ -1642,6 +1692,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The minimum height of the window. + * + * @type { ?number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ minHeight?: number; } @@ -1652,6 +1710,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Rectangular area of the title buttons relative to the upper right corner of the window. + * + * @interface TitleButtonRect + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ interface TitleButtonRect { /** @@ -1661,6 +1727,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The right of the Rect. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ right: number; /** @@ -1670,6 +1744,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The top of the Rect. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ top: number; /** @@ -1679,6 +1761,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The width of the Rect. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ width: number; /** @@ -1688,6 +1778,14 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * The height of the Rect. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ height: number; } @@ -2049,6 +2147,20 @@ declare namespace window { * @crossplatform * @since 10 */ + /** + * Get the final show window. + * + * @param { BaseContext } ctx - Current application context. + * @param { AsyncCallback } callback - Callback used to return the top window obtained. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300006 - This window context is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ function getLastWindow(ctx: BaseContext, callback: AsyncCallback): void; /** @@ -2076,6 +2188,20 @@ declare namespace window { * @crossplatform * @since 10 */ + /** + * Get the final show window. + * + * @param { BaseContext } ctx - Current application context. + * @returns { Promise } Promise used to return the top window obtained. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300006 - This window context is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ function getLastWindow(ctx: BaseContext): Promise; /** @@ -2239,21 +2365,6 @@ declare namespace window { */ function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise; - /** - * gets snapshot of window - * - * @param { number } windowId - Indicates target window id. - * @returns { Promise } - Promise that returns no value. - * @throws {BusinessError} 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws {BusinessError} 1300002 - This window state is abnormal. - * @throws {BusinessError} 1300003 - This window manager service work abnormally. - * @throws {BusinessError} 1300004 - This operation is not access. - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @since 12 - */ - function getSnapshot(windowId: number): Promise; - /** * Register the callback of systemBarTintChange * @@ -3553,6 +3664,20 @@ declare namespace window { * @crossplatform * @since 10 */ + /** + * Set the system bar to have visible. + * + * @param { Array<'status' | 'navigation'> } names - The set of system bar + * @param { AsyncCallback } callback - Callback used to return the result. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ setWindowSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback): void; /** @@ -3580,6 +3705,20 @@ declare namespace window { * @crossplatform * @since 10 */ + /** + * Set the system bar to have visible. + * + * @param { Array<'status' | 'navigation'> } names - The set of system bar + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise; /** @@ -4158,6 +4297,19 @@ declare namespace window { * @atomicservice * @since 11 */ + /** + * Register the callback of windowSizeChange + * + * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. + * @param { Callback } callback - Callback used to return the window size. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ on(type: 'windowSizeChange', callback: Callback): void; /** @@ -4181,6 +4333,18 @@ declare namespace window { * @atomicservice * @since 11 */ + /** + * Unregister the callback of windowSizeChange + * + * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. + * @param { Callback } callback - Callback used to return the window size. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ off(type: 'windowSizeChange', callback?: Callback): void; /** @@ -4617,6 +4781,16 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Whether the window supports thr wide gamut setting. + * + * @returns { Promise } Promise used to return the result. + * The value true means that the wide-gamut color space is supported, and false means the opposite. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ isWindowSupportWideGamut(): Promise; /** @@ -4627,6 +4801,15 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Whether the window supports thr wide gamut setting. + * + * @param { AsyncCallback } callback Callback used to return the result. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ isWindowSupportWideGamut(callback: AsyncCallback): void; /** @@ -4678,6 +4861,20 @@ declare namespace window { * @crossplatform * @since 11 */ + /** + * Sets the specified color space. + * + * @param { ColorSpace } colorSpace the specified color space. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ setWindowColorSpace(colorSpace: ColorSpace): Promise; /** @@ -4705,6 +4902,20 @@ declare namespace window { * @crossplatform * @since 11 */ + /** + * Sets the specified color space. + * + * @param { ColorSpace } colorSpace the specified color space. + * @param { AsyncCallback } callback Callback used to return the result. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ setWindowColorSpace(colorSpace: ColorSpace, callback: AsyncCallback): void; /** @@ -4746,6 +4957,16 @@ declare namespace window { * @crossplatform * @since 11 */ + /** + * Obtains the set color space. + * + * @returns { ColorSpace } Color space obtained. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @crossplatform + * @atomicservice + * @since 12 + */ getWindowColorSpace(): ColorSpace; /** @@ -4989,6 +5210,19 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Sets whether focusable or not. + * + * @param { boolean } isFocusable can be focus if true, or can not be focus if false. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setWindowFocusable(isFocusable: boolean): Promise; /** @@ -5003,6 +5237,19 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Sets whether focusable or not. + * + * @param { boolean } isFocusable can be focus if true, or can not be focus if false. + * @param { AsyncCallback } callback Callback used to return the result. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setWindowFocusable(isFocusable: boolean, callback: AsyncCallback): void; /** @@ -5278,6 +5525,19 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Sets whether is touchable or not. + * + * @param { boolean } isTouchable is touchable if true, or not if false. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setWindowTouchable(isTouchable: boolean): Promise; /** @@ -5292,6 +5552,19 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Sets whether is touchable or not. + * + * @param { boolean } isTouchable is touchable if true, or not if false. + * @param { AsyncCallback } callback Callback used to return the result. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setWindowTouchable(isTouchable: boolean, callback: AsyncCallback): void; /** @@ -5349,6 +5622,15 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Obtains snapshot of window + * + * @param { AsyncCallback } callback Callback used to return the result. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ snapshot(callback: AsyncCallback): void; /** @@ -5359,6 +5641,15 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ + /** + * Obtains snapshot of window + * + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ snapshot(): Promise; /** @@ -5554,6 +5845,20 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ + /** + * Sets the aspect ratio of window + * + * @param { number } ratio - The aspect ratio of window except decoration + * @param { AsyncCallback } callback - The callback of setAspectRatio. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setAspectRatio(ratio: number, callback: AsyncCallback): void; /** @@ -5569,6 +5874,20 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ + /** + * Sets the aspect ratio of window + * + * @param { number } ratio - The aspect ratio of window except decoration + * @returns { Promise } - The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ setAspectRatio(ratio: number): Promise; /** @@ -5580,6 +5899,16 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ + /** + * Resets the aspect ratio of window + * + * @param { AsyncCallback } callback - The callback of setAspectRatio. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ resetAspectRatio(callback: AsyncCallback): void; /** @@ -5591,6 +5920,16 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ + /** + * Resets the aspect ratio of window + * + * @returns { Promise } - The promise returned by the function. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 12 + */ resetAspectRatio(): Promise; /** @@ -5705,6 +6044,17 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Minimize app main window and hide app subWindow. + * + * @param { AsyncCallback } callback - The callback of Minimize. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ minimize(callback: AsyncCallback): void; /** @@ -5717,6 +6067,17 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Minimize app main window and hide app subWindow. + * + * @returns { Promise } - The promise returned by the function. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ minimize(): Promise; /** @@ -5729,6 +6090,7 @@ declare namespace window { * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ maximize(): Promise; @@ -5828,6 +6190,16 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Get the window limits of current window. + * + * @returns { WindowLimits } - The limits of window. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ getWindowLimits(): WindowLimits; /** @@ -5845,6 +6217,22 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Set the window limits of a window. + * + * @param { WindowLimits } windowLimits - window limits of the window. + * @returns { Promise } - Promise is used to return the limits of window. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ setWindowLimits(windowLimits: WindowLimits): Promise; /** @@ -5875,6 +6263,19 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * When get focused, keep the keyboard created by other windows, support system window and app subwindow. + * + * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ keepKeyboardOnFocus(keepKeyboardFlag: boolean): void; /** @@ -5887,6 +6288,17 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Recover app main window. + * + * @returns { Promise } - The promise returned by the function. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300001 - Repeated operation. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ recover(): Promise; /** @@ -5901,6 +6313,19 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Set the visibility of the window decor. + * + * @param { boolean } - Enable the decor visible if true, otherwise means the opposite. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ setWindowDecorVisible(isVisible: boolean): void; /** @@ -5914,6 +6339,7 @@ declare namespace window { * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ setSubWindowModal(isModal: boolean): Promise; @@ -5930,6 +6356,19 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Set the height of the window decor. + * + * @param { number } - The height of window decor. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ setWindowDecorHeight(height: number): void; /** @@ -5941,6 +6380,16 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Get the height of the window decor. + * + * @returns { number } - The height of window decor. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ getWindowDecorHeight(): number; /** @@ -5970,6 +6419,16 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Get the area of window title buttons. + * + * @returns { TitleButtonRect } - The area of window title buttons. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ getTitleButtonRect(): TitleButtonRect; /** @@ -5998,6 +6457,7 @@ declare namespace window { * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ enableLandscapeMultiWindow(): Promise; @@ -6010,6 +6470,7 @@ declare namespace window { * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ disableLandscapeMultiWindow(): Promise; @@ -6027,6 +6488,20 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Register the callback of title buttons area change. + * + * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. + * @param { Callback } callback - Callback used to return the current title buttons area. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ on(type: 'windowTitleButtonRectChange', callback: Callback): void; /** @@ -6041,6 +6516,19 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @since 11 */ + /** + * Unregister the callback of title buttons area change. + * + * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. + * @param { Callback } callback - Callback used to return the current title buttons area. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 12 + */ off(type: 'windowTitleButtonRectChange', callback?: Callback): void; /** @@ -6054,6 +6542,7 @@ declare namespace window { * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager + * @atomicservice * @since 12 */ setWindowMask(windowMask: Array>): Promise; @@ -6103,37 +6592,10 @@ declare namespace window { * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager - * @since 12 - */ - setWindowGrayScale(grayScale: number): Promise; - - /** - * Set whether to enable immersive mode. - * - * @param { boolean } enabled - The value true means to enable immersive mode, and false means the opposite. - * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @throws { BusinessError } 1300003 - This window manager service works abnormally. - * @throws { BusinessError } 1300004 - Unauthorized operation. - * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ - setImmersiveModeEnabledState(enabled: boolean): void; - - /** - * Get whether the immersive mode is enabled or not. - * - * @returns { boolean } - The value true means the immersive mode is enabled, and false means the opposite. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @throws { BusinessError } 1300003 - This window manager service works abnormally. - * @throws { BusinessError } 1300004 - Unauthorized operation. - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @atomicservice - * @since 12 - */ - getImmersiveModeEnabledState(): boolean; + setWindowGrayScale(grayScale: number): Promise; } /** diff --git a/api/@ohos.worker.d.ts b/api/@ohos.worker.d.ts index c608673fa31ba37130fa47c0d798386b0494f736..81d72e143bc33eabbd1a9eb3fafeffee383e1758 100644 --- a/api/@ohos.worker.d.ts +++ b/api/@ohos.worker.d.ts @@ -137,6 +137,14 @@ export interface Event { * @crossplatform * @since 10 */ + /** + * Type of the Event. + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ readonly type: string; /** @@ -152,6 +160,14 @@ export interface Event { * @crossplatform * @since 10 */ + /** + * Timestamp(accurate to millisecond) when the event is created. + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ readonly timeStamp: number; } @@ -294,13 +310,13 @@ export interface ErrorEvent extends Event { } /** - * @typedef MessageEvent + * @typedef MessageEvent * Holds the data transferred between worker threads. * @syscap SystemCapability.Utils.Lang * @since 7 */ /** - * @typedef MessageEvent + * @typedef MessageEvent * Holds the data transferred between worker threads. * @syscap SystemCapability.Utils.Lang * @crossplatform @@ -499,6 +515,14 @@ export interface WorkerEventListener { * @crossplatform * @since 10 */ +/** + * Type of message, only "message" and "messageerror". + * + * @typedef { 'message' | 'messageerror' } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @since 12 + */ type MessageType = 'message' | 'messageerror'; /** @@ -622,6 +646,22 @@ export interface WorkerEventTarget { * @crossplatform * @since 11 */ + /** + * Adds an event listener to the 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 - 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 + * @crossplatform + * @atomicservice + * @since 12 + */ addEventListener(type: string, listener: WorkerEventListener): void; /** * Handle the event defined for the worker. @@ -650,6 +690,21 @@ export interface WorkerEventTarget { * @crossplatform * @since 10 */ + /** + * Handle the event defined for the worker. + * + * @param { Event } event - event Event to dispatch. + * @returns { boolean } + * @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 + * @atomicservice + * @since 12 + */ dispatchEvent(event: Event): boolean; /** * Remove an event defined for the worker. @@ -678,6 +733,21 @@ export interface WorkerEventTarget { * @crossplatform * @since 10 */ + /** + * Remove an event defined for the 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 - 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 + * @atomicservice + * @since 12 + */ removeEventListener(type: string, callback?: WorkerEventListener): void; /** * Remove all event listeners for the worker. @@ -694,6 +764,15 @@ export interface WorkerEventTarget { * @crossplatform * @since 10 */ + /** + * Remove all event listeners for the worker. + * + * @throws { BusinessError } 10200004 - Worker instance is not running. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ removeAllListener(): void; } diff --git a/api/@ohos.zlib.d.ts b/api/@ohos.zlib.d.ts index ae69d7c98f7f8c80c0fff3eead12e3640d0f9cf2..942ac37c2f88f5b7c82028dc90608be0db8cdbde 100644 --- a/api/@ohos.zlib.d.ts +++ b/api/@ohos.zlib.d.ts @@ -1134,7 +1134,7 @@ declare namespace zlib { * @since 11 */ function decompressFile(inFile: string, outFile: string, options?: Options): Promise; - + /** * Get the original size of the compressed zip file, the size is the meta data stored in zip file. * @@ -1159,7 +1159,7 @@ declare namespace zlib { * @since 12 */ function createChecksum(): Promise; - + /** * Synchronize creation of verification objects. * @@ -1169,7 +1169,7 @@ declare namespace zlib { * @since 12 */ function createChecksumSync(): Checksum; - + /** * Asynchronous creation of zip objects. * @@ -1225,14 +1225,14 @@ declare namespace zlib { * @param { number } adler - Initial value of Adler32 checksum. * @param { ArrayBuffer } buf - Calculate checksum data buffer. * @returns { Promise } Return the updated checksum. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 */ adler32(adler: number, buf: ArrayBuffer): Promise; - + /** * Combine two Adler-32 checksum into one. * @@ -1240,28 +1240,28 @@ declare namespace zlib { * @param { number } adler2 - The second Adler32 checksum. * @param { number } len2 - The length of the data block associated with the second Adler32 checksum. * @returns { Promise } Returns the Adler-32 checksum. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 */ adler32Combine(adler1: number, adler2: number, len2: number): Promise; - + /** * Update a running CRC-32 with the bytes buf. * * @param { number } crc - Initial value of CRC-32 checksum. * @param { ArrayBuffer } buf - Calculate checksum data buffer. * @returns { Promise } Return the updated CRC-32. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 */ crc32(crc: number, buf: ArrayBuffer): Promise; - + /** * Combine two CRC-32 check values into one. * @@ -1269,28 +1269,28 @@ declare namespace zlib { * @param { number } crc2 - The second CRC-32 checksum. * @param { number } len2 - The length of the data block associated with the second CRC-32 checksum. * @returns { Promise } Returns the CRC-32 check value. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 */ crc32Combine(crc1: number, crc2: number, len2: number): Promise; - + /** * Update a running CRC-64 with the bytes buf. * * @param { number } crc - Initial value of CRC-64 checksum. * @param { ArrayBuffer } buf - Calculate checksum data buffer. * @returns { Promise } Return the updated CRC-64. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 */ crc64(crc: number, buf: ArrayBuffer): Promise; - + /** * Get CRC-32 table. * @@ -1300,7 +1300,7 @@ declare namespace zlib { * @since 12 */ getCrcTable(): Promise>; - + /** * Get CRC-64 table. * @@ -1405,6 +1405,7 @@ declare namespace zlib { * @returns { Promise } Return ReturnStatus and total sizeof the destination buffer. * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17800004 - ZStream error. * @throws { BusinessError } 17800007 - Buffer error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice @@ -1452,6 +1453,7 @@ declare namespace zlib { * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17800005 - Data error. + * @throws { BusinessError } 17800007 - Buffer error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -1473,22 +1475,6 @@ declare namespace zlib { */ inflateValidate(strm: ZStream, check: number): Promise; - /** - * Used to modify the sane flag in the structure. - * - * @param { ZStream } strm - Object to structure z_stream. - * @param { number } subvert - Whether to subvert the internal sane logo. - * @returns { Promise } Return ReturnStatus the specific meaning is defined as enum. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17800004 - ZStream error. - * @throws { BusinessError } 17800005 - Data error. - * @syscap SystemCapability.BundleManager.Zlib - * @atomicservice - * @since 12 - */ - inflateUndermine(strm: ZStream, subvert: number): Promise; - /** * Find a synchronization point for the current decompressed stream. * @@ -1512,6 +1498,7 @@ declare namespace zlib { * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17800004 - ZStream error. * @throws { BusinessError } 17800005 - Data error. + * @throws { BusinessError } 17800007 - Buffer error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -1527,6 +1514,7 @@ declare namespace zlib { * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17800004 - ZStream error. + * @throws { BusinessError } 17800005 - Data error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -1725,11 +1713,12 @@ declare namespace zlib { * Initialize the internal stream state for decompression using inflateBack() calls. * * @param { ZStream } strm - Object to structure z_stream. - * @param { number } windowBits - Parameter is interpreted the same as it is for inflateInit2. + * @param { number } windowBits - Parameter is interpreted the same as it is for inflateInit2. The value range is between 8~15. * @param { ArrayBuffer } window - The preset sliding window buffer. * @returns { Promise } Return ReturnStatus the specific meaning is defined as enum. * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17800004 - ZStream error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -1827,6 +1816,7 @@ declare namespace zlib { * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17800004 - ZStream error. + * @throws { BusinessError } 17800007 - Buffer error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2000,7 +1990,7 @@ declare namespace zlib { * Inserts bits in the deflate output stream. * * @param { ZStream } strm - Object to structure z_stream. - * @param { number } bits - The number of bits to be inserted. + * @param { number } bits - The number of bits to be inserted. The value range is between 0~16. * @param { number } value - The bit value corresponding to the number of bits. * @returns { Promise } Return ReturnStatus the specific meaning is defined as enum. * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2031,7 +2021,7 @@ declare namespace zlib { * @returns { Promise } * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17800002 - No such file or directory. + * @throws { BusinessError } 17800002 - No such file or access mode error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2045,6 +2035,7 @@ declare namespace zlib { * @returns { Promise } Returns 0 on success. * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17800009 - Internal structure error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2054,12 +2045,13 @@ declare namespace zlib { /** * Open the gzip (.gz) file at path for reading and decompressing, or compressing and writing. * + * @param { string } path - The file path to be opened. * @param { string } mode - Specify the file opening method. * @returns { Promise } * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17800002 - No such file or directory. + * @throws { BusinessError } 17800002 - No such file or access mode error. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2091,6 +2083,7 @@ declare namespace zlib { * * @returns { Promise } Return ReturnStatus the specific meaning is defined as enum. * @throws { BusinessError } 17800004 - ZStream error. + * @throws { BusinessError } 17800006 - Memory allocation failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2180,6 +2173,7 @@ declare namespace zlib { * * @returns { Promise } Return ReturnStatus the specific meaning is defined as enum. * @throws { BusinessError } 17800004 - ZStream error. + * @throws { BusinessError } 17800006 - Memory allocation failed. * @syscap SystemCapability.BundleManager.Zlib * @atomicservice * @since 12 @@ -2336,21 +2330,6 @@ declare namespace zlib { */ gzprintf(format: string, ...args: Array): Promise; - /** - * Open gzip compressed file with wide character path name and mode. - * - * @param { string } widePath - A wide character path name. - * @param { string } mode - Specify the file opening method. - * @returns { Promise } - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17800010 - System architecture error, compiling with _WIN32. - * @syscap SystemCapability.BundleManager.Zlib - * @atomicservice - * @since 12 - */ - gzopenw(widePath: string, mode: string): Promise; - /** * Return the current compressed (actual) read or write offset of file. * diff --git a/api/application/AbilityDelegator.d.ts b/api/application/AbilityDelegator.d.ts index 98aa3130bca732e33c046eaa7eab6b3490278e9f..b2992cad1b55f922f11e5e6edf7b2890478f6bb6 100644 --- a/api/application/AbilityDelegator.d.ts +++ b/api/application/AbilityDelegator.d.ts @@ -57,7 +57,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @param { AsyncCallback } callback - The callback of addAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -67,7 +67,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @param { AsyncCallback } callback - The callback of addAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -78,7 +78,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @param { AsyncCallback } callback - The callback of addAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -92,7 +92,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -102,7 +102,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -113,7 +113,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -126,7 +126,7 @@ export interface AbilityDelegator { * Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process. * * @param { AbilityMonitor } monitor - AbilityMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -136,7 +136,7 @@ export interface AbilityDelegator { * Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process. * * @param { AbilityMonitor } monitor - AbilityMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -150,7 +150,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of addAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -160,7 +160,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of addAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -171,7 +171,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of addAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -185,7 +185,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -195,7 +195,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -206,7 +206,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -219,7 +219,7 @@ export interface AbilityDelegator { * Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process. * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -229,7 +229,7 @@ export interface AbilityDelegator { * Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process. * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - AddAbilityStageMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -243,7 +243,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -253,7 +253,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -264,7 +264,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -278,7 +278,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -288,7 +288,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -299,7 +299,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -312,7 +312,7 @@ export interface AbilityDelegator { * Remove a specified AbilityMonitor object from the application memory. * * @param { AbilityMonitor } monitor - AbilityMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -322,7 +322,7 @@ export interface AbilityDelegator { * Remove a specified AbilityMonitor object from the application memory. * * @param { AbilityMonitor } monitor - AbilityMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -336,7 +336,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -346,7 +346,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -357,7 +357,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback of removeAbilityStageMonitor. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -371,7 +371,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -381,7 +381,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -392,7 +392,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -405,7 +405,7 @@ export interface AbilityDelegator { * Remove a specified AbilityStageMonitor object from the application memory. * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -415,7 +415,7 @@ export interface AbilityDelegator { * Remove a specified AbilityStageMonitor object from the application memory. * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - RemoveAbilityStageMonitorSync failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -429,7 +429,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -439,7 +439,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -450,7 +450,7 @@ export interface AbilityDelegator { * * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -465,7 +465,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -476,7 +476,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -488,7 +488,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -503,7 +503,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -514,7 +514,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -526,7 +526,7 @@ export interface AbilityDelegator { * @param { AbilityMonitor } monitor - AbilityMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -540,7 +540,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -550,7 +550,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -561,7 +561,7 @@ export interface AbilityDelegator { * * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -576,7 +576,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -587,7 +587,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -599,7 +599,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } timeout - Maximum wait time, in milliseconds. * @param { AsyncCallback } callback - The callback is used to return the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -614,7 +614,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -625,7 +625,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -637,7 +637,7 @@ export interface AbilityDelegator { * @param { AbilityStageMonitor } monitor - AbilityStageMonitor object. * @param { number } [timeout] - Maximum wait time, in milliseconds. * @returns { Promise } Returns the AbilityStage object. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -677,7 +677,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The Ability object. * @returns { number } Returns the state of the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ @@ -686,7 +686,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The Ability object. * @returns { number } Returns the state of the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @since 10 @@ -696,7 +696,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The Ability object. * @returns { number } Returns the state of the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice @@ -708,7 +708,7 @@ export interface AbilityDelegator { * Obtain the ability that is currently being displayed in this process. * * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - GetCurrentTopAbility failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -717,7 +717,7 @@ export interface AbilityDelegator { * Obtain the ability that is currently being displayed in this process. * * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - GetCurrentTopAbility failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -727,7 +727,7 @@ export interface AbilityDelegator { * Obtain the ability that is currently being displayed in this process. * * @param { AsyncCallback } callback - The callback is used to return the Ability object. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - GetCurrentTopAbility failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -770,7 +770,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -792,7 +792,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -817,7 +817,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -845,7 +845,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -867,7 +867,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -892,7 +892,7 @@ export interface AbilityDelegator { * * @param { Want } want - Indicates the ability to start * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -920,7 +920,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityForeground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -930,7 +930,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityForeground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -941,7 +941,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityForeground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -955,7 +955,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -965,7 +965,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -976,7 +976,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityForeground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -990,7 +990,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityBackground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -1000,7 +1000,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityBackground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1011,7 +1011,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @param { AsyncCallback } callback - The callback of doAbilityBackground. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1025,7 +1025,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -1035,7 +1035,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1046,7 +1046,7 @@ export interface AbilityDelegator { * * @param { UIAbility } ability - The ability object. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - DoAbilityBackground failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1124,7 +1124,7 @@ export interface AbilityDelegator { * The total length of the log information to be printed cannot exceed 1000 characters. * * @param { string } msg - Log information. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ @@ -1133,7 +1133,7 @@ export interface AbilityDelegator { * The total length of the log information to be printed cannot exceed 1000 characters. * * @param { string } msg - Log information. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @since 10 @@ -1143,7 +1143,7 @@ export interface AbilityDelegator { * The total length of the log information to be printed cannot exceed 1000 characters. * * @param { string } msg - Log information. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice @@ -1219,7 +1219,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @param { AsyncCallback } callback - The callback of finishTest. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -1231,7 +1231,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @param { AsyncCallback } callback - The callback of finishTest. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1244,7 +1244,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @param { AsyncCallback } callback - The callback of finishTest. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1260,7 +1260,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 @@ -1272,7 +1272,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1285,7 +1285,7 @@ export interface AbilityDelegator { * @param { string } msg - Log information. * @param { number } code - Result code. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000100 - FinishTest failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform @@ -1299,7 +1299,7 @@ export interface AbilityDelegator { * @param { Record } mockList - An object with string keys and string values. The keys represent the * target path to be replaced and the values represent the path of the * mock implementation to be used for the replacement. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice diff --git a/api/application/ApplicationContext.d.ts b/api/application/ApplicationContext.d.ts index 4c9f443546bd6649a4980519cf85116d3941b9ae..c333d0906a3b08c7b047af314f919ae2979e2c3d 100644 --- a/api/application/ApplicationContext.d.ts +++ b/api/application/ApplicationContext.d.ts @@ -61,7 +61,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { AbilityLifecycleCallback } callback - The ability lifecycle callback. * @returns { number } Returns the number code of the callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -72,7 +72,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { AbilityLifecycleCallback } callback - The ability lifecycle callback. * @returns { number } Returns the number code of the callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -84,7 +84,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { AbilityLifecycleCallback } callback - The ability lifecycle callback. * @returns { number } Returns the number code of the callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -99,7 +99,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { number } callbackId - Indicates the number code of the callback. * @param { AsyncCallback } callback - The callback of off. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -110,7 +110,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { number } callbackId - Indicates the number code of the callback. * @param { AsyncCallback } callback - The callback of off. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -122,7 +122,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { number } callbackId - Indicates the number code of the callback. * @param { AsyncCallback } callback - The callback of off. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -137,7 +137,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { number } callbackId - Indicates the number code of the callback. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -148,7 +148,7 @@ export default class ApplicationContext extends Context { * @param { 'abilityLifecycle' } type - abilityLifecycle. * @param { number } callbackId - Indicates the number code of the callback. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -162,7 +162,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { EnvironmentCallback } callback - The environment callback. * @returns { number } Returns the number code of the callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -173,7 +173,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { EnvironmentCallback } callback - The environment callback. * @returns { number } Returns the number code of the callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -187,7 +187,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { number } callbackId - Indicates the number code of the callback. * @param { AsyncCallback } callback - The callback of unregisterEnvironmentCallback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -198,7 +198,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { number } callbackId - Indicates the number code of the callback. * @param { AsyncCallback } callback - The callback of unregisterEnvironmentCallback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -212,7 +212,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { number } callbackId - Indicates the number code of the callback. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -223,7 +223,7 @@ export default class ApplicationContext extends Context { * @param { 'environment' } type - environment. * @param { number } callbackId - Indicates the number code of the callback. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -236,7 +236,7 @@ export default class ApplicationContext extends Context { * * @param { 'applicationStateChange' } type - applicationStateChange. * @param { ApplicationStateChangeCallback } callback - The applicationStateChange callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 10 @@ -246,7 +246,7 @@ export default class ApplicationContext extends Context { * * @param { 'applicationStateChange' } type - applicationStateChange. * @param { ApplicationStateChangeCallback } callback - The applicationStateChange callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -259,7 +259,7 @@ export default class ApplicationContext extends Context { * * @param { 'applicationStateChange' } type - applicationStateChange. * @param { ApplicationStateChangeCallback } [callback] - The applicationStateChange callback. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 10 @@ -269,7 +269,7 @@ export default class ApplicationContext extends Context { * * @param { 'applicationStateChange' } type - applicationStateChange. * @param { ApplicationStateChangeCallback } [callback] - The applicationStateChange callback. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -281,7 +281,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @returns { Promise> } Returns the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -292,7 +292,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @returns { Promise> } Returns the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -304,7 +304,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @returns { Promise> } Returns the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -319,7 +319,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @param { AsyncCallback> } callback - The callback is used to return the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -330,7 +330,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @param { AsyncCallback> } callback - The callback is used to return the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -342,7 +342,7 @@ export default class ApplicationContext extends Context { * Get information about running processes * * @param { AsyncCallback> } callback - The callback is used to return the array of {@link ProcessInformation}. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -357,7 +357,7 @@ export default class ApplicationContext extends Context { * Kill all processes of the application * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -367,7 +367,7 @@ export default class ApplicationContext extends Context { * Kill all processes of the application * * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -380,7 +380,7 @@ export default class ApplicationContext extends Context { * Kill all processes of the application * * @param { AsyncCallback } callback - The callback of killAllProcesses. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -390,7 +390,7 @@ export default class ApplicationContext extends Context { * Kill all processes of the application * * @param { AsyncCallback } callback - The callback of killAllProcesses. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -403,7 +403,7 @@ export default class ApplicationContext extends Context { * Set colorMode of the application * * @param { ConfigurationConstant.ColorMode } colorMode - Color mode. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -416,7 +416,7 @@ export default class ApplicationContext extends Context { * Set language of the application * * @param { string } language - Language. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -441,7 +441,7 @@ export default class ApplicationContext extends Context { * Clear up application data by app self * * @param { AsyncCallback } callback - The callback of clearUpApplicationData. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -454,7 +454,7 @@ export default class ApplicationContext extends Context { * Kill the application and does not call back the onDestroy method, then start UIAbility. * * @param { Want } want - Indicates the want name of the current app, and the ability name is UIAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16000063 - The target to restart does not belong to the current app or is not a UIAbility. * @throws { BusinessError } 16000064 - Restart too frequently. Try again at least 10s later. @@ -464,7 +464,7 @@ export default class ApplicationContext extends Context { * @since 12 */ restartApp(want: Want): void; - + /** * Preload UIExtensionAbility. * @@ -473,7 +473,7 @@ export default class ApplicationContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -484,23 +484,5 @@ export default class ApplicationContext extends Context { * @stagemodelonly * @since 12 */ - preloadUIExtensionAbility(want: Want): Promise; - - /** - * Set the state about whether the application supports process cache or not. - * - * @permission ohos.permission.SET_PROCESS_CACHE_STATE - * @param { boolean } isSupported - Indicates the process cache support state. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - The input parameter is not a valid parameter. - * @throws { BusinessError } 16000011 - The context does not exist. - * @throws { BusinessError } 16000050 - Internal error. - * @throws { BusinessError } 16000068 - The supported process cache state cannot be set more than once. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi - * @stagemodelonly - * @since 12 - */ - setSupportedProcessCache(isSupported : boolean): void; + preloadUIExtensionAbility(want: Want): Promise; } diff --git a/api/application/ApplicationStateObserver.d.ts b/api/application/ApplicationStateObserver.d.ts index 22b6d5b2e0a165ddde91f8293cfb3163acaab5e7..2cb0578f6130aebd0b356e4e0a9c6a0f0f724c2f 100644 --- a/api/application/ApplicationStateObserver.d.ts +++ b/api/application/ApplicationStateObserver.d.ts @@ -79,31 +79,11 @@ export default class ApplicationStateObserver { * @since 9 */ onProcessStateChanged(processData: ProcessData): void; - - /** - * Called when application is started. - * - * @param { AppStateData } appStateData - State changed Application info. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi - * @since 12 - */ - onAppStarted(appStateData: AppStateData): void; - - /** - * Called when application is stopped. - * - * @param { AppStateData } appStateData - State changed Application info. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi - * @since 12 - */ - onAppStopped(appStateData: AppStateData): void; } /** * The process data. - * @typedef { _ProcessData.default } + * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @since 9 diff --git a/api/application/AutoFillRequest.d.ts b/api/application/AutoFillRequest.d.ts index 5739be8485b632bc1df73be838a65d21d02c87aa..eb4bc4c330923d6867b3edb068aa72304b4fa16e 100644 --- a/api/application/AutoFillRequest.d.ts +++ b/api/application/AutoFillRequest.d.ts @@ -28,7 +28,7 @@ import type ViewData from './ViewData'; * @interface FillRequest * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export interface FillRequest { @@ -38,7 +38,7 @@ export interface FillRequest { * @type { AutoFillType } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ type: AutoFillType; @@ -49,7 +49,7 @@ export interface FillRequest { * @type { ViewData } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ viewData: ViewData; @@ -60,7 +60,7 @@ export interface FillRequest { * @type { boolean } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 12 */ isPopup: boolean; @@ -72,7 +72,7 @@ export interface FillRequest { * @interface SaveRequest * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export interface SaveRequest { @@ -82,7 +82,7 @@ export interface SaveRequest { * @type { ViewData } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ viewData: ViewData; @@ -94,7 +94,7 @@ export interface SaveRequest { * @interface UpdateRequest * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 12 */ export interface UpdateRequest { @@ -104,7 +104,7 @@ export interface UpdateRequest { * @type { ViewData } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 12 */ viewData: ViewData; @@ -116,7 +116,7 @@ export interface UpdateRequest { * @interface FillResponse * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export interface FillResponse { @@ -126,7 +126,7 @@ export interface FillResponse { * @type { ViewData } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ viewData: ViewData; @@ -138,7 +138,7 @@ export interface FillResponse { * @interface FillRequestCallback * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export interface FillRequestCallback { @@ -147,11 +147,12 @@ export interface FillRequestCallback { * * @param { FillResponse } response - Indicates the fill response. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ onSuccess(response: FillResponse): void; @@ -163,7 +164,7 @@ export interface FillRequestCallback { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ onFailure(): void; @@ -175,17 +176,31 @@ export interface FillRequestCallback { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ - onCancel(): void; + /** + * Notification system that filling has been cancelled. + * + * @param { string } [fillContent] - Indicates the content to be filled in. + * @throws { BusinessError } 202 - Permission denied, non-system app called system api. + * @throws { BusinessError } 401 - Incorrect parameter types. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameters types. + * @throws { BusinessError } 16000050 - Internal error. + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @since 12 + */ + onCancel(fillContent?: string): void; /** * autofill popup config. * * @param { AutoFillPopupConfig } autoFillPopupConfig - Indicates the autofill popup config. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The input parameter is not valid parameter. + * @throws { BusinessError } 401 - The input parameter is not valid parameter. Possible causes: 1. Mandatory parameters are left unspecified; + *
    2. Incorrect parameters types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi @@ -201,7 +216,7 @@ export interface FillRequestCallback { * @interface SaveRequestCallback * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export interface SaveRequestCallback { @@ -212,7 +227,7 @@ export interface SaveRequestCallback { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ onSuccess(): void; @@ -224,7 +239,7 @@ export interface SaveRequestCallback { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ onFailure(): void; diff --git a/api/application/Context.d.ts b/api/application/Context.d.ts index 478f0b9338c3657f5d0eedd1c8613a11478c5783..fff9bd0f8f1093ab1652ea7f0843c6716b70553a 100644 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -387,7 +387,7 @@ export default class Context extends BaseContext { * @returns { Context } Returns the application context. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly @@ -400,7 +400,7 @@ export default class Context extends BaseContext { * * @param { string } moduleName - Indicates the module name. * @returns { Context } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -410,7 +410,7 @@ export default class Context extends BaseContext { * * @param { string } moduleName - Indicates the module name. * @returns { Context } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -421,7 +421,7 @@ export default class Context extends BaseContext { * * @param { string } moduleName - Indicates the module name. * @returns { Context } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -436,7 +436,7 @@ export default class Context extends BaseContext { * @param { string } bundleName - Indicates the bundle name. * @param { string } moduleName - Indicates the module name. * @returns { Context } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly @@ -450,7 +450,7 @@ export default class Context extends BaseContext { * @param { string } bundleName - Indicates the bundle name. * @param { string } moduleName - Indicates the module name. * @returns { resmgr.ResourceManager } Returns the system HSP module resource manager. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16400001 - If the input bundleName is not system hsp. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -463,7 +463,7 @@ export default class Context extends BaseContext { * Get application context * * @returns { ApplicationContext } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 9 @@ -472,7 +472,7 @@ export default class Context extends BaseContext { * Get application context * * @returns { ApplicationContext } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -482,7 +482,7 @@ export default class Context extends BaseContext { * Get application context * * @returns { ApplicationContext } Returns the application context. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @crossplatform @@ -496,7 +496,7 @@ export default class Context extends BaseContext { * * @param { string } dataGroupID - Indicates the groupId. * @param { AsyncCallback } callback - The callback of getGroupDir. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -507,7 +507,7 @@ export default class Context extends BaseContext { * * @param { string } dataGroupID - Indicates the groupId. * @param { AsyncCallback } callback - The callback of getGroupDir. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -521,7 +521,7 @@ export default class Context extends BaseContext { * * @param { string } dataGroupID - Indicates the groupId. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -532,7 +532,7 @@ export default class Context extends BaseContext { * * @param { string } dataGroupID - Indicates the groupId. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly @@ -550,7 +550,7 @@ export default class Context extends BaseContext { * @returns { resmgr.ResourceManager } Returns the module resource manager. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index e88aa55e1d4e3b7a2adefea008c714610a7817b8..09fa662843fe3f735c5f0c3e446999357d1d8675 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -49,7 +49,8 @@ export default class FormExtensionContext extends ExtensionContext { * @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500101 - The application is not a system application. @@ -65,7 +66,8 @@ export default class FormExtensionContext extends ExtensionContext { * @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -82,7 +84,8 @@ export default class FormExtensionContext extends ExtensionContext { * @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500101 - The application is not a system application. @@ -98,7 +101,8 @@ export default class FormExtensionContext extends ExtensionContext { * @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. @@ -123,7 +127,8 @@ export default class FormExtensionContext extends ExtensionContext { * @param { ConnectOptions } options - Indicates the callback of connection. * @returns { number } Returns the connection id. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -146,7 +151,8 @@ export default class FormExtensionContext extends ExtensionContext { * * @param { number } connection - the connection id returned from connectServiceExtensionAbility api. * @param { AsyncCallback } callback - The callback of disconnectServiceExtensionAbility. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.Form @@ -161,7 +167,8 @@ export default class FormExtensionContext extends ExtensionContext { * * @param { number } connection - the connection id returned from connectServiceExtensionAbility api. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.Form diff --git a/api/application/ServiceExtensionContext.d.ts b/api/application/ServiceExtensionContext.d.ts index d4b93b5bab6a414fd85388561ac86bca90debd5e..cbdbc52e2b999dd76b3dc814470e274ce4fc39ff 100644 --- a/api/application/ServiceExtensionContext.d.ts +++ b/api/application/ServiceExtensionContext.d.ts @@ -770,6 +770,36 @@ export default class ServiceExtensionContext extends ExtensionContext { * @StageModelOnly * @since 10 */ + /** + * Starts a new service extension ability. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @param { Want } want - Indicates the want info to start. + * @param { AsyncCallback } callback - The callback of startServiceExtensionAbility. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbility(want: Want, callback: AsyncCallback): void; /** @@ -823,6 +853,36 @@ export default class ServiceExtensionContext extends ExtensionContext { * @StageModelOnly * @since 10 */ + /** + * Starts a new service extension ability. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @param { Want } want - Indicates the want info to start. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbility(want: Want): Promise; /** @@ -880,6 +940,38 @@ export default class ServiceExtensionContext extends ExtensionContext { * @StageModelOnly * @since 10 */ + /** + * Starts a new service extension ability with account. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + * @param { Want } want - Indicates the want info to start. + * @param { number } accountId - Indicates the account to start. + * @param { AsyncCallback } callback - The callback of startServiceExtensionAbilityWithAccount. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; /** @@ -937,6 +1029,38 @@ export default class ServiceExtensionContext extends ExtensionContext { * @StageModelOnly * @since 10 */ + /** + * Starts a new service extension ability with account. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + * @param { Want } want - Indicates the want info to start. + * @param { number } accountId - Indicates the account to start. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; /** diff --git a/api/application/UIAbilityContext.d.ts b/api/application/UIAbilityContext.d.ts index df5db891bbc24cfc6aeb78cac88e67dc6d0b2806..2df6ab86bcebae5e66dbcb533f2eaf28b11f456c 100644 --- a/api/application/UIAbilityContext.d.ts +++ b/api/application/UIAbilityContext.d.ts @@ -171,7 +171,7 @@ export default class UIAbilityContext extends Context { * * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -199,7 +199,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -230,7 +230,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -262,7 +262,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -294,7 +294,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -323,7 +323,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -352,7 +352,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -382,7 +382,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not support. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -415,7 +415,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -445,7 +445,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -476,7 +476,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -508,7 +508,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not support. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. @@ -549,7 +549,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } [callback] - The callback is used to return the ability result. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -582,7 +582,8 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -618,7 +619,8 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -652,7 +654,8 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -682,7 +685,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @returns { Promise } Returns the Caller interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -709,7 +712,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @returns { Promise } Returns the Caller interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -736,7 +739,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @returns { Promise } Returns the Caller interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -763,7 +766,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @returns { Promise } Returns the Caller interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -795,7 +798,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the Caller interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -828,7 +831,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -863,7 +866,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -897,7 +900,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -931,7 +934,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -965,7 +968,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1002,7 +1005,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1038,7 +1041,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1067,7 +1070,7 @@ export default class UIAbilityContext extends Context { * * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1096,7 +1099,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1127,7 +1130,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1159,7 +1162,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1190,7 +1193,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1220,7 +1223,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1250,7 +1253,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1281,7 +1284,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1310,7 +1313,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1340,7 +1343,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1372,7 +1375,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1405,7 +1408,7 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1444,7 +1447,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1472,7 +1475,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1502,7 +1505,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1536,7 +1539,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1570,7 +1573,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1604,7 +1607,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1646,7 +1649,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1675,7 +1678,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1706,7 +1709,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1737,7 +1740,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startServiceExtensionAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1762,7 +1765,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startServiceExtensionAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1779,6 +1782,35 @@ export default class UIAbilityContext extends Context { * @stagemodelonly * @since 10 */ + /** + * Starts a new service extension ability. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @param { Want } want - Indicates the want info to start. + * @param { AsyncCallback } callback - The callback of startServiceExtensionAbility. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbility(want: Want, callback: AsyncCallback): void; /** @@ -1788,7 +1820,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1813,7 +1845,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1830,6 +1862,35 @@ export default class UIAbilityContext extends Context { * @stagemodelonly * @since 10 */ + /** + * Starts a new service extension ability. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @param { Want } want - Indicates the want info to start. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbility(want: Want): Promise; /** @@ -1841,7 +1902,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startServiceExtensionAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1868,7 +1929,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startServiceExtensionAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1885,6 +1946,37 @@ export default class UIAbilityContext extends Context { * @stagemodelonly * @since 10 */ + /** + * Starts a new service extension ability with account. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + * @param { Want } want - Indicates the want info to start. + * @param { number } accountId - Indicates the account to start. + * @param { AsyncCallback } callback - The callback of startServiceExtensionAbilityWithAccount. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; /** @@ -1896,7 +1988,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1923,7 +2015,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1940,6 +2032,37 @@ export default class UIAbilityContext extends Context { * @stagemodelonly * @since 10 */ + /** + * Starts a new service extension ability with account. + * If the target service extension ability is visible, you can start the target service extension ability; + * If the target service extension ability is invisible, + * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible service extension ability. + * If the target service extension ability is in cross-device, you need to apply for permission:ohos.permission.DISTRIBUTED_DATASYNC. + * + * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + * @param { Want } want - Indicates the want info to start. + * @param { number } accountId - Indicates the account to start. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - The application does not have permission to call the interface. + * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 16000001 - The specified ability does not exist. + * @throws { BusinessError } 16000002 - Incorrect ability type. + * @throws { BusinessError } 16000004 - Can not start invisible component. + * @throws { BusinessError } 16000005 - The specified process does not have the permission. + * @throws { BusinessError } 16000006 - Cross-user operations are not allowed. + * @throws { BusinessError } 16000008 - The crowdtesting application expires. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000012 - The application is controlled. + * @throws { BusinessError } 16000013 - The application is controlled by EDM. + * @throws { BusinessError } 16000019 - Can not match any component. + * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16200001 - The caller has been released. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 12 + */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; /** @@ -1948,7 +2071,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the want info to start. * @param { AsyncCallback } callback - The callback of stopServiceExtensionAbility. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -1972,7 +2095,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of stopServiceExtensionAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -1996,7 +2119,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the want info to start. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2020,7 +2143,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2045,7 +2168,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of stopServiceExtensionAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2071,7 +2194,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of stopServiceExtensionAbilityWithAccount. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2096,7 +2219,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2122,7 +2245,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2142,7 +2265,7 @@ export default class UIAbilityContext extends Context { * Destroys this Page ability. * * @param { AsyncCallback } callback - The callback of terminateSelf. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2157,7 +2280,7 @@ export default class UIAbilityContext extends Context { * Destroys this Page ability. * * @param { AsyncCallback } callback - The callback of terminateSelf. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2170,7 +2293,7 @@ export default class UIAbilityContext extends Context { * Destroys this Page ability. * * @param { AsyncCallback } callback - The callback of terminateSelf. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2228,7 +2351,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2244,7 +2367,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2257,7 +2380,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2273,7 +2396,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2289,7 +2412,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2302,7 +2425,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityResult } parameter - Indicates the result to return. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. @@ -2320,7 +2443,7 @@ export default class UIAbilityContext extends Context { * @param { ConnectOptions } options - The remote object instance * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000005 - The specified process does not have the permission. * @throws { BusinessError } 16000011 - The context does not exist. @@ -2340,7 +2463,7 @@ export default class UIAbilityContext extends Context { * @param { ConnectOptions } options - The remote object instance * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2367,7 +2490,7 @@ export default class UIAbilityContext extends Context { * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000005 - The specified process does not have the permission. * @throws { BusinessError } 16000011 - The context does not exist. @@ -2391,7 +2514,7 @@ export default class UIAbilityContext extends Context { * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2414,7 +2537,7 @@ export default class UIAbilityContext extends Context { * * @param { number } connection - The number code of the ability connected * @param { AsyncCallback } callback - The callback of disconnectAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2428,7 +2551,7 @@ export default class UIAbilityContext extends Context { * * @param { number } connection - The number code of the ability connected * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2442,7 +2565,7 @@ export default class UIAbilityContext extends Context { * * @param { string } label - The label of ability that showed in recent missions. * @param { AsyncCallback } callback - The callback of setMissionLabel. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2454,7 +2577,7 @@ export default class UIAbilityContext extends Context { * * @param { string } label - The label of ability that showed in recent missions. * @param { AsyncCallback } callback - The callback of setMissionLabel. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2469,7 +2592,7 @@ export default class UIAbilityContext extends Context { * * @param { string } label - The label of ability that showed in recent missions. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2481,7 +2604,7 @@ export default class UIAbilityContext extends Context { * * @param { string } label - The label of ability that showed in recent missions. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2496,7 +2619,7 @@ export default class UIAbilityContext extends Context { * * @param { image.PixelMap } icon - The icon of ability that showed in recent missions. * @param { AsyncCallback } callback - The callback of setMissionIcon. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2510,7 +2633,7 @@ export default class UIAbilityContext extends Context { * @param { image.PixelMap } icon - The icon of ability that showed in recent missions. * @param { AsyncCallback } callback - The callback of setMissionIcon. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2525,7 +2648,7 @@ export default class UIAbilityContext extends Context { * * @param { image.PixelMap } icon - The icon of ability that showed in recent missions. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2539,7 +2662,7 @@ export default class UIAbilityContext extends Context { * @param { image.PixelMap } icon - The icon of ability that showed in recent missions. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2554,7 +2677,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityConstant.ContinueState } state - The mission continue state of current ability. * @param { AsyncCallback } callback - The callback of setMissionContinueState. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2566,7 +2689,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityConstant.ContinueState } state - The mission continue state of current ability. * @param { AsyncCallback } callback - The callback of setMissionContinueState. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2581,7 +2704,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityConstant.ContinueState } state - The mission continue state of current ability. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2593,7 +2716,7 @@ export default class UIAbilityContext extends Context { * * @param { AbilityConstant.ContinueState } state - The mission continue state of current ability. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2607,7 +2730,7 @@ export default class UIAbilityContext extends Context { * Restore window stage data in ability continuation * * @param { LocalStorage } localStorage - the storage data used to restore window stage - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2618,7 +2741,7 @@ export default class UIAbilityContext extends Context { * Restore window stage data in ability continuation * * @param { LocalStorage } localStorage - the storage data used to restore window stage - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -2655,7 +2778,8 @@ export default class UIAbilityContext extends Context { * * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2685,7 +2809,8 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2715,7 +2840,8 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2746,7 +2872,8 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -2774,7 +2901,8 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the ability to start. * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2805,7 +2933,8 @@ export default class UIAbilityContext extends Context { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2833,7 +2962,7 @@ export default class UIAbilityContext extends Context { * * @param { Want } want - Indicates the dialog service to start. * @param { AsyncCallback } result - The callback is used to return the request result. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2862,7 +2991,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the dialog service to start. * @param { AsyncCallback } result - The callback is used to return the request result. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2889,7 +3018,7 @@ export default class UIAbilityContext extends Context { * * @param { Want } want - Indicates the dialog service to start. * @returns { Promise } Returns the request result. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2919,7 +3048,7 @@ export default class UIAbilityContext extends Context { * @param { Want } want - Indicates the dialog service to start. * @returns { Promise } Returns the request result. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2986,7 +3115,8 @@ export default class UIAbilityContext extends Context { * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + *
    2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -2999,21 +3129,14 @@ export default class UIAbilityContext extends Context { */ /** * Starts the UIAbility or UIExtensionAbility by type. - * If the target ability is visible, you can start the target ability; If the target ability is invisible, - * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible ability. * * @param { string } type - The type of target ability. * @param { Record } wantParam - Indicates the want parameter. * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. * @param { AsyncCallback } callback - The callback of startAbility. - * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * @throws { BusinessError } 16000001 - The specified ability does not exist. - * @throws { BusinessError } 16000002 - Incorrect ability type. - * @throws { BusinessError } 16000004 - Can not start invisible component. - * @throws { BusinessError } 16000018 - The application is not allow jumping to other applications. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + *
    2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. - * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -3032,7 +3155,8 @@ export default class UIAbilityContext extends Context { * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + *
    2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -3045,21 +3169,14 @@ export default class UIAbilityContext extends Context { */ /** * Starts the UIAbility or UIExtensionAbility by type. - * If the target ability is visible, you can start the target ability; If the target ability is invisible, - * you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible ability. * * @param { string } type - The type of target ability. * @param { Record } wantParam - Indicates the want parameter. * @param { AbilityStartCallback } abilityStartCallback - Indicates the abilityStartCallback. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * @throws { BusinessError } 16000001 - The specified ability does not exist. - * @throws { BusinessError } 16000002 - Incorrect ability type. - * @throws { BusinessError } 16000004 - Can not start invisible component. - * @throws { BusinessError } 16000018 - The application is not allow jumping to other applications. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. + *
    2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. - * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice @@ -3077,7 +3194,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of requestModalUIExtension. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -3100,7 +3217,7 @@ export default class UIAbilityContext extends Context { * @param { Want } type - Indicates the UIExtensionAbility to start. * @param { AsyncCallback } callback - The callback of requestModalUIExtension. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -3118,7 +3235,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the requestModalUIExtension. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -3141,7 +3258,7 @@ export default class UIAbilityContext extends Context { * @param { Want } type - Indicates the UIExtensionAbility to start. * @returns { Promise } The promise returned by the requestModalUIExtension. * @throws { BusinessError } 202 - The application is not system-app, can not use system-api. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi @@ -3156,7 +3273,7 @@ export default class UIAbilityContext extends Context { * @param { string } appId - Globally unique identifier of an application, which is allocated by the cloud. * @param { AtomicServiceOptions } [options] - Indicates the atomic service start options. * @returns { Promise } Returns the result of openAtomicService. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000003 - The appId does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component diff --git a/api/application/UIExtensionContext.d.ts b/api/application/UIExtensionContext.d.ts index eba6977d2b1bfb028c881c5d1b858d46354987cc..17ddb09076d4ca03423d01d40f3765e8caf2c72c 100755 --- a/api/application/UIExtensionContext.d.ts +++ b/api/application/UIExtensionContext.d.ts @@ -47,7 +47,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -78,7 +78,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -114,7 +114,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -144,7 +144,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -178,7 +178,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -210,7 +210,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -247,7 +247,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { AsyncCallback } [callback] - The callback is used to return the ability result. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -278,7 +278,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -309,7 +309,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { Want } want - Indicates the ability to start. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -345,7 +345,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -375,7 +375,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } options - Indicates the start options. * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000005 - The specified process does not have the permission. @@ -409,7 +409,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -441,7 +441,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { StartOptions } [options] - Indicates the start options. * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -478,7 +478,7 @@ export default class UIExtensionContext extends ExtensionContext { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. - * @throws { BusinessError } 401 - Params error. Possible causes: Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000050 - Internal error. @@ -500,7 +500,7 @@ export default class UIExtensionContext extends ExtensionContext { * @param { ConnectOptions } options - The remote object instance * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 201 - The application does not have permission to call the interface. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000004 - Can not start invisible component. @@ -522,7 +522,7 @@ export default class UIExtensionContext extends ExtensionContext { * * @param { number } connection - The number code of the ability connected * @param { AsyncCallback } callback - The callback of disconnectAbility. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -536,7 +536,7 @@ export default class UIExtensionContext extends ExtensionContext { * * @param { number } connection - The number code of the ability connected * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core @@ -561,7 +561,7 @@ export default class UIExtensionContext extends ExtensionContext { * Destroys the UI extension. * * @param { AsyncCallback } callback - The callback of terminateSelf. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 12 @@ -583,7 +583,7 @@ export default class UIExtensionContext extends ExtensionContext { * * @param { AbilityResult } parameter - Indicates the result to return. * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 12 @@ -595,7 +595,7 @@ export default class UIExtensionContext extends ExtensionContext { * * @param { AbilityResult } parameter - Indicates the result to return. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @since 12 @@ -608,13 +608,14 @@ export default class UIExtensionContext extends ExtensionContext { * @param { string } appId - Globally unique identifier of an application, which is allocated by the cloud. * @param { AtomicServiceOptions } [options] - Indicates the atomic service start options. * @returns { Promise } Returns the result of openAtomicService. - * @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000003 - The appId does not exist. * @throws { BusinessError } 16000004 - Can not start invisible component * @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000012 - The application is controlled. * @throws { BusinessError } 16000050 - Internal error. + * @throws { BusinessError } 16000069 - The extension cannot start the third party application. * @throws { BusinessError } 16200001 - The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly diff --git a/api/application/ViewData.d.ts b/api/application/ViewData.d.ts index d6debdfd2f363c5bbe5454e5a8b1c57fc305c3ce..09c3adb5e40ce9f544a94dbc478288d435f31a6f 100644 --- a/api/application/ViewData.d.ts +++ b/api/application/ViewData.d.ts @@ -27,7 +27,7 @@ import type AutoFillRect from './AutoFillRect'; * @interface ViewData * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ export default interface ViewData { @@ -37,7 +37,7 @@ export default interface ViewData { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ bundleName: string; @@ -48,7 +48,7 @@ export default interface ViewData { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ moduleName: string; @@ -59,7 +59,7 @@ export default interface ViewData { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ abilityName: string; @@ -70,7 +70,7 @@ export default interface ViewData { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ pageUrl: string; @@ -81,7 +81,7 @@ export default interface ViewData { * @type { Array } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 11 */ pageNodeInfos: Array; @@ -92,8 +92,30 @@ export default interface ViewData { * @type { AutoFillRect } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @StageModelOnly + * @stagemodelonly * @since 12 */ pageRect: AutoFillRect; + + /** + * Indicates whether the content is user-selected fill-in content. + * + * @type { boolean } + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @since 12 + */ + isUserSelected: boolean; + + /** + * Indicates whether it is other account. + * + * @type { boolean } + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @systemapi + * @stagemodelonly + * @since 12 + */ + isOtherAccount: boolean; } \ No newline at end of file diff --git a/api/arkui/BuilderNode.d.ts b/api/arkui/BuilderNode.d.ts index 0290f7faffa42d706939ad7c220191e3f9ec2e3e..4bea910491d0b4a9a86dd156c33d411a5eabd93c 100644 --- a/api/arkui/BuilderNode.d.ts +++ b/api/arkui/BuilderNode.d.ts @@ -269,4 +269,23 @@ export class BuilderNode { * @since 12 */ dispose(): void; + + /** + * Reuse the BuilderNode based on the provided parameters. + * + * @param { Object } [param] - Parameters for reusing BuilderNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + reuse(param?: Object): void; + + /** + * Recycle the BuilderNode. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + recycle(): void; } diff --git a/api/arkui/ComponentContent.d.ts b/api/arkui/ComponentContent.d.ts index 30b3672389a4d913dab0cd35e610820c16f2b434..80bb4cb00c9374869f23874a152312d064e57c07 100644 --- a/api/arkui/ComponentContent.d.ts +++ b/api/arkui/ComponentContent.d.ts @@ -28,6 +28,7 @@ import { WrappedBuilder } from 'wrappedBuilderObject'; * @extends Content * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class ComponentContent extends Content{ @@ -38,6 +39,7 @@ export class ComponentContent extends Content{ * @param { WrappedBuilder<[]> } builder - Defined the builder will be called to build ComponentContent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ constructor(uiContext: UIContext, builder: WrappedBuilder<[]>); @@ -50,6 +52,7 @@ export class ComponentContent extends Content{ * @param { T } args - Parameters used to update the ComponentContent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ constructor(uiContext: UIContext, builder: WrappedBuilder<[T]>, args: T); @@ -60,7 +63,27 @@ export class ComponentContent extends Content{ * @param { T } args - Parameters used to update the ComponentContent, which must match the types required by the builder bound to the ComponentContent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ update(args: T): void; + + /** + * Reuse the ComponentContent based on the provided parameters. + * + * @param { Object } [param] - Parameters for reusing ComponentContent. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + reuse(param?: Object): void; + + /** + * Recycle the ComponentContent. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + recycle(): void; } \ No newline at end of file diff --git a/api/arkui/Content.d.ts b/api/arkui/Content.d.ts index 87639f3b285827f8c6191c5b28052c243cee049a..8c3d9518534b4dd76b01c3fc07c325e42ce42543 100644 --- a/api/arkui/Content.d.ts +++ b/api/arkui/Content.d.ts @@ -23,6 +23,7 @@ * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export abstract class Content{ diff --git a/api/arkui/FrameNode.d.ts b/api/arkui/FrameNode.d.ts index 12076687bd4e12d49b5028f575b1aadfb8bb8e5b..f8ad3510d90454b8b27cd928e66994ecabf79084 100644 --- a/api/arkui/FrameNode.d.ts +++ b/api/arkui/FrameNode.d.ts @@ -24,6 +24,7 @@ import { Size, Position, Edges, LengthMetrics, SizeT } from './Graphics'; import { UICommonEvent } from 'commonEvent'; import { CommonAttribute } from 'commonAttribute'; import { DrawContext } from './Graphics'; +import { ComponentContent } from './ComponentContent'; /** * Layout constraint, include the max size, the min size and the reference size for children to calculate percent. @@ -31,6 +32,7 @@ import { DrawContext } from './Graphics'; * @interface LayoutConstraint * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface LayoutConstraint { @@ -40,6 +42,7 @@ declare interface LayoutConstraint { * @type { Size } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ maxSize: Size; @@ -50,6 +53,7 @@ declare interface LayoutConstraint { * @type { Size } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ minSize: Size; @@ -61,6 +65,7 @@ declare interface LayoutConstraint { * @type { Size } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ percentReference: Size; @@ -126,6 +131,7 @@ export class FrameNode { * @returns { boolean } - Returns true if the FrameNode can be modified, otherwise return false. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ isModifiable(): boolean; @@ -137,6 +143,7 @@ export class FrameNode { * @throws { BusinessError } 100021 - The FrameNode is not modifiable. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ appendChild(node: FrameNode): void; @@ -149,6 +156,7 @@ export class FrameNode { * @throws { BusinessError } 100021 - The FrameNode is not modifiable. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ insertChildAfter(child: FrameNode, sibling: FrameNode | null): void; @@ -160,6 +168,7 @@ export class FrameNode { * @throws { BusinessError } 100021 - The FrameNode is not modifiable. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ removeChild(node: FrameNode): void; @@ -170,6 +179,7 @@ export class FrameNode { * @throws { BusinessError } 100021 - The FrameNode is not modifiable. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ clearChildren(): void; @@ -181,6 +191,7 @@ export class FrameNode { * @returns { FrameNode | null } - Returns a FrameNode. When the required node does not exist, returns null. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getChild(index: number): FrameNode | null; @@ -192,6 +203,7 @@ export class FrameNode { * If current FrameNode does not have child node, returns null. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getFirstChild(): FrameNode | null; @@ -202,6 +214,7 @@ export class FrameNode { * @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have next sibling node, returns null. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getNextSibling(): FrameNode | null; @@ -212,6 +225,7 @@ export class FrameNode { * @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have previous sibling node, returns null. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPreviousSibling(): FrameNode | null; @@ -222,6 +236,7 @@ export class FrameNode { * @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have parent node, returns null. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getParent(): FrameNode | null; @@ -232,6 +247,7 @@ export class FrameNode { * @returns { number } - Returns the number of the children of the current FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getChildrenCount(): number; @@ -241,6 +257,7 @@ export class FrameNode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ dispose(): void; @@ -251,6 +268,7 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to window. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToWindow(): Position; @@ -261,6 +279,7 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to its parent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToParent(): Position; @@ -271,6 +290,7 @@ export class FrameNode { * @returns { Size } - Returns the size of the FrameNode after measure, with unit PX. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getMeasuredSize(): Size; @@ -281,6 +301,7 @@ export class FrameNode { * @returns { Position } - Returns the offset to the parent of the FrameNode after layout, with unit PX. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getLayoutPosition(): Position; @@ -291,6 +312,7 @@ export class FrameNode { * @returns { Edges } - Returns the user config border width of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getUserConfigBorderWidth(): Edges; @@ -301,6 +323,7 @@ export class FrameNode { * @returns { Edges } - Returns the user config padding of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getUserConfigPadding(): Edges; @@ -311,6 +334,7 @@ export class FrameNode { * @returns { Edges } - Returns the user config margin of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getUserConfigMargin(): Edges; @@ -321,6 +345,7 @@ export class FrameNode { * @returns { SizeT } - Returns the user config size of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getUserConfigSize(): SizeT; @@ -331,6 +356,7 @@ export class FrameNode { * @returns { string } - Returns the id of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getId(): string; @@ -341,6 +367,7 @@ export class FrameNode { * @returns { number } - Returns the unique id of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getUniqueId(): number; @@ -352,6 +379,7 @@ export class FrameNode { * @returns { string } - Returns the type of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getNodeType(): string; @@ -362,6 +390,7 @@ export class FrameNode { * @returns { number } - Returns the opacity of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getOpacity(): number; @@ -372,6 +401,7 @@ export class FrameNode { * @returns { boolean } - Returns if the FrameNode is visible. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ isVisible(): boolean; @@ -382,6 +412,7 @@ export class FrameNode { * @returns { boolean } - Returns if the FrameNode is clip to frame. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ isClipToFrame(): boolean; @@ -392,6 +423,7 @@ export class FrameNode { * @returns { boolean } - Returns if the FrameNode is attached. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ isAttached(): boolean; @@ -402,6 +434,7 @@ export class FrameNode { * @returns { Object } - Returns the inspector information of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getInspectorInfo(): Object; @@ -413,6 +446,7 @@ export class FrameNode { * @returns { Object | undefined } - Returns the value of the custom property. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getCustomProperty(name: string): Object | undefined; @@ -423,6 +457,7 @@ export class FrameNode { * @returns { UICommonEvent } - Returns a Object inside the FrameNode, which is used to set callbacks about different events. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ get commonEvent(): UICommonEvent; @@ -433,16 +468,18 @@ export class FrameNode { * @returns { CommonAttribute } - Returns the CommonAttribute which is used to modify the common attributes of the FrameNode. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ get commonAttribute(): CommonAttribute; /** - * Draw Method. Executed when the associated RenderNode in the current FrameNode is onDraw. + * Draw Method. Executed when the current FrameNode is rendering its content. * * @param { DrawContext } context - The DrawContext will be used when executed draw method. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ onDraw?(context: DrawContext): void; @@ -455,6 +492,7 @@ export class FrameNode { * method. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ onMeasure(constraint: LayoutConstraint): void; @@ -466,6 +504,7 @@ export class FrameNode { * @param { Position } position - The position of the node, will be used when executed layout method. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ onLayout(position: Position): void; @@ -476,6 +515,7 @@ export class FrameNode { * @param { Size } size - The size of the FrameNode after measure. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setMeasuredSize(size: Size): void; @@ -486,6 +526,7 @@ export class FrameNode { * @param { Position } position - The position to the parent of the FrameNode after layout. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setLayoutPosition(position: Position): void; @@ -497,6 +538,7 @@ export class FrameNode { * @param { LayoutConstraint } constraint - The layout constraint of the node, supplied by the parent node. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ measure(constraint: LayoutConstraint): void; @@ -509,6 +551,7 @@ export class FrameNode { * @param { Position } position - The position of the node, will be used when executed the layout method. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ layout(position: Position): void; @@ -518,6 +561,7 @@ export class FrameNode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ setNeedsLayout(): void; @@ -527,6 +571,7 @@ export class FrameNode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ invalidate(): void; @@ -537,6 +582,7 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to screen. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToScreen(): Position; @@ -547,6 +593,7 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to window with transform. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToWindowWithTransform(): Position; @@ -557,6 +604,7 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to its parent with transform. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToParentWithTransform(): Position; @@ -567,7 +615,447 @@ export class FrameNode { * @returns { Position } - Returns position of the node relative to screen with transform. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getPositionToScreenWithTransform(): Position; + + /** + * Detach from parent and dispose all child recursively. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + disposeTree(): void; + + /** + * Mount ComponentContent to FrameNode. + * + * @param { ComponentContent } content - Newly added ComponentContent. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ + addComponentContent(content: ComponentContent): void; +} + +/** + * Used to define the FrameNode type. + * + * @interface TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +export interface TypedFrameNode extends FrameNode { + /** + * Initialize FrameNode. + * + * @type { C } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + initialize: C; + /** + * Get attribute instance of FrameNode to set attributes. + * + * @type { T } + * @readonly + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + readonly attribute: T; +} + +/** + * Provides methods to implement FrameNode. + * + * @namespace typeNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ +export namespace typeNode { + /** + * Define the FrameNode type for Text. + * + * @typedef { TypedFrameNode } Text + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Text = TypedFrameNode; + + /** + * Create a FrameNode of Text type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Text' } nodeType - node type. + * @returns { Text } - Return Text type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Text'): Text; + + /** + * Define the FrameNode type for Column. + * + * @typedef { TypedFrameNode } Column + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Column = TypedFrameNode; + + /** + * Create a FrameNode of Column type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Column' } nodeType - node type. + * @returns { Column } - Return Column type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Column'): Column; + + /** + * Define the FrameNode type for Row. + * + * @typedef { TypedFrameNode } Row + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Row = TypedFrameNode; + + /** + * Create a FrameNode of Row type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Row' } nodeType - node type. + * @returns { Row } - Return Row type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Row'): Row; + + /** + * Define the FrameNode type for Stack. + * + * @typedef { TypedFrameNode } Stack + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Stack = TypedFrameNode; + + /** + * Create a FrameNode of Stack type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Stack' } nodeType - node type. + * @returns { Stack } - Return Stack type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Stack'): Stack; + + /** + * Define the FrameNode type for GridRow. + * + * @typedef { TypedFrameNode } GridRow + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type GridRow = TypedFrameNode; + + /** + * Create a FrameNode of GridRow type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'GridRow' } nodeType - node type. + * @returns { GridRow } - Return GridRow type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'GridRow'): GridRow; + + /** + * Define the FrameNode type for GridCol. + * + * @typedef { TypedFrameNode } GridCol + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type GridCol = TypedFrameNode; + + /** + * Create a FrameNode of GridCol type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'GridCol' } nodeType - node type. + * @returns { GridCol } - Return GridCol type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'GridCol'): GridCol; + + /** + * Define the FrameNode type for Flex. + * + * @typedef { TypedFrameNode } Flex + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Flex = TypedFrameNode; + + /** + * Create a FrameNode of Flex type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Flex' } nodeType - node type. + * @returns { Flex } - Return Flex type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Flex'): Flex; + + /** + * Define the FrameNode type for Swiper. + * + * @typedef { TypedFrameNode } Swiper + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Swiper = TypedFrameNode; + + /** + * Create a FrameNode of Swiper type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Swiper' } nodeType - node type. + * @returns { Swiper } - Return Swiper type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Swiper'): Swiper; + + /** + * Define the FrameNode type for Progress. + * + * @typedef { TypedFrameNode } Progress + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Progress = TypedFrameNode; + + /** + * Create a FrameNode of Progress type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Progress' } nodeType - node type. + * @returns { Progress } - Return Progress type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Progress'): Progress; + + /** + * Define the FrameNode type for Scroll. + * + * @typedef { TypedFrameNode } Scroll + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Scroll = TypedFrameNode; + + /** + * Create a FrameNode of Scroll type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Scroll' } nodeType - node type. + * @returns { Scroll } - Return Scroll type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Scroll'): Scroll; + + /** + * Define the FrameNode type for RelativeContainer. + * + * @typedef { TypedFrameNode } RelativeContainer + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type RelativeContainer = TypedFrameNode; + + /** + * Create a FrameNode of RelativeContainer type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'RelativeContainer' } nodeType - node type. + * @returns { RelativeContainer } - Return RelativeContainer type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'RelativeContainer'): RelativeContainer; + + /** + * Define the FrameNode type for Divider. + * + * @typedef { TypedFrameNode } Divider + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Divider = TypedFrameNode; + + /** + * Create a FrameNode of Divider type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Divider' } nodeType - node type. + * @returns { Divider } - Return Divider type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Divider'): Divider; + + /** + * Define the FrameNode type for LoadingProgress. + * + * @typedef { TypedFrameNode } LoadingProgress + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type LoadingProgress = TypedFrameNode; + + /** + * Create a FrameNode of LoadingProgress type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'LoadingProgress' } nodeType - node type. + * @returns { LoadingProgress } - Return LoadingProgress type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'LoadingProgress'): LoadingProgress; + + /** + * Define the FrameNode type for Search. + * + * @typedef { TypedFrameNode } Search + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Search = TypedFrameNode; + + /** + * Create a FrameNode of Search type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Search' } nodeType - node type. + * @returns { Search } - Return Search type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Search'): Search; + + /** + * Define the FrameNode type for Blank. + * + * @typedef { TypedFrameNode } Blank + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Blank = TypedFrameNode; + + /** + * Create a FrameNode of Blank type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Blank' } nodeType - node type. + * @returns { Blank } - Return Blank type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Blank'): Blank; + + /** + * Define the FrameNode type for Image. + * + * @typedef { TypedFrameNode } Image + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type Image = TypedFrameNode; + + /** + * Create a FrameNode of Image type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Image' } nodeType - node type. + * @returns { Image } - Return Image type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'Image'): Image; + + /** + * Define the FrameNode type for List. + * + * @typedef { TypedFrameNode } List + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type List = TypedFrameNode; + + /** + * Create a FrameNode of List type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'List' } nodeType - node type. + * @returns { List } - Return List type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'List'): List; + + /** + * Define the FrameNode type for ListItem. + * + * @typedef { TypedFrameNode } ListItem + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + type ListItem = TypedFrameNode; + + /** + * Create a FrameNode of ListItem type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'ListItem' } nodeType - node type. + * @returns { ListItem } - Return ListItem type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 12 + */ + function createNode(context: UIContext, nodeType: 'ListItem'): ListItem; } \ No newline at end of file diff --git a/api/arkui/Graphics.d.ts b/api/arkui/Graphics.d.ts index 17fe5eb72a71aa4f3e70e2ae42efdf38cf3e144a..e6553b9cf4e0d1497bc44eff74bbe7674ee28e9b 100644 --- a/api/arkui/Graphics.d.ts +++ b/api/arkui/Graphics.d.ts @@ -359,6 +359,14 @@ export type Offset = Vector2; * @crossplatform * @since 11 */ +/** + * Position info. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ export type Position = Vector2; /** @@ -539,6 +547,7 @@ export declare interface Frame { * @interface Edges * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface Edges { @@ -548,6 +557,7 @@ export interface Edges { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ left: T, @@ -558,6 +568,7 @@ export interface Edges { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ right: T, @@ -568,6 +579,7 @@ export interface Edges { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ top: T, @@ -578,6 +590,7 @@ export interface Edges { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ bottom: T @@ -589,6 +602,7 @@ export interface Edges { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare enum LengthUnit { @@ -599,6 +613,7 @@ declare enum LengthUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ PX = 0, @@ -608,6 +623,7 @@ declare enum LengthUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ VP = 1, @@ -618,6 +634,7 @@ declare enum LengthUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ FP = 2, @@ -628,6 +645,7 @@ declare enum LengthUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ PERCENT = 3, @@ -637,6 +655,7 @@ declare enum LengthUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ LPX = 4, @@ -648,6 +667,7 @@ declare enum LengthUnit { * @interface SizeT * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export interface SizeT { @@ -657,6 +677,7 @@ export interface SizeT { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ width: T; @@ -667,6 +688,7 @@ export interface SizeT { * @type { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ height: T; @@ -706,6 +728,7 @@ export enum LengthMetricsUnit { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare class LengthMetrics { @@ -716,6 +739,7 @@ declare class LengthMetrics { * @param { LengthUnit } [unit] - The length unit. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ constructor(value: number, unit?:LengthUnit); @@ -728,6 +752,7 @@ declare class LengthMetrics { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ static px(value: number): LengthMetrics; @@ -740,6 +765,7 @@ declare class LengthMetrics { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ static vp(value: number): LengthMetrics; @@ -752,6 +778,7 @@ declare class LengthMetrics { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ static fp(value: number): LengthMetrics; @@ -764,6 +791,7 @@ declare class LengthMetrics { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ static percent(value: number): LengthMetrics; @@ -776,6 +804,7 @@ declare class LengthMetrics { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ static lpx(value: number): LengthMetrics; @@ -787,6 +816,7 @@ declare class LengthMetrics { * @default VP * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ public unit: LengthUnit; @@ -797,114 +827,120 @@ declare class LengthMetrics { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ public value: number; } /** -* Defines the ColorMetrics class. -* -* @syscap SystemCapability.ArkUI.ArkUI.Full -* @crossplatform -* @since 12 -*/ + * Defines the ColorMetrics class. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ declare class ColorMetrics { /** - * Instantiate the ColorMetrics class using color number - * - * @param { number } value - color number - * @returns { ColorMetrics } ColorMetrics class - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Instantiate the ColorMetrics class using color number + * + * @param { number } value - color number + * @returns { ColorMetrics } ColorMetrics class + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ static numeric(value: number): ColorMetrics; /** - * Instantiate the ColorMetrics class using color rgb - * - * @param { number } red - red value of rgba - * @param { number } green - green value of rgba - * @param { number } blue - blue value of rgba - * @param { number } alpha - opacity value of rgba - * @returns { ColorMetrics } ColorMetrics class - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Instantiate the ColorMetrics class using color rgb + * + * @param { number } red - red value of rgba + * @param { number } green - green value of rgba + * @param { number } blue - blue value of rgba + * @param { number } alpha - opacity value of rgba + * @returns { ColorMetrics } ColorMetrics class + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ static rgba(red: number, green: number, blue: number, alpha?: number): ColorMetrics; /** - * Instantiate the ColorMetrics class using ResourceColor - * - * @param { ResourceColor } color - resource color - * @returns { ColorMetrics } ColorMetrics class - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Instantiate the ColorMetrics class using ResourceColor + * + * @param { ResourceColor } color - resource color + * @returns { ColorMetrics } ColorMetrics class + * @throws { BusinessError } 180003 - Failed to obtain the color resource. + * @throws { BusinessError } 401 - Parameter error. Possible cause: + * 1. The type of the input color parameter is not ResourceColor. + * 2. The format of the input color string is not RGB or RGBA. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ static resourceColor(color: ResourceColor): ColorMetrics; /** - * blend color - * - * @param { ColorMetrics } overlayColor - overlay color - * @returns { ColorMetrics } ColorMetrics class - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * blend color + * + * @param { ColorMetrics } overlayColor - overlay color + * @returns { ColorMetrics } ColorMetrics class + * @throws { BusinessError } 401 - Parameter error. The type of the input parameter is not ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ blendColor(overlayColor: ColorMetrics): ColorMetrics; /** - * Get color of the ColorMetrics. - * - * @returns { string } The color of the ColorMetrics. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Get color of the ColorMetrics. + * + * @returns { string } The color of the ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ get color(): string; /** - * Get red value of the ColorMetrics. - * - * @returns { number } The red value of the ColorMetrics. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Get red value of the ColorMetrics. + * + * @returns { number } The red value of the ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ get red(): number; /** - * Get green value of the ColorMetrics. - * - * @returns { number } The green value of the ColorMetrics. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Get green value of the ColorMetrics. + * + * @returns { number } The green value of the ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ get green(): number; /** - * Get blue value of the ColorMetrics. - * - * @returns { number } The blue value of the ColorMetrics. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Get blue value of the ColorMetrics. + * + * @returns { number } The blue value of the ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ get blue(): number; /** - * Get opacity value of the ColorMetrics. - * - * @returns { number } The opacity value of the ColorMetrics. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 12 - */ + * Get opacity value of the ColorMetrics. + * + * @returns { number } The opacity value of the ColorMetrics. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ get alpha(): number; } diff --git a/api/arkui/NodeContent.d.ts b/api/arkui/NodeContent.d.ts index 249e2bb3b69bf595d622962ea020a7b7b050e426..62534e358cb403367bbc738f4eda6579676e4d42 100644 --- a/api/arkui/NodeContent.d.ts +++ b/api/arkui/NodeContent.d.ts @@ -38,4 +38,24 @@ export class NodeContent extends Content{ * @since 12 */ constructor(); + + /** + * Add FrameNode to NodeContent based on parameters. + * + * @param { FrameNode } node - Newly added FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + addFrameNode(node: FrameNode): void; + + /** + * Delete FrameNode based on the NodeContent parameter. + * + * @param { FrameNode } node - FrameNode deleted. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 12 + */ + removeFrameNode(node: FrameNode): void; } diff --git a/api/bundleManager/AppProvisionInfo.d.ts b/api/bundleManager/AppProvisionInfo.d.ts index 6b755d0e8773c7a0d3031bbe74c0e0ca963a92f4..3175bf232ae68ce73a44fe110f9a8fff7a1020de 100644 --- a/api/bundleManager/AppProvisionInfo.d.ts +++ b/api/bundleManager/AppProvisionInfo.d.ts @@ -126,7 +126,6 @@ export interface AppProvisionInfo { * @since 10 */ readonly issuer: string; - /** * Globally unique identifier of an application, which is allocated by the cloud. * AppIdentifier does not change along the application lifecycle, including version updates, certificate changes, diff --git a/api/bundleManager/ApplicationInfo.d.ts b/api/bundleManager/ApplicationInfo.d.ts index 53c15cc39cfe7c28edcf93f45eb441ea15da6d3c..94bfea7859551c70031b4d13585b8b7f9b5f7acb 100644 --- a/api/bundleManager/ApplicationInfo.d.ts +++ b/api/bundleManager/ApplicationInfo.d.ts @@ -654,4 +654,4 @@ export interface PreinstalledApplicationInfo { * @since 12 */ readonly labelId: number; -} \ No newline at end of file +} diff --git a/api/bundleManager/HapModuleInfo.d.ts b/api/bundleManager/HapModuleInfo.d.ts index 026428585532d91f7556cd67b4846528f37edb32..594389df409e83f26a66192d25758e639edac52e 100644 --- a/api/bundleManager/HapModuleInfo.d.ts +++ b/api/bundleManager/HapModuleInfo.d.ts @@ -449,26 +449,26 @@ export interface HapModuleInfo { */ readonly routerMap: Array; - /** - * Indicates the code path + /** + * Indicates native library path. * * @type { string } * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice * @since 12 */ - readonly codePath: string; + readonly nativeLibraryPath: string; - /** - * Indicates native library path. + /** + * Indicates the code path * * @type { string } * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice * @since 12 */ - readonly nativeLibraryPath: string; + readonly codePath: string; } /** @@ -613,7 +613,38 @@ export interface RouterItem { */ readonly buildFunction: string; /** - * Indicates the json string of custom data + * Indicates the custom data + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 12 + */ + readonly data: Array; +} + +/** + * Indicates the data item defined in router item + * + * @typedef DataItem + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 12 + */ +export interface DataItem { + /** + * Indicates the key of the custom data item + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 12 + */ + readonly key: string; + /** + * Indicates the value of the custom data item * * @type { string } * @readonly @@ -621,5 +652,5 @@ export interface RouterItem { * @atomicservice * @since 12 */ - readonly data: string; + readonly value: string; } \ No newline at end of file diff --git a/api/bundleManager/Skill.d.ts b/api/bundleManager/Skill.d.ts index 9f5df417148536a726d614565ed464bf50fb0b27..ef54bff027d786da78400d32aaf67bb982fdaa44 100644 --- a/api/bundleManager/Skill.d.ts +++ b/api/bundleManager/Skill.d.ts @@ -54,6 +54,17 @@ export interface Skill { * @since 12 */ readonly uris: Array; + + /** + * Indicates the domainVerify of the skill + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 12 + */ + readonly domainVerify: boolean; } /** diff --git a/api/commonEvent/commonEventPublishData.d.ts b/api/commonEvent/commonEventPublishData.d.ts index 2b13d3ffc2c8db3568bd0405a552a2eee3079662..3b6865ac24a92c9a3f7b57cfe862cfeba9bbbd3c 100644 --- a/api/commonEvent/commonEventPublishData.d.ts +++ b/api/commonEvent/commonEventPublishData.d.ts @@ -33,6 +33,15 @@ * @atomicservice * @since 11 */ +/** + * containing the common event content and attributes + * + * @typedef CommonEventPublishData + * @syscap SystemCapability.Notification.CommonEvent + * @crossplatform + * @atomicservice + * @since 12 + */ export interface CommonEventPublishData { /** * bundle name @@ -85,6 +94,15 @@ export interface CommonEventPublishData { * @atomicservice * @since 11 */ + /** + * The custom result data of the common event. + * + * @type { ?string } + * @syscap SystemCapability.Notification.CommonEvent + * @crossplatform + * @atomicservice + * @since 12 + */ data?: string; /** diff --git a/api/commonEvent/commonEventSubscriber.d.ts b/api/commonEvent/commonEventSubscriber.d.ts index cd76794d081d436f96a396f7f093cbe128eda294..0345b7a06a43ca4e2dc3340bd6fa3c8b0b848de0 100644 --- a/api/commonEvent/commonEventSubscriber.d.ts +++ b/api/commonEvent/commonEventSubscriber.d.ts @@ -130,7 +130,8 @@ export interface CommonEventSubscriber { * Sets the result code of the current ordered common event. * * @param { number } code - Indicates the custom result code to set. You can set it to any value. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 10 */ @@ -138,7 +139,8 @@ export interface CommonEventSubscriber { * Sets the result code of the current ordered common event. * * @param { number } code - Indicates the custom result code to set. You can set it to any value. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @atomicservice * @since 11 @@ -238,7 +240,8 @@ export interface CommonEventSubscriber { * Sets the result data of the current ordered common event. * * @param { string } data - Indicates the custom result data to set. You can set it to any character string. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 10 */ @@ -246,7 +249,8 @@ export interface CommonEventSubscriber { * Sets the result data of the current ordered common event. * * @param { string } data - Indicates the custom result data to set. You can set it to any character string. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @atomicservice * @since 11 @@ -300,7 +304,8 @@ export interface CommonEventSubscriber { * * @param { number } code - Indicates the custom result code to set. You can set it to any value. * @param { string } data - Indicates the custom result data to set. You can set it to any character string. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @since 10 */ @@ -309,7 +314,8 @@ export interface CommonEventSubscriber { * * @param { number } code - Indicates the custom result code to set. You can set it to any value. * @param { string } data - Indicates the custom result data to set. You can set it to any character string. - * @throws { BusinessError } 401 - If the input parameter is not valid parameter. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @atomicservice * @since 11 diff --git a/api/global/sendableResource.d.ets b/api/global/sendableResource.d.ets new file mode 100755 index 0000000000000000000000000000000000000000..b318d314fead5c915aa73a3259b90803b502c559 --- /dev/null +++ b/api/global/sendableResource.d.ets @@ -0,0 +1,89 @@ +/* +* Copyright (c) 2024 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** + * @file + * @kit LocalizationKit + */ + +import lang from '../../arkts/@arkts.lang'; +import collections from '../../arkts/@arkts.collections'; + +/** + * Contains sendable resource descriptor information. + * + * @interface SendableResource + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ +interface SendableResource extends lang.ISendable { + + /** + * bundle name in hap + * + * @type { string } + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + bundleName: string; + + /** + * module name in hap + * + * @type { string } + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + moduleName: string; + + /** + * resource id in hap + * + * @type { number } + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + id: number; + + /** + * Set params. + * + * @type { ?collections.Array } + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + params?: collections.Array ; + + /** + * Set type. + * + * @type { ?number } + * @syscap SystemCapability.Global.ResourceManager + * @crossplatform + * @atomicservice + * @since 12 + */ + type?: number; +} \ No newline at end of file diff --git a/api/multimedia/ringtonePlayer.d.ts b/api/multimedia/ringtonePlayer.d.ts index 56716ef7f9ff98fa9c91ec1ae120a3750e6ee8eb..9025a7a49e9ccb392682a4eede999f7295585729 100644 --- a/api/multimedia/ringtonePlayer.d.ts +++ b/api/multimedia/ringtonePlayer.d.ts @@ -166,8 +166,10 @@ export interface RingtonePlayer { * triggered when audio playback is interrupted. * @param { 'audioInterrupt' } type - Type of the event to listen for. Only the audioInterrupt event is supported. * @param { Callback } callback - Callback used to listen for interrupt callback. - * @throws { BusinessError } 401 - if input parameter type or number mismatch - * @throws { BusinessError } 6800101 - if input parameter value error + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 10 @@ -177,8 +179,10 @@ export interface RingtonePlayer { /** * Unsubscribes to audio interrupt events. * @param { 'audioInterrupt' } type - Type of the event to listen for. Only the audioInterrupt event is supported. - * @throws { BusinessError } 401 - if input parameter type or number mismatch - * @throws { BusinessError } 6800101 - if input parameter value error + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi * @since 10 diff --git a/api/multimedia/soundPool.d.ts b/api/multimedia/soundPool.d.ts index f33ea7a7e9f88773f4a2c7d0c44ce164e6fabeec..19653a782cc0bdc1ef4274f545569e2d5521a770 100644 --- a/api/multimedia/soundPool.d.ts +++ b/api/multimedia/soundPool.d.ts @@ -408,3 +408,4 @@ export interface SoundPool { */ off(type: 'error'): void; } + diff --git a/api/multimedia/systemTonePlayer.d.ts b/api/multimedia/systemTonePlayer.d.ts index e76a56848130adb490d1df0ad38702075fcda0d5..ceb2f3c18aba26128d134f9a6ab5ae4dfe73e6a2 100644 --- a/api/multimedia/systemTonePlayer.d.ts +++ b/api/multimedia/systemTonePlayer.d.ts @@ -52,7 +52,9 @@ export interface SystemTonePlayer { * @returns { Promise } Promise used to return the id of this playback. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400102 - Operation not allowed. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -65,7 +67,9 @@ export interface SystemTonePlayer { * @param { number } id - The Playback id to stop. * @returns { Promise } Promise used to return result of this stop. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - The parameters check failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. * @throws { BusinessError } 5400102 - Operation not allowed. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi diff --git a/api/notification/notificationContent.d.ts b/api/notification/notificationContent.d.ts index 725f637788797084d0a60416e197438848b9ab7e..67490f0104ad2ea42174500c30d1622ef8e434f6 100644 --- a/api/notification/notificationContent.d.ts +++ b/api/notification/notificationContent.d.ts @@ -425,7 +425,7 @@ export interface NotificationTime { initialTime?: number; /** - * + * * Count down the time. * * @type { ?boolean } diff --git a/api/notification/notificationRequest.d.ts b/api/notification/notificationRequest.d.ts index 1c03189d83a829ac0fe44a7345ca0aa4b8bdfb0a..7be136742286ae159f5eb43488a6573a54a9f33f 100644 --- a/api/notification/notificationRequest.d.ts +++ b/api/notification/notificationRequest.d.ts @@ -440,16 +440,6 @@ export interface NotificationRequest { */ badgeNumber?: number; - /** - * Notification control flags. - * - * @type { ?number } - * @syscap SystemCapability.Notification.Notification - * @systemapi - * @since 12 - */ - notificationControlFlags?: number; - /** * Whether the notification need to be agent display. * @@ -479,6 +469,16 @@ export interface NotificationRequest { * @since 12 */ unifiedGroupInfo?: UnifiedGroupInfo; + + /** + * Notification control flags. + * + * @type { ?number } + * @syscap SystemCapability.Notification.Notification + * @systemapi + * @since 12 + */ + notificationControlFlags?: number; } /** diff --git a/api/tag/nfctech.d.ts b/api/tag/nfctech.d.ts index 9c5381e8de86183b670f0e870d1c024eaaa4f303..acbd8e9fb4b84c26bba5a77ba1d49f8995e4490d 100644 --- a/api/tag/nfctech.d.ts +++ b/api/tag/nfctech.d.ts @@ -302,7 +302,10 @@ export interface IsoDepTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } Returns true if extended apdu length supported, otherwise false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -313,7 +316,10 @@ export interface IsoDepTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } Returns true if extended apdu length supported, otherwise false. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -328,7 +334,10 @@ export interface IsoDepTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -339,7 +348,10 @@ export interface IsoDepTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -456,7 +468,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } The NDEF message in tag. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -467,7 +482,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } The NDEF message in tag. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -482,7 +500,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -493,7 +514,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -509,7 +533,10 @@ export interface NdefTag extends TagSession { * @param { NdefMessage } msg - The NDEF message to be written. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -521,7 +548,10 @@ export interface NdefTag extends TagSession { * @param { NdefMessage } msg - The NDEF message to be written. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -537,7 +567,10 @@ export interface NdefTag extends TagSession { * @param { NdefMessage } msg - The NDEF message to be written. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -549,7 +582,10 @@ export interface NdefTag extends TagSession { * @param { NdefMessage } msg - The NDEF message to be written. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -587,7 +623,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -598,7 +637,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -613,7 +655,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -624,7 +669,10 @@ export interface NdefTag extends TagSession { * @permission ohos.permission.NFC_TAG * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -638,7 +686,10 @@ export interface NdefTag extends TagSession { * * @param { tag.NfcForumType } type - NFC forum type of NDEF tag. * @returns { string } The NFC forum string type. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -647,7 +698,10 @@ export interface NdefTag extends TagSession { * * @param { tag.NfcForumType } type - NFC forum type of NDEF tag. * @returns { string } The NFC forum string type. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -680,7 +734,10 @@ export interface MifareClassicTag extends TagSession { * @param { boolean } isKeyA - KeyA flag. true means KeyA, otherwise KeyB. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -694,7 +751,10 @@ export interface MifareClassicTag extends TagSession { * @param { boolean } isKeyA - KeyA flag. true means KeyA, otherwise KeyB. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -712,7 +772,10 @@ export interface MifareClassicTag extends TagSession { * @param { boolean } isKeyA - KeyA flag. true means KeyA, otherwise KeyB. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -726,7 +789,10 @@ export interface MifareClassicTag extends TagSession { * @param { boolean } isKeyA - KeyA flag. true means KeyA, otherwise KeyB. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -742,7 +808,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of block to read. * @returns { Promise } Returns the block data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -754,7 +823,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of block to read. * @returns { Promise } Returns the block data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -770,7 +842,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of block to read. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -782,7 +857,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of block to read. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -799,7 +877,10 @@ export interface MifareClassicTag extends TagSession { * @param { number[] } data - The block data to write. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -812,7 +893,10 @@ export interface MifareClassicTag extends TagSession { * @param { number[] } data - The block data to write. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -829,7 +913,10 @@ export interface MifareClassicTag extends TagSession { * @param { number[] } data - The block data to write. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -842,7 +929,10 @@ export interface MifareClassicTag extends TagSession { * @param { number[] } data - The block data to write. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -859,7 +949,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to increment, none-negative. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -872,7 +965,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to increment, none-negative. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -889,7 +985,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to increment, none-negative. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -902,7 +1001,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to increment, none-negative. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -919,7 +1021,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to decrease, none-negative. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -932,7 +1037,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to decrease, none-negative. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -949,7 +1057,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to decrease, none-negative. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -962,7 +1073,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } value - The value to decrease, none-negative. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -978,7 +1092,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be written. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -990,7 +1107,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be written. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1006,7 +1126,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be written. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1018,7 +1141,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be written. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1034,7 +1160,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be moved from. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1046,7 +1175,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be moved from. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1062,7 +1194,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be moved from. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1074,7 +1209,10 @@ export interface MifareClassicTag extends TagSession { * @param { number } blockIndex - The index of value block to be moved from. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1105,7 +1243,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } sectorIndex - The index of sector. * @returns { number } Returns the number of blocks. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1114,7 +1255,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } sectorIndex - The index of sector. * @returns { number } Returns the number of blocks. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1177,7 +1321,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } sectorIndex - The index of sector. * @returns { number } Returns index of first block in the sector. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1186,7 +1333,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } sectorIndex - The index of sector. * @returns { number } Returns index of first block in the sector. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1198,7 +1348,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } blockIndex - The index of block. * @returns { number } Returns the sector index. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ @@ -1207,7 +1360,10 @@ export interface MifareClassicTag extends TagSession { * * @param { number } blockIndex - The index of block. * @returns { number } Returns the sector index. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 @@ -1238,7 +1394,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number } pageIndex - The index of page to read. * @returns { Promise } Returns 4 pages data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1250,7 +1409,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number } pageIndex - The index of page to read. * @returns { Promise } Returns 4 pages data. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1266,7 +1428,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number } pageIndex - The index of page to read. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1278,7 +1443,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number } pageIndex - The index of page to read. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1295,7 +1463,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number[] } data - The page data to write. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1308,7 +1479,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number[] } data - The page data to write. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1325,7 +1499,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number[] } data - The page data to write. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1338,7 +1515,10 @@ export interface MifareUltralightTag extends TagSession { * @param { number[] } data - The page data to write. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1388,7 +1568,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1400,7 +1583,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1416,7 +1602,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1428,7 +1617,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1444,7 +1636,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1456,7 +1651,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @returns { Promise } The void * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag @@ -1472,7 +1670,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag * @since 9 @@ -1484,7 +1685,10 @@ export interface NdefFormatableTag extends TagSession { * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag diff --git a/api/tag/tagSession.d.ts b/api/tag/tagSession.d.ts index c744f9e43127a98a36c1bf8b1a38090ba7a4fdb4..c881e567168bdc4219891b93bdaf55562ef9d435 100644 --- a/api/tag/tagSession.d.ts +++ b/api/tag/tagSession.d.ts @@ -174,7 +174,10 @@ export interface TagSession { * @permission ohos.permission.NFC_TAG * @param { number } timeout Indicates the timeout duration to be set. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -186,7 +189,10 @@ export interface TagSession { * @permission ohos.permission.NFC_TAG * @param { number } timeout Indicates the timeout duration to be set. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -268,7 +274,10 @@ export interface TagSession { * @returns { Promise } Returns bytes received in response. Or bytes with a length of 0 if the * data fails to be written to the tag. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -282,7 +291,10 @@ export interface TagSession { * @returns { Promise } Returns bytes received in response. Or bytes with a length of 0 if the * data fails to be written to the tag. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. @@ -299,7 +311,10 @@ export interface TagSession { * @param { number[] } data Indicates the data to be written to the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.Tag @@ -312,7 +327,10 @@ export interface TagSession { * @param { number[] } data Indicates the data to be written to the tag. * @param { AsyncCallback } callback The callback. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 401 - The parameter check failed. Possible causes: + *
    1. Mandatory parameters are left unspecified. + *
    2. Incorrect parameters types. + *
    3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. * @throws { BusinessError } 3100204 - Tag I/O operation failed. diff --git a/arkts/@arkts.collections.d.ets b/arkts/@arkts.collections.d.ets index 91769cdbfb05fedde1f05d3505effd78207d5b3d..068169f2153b7957ad908051a47c608aec39d233 100644 --- a/arkts/@arkts.collections.d.ets +++ b/arkts/@arkts.collections.d.ets @@ -18,6 +18,8 @@ * @kit ArkTS */ +import lang from './@arkts.lang' + /** * ArkTS collections. * @@ -96,18 +98,73 @@ declare namespace collections { */ type TypedArrayCompareFn = (first: ElementType, second: ElementType) => number; /** - * Array is a data structure that is implemented based on array. + * Redefines ISendable for convenience. + * + * @typedef { lang.ISendable } ISendable + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + type ISendable = lang.ISendable; + /** + * Represents an array-like object that can be concatenated. + * + * @interface ConcatArray + * @syscap SystemCapability.Utils.Lang + * @since 12 + */ + interface ConcatArray extends ISendable { + /** + * Gets the length of the ArkTS ConcatArray. This is a number one higher than the highest index in the array. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Utils.Lang + * @since 12 + */ + readonly length: number; + /** + * Adds all the elements of an ArkTS ConcatArray into a string, separated by the specified separator string. + * + * @param { string } [separator] - A string used to separate one element of the array from + * the next in the resulting string. If omitted, the array elements are separated with a comma. + * @returns { string } A string with all array elements joined. + * If ConcatArray.length is 0, the empty string is returned. + * @throws { BusinessError } 401 - Parameter error. Invalid separator. + * @syscap SystemCapability.Utils.Lang + * @since 12 + */ + join(separator?: string): string; + /** + * Returns a copy of a section of an ArkTS ConcatArray. + * + * @param { number } [start] - The beginning index of the specified portion of the array. + * If start is undefined, then the slice begins at index 0. + * @param { number } [end] - The end index of the specified portion of the array. + * This is exclusive of the element at the index 'end'. + * If end is undefined, then the slice extends to the end of the array. + * @returns { ConcatArray } A new ConcatArray containing the extracted elements. + * @throws { BusinessError } 401 - Parameter error. Invalid `start` or `end` parameters. + * @syscap SystemCapability.Utils.Lang + * @since 12 + */ + slice(start?: number, end?: number): ConcatArray; + } + /** + * Array is a data structure that stores a collection of elements. * If multiple threads access a Array instance concurrently, * and at least one of the threads modifies the array structurally, * it must be synchronized externally. * + * @implements ConcatArray * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice * @since 12 */ @Sendable - class Array { + class Array implements ConcatArray { /** * Gets the length of the ArkTS array. This is a number one higher than the highest index in the ArkTS array. * @@ -123,7 +180,6 @@ declare namespace collections { * Creates an ArkTS Array with arrayLength elements initialized to initialValue. * * @param { number } arrayLength - The length of the array. - * @returns { Array } A new Array instance * @param { T } initialValue - Element initial value that will be filled into the Array. * @returns { Array } A new Array instance * @throws { BusinessError } 401 - Parameter error. @@ -548,6 +604,18 @@ declare namespace collections { * @since 12 */ [index: number]: T; + /** + * Concatenates two or more arrays. + * + * @param { ConcatArray[] } items - The arrays to concatenate. + * @returns { Array } A new array containing the elements of the concatenated arrays. + * @throws { BusinessError } 401 - Parameter error. Not a valid array. + * @throws { BusinessError } 10200011 - The concat method cannot be bound. + * @throws { BusinessError } 10200201 - Concurrent modification error. + * @syscap SystemCapability.Utils.Lang + * @since 12 + */ + concat(...items: ConcatArray[]): Array; } /** diff --git a/arkts/@arkts.math.Decimal.d.ets b/arkts/@arkts.math.Decimal.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..5253392bd58d784b13a0651e4844e53470d4db08 --- /dev/null +++ b/arkts/@arkts.math.Decimal.d.ets @@ -0,0 +1,2062 @@ +/* + * Copyright (c) 2024 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file Defines the Decimal for ArkTS. Decimal support arbitrary precision decimal operation. + * @kit ArkTS + */ + +/** + * The type uesd to set rounding + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ +type Rounding = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8; + +/** + * The type uesd to set modulo + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ +type Modulo = Rounding | 9; + +/** + * The type uesd to denote decimal value + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ +type Value = string | number | Decimal; + +/** + * Provides configuration for decimal. + * + * @interface DecimalConfig + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ +interface DecimalConfig { + /** + * The maximum number of significant digits of the result of an operation. + * Default value: 20 + * + * @type { number } integer, 1 to 1e+9 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + precision?: number; + /** + * The default rounding mode used when rounding the result of an operation to precision significant digits, + * and when rounding the return value of the round, toBinary, toDecimalPlaces, toExponential, toFixed, + * toHexadecimal, toNearest, toOctal, toPrecision and toSignificantDigits methods. + * Default value: 4 (ROUND_HALF_UP) + * + * @type { number } integer, integer, 0 to 8 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + rounding?: Rounding; + /** + * The negative exponent value at and below which toString returns exponential notation. + * Default value: -7 + * + * @type { number } integer, -9e15 to 0 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toExpNeg?: number; + /** + * The positive exponent value at and above which toString returns exponential notation. + * Default value: 20 + * + * @type { number } integer, 0 to 9e15 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toExpPos?: number; + /** + * The negative exponent limit, i.e. the exponent value below which underflow to zero occurs. + * Default value: -9e15 + * + * @type { number } integer, -9e15 to 0 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + minE?: number; + /** + * The positive exponent limit, i.e. the exponent value above which overflow to Infinity occurs. + * Default value: 9e15 + * + * @type { number } integer, 0 to 9e15 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + maxE?: number; + /** + * The value that determines whether cryptographically-secure pseudo-random number generation is used. + * Default value: false + * + * @type { boolean } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + crypto?: boolean; + /** + * The modulo mode used when calculating the modulus: a mod n. + * Default value: 1 (ROUND_DOWN) + * + * @type { number } integer, 0 to 9 inclusive + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + modulo?: Modulo; + /** + * If object has a 'defaults' property with value true then the new constructor will use the default configuration. + * Default value: false + * + * @type { boolean } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + defaults?: boolean; +} + +/** + * An arbitrary-precision Decimal type + * + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ +declare class Decimal { + /** + * The numbers of decimal digits. + * + * @type { number[] } + * @readonly + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + readonly d: number[]; + + /** + * The number of decimal exponent. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + readonly e: number; + + /** + * The number of decimal sign. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + readonly s: number; + + /** + * Return a new Decimal whose value is the absolute value of this Decimal. + * + * @param { Value } n {number | string | Decimal} + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + constructor(n: Value); + + /** + * Return a new Decimal whose value is the absolute value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + abs(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a whole number in the + * direction of negative Infinity. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + floor(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a whole number in the + * direction of positive Infinity. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + ceil(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal truncated to a whole number. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + trunc(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal clamped to the range + * delineated by `min` and `max`. + * + * @param { Value } min {number | string | Decimal} + * @param { Value } max {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200001 - The value of `min` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + clamp(min: Value, max: Value): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal plus `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + add(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal minus `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + sub(n: Value): Decimal; + + /** + * Return a new Decimal whose value is this Decimal times `n`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + mul(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal divided by `n`, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + div(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal modulo `n`, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal }the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + mod(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the square root of this Decimal, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + sqrt(): Decimal; + + /** + * Return a new Decimal whose value is the cube root of the value of this Decimal, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + cbrt(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal raised to the power `n`, rounded + * to `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + pow(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the natural exponential of the value of this Decimal, + * i.e. the base e raised to the power the value of this Decimal, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + exp(): Decimal; + + /** + * Return the logarithm of the value of this Decimal to the specified base, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + log(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the natural logarithm of the value of this Decimal, + * rounded to `precision` significant digits using rounding mode `rounding`. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + ln(): Decimal; + + /** + * Return a new Decimal whose value is the cosine of the value in radians of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + cos(): Decimal; + + /** + * Return a new Decimal whose value is the sine of the value in radians of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + sin(): Decimal; + + /** + * Return a new Decimal whose value is the tangent of the value in radians of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + tan(): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic cosine of the value in radians of this + * Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + cosh(): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic sine of the value in radians of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + sinh(): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic tangent of the value in radians of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + tanh(): Decimal; + + /** + * Return a new Decimal whose value is the arccosine (inverse cosine) in radians of the value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + acos(): Decimal; + + /** + * Return a new Decimal whose value is the arcsine (inverse sine) in radians of the value of this + * Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + asin(): Decimal; + + /** + * Return a new Decimal whose value is the arctangent (inverse tangent) in radians of the value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + atan(): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic cosine in radians of the + * value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + acosh(): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic sine in radians of the value + * of this Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + asinh(): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic tangent in radians of the + * value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + atanh(): Decimal; + + /** + * Return + * 1 if the value of this Decimal is greater than the value of `n`, + * -1 if the value of this Decimal is less than the value of `n`, + * 0 if they have the same value, + * NaN if the value of either Decimal is NaN. + * + * @param { Value } n {number | string | Decimal} + * @returns { number } the number type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + comparedTo(n: Value): number; + + /** + * Return true if the value of this Decimal is equal to the value of `n`, otherwise return false. + * + * @param { Value } n {number | string | Decimal} + * @returns { boolean } the boolean type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + equals(n: Value): boolean; + + /** + * Return true if the value of this Decimal is greater than the value of `n`, otherwise return false. + * + * @param { Value } n {number | string | Decimal} + * @returns { boolean } the boolean type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + greaterThan(n: Value): boolean; + + /** + * Return true if the value of this Decimal is greater than or equal to the value of `n`, + * otherwise return false. + * + * @param { Value } n {number | string | Decimal} + * @returns { boolean } the boolean type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + greaterThanOrEqualTo(n: Value): boolean; + + /** + * Return true if the value of this Decimal is less than `n`, otherwise return false. + * + * @param { Value } n {number | string | Decimal} + * @returns { boolean } the boolean type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + lessThan(n: Value): boolean; + + /** + * Return true if the value of this Decimal is less than or equal to `n`, otherwise return false. + * + * @param { Value } n {number | string | Decimal} + * @returns { boolean } the boolean type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + lessThanOrEqualTo(n: Value): boolean; + + /** + * Return true if the value of this Decimal is a finite number, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isFinite(): boolean; + + /** + * Return true if the value of this Decimal is an integer, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isInteger(): boolean; + + /** + * Return true if the value of this Decimal is NaN, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isNaN(): boolean; + + /** + * Return true if the value of this Decimal is negative, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isNegative(): boolean; + + /** + * Return true if the value of this Decimal is positive, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isPositive(): boolean; + + /** + * Return true if the value of this Decimal is 0 or -0, otherwise return false. + * + * @returns { boolean } the boolean type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + isZero(): boolean; + + /** + * Return a new Decimal whose value is the integer part of dividing the value of this Decimal + * by the value of `n`, rounded to `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + dividedToIntegerBy(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal negated, i.e. as if multiplied by -1. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + negate(): Decimal; + + /** + * Return a string representing the value of this Decimal in base 2. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toBinary(): string; + + /** + * Return a string representing the value of this Decimal in base 2, round to `significantDigits` + * significant digits. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toBinary(significantDigits: number): string; + + /** + * Return a string representing the value of this Decimal in base 2, round to `significantDigits` + * significant digits using rounding mode `rounding`. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toBinary(significantDigits: number, rounding: Rounding): string; + + /** + * Return a string representing the value of this Decimal in base 8. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toOctal(): string; + + /** + * Return a string representing the value of this Decimal in base 8, round to `significantDigits` significant. + * + * @param { number } significantDigits {number | string | Decimal} + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toOctal(significantDigits: number): string; + + /** + * Return a string representing the value of this Decimal in base 8, round to `significantDigits` significant + * digits using rounding mode `rounding`. + * + * @param { number } significantDigits {number | string | Decimal} + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toOctal(significantDigits: number, rounding: Rounding): string; + + /** + * Return a string representing the value of this Decimal in base 16 + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toHexadecimal(): string; + + /** + * Return a string representing the value of this Decimal in base 16, round to `significantDigits` significant. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toHexadecimal(significantDigits: number): string; + + /** + * Return a string representing the value of this Decimal in base 16, round to `significantDigits` significant + * digits using rounding mode `rounding`. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toHexadecimal(significantDigits: number, rounding: Rounding): string; + + /** + * Return a new Decimal whose value is the value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toDecimalPlaces(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a maximum of `decimalPlaces` + * decimal places. + * + * @param { number } decimalPlaces Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toDecimalPlaces(decimalPlaces: number): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a maximum of `decimalPlaces` + * decimal places using rounding mode `rounding`. + * + * @param { number } decimalPlaces Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toDecimalPlaces(decimalPlaces: number, rounding: Rounding): Decimal; + + /** + * Return a string representing the value of this Decimal in exponential notation. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toExponential(): string; + + /** + * Return a string representing the value of this Decimal in exponential notation rounded to + * `decimalPlaces` fixed decimal places. + * + * @param { number } decimalPlaces Decimal places. Integer, 0 to MAX_DIGITS inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toExponential(decimalPlaces: number): string; + + /** + * Return a string representing the value of this Decimal in exponential notation rounded to + * `decimalPlaces` fixed decimal places using rounding mode `rounding`. + * + * @param { number } decimalPlaces Decimal places. Integer, 0 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toExponential(decimalPlaces: number, rounding: Rounding): string; + + /** + * Return a string representing the value of this Decimal in normal (fixed-point). + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toFixed(): string; + + /** + * Return a string representing the value of this Decimal in normal (fixed-point) notation to + * `decimalPlaces` fixed decimal places. + * + * @param { number } decimalPlaces Decimal places. Integer, 0 to MAX_DIGITS inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces` is out of range. + * @crossplatform + * @atomicservice + * @since 12 + */ + toFixed(decimalPlaces: number): string; + + /** + * Return a string representing the value of this Decimal in normal (fixed-point) notation to + * `decimalPlaces` fixed decimal places and rounded using rounding mode `rounding`. + * + * @param { number } decimalPlaces Decimal places. Integer, 0 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `decimalPlaces | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toFixed(decimalPlaces: number, rounding: Rounding): string; + + /** + * Return an array representing the value of this Decimal as a simple fraction with an integer + * numerator and an integer denominator. + * + * @returns { Decimal[] } the Decimal[] type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toFraction(): Decimal[]; + + /** + * Return an array representing the value of this Decimal as a simple fraction with an integer + * numerator and an integer denominator. The denominator will be a positive non-zero value + * less than or equal to `max_denominator`. + * + * @param { Value } maxDenominator {number | string | Decimal} + * @returns { Decimal[] } the Decimal[] type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toFraction(maxDenominator: Value): Decimal[]; + + /** + * Returns a new Decimal whose value is the nearest multiple of `n`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toNearest(n: Value): Decimal; + + /** + * Returns a new Decimal whose value is the nearest multiple of `n` in the direction of rounding + * mode `rounding`, to the value of this Decimal. + * + * @param { Value } n {number | string | Decimal} + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200001 - The value of `rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toNearest(n: Value, rounding: Rounding): Decimal; + + /** + * Return a string representing the value of this Decimal. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toPrecision(): string; + + /** + * Return a string representing the value of this Decimal rounded to `significantDigits` significant digits. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toPrecision(significantDigits: number): string; + + /** + * Return a string representing the value of this Decimal rounded to `significantDigits` significant digits + * using rounding mode `rounding`. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { string } the string type + * @throws { BusinessError } 10200001 - The value of `significantDigits | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toPrecision(significantDigits: number, rounding: Rounding): string; + + /** + * Return a new Decimal whose value is the value of this Decimal. + * + * @returns { Decimal } the Decimal type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toSignificantDigits(): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a maximum of `significantDigits` + * significant digits. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200001 - The value of `significantDigits` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toSignificantDigits(significantDigits: number): Decimal; + + /** + * Return a new Decimal whose value is the value of this Decimal rounded to a maximum of `significantDigits` + * significant digits using rounding mode `rounding`. + * + * @param { number } significantDigits Significant digits. Integer, 1 to MAX_DIGITS inclusive. + * @param { Rounding } rounding Rounding mode. Integer, 0 to 8 inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200001 - The value of `significantDigits | rounding` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toSignificantDigits(significantDigits: number, rounding: Rounding): Decimal; + + /** + * Return the value of this Decimal converted to a number primitive. Zero keeps its sign. + * + * @returns { number } the number type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toNumber(): number; + + /** + * Return a string representing the value of this Decimal. + * Return exponential notation if this Decimal has a positive exponent equal to or greater than + * `toExpPos`, or a negative exponent equal to or less than `toExpNeg`. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + toString(): string; + + /** + * Return a string representing the value of this Decimal. + * Unlike `toString`, negative zero will include the minus sign. + * + * @returns { string } the string type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + valueOf(): string; + + /** + * Return the number of decimal places of the value of this Decimal. + * + * @returns { number } the number type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + decimalPlaces(): number; + + /** + * Return the number of significant digits of the value of this Decimal. + * + * @returns { number } the number type + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + precision(): number; + + /** + * Return the number of significant digits of the value of this Decimal, whether to count + * integer-part trailing zeros. + * + * @param { boolean | number } includeZeros Whether to count integer-part trailing zeros: true, false, + * 1 or 0. + * @returns { number } the number type + * @throws { BusinessError } 10200001 - The value of `includeZeros` is out of range. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + precision(includeZeros: boolean | number): number; + + /** + * Return a new Decimal whose value is the absolute value of `n`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static abs(n: Value): Decimal; + + /** + * Return a new Decimal whose value is `n` round to an integer using `ROUND_FLOOR`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static floor(n: Value): Decimal; + + /** + * Return a new Decimal whose value is `n` rounded to an integer using `ROUND_CEIL`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static ceil(n: Value): Decimal; + + /** + * Return a new Decimal whose value is `n` truncated to an integer. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static trunc(n: Value): Decimal; + + /** + * Return a new Decimal whose value is `n` clamped to the range delineated by `min` and `max`. + * + * @param { Value } n {number | string | Decimal} + * @param { Value } min {number | string | Decimal} + * @param { Value } max {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200001 - The value of `min` is out of range. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static clamp(n: Value, min: Value, max: Value): Decimal; + + /** + * Return a new Decimal whose value is the sum of `x` and `y`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } x {number | string | Decimal} + * @param { Value } y {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static add(x: Value, y: Value): Decimal; + + /** + * Return a new Decimal whose value is the sum of the arguments, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * Only the result is rounded, not the intermediate calculations. + * + * @param { Value[] } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sum(...n: Value[]): Decimal; + + /** + * Return a new Decimal whose value is `x` minus `y`, rounded to `precision` significant digits + * using rounding mode `rounding`. + * + * @param { Value } x {number | string | Decimal} + * @param { Value } y {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sub(x: Value, y: Value): Decimal; + + /** + * Return a new Decimal whose value is `x` multiplied by `y`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } x {number | string | Decimal} + * @param { Value } y {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static mul(x: Value, y: Value): Decimal; + + /** + * Return a new Decimal whose value is `x` divided by `y`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } x {number | string | Decimal} + * @param { Value } y {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static div(x: Value, y: Value): Decimal; + + /** + * Return a new Decimal whose value is `x` modulo `y`, rounded to `precision` significant digits + * using rounding mode `rounding`. + * + * @param { Value } x {number | string | Decimal} + * @param { Value } y {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static mod(x: Value, y: Value): Decimal; + + /** + * Return a new Decimal whose value is the square root of `n`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sqrt(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the cube root of `n`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static cbrt(n: Value): Decimal; + + /** + * Return a new Decimal whose value is `base` raised to the power `exponent`, rounded to precision + * significant digits using rounding mode `rounding`. + * + * @param { Value } base {number | string | Decimal} The base. + * @param { Value } exponent {number | string | Decimal} The exponent. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static pow(base: Value, exponent: Value): Decimal; + + /** + * Return a new Decimal whose value is the natural exponential of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static exp(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the log of `n` to the base `base`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @param { Value } base {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static log(n: Value, base: Value): Decimal; + + /** + * Return a new Decimal whose value is the natural logarithm of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static ln(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the base 2 logarithm of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static log2(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the base 10 logarithm of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static log10(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the cosine of `n`, rounded to `precision` significant + * digits using rounding mode `rounding` + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static cos(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the sine of `n`, rounded to `precision` significant digits + * using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sin(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the tangent of `n`, rounded to `precision` significant + * digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static tan(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic cosine of `n`, rounded to precision + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static cosh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic sine of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sinh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the hyperbolic tangent of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static tanh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the arccosine in radians of `n`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static acos(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the arcsine in radians of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static asin(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the arctangent in radians of `n`, rounded to `precision` + * significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static atan(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic cosine of `n`, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static acosh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic sine of `n`, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static asinh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the inverse of the hyperbolic tangent of `n`, rounded to + * `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} A value in radians. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static atanh(n: Value): Decimal; + + /** + * Return a new Decimal whose value is the arctangent in radians of `y/x` in the range -pi to pi + * (inclusive), rounded to `precision` significant digits using rounding mode `rounding`. + * + * @param { Value } y {number | string | Decimal} The y-coordinate. + * @param { Value } x {number | string | Decimal} The x-coordinate. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200060 - Precision limit exceeded. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static atan2(y: Value, x: Value): Decimal; + + /** + * Return a new Decimal whose value is the square root of the sum of the squares of the arguments, + * rounded to `precision` significant digits using rounding mode `rounding`. + * + * @param { Value[] } n {number | string | Decimal} Decimal + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static hypot(...n: Value[]): Decimal; + + /** + * Return a new Decimal whose value is the maximum of the arguments. + * + * @param { Value[] } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static max(...n: Value[]): Decimal; + + /** + * Return a new Decimal whose value is the minimum of the arguments. + * + * @param { Value[] } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static min(...n: Value[]): Decimal; + + /** + * Returns a new Decimal with a random value equal to or greater than 0 and less than 1. + * + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 10200061 - Crypto unavailable + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static random(): Decimal; + + /** + * Returns a new Decimal with a random value equal to or greater than 0 and less than 1, and with + * `significantDigits` significant digits (or less if trailing zeros are produced). + * + * @param { Value } significantDigits {number} Significant digits. Integer, 0 to MAX_DIGITS inclusive. + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200061 - Crypto unavailable + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static random(significantDigits: number): Decimal; + + /** + * Return the sign of the passed value to the method. + * 1 if x > 0, + * -1 if x < 0, + * 0 if x is 0, + * -0 if x is -0, + * NaN otherwise + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static sign(n: Value): number; + + /** + * Return a new Decimal whose value is `n` rounded to an integer using rounding mode `rounding`. + * + * @param { Value } n {number | string | Decimal} + * @returns { Decimal } the Decimal type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static round(n: Value): Decimal; + + /** + * Configures the 'global' settings for this particular Decimal constructor. + * + * @param { DecimalConfig } An object with one or more of the following properties, + * precision {number} + * rounding {number} + * toExpNeg {number} + * toExpPos {number} + * maxE {number} + * minE {number} + * modulo {number} + * crypto {boolean|number} + * defaults {true} + * @returns { void } + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Incorrect parameter types; + * 2. Parameter verification failed. + * @throws { BusinessError } 10200001 - The value of `DecimalConfig.properties` is out of range. + * @throws { BusinessError } 10200061 - Crypto unavailable + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static set(config: DecimalConfig): void; + + /** + * Rounds away from zero + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_UP : 0; + + /** + * Rounds towards zero + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_DOWN : 1; + + /** + * Rounds towards Infinity + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_CEILING : 2; + + /** + * Rounds towards -Infinity + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_FLOOR : 3; + + /** + * Rounds towards nearest neighbour. If equidistant, rounds away from zero + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_HALF_UP : 4; + + /** + * Rounds towards nearest neighbour. If equidistant, rounds towards zero + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_HALF_DOWN : 5; + + /** + * Rounds towards nearest neighbour. If equidistant, rounds towards even neighbour + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_HALF_EVEN : 6; + + /** + * Rounds towards nearest neighbour. If equidistant, rounds towards Infinity + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_HALF_CEILING : 7; + + /** + * Rounds towards nearest neighbour. If equidistant, rounds towards -Infinity + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly ROUND_HALF_FLOOR : 8; + + /** + * Not a rounding mode, see modulo + * + * @readonly + * @static + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 12 + */ + static readonly EUCLIDEAN : 9; +} +export default Decimal; diff --git a/arkts/@arkts.utils.d.ets b/arkts/@arkts.utils.d.ets index 351874231429d48aa9d0022a3b8f4b7af93f56aa..ad379729e3017837f7b25c65027f43d1374dd607 100644 --- a/arkts/@arkts.utils.d.ets +++ b/arkts/@arkts.utils.d.ets @@ -400,7 +400,7 @@ declare namespace utils { /** * Converts an ArkTS value to a JavaScript Object Notation (JSON) string. * - * @param { ISendable } value - The value to stringify. + * @param { ISendable | null | undefined } value - The value to stringify. * @returns { string } The JSON string representation of the value. * @throws { BusinessError } 401 - Parameter error. Invalid ArkTS value. * @syscap SystemCapability.Utils.Lang @@ -408,7 +408,7 @@ declare namespace utils { * @atomicservice * @since 12 */ - function stringify(value: ISendable): string; + function stringify(value: ISendable | null | undefined): string; } } export default utils; diff --git a/build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt b/build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt index 07ce5a901e8dcd0a43d5bb651d9724d9cc1dd3dc..88ed1b3be49c9651b2972ba7882623ea3319504c 100644 --- a/build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt +++ b/build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt @@ -173,6 +173,7 @@ csh cubemap cug cyclewindows +cyclically daltonization darkens darkest @@ -546,6 +547,8 @@ mgf1 mifare minibar minimizing +minors +minorsmode mirrored misconfigured mismatches @@ -1126,3 +1129,4 @@ gbk ocsp encipherment reconfirmed +subresource diff --git a/build-tools/api_label_detection/src/coreImpl/process_three_type.py b/build-tools/api_label_detection/src/coreImpl/process_three_type.py index f55232728b4cf577cec964f38d1f37aba9a35270..0b75431940170189c339d60ccbbbf537534e1d77 100644 --- a/build-tools/api_label_detection/src/coreImpl/process_three_type.py +++ b/build-tools/api_label_detection/src/coreImpl/process_three_type.py @@ -46,20 +46,22 @@ def process_method_type(dict_data: dict, label='default') -> list: def judgment_is_default(dict_data: dict, label) -> list: - result_data = [] + result_data_total = [] if 'default' == label: - result_data = default_processing_label(dict_data) + result_data_total = default_processing_label(dict_data) else: if 'Method' == dict_data['apiType']: for label_element in label: change_label = label_comparison_dist[label_element] result_data = process_method_tag(dict_data, change_label) + result_data_total.extend(result_data) else: for label_element in label: change_label = label_comparison_dist[label_element] result_data = process_tag(dict_data, change_label) + result_data_total.extend(result_data) - return result_data + return result_data_total def process_method_tag(dict_data: dict, label): @@ -160,6 +162,10 @@ def process_tag(dict_data: dict, label): missing_tag_data_list = [] if 'childApis' not in dict_data: return missing_tag_data_list + # 处理property + for child_data in dict_data['childApis']: + result_list = process_child_quote_of_three(child_data, label) + missing_tag_data_list.extend(result_list) # 节点没有jsDocInfos if 'jsDocInfos' not in dict_data: error_result = process_no_js_info(dict_data, label) @@ -172,6 +178,79 @@ def process_tag(dict_data: dict, label): return missing_tag_data_list +def process_child_quote_of_three(child_data, label): + missing_tag_data_list = [] + if 'jsDocInfos' not in child_data: + return missing_tag_data_list + child_info = get_js_doc_info(child_data['jsDocInfos']) + if not child_info: + return missing_tag_data_list + if 'typeLocations' in child_data and child_data['typeLocations']: + process_key = 'typeLocations' + result_list_of_type = process_reference_type_child(child_data, child_info, label, process_key) + missing_tag_data_list.extend(result_list_of_type) + if 'objLocations' in child_data and child_data['objLocations']: + process_key = 'objLocations' + result_list_of_obj = process_reference_type_child(child_data, child_info, label, process_key) + missing_tag_data_list.extend(result_list_of_obj) + + return missing_tag_data_list + + +def process_reference_type_child(child_data, current_info, label, process_key): + missing_tag_message_list = [] + new_label = label.replace('is', '') + for refer_info in child_data[process_key]: + error_result = {} + if label in current_info and label in refer_info: + # property有，引用没 + if current_info[label] and (not refer_info[label]): + error_result = reference_obj_or_type(process_key, new_label, 1) + error_result.setdefault('error_quote_name', refer_info.get('typeName')) + # property没，引用有 + elif (not current_info[label]) and refer_info[label]: + error_result = reference_obj_or_type(process_key, new_label, 0) + message_obj = get_message_obj(child_data, error_result) + missing_tag_message_list.append(message_obj) + break + + if error_result: + message_obj = get_message_obj(child_data, error_result) + missing_tag_message_list.append(message_obj) + + return missing_tag_message_list + + +def reference_obj_or_type(process_key, new_label, key_num): + error_result = {} + error_type = '' + error_message = '' + if 'typeLocations' == process_key: + # property有，引用没 + if 1 == key_num: + error_type = ErrorType.PROPERTY_REFERENCE_NO_TAG.value + error_message = ErrorMessage.PROPERTY_HAVE_REFERENCE_NO.value.replace('&', new_label) + # property没，引用有 + elif 0 == key_num: + error_type = ErrorType.PROPERTY_NO_TAG.value + error_message = ErrorMessage.REFERENCE_HAVE_PROPERTY_NO.value.replace('&', new_label) + + elif 'objLocations' == process_key: + # property有，引用对象没 + if 1 == key_num: + error_type = ErrorType.PROPERTY_REFERENCE_OBJ_NO_TAG.value + error_message = ErrorMessage.PROPERTY_HAVE_REFERENCE_OBJ_NO.value.replace('&', new_label) + # property没，引用对象有 + elif 0 == key_num: + error_type = ErrorType.PROPERTY_NO_TAG.value + error_message = ErrorMessage.REFERENCE_OBJ_HAVE_PROPERTY_NO.value.replace('&', new_label) + + error_result.setdefault('error_type', error_type) + error_result.setdefault('error_message', error_message) + + return error_result + + def process_no_js_info(dict_data: dict, label): error_result = {} new_label = label.replace('is', '') @@ -251,9 +330,13 @@ def get_message_obj(dict_data: dict, error_result: dict, in_or_out=None) -> Outp defined_text = in_or_out['definedText'] else: defined_text = dict_data['definedText'] + if error_result.get('error_quote_name'): + error_message = '({});{}'.format(error_result.get('error_quote_name'), + error_result['error_message']) + else: + error_message = error_result['error_message'] message_obj = Output(dict_data['filePath'], error_result['error_type'], defined_text, - get_position_information(dict_data['pos']), - error_result['error_message']) + get_position_information(dict_data['pos']), error_message) return message_obj diff --git a/build-tools/api_label_detection/src/typedef/detection.py b/build-tools/api_label_detection/src/typedef/detection.py index 3257eaecc4022f32be8c358454a75e55fbaa4ab9..c91f4b1b1e00e52f516c94caa7bdd2b40f82150d 100644 --- a/build-tools/api_label_detection/src/typedef/detection.py +++ b/build-tools/api_label_detection/src/typedef/detection.py @@ -44,6 +44,10 @@ class ErrorMessage(enum.Enum): METHOD_HAVE_OUTPUT_PARAM_NO = 'functions have [&] label, but the return value do not have [&] label' METHOD_HAVE_PARAM_OBJ_NO = 'functions have [&] label, but the argument anonymous object do not have [&] label' METHOD_HAVE_RETURN_OBJ_NO = 'functions have [&] label, but the return anonymous objects do not have [&] label' + PROPERTY_HAVE_REFERENCE_NO = 'property have [&] label, but the reference of property do not have [&] label' + REFERENCE_HAVE_PROPERTY_NO = 'reference of property have [&] label, but the property do not have [&] label' + PROPERTY_HAVE_REFERENCE_OBJ_NO = 'property have [&] label, but the reference_obj of property do not have [&] label' + REFERENCE_OBJ_HAVE_PROPERTY_NO = 'reference_obj of property have [&] label, but the property do not have [&] label' class ErrorType(enum.Enum): @@ -57,3 +61,6 @@ class ErrorType(enum.Enum): RETURN_NO_TAG = 'return_missing_label' PARAM_OBJ_NO_TAG = 'param_anonymous_object_missing_label' RETURN_OBJ_NO_TAG = 'return_anonymous_object_missing_label' + PROPERTY_NO_TAG = 'property_missing_label' + PROPERTY_REFERENCE_NO_TAG = 'property_of_reference_missing_label' + PROPERTY_REFERENCE_OBJ_NO_TAG = 'property_of_reference_obj_missing_label' diff --git a/kits/@kit.AVSessionKit.d.ts b/kits/@kit.AVSessionKit.d.ts index af24152e98378b25f3b10e37dfe67e845e3bed2d..87903bfb9af6d1d5202c622f56a3f31d66458fc1 100644 --- a/kits/@kit.AVSessionKit.d.ts +++ b/kits/@kit.AVSessionKit.d.ts @@ -19,8 +19,8 @@ */ import AVCastPicker from '@ohos.multimedia.avCastPicker'; -import { AVCastPickerState } from '@ohos.multimedia.avCastPickerParam'; +import { AVCastPickerState, AVCastPickerStyle, AVCastPickerColorMode } from '@ohos.multimedia.avCastPickerParam'; import avSession from '@ohos.multimedia.avsession'; import MediaControlExtensionAbility from '@ohos.app.ability.MediaControlExtensionAbility'; -export { AVCastPicker, AVCastPickerState, avSession, MediaControlExtensionAbility }; +export { AVCastPicker, AVCastPickerState, AVCastPickerStyle, AVCastPickerColorMode, avSession, MediaControlExtensionAbility }; diff --git a/kits/@kit.ArkData.d.ts b/kits/@kit.ArkData.d.ts index 18a92865f65f810de1ed24504029086c1ef508c0..e1a5e1eabcfda731d2025c5018ab85a8670cc22a 100644 --- a/kits/@kit.ArkData.d.ts +++ b/kits/@kit.ArkData.d.ts @@ -33,9 +33,10 @@ import unifiedDataChannel from '@ohos.data.unifiedDataChannel'; import uniformTypeDescriptor from '@ohos.data.uniformTypeDescriptor'; import uniformDataStruct from '@ohos.data.uniformDataStruct'; import { ValueType, ValuesBucket } from '@ohos.data.ValuesBucket'; +import sendablePreferences from '@ohos.data.sendablePreferences'; export { DataShareExtensionAbility, DataShareResultSet, DataType, ValueType, ValuesBucket, cloudData, cloudExtension, commonType, dataShare, dataSharePredicates, distributedDataObject, distributedKVStore, preferences, - relationalStore, unifiedDataChannel, uniformTypeDescriptor, uniformDataStruct + relationalStore, unifiedDataChannel, uniformTypeDescriptor, uniformDataStruct, sendablePreferences, }; diff --git a/kits/@kit.ArkTS.d.ts b/kits/@kit.ArkTS.d.ts index 5d08b3bf5a844e255ec4dafd46a8db87571f7974..b6884b663c71ae62512089ad23f3e30732929d24 100644 --- a/kits/@kit.ArkTS.d.ts +++ b/kits/@kit.ArkTS.d.ts @@ -50,11 +50,12 @@ import lang from '@arkts.lang'; import ArkTSUtils from '@arkts.utils'; import collections from '@arkts.collections'; import stream from '@ohos.util.stream'; +import Decimal from '@arkts.math.Decimal'; export { ArrayList, convertxml, DedicatedWorkerGlobalScope, Deque, ErrorEvent, Event, EventListener, EventTarget, HashMap, HashSet, LightWeightMap, LightWeightSet, LinkedList, List, MessageEvent, MessageEvents, PlainArray, PostMessageOptions, Queue, Stack, ThreadWorkerGlobalScope, TreeMap, TreeSet, Vector, WorkerEventListener, WorkerEventTarget, WorkerOptions, buffer, process, taskpool, - uri, url, util, worker, xml, JSON, lang, ArkTSUtils, collections, stream + uri, url, util, worker, xml, JSON, lang, ArkTSUtils, collections, stream, Decimal }; diff --git a/kits/@kit.ArkUI.d.ts b/kits/@kit.ArkUI.d.ts index 682c8b3140ae33eeb4cd09e5523118eb253ef7bb..c9c737327dcb308fa9cf42a972903a7bf3c1a9ff 100644 --- a/kits/@kit.ArkUI.d.ts +++ b/kits/@kit.ArkUI.d.ts @@ -23,7 +23,7 @@ import Animator, { AnimatorOptions, AnimatorResult } from '@ohos.animator'; import WindowExtensionAbility, { WindowExtensionContext } from '@ohos.application.WindowExtensionAbility'; import { Chip, ChipOptions, ChipSize, IconCommonOptions, LabelMarginOptions, LabelOptions, PrefixIconOptions, - SuffixIconOptions, SymbolOptions + SuffixIconOptions } from '@ohos.arkui.advanced.Chip'; import { IconOptions, LabelOptions as ChipItemLabelOptions, ChipGroupItemOptions, ChipItemStyle, ChipGroupSpaceOptions, IconItemOptions, IconGroupSuffix, ChipGroup @@ -37,10 +37,11 @@ import { AlertDialog, ButtonOptions, ConfirmDialog, LoadingDialog, SelectDialog, TipsDialog, CustomContentDialog } from '@ohos.arkui.advanced.Dialog'; import { - EditableLeftIconType, EditableTitleBar, EditableTitleBarMenuItem + EditableLeftIconType, EditableTitleBar, EditableTitleBarMenuItem, EditableTitleBarItem, EditableTitleBarOptions, } from '@ohos.arkui.advanced.EditableTitleBar'; import { MarginType, PromptOptions, ExceptionPrompt } from '@ohos.arkui.advanced.ExceptionPrompt'; import { Filter, FilterParams, FilterResult, FilterType } from '@ohos.arkui.advanced.Filter'; +import { AddFormMenuItem, FormMenuItemStyle, AddFormOptions } from '@ohos.arkui.advanced.FormMenu'; import { GridObjectSortComponentType, GridObjectSortComponentItem, GridObjectSortComponentOptions, GridObjectSortComponent } from '@ohos.arkui.advanced.GridObjectSortComponent'; import { Popup, PopupButtonOptions, PopupIconOptions, PopupOptions, PopupTextOptions @@ -55,7 +56,7 @@ import { } from '@ohos.arkui.advanced.SelectionMenu'; import { SelectTitleBar, SelectTitleBarMenuItem } from '@ohos.arkui.advanced.SelectTitleBar'; import { SplitLayout } from '@ohos.arkui.advanced.SplitLayout'; -import { OperationOption, OperationType, SelectOptions, SubHeader } from '@ohos.arkui.advanced.SubHeader'; +import { OperationOption, OperationType, SelectOptions, SubHeader, SymbolOptions } from '@ohos.arkui.advanced.SubHeader'; import { SwipeRefresher } from '@ohos.arkui.advanced.SwipeRefresher'; import { TabTitleBar, TabTitleBarMenuItem, TabTitleBarTabItem } from '@ohos.arkui.advanced.TabTitleBar'; import { ItemState, ToolBar, ToolBarOption, ToolBarOptions } from '@ohos.arkui.advanced.ToolBar'; @@ -67,7 +68,7 @@ import componentUtils from '@ohos.arkui.componentUtils'; import dragController from '@ohos.arkui.dragController'; import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor'; import inspector from '@ohos.arkui.inspector'; -import { NodeRenderType, RenderOptions, BuilderNode, NodeController, FrameNode, DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4, Rotation, Frame, RenderNode, XComponentNode, ComponentContent } from '@ohos.arkui.node'; +import { NodeRenderType, RenderOptions, BuilderNode, NodeController, FrameNode, DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4, Rotation, Frame, RenderNode, XComponentNode, LengthMetrics, LayoutConstraint, ComponentContent } from '@ohos.arkui.node'; import uiObserver from '@ohos.arkui.observer'; import performanceMonitor from '@ohos.arkui.performanceMonitor'; import { RectShape, CircleShape, EllipseShape, PathShape } from '@ohos.arkui.shape'; @@ -103,16 +104,19 @@ import SystemRouter, { BackRouterOptions, DisableAlertBeforeBackPageOptions, EnableAlertBeforeBackPageOptions, RouterOptions, RouterState } from '@system.router'; +import { SymbolGlyphModifier } from '@ohos.arkui.modifier'; +import { Colors, CustomColors, Theme, ThemeControl, CustomTheme } from '@ohos.arkui.theme'; export { - AlertDialog, Animator, AnimatorOptions, AnimatorResult, App, AppResponse, AtomicServiceBar, + AddFormMenuItem, AddFormOptions, AlertDialog, Animator, AnimatorOptions, AnimatorResult, App, AppResponse, AtomicServiceBar, BackRouterOptions, BuilderNode, Button, ButtonOptions, CallbackParam, CapsuleSegmentButtonConstructionOptions, CapsuleSegmentButtonOptions, Chip, ChipOptions, ChipSize, CircleShape, ComponentUtils, ComposeListItem, ComposeTitleBar, ComposeTitleBarMenuItem, Configuration, ConfirmDialog, ContentItem, CounterComponent, CounterOptions, CounterType, DateData, DisableAlertBeforeBackPageOptions, DragController, - DrawableDescriptor, DrawContext, EditableLeftIconType, EditableTitleBar, EditableTitleBarMenuItem, EditorEventInfo, + DrawableDescriptor, DrawContext, EditableLeftIconType, EditableTitleBar, EditableTitleBarItem, + EditableTitleBarOptions, EditableTitleBarMenuItem, EditorEventInfo, EditorMenuOptions, EllipseShape, EnableAlertBeforeBackPageOptions, ExceptionPrompt, ExpandedMenuOptions, Filter, FilterParams, FilterResult, - FilterType, Font, Frame, FrameNode, GridObjectSortComponent, GridObjectSortComponentItem, GridObjectSortComponentOptions, + FilterType, Font, FormMenuItemStyle, Frame, FrameNode, GridObjectSortComponent, GridObjectSortComponentItem, GridObjectSortComponentOptions, GridObjectSortComponentType, IconCommonOptions, IconType, ItemState, KeyboardAvoidMode, LabelMarginOptions, LabelOptions, LayeredDrawableDescriptor, LoadingDialog, LocaleResponse, MarginType, Matrix4, MeasureOptions, MeasureText, MediaQuery, MediaQueryEvent, MediaQueryList, NodeController, NodeParam, NodeRenderType, Offset, OperateButton, OperateCheck, OperateIcon, @@ -124,9 +128,10 @@ export { ShowToastOptions, Size, SplitLayout, SubHeader, SuffixIconOptions, SwipeRefresher, SymbolOptions, SystemMediaQuery, SystemRouter, TabSegmentButtonConstructionOptions, TabSegmentButtonOptions, TabTitleBar, TabTitleBarMenuItem, TabTitleBarTabItem, TipsDialog, ToolBar, ToolBarOption, ToolBarOptions, Translation, TreeController, TreeListenType, TreeListener, - TreeListenerManager, TreeView, UIContext, UIInspector, UIObserver, WindowExtensionAbility, - WindowExtensionContext, XComponentNode, ComponentContent, componentSnapshot, componentUtils, curves, display, dragController, dragInteraction, + TreeListenerManager, TreeView, UIContext, UIInspector, UIObserver, WindowExtensionAbility, WindowExtensionContext, XComponentNode, + LengthMetrics, LayoutConstraint, ComponentContent, componentSnapshot, componentUtils, curves, display, dragController, dragInteraction, font, inspector, matrix4, mediaquery, performanceMonitor, pluginComponentManager, prompt, promptAction, router, screen, screenshot, uiAppearance, uiExtensionHost, uiObserver, window, windowAnimationManager, CustomContentDialog, - IconOptions, ChipItemLabelOptions, ChipGroupItemOptions, ChipItemStyle, ChipGroupSpaceOptions, IconItemOptions, IconGroupSuffix, ChipGroup + IconOptions, ChipItemLabelOptions, ChipGroupItemOptions, ChipItemStyle, ChipGroupSpaceOptions, IconItemOptions, IconGroupSuffix, ChipGroup, + SymbolGlyphModifier, Colors, CustomColors, Theme, ThemeControl, CustomTheme }; diff --git a/kits/@kit.AudioKit.d.ts b/kits/@kit.AudioKit.d.ts index e368238ca7ac0ada0d16ab4cdc487db2c881eddd..fc7bf3894263266d368ba006d7e025a57cbd39e5 100644 --- a/kits/@kit.AudioKit.d.ts +++ b/kits/@kit.AudioKit.d.ts @@ -21,5 +21,6 @@ import audio from '@ohos.multimedia.audio'; import audioHaptic from '@ohos.multimedia.audioHaptic'; import systemSoundManager from '@ohos.multimedia.systemSoundManager'; +import { AVVolumePanel, AVVolumePanelParameter } from '@ohos.multimedia.avVolumePanel'; -export { audio, audioHaptic, systemSoundManager }; +export { audio, audioHaptic, systemSoundManager, AVVolumePanel, AVVolumePanelParameter }; diff --git a/kits/@kit.LocalizationKit.d.ts b/kits/@kit.LocalizationKit.d.ts index c003cdb534792b7888155446463f39f5ce36bc7e..cc7bd0455952f5a3ed203963b0579cb52355a537 100644 --- a/kits/@kit.LocalizationKit.d.ts +++ b/kits/@kit.LocalizationKit.d.ts @@ -21,5 +21,6 @@ import i18n from '@ohos.i18n'; import intl from '@ohos.intl'; import resourceManager from '@ohos.resourceManager'; +import sendableResourceManager from '@ohos.sendableResourceManager'; -export { i18n, intl, resourceManager }; +export { i18n, intl, resourceManager, sendableResourceManager };