mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
Merge branch 'master' of gitee.com:openharmony/interface_sdk-js into set_update_policy
Signed-off-by: 方昀 <fangyun2@huawei.com>
This commit is contained in:
方昀
Gitee
commit
5abb67dec4
10
api/@internal/component/ets/common.d.ts
vendored
10
api/@internal/component/ets/common.d.ts
vendored
@ -12142,6 +12142,16 @@ interface ContextMenuAnimationOptions {
|
||||
* @since 12
|
||||
*/
|
||||
transition?: TransitionEffect;
|
||||
|
||||
/**
|
||||
* Sets the scale start and end animator of the image displayed before the custom builder preview is displayed.
|
||||
*
|
||||
* @type { ?AnimationRange<number> }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
hoverScale?: AnimationRange<number>;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
12
api/@internal/component/ets/nav_destination.d.ts
vendored
12
api/@internal/component/ets/nav_destination.d.ts
vendored
@ -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
|
||||
@ -632,7 +642,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
|
||||
onWillHide(callback: Callback<void>): NavDestinationAttribute;
|
||||
|
||||
/**
|
||||
* Set navdestination content expand types and edges.
|
||||
* Set navDestination content expand types and edges.
|
||||
*
|
||||
* @param { Array<LayoutSafeAreaType> } [types] - Indicates the types of the safe area.
|
||||
* @param { Array<LayoutSafeAreaEdge> } [edges] - Indicates the edges of the safe area.
|
||||
|
||||
44
api/@internal/component/ets/search.d.ts
vendored
44
api/@internal/component/ets/search.d.ts
vendored
@ -1267,6 +1267,50 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
|
||||
* @since 12
|
||||
*/
|
||||
fontFeature(value: string): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to input.
|
||||
*
|
||||
* @param { Callback<InsertValue, boolean> } callback - The triggered function when text content is about to insert.
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillInsert(callback: Callback<InsertValue, boolean>): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when completed input.
|
||||
*
|
||||
* @param { Callback<InsertValue> } callback - The triggered function when text content has been inserted.
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidInsert(callback: Callback<InsertValue>): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to delete.
|
||||
*
|
||||
* @param { Callback<DeleteValue, boolean> } callback - The triggered function when text content is about to delete.
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillDelete(callback: Callback<DeleteValue, boolean>): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when the deletion has been completed
|
||||
*
|
||||
* @param { Callback<DeleteValue> } callback - The triggered function when text content has been deleted.
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidDelete(callback: Callback<DeleteValue>): SearchAttribute;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
20
api/@internal/component/ets/select.d.ts
vendored
20
api/@internal/component/ets/select.d.ts
vendored
@ -94,6 +94,16 @@ declare interface SelectOption {
|
||||
* @since 11
|
||||
*/
|
||||
icon?: ResourceStr;
|
||||
|
||||
/**
|
||||
* Indicates the symbol icon of this menu item.
|
||||
*
|
||||
* @type { ?SymbolGlyphModifier }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
symbolIcon?: SymbolGlyphModifier;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -792,6 +802,16 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
|
||||
*/
|
||||
icon?: ResourceStr;
|
||||
|
||||
/**
|
||||
* Indicates the symbol icon of this menu item.
|
||||
*
|
||||
* @type { ?SymbolGlyphModifier }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
symbolIcon?: SymbolGlyphModifier;
|
||||
|
||||
/**
|
||||
* Indicates whether this menu item is selected or not.
|
||||
*
|
||||
|
||||
44
api/@internal/component/ets/text_area.d.ts
vendored
44
api/@internal/component/ets/text_area.d.ts
vendored
@ -1541,6 +1541,50 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
|
||||
* @since 12
|
||||
*/
|
||||
fontFeature(value: string): TextAreaAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to input.
|
||||
*
|
||||
* @param { Callback<InsertValue, boolean> } callback - The triggered function when text content is about to insert.
|
||||
* @returns { TextAreaAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillInsert(callback: Callback<InsertValue, boolean>): TextAreaAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when completed input.
|
||||
*
|
||||
* @param { Callback<InsertValue> } callback - The triggered function when text content has been inserted.
|
||||
* @returns { TextAreaAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidInsert(callback: Callback<InsertValue>): TextAreaAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to delete.
|
||||
*
|
||||
* @param { Callback<DeleteValue, boolean> } callback - The triggered function when text content is about to delete.
|
||||
* @returns { TextAreaAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillDelete(callback: Callback<DeleteValue, boolean>): TextAreaAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when the deletion has been completed
|
||||
*
|
||||
* @param { Callback<DeleteValue> } callback - The triggered function when text content has been deleted.
|
||||
* @returns { TextAreaAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidDelete(callback: Callback<DeleteValue>): TextAreaAttribute;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
98
api/@internal/component/ets/text_common.d.ts
vendored
98
api/@internal/component/ets/text_common.d.ts
vendored
@ -178,6 +178,104 @@ declare interface TextRange {
|
||||
end?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the inserted text value info.
|
||||
*
|
||||
* @interface InsertValue
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
declare interface InsertValue {
|
||||
/**
|
||||
* The location info where the value will be inserted.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
insertOffset: number;
|
||||
|
||||
/**
|
||||
* The inserted value.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
insertValue: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines delete text direction.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
declare enum TextDeleteDirection {
|
||||
/**
|
||||
* Delete backward.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
BACKWARD = 0,
|
||||
|
||||
/**
|
||||
* Delete forward.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
FORWARD = 1,
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides an interface for deleting value from text.
|
||||
*
|
||||
* @interface DeleteValue
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
declare interface DeleteValue {
|
||||
/**
|
||||
* The location info where the value will be deleted.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
deleteOffset: number;
|
||||
|
||||
/**
|
||||
* The deleted direction.
|
||||
*
|
||||
* @type { TextDeleteDirection }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction: TextDeleteDirection;
|
||||
|
||||
/**
|
||||
* The deleted value.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
deleteValue: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback after content changed.
|
||||
*
|
||||
|
||||
56
api/@internal/component/ets/text_input.d.ts
vendored
56
api/@internal/component/ets/text_input.d.ts
vendored
@ -1964,7 +1964,17 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
*/
|
||||
showError(value?: string | undefined): TextInputAttribute;
|
||||
/**
|
||||
* Define the show error of the text input.
|
||||
*
|
||||
* @param { ResourceStr | undefined } [value]
|
||||
* @returns { TextInputAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
showError(value?: ResourceStr | undefined): TextInputAttribute;
|
||||
|
||||
/**
|
||||
* Define the show unit of the text input.
|
||||
@ -2326,6 +2336,50 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
|
||||
* @since 12
|
||||
*/
|
||||
onSecurityStateChange(callback: Callback<boolean>): TextInputAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to input.
|
||||
*
|
||||
* @param { Callback<InsertValue, boolean> } callback - The triggered function when text content is about to insert.
|
||||
* @returns { TextInputAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillInsert(callback: Callback<InsertValue, boolean>): TextInputAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when completed input.
|
||||
*
|
||||
* @param { Callback<InsertValue> } callback - The triggered function when text content has been inserted.
|
||||
* @returns { TextInputAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidInsert(callback: Callback<InsertValue>): TextInputAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when about to delete.
|
||||
*
|
||||
* @param { Callback<DeleteValue, boolean> } callback - The triggered function when text content is about to delete.
|
||||
* @returns { TextInputAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onWillDelete(callback: Callback<DeleteValue, boolean>): TextInputAttribute;
|
||||
|
||||
/**
|
||||
* Get text value information when the deletion has been completed
|
||||
*
|
||||
* @param { Callback<DeleteValue> } callback - The triggered function when text content has been deleted.
|
||||
* @returns { TextInputAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onDidDelete(callback: Callback<DeleteValue>): TextInputAttribute;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
23
api/@ohos.PiPWindow.d.ts
vendored
23
api/@ohos.PiPWindow.d.ts
vendored
@ -44,8 +44,10 @@ declare namespace PiPWindow {
|
||||
* the context and componentController in config should not be null. If templateType is specified, make sure
|
||||
* it's type of PiPTemplateType. If controlGroups is specified, make sure it correspond to the templateType.
|
||||
* @returns { Promise<PiPController> } - The promise returned by the function
|
||||
* @throws { BusinessError } 401 - Params 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 } 401 - Params 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 the API due to limited device capabilities.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
* @since 11
|
||||
*/
|
||||
@ -392,10 +394,10 @@ declare namespace PiPWindow {
|
||||
/**
|
||||
* Start picture-in-picture
|
||||
* @returns { Promise<void> } - The promise returned by the function
|
||||
* @throws { BusinessError } 1300012 - If PiP window state is abnormal.
|
||||
* @throws { BusinessError } 1300013 - Create PiP window failed.
|
||||
* @throws { BusinessError } 1300014 - Error when load PiP window content or show PiP window
|
||||
* @throws { BusinessError } 1300015 - If window has created
|
||||
* @throws { BusinessError } 1300012 - The PiP window state is abnormal.
|
||||
* @throws { BusinessError } 1300013 - Failed to create the PiP window.
|
||||
* @throws { BusinessError } 1300014 - PiP internal error.
|
||||
* @throws { BusinessError } 1300015 - Repeated PiP operation.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
* @since 11
|
||||
*/
|
||||
@ -404,9 +406,9 @@ declare namespace PiPWindow {
|
||||
/**
|
||||
* Stop picture-in-picture.
|
||||
* @returns { Promise<void> } - The promise returned by the function.
|
||||
* @throws { BusinessError } 1300011 - Stop PiP window failed.
|
||||
* @throws { BusinessError } 1300012 - If PiP window state is abnormal.
|
||||
* @throws { BusinessError } 1300015 - If window is stopping
|
||||
* @throws { BusinessError } 1300011 - Failed to destroy the PiP window.
|
||||
* @throws { BusinessError } 1300012 - The PiP window state is abnormal.
|
||||
* @throws { BusinessError } 1300015 - Repeated PiP operation.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
* @since 11
|
||||
*/
|
||||
@ -424,7 +426,8 @@ declare namespace PiPWindow {
|
||||
* Update source content size to adjust PiP window aspect ratio.
|
||||
* @param { number } width - Indicate the width of the content. The width can consist of only digits and above 0.
|
||||
* @param { number } height - Indicate the height of the content. The height can consist of only digits and above 0.
|
||||
* @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
* @since 11
|
||||
*/
|
||||
|
||||
6
api/@ohos.animator.d.ts
vendored
6
api/@ohos.animator.d.ts
vendored
@ -337,7 +337,7 @@ export interface AnimatorResult {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
|
||||
* @throws { BusinessError } 100001 - The specified page is not found or the object property list is not obtained.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 9
|
||||
*/
|
||||
@ -348,7 +348,7 @@ export interface AnimatorResult {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
|
||||
* @throws { BusinessError } 100001 - The specified page is not found or the object property list is not obtained.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -360,7 +360,7 @@ export interface AnimatorResult {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
|
||||
* @throws { BusinessError } 100001 - The specified page is not found or the object property list is not obtained.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
|
||||
48
api/@ohos.arkui.UIContext.d.ts
vendored
48
api/@ohos.arkui.UIContext.d.ts
vendored
@ -362,7 +362,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -377,7 +377,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -395,7 +395,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -410,7 +410,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -429,7 +429,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -445,7 +445,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -464,7 +464,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -480,7 +480,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -805,7 +805,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -819,7 +819,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -836,7 +836,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -847,7 +847,7 @@ export class Router {
|
||||
* @param { router.NamedRouterOptions } options - Options.
|
||||
* @returns { Promise<void> } 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 } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -865,7 +865,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -877,7 +877,7 @@ export class Router {
|
||||
* @param { router.RouterMode } mode - RouterMode.
|
||||
* @param { AsyncCallback<void> } 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 } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -895,7 +895,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -910,7 +910,7 @@ export class Router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1104,7 +1104,7 @@ export class PromptAction {
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 103301 - the ComponentContent is incorrect.
|
||||
* @throws { BusinessError } 103302 - Dialog content already exists
|
||||
* @throws { BusinessError } 103302 - Dialog content already exists.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
@ -1821,7 +1821,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 11
|
||||
*/
|
||||
@ -1835,7 +1835,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -1853,7 +1853,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 11
|
||||
*/
|
||||
@ -1866,7 +1866,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -1884,7 +1884,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 11
|
||||
*/
|
||||
@ -1897,7 +1897,7 @@ export class DragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -1982,7 +1982,7 @@ 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 - This component has an unfocusable ancestor
|
||||
* @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
|
||||
* @since 12
|
||||
|
||||
@ -316,6 +316,37 @@ export interface LabelMarginOptions {
|
||||
right?: Dimension;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines localized label margin.
|
||||
*
|
||||
* @interface LocalizedLabelMarginOptions
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
export interface LocalizedLabelMarginOptions {
|
||||
|
||||
/**
|
||||
* start localized label margin length.
|
||||
*
|
||||
* @type { ?LengthMetrics }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
start?: LengthMetrics;
|
||||
|
||||
/**
|
||||
* end localized label margin length.
|
||||
*
|
||||
* @type { ?LengthMetrics }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
end?: LengthMetrics;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines label option.
|
||||
*
|
||||
@ -439,6 +470,16 @@ export interface LabelOptions {
|
||||
* @since 12
|
||||
*/
|
||||
labelMargin?: LabelMarginOptions;
|
||||
|
||||
/**
|
||||
* Localized label margin.
|
||||
*
|
||||
* @type { ?LocalizedLabelMarginOptions }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
localizedLabelMargin?: LocalizedLabelMarginOptions;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -679,6 +720,16 @@ export interface ChipOptions {
|
||||
* @since 12
|
||||
*/
|
||||
onClicked?: Callback<void>;
|
||||
|
||||
/**
|
||||
* Indicates the attribute of the current chip direction.
|
||||
*
|
||||
* @type { ?Direction }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction?: Direction;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -731,6 +731,16 @@ declare class CounterOptions {
|
||||
* @since 12
|
||||
*/
|
||||
dateOptions?: DateStyleOptions;
|
||||
|
||||
/**
|
||||
* Indicates the attribute of the current counter direction.
|
||||
*
|
||||
* @type { ?Direction }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction?: Direction;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -413,6 +413,16 @@ export interface PopupOptions {
|
||||
* @since 12
|
||||
*/
|
||||
buttons?: [PopupButtonOptions?, PopupButtonOptions?];
|
||||
|
||||
/**
|
||||
* Indicates the attribute of the current popup direction.
|
||||
*
|
||||
* @type { ?Direction }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction?: Direction;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -435,6 +435,20 @@ interface CommonSegmentButtonOptions {
|
||||
*/
|
||||
buttonPadding?: Padding | Dimension;
|
||||
|
||||
/**
|
||||
* The localized padding of buttons.
|
||||
*
|
||||
* @type { ?LocalizedPadding }
|
||||
* @default For text only / icon only buttons LocalizedPadding
|
||||
* { top: LengthMetrics.vp(4), end: LengthMetrics.vp(8), bottom: LengthMetrics.vp(4), start: LengthMetrics.vp(8) }.
|
||||
* For text & icon buttons LocalizedPadding
|
||||
* {{ top: LengthMetrics.vp(6), end: LengthMetrics.vp(8), bottom: LengthMetrics.vp(6), start: LengthMetrics.vp(8) }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
localizedButtonPadding?: LocalizedPadding;
|
||||
|
||||
/**
|
||||
* The padding of text in button.
|
||||
*
|
||||
@ -456,6 +470,16 @@ interface CommonSegmentButtonOptions {
|
||||
*/
|
||||
textPadding?: Padding | Dimension;
|
||||
|
||||
/**
|
||||
* The localized padding of text in button.
|
||||
*
|
||||
* @type { ?LocalizedPadding }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
localizedTextPadding?: LocalizedPadding;
|
||||
|
||||
/**
|
||||
* The blurStyle of background.
|
||||
*
|
||||
@ -474,6 +498,16 @@ interface CommonSegmentButtonOptions {
|
||||
* @since 12
|
||||
*/
|
||||
backgroundBlurStyle?: BlurStyle;
|
||||
|
||||
/**
|
||||
* Indicates the attribute of the current segment button direction.
|
||||
*
|
||||
* @type { ?Direction }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction?: Direction;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1287,6 +1321,16 @@ declare class SegmentButtonOptions {
|
||||
*/
|
||||
buttonPadding: Padding | Dimension;
|
||||
|
||||
/**
|
||||
* The localized padding of buttons.
|
||||
*
|
||||
* @type { ?LocalizedPadding }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
localizedButtonPadding?: LocalizedPadding;
|
||||
|
||||
/**
|
||||
* The padding of text in button.
|
||||
*
|
||||
@ -1306,6 +1350,16 @@ declare class SegmentButtonOptions {
|
||||
*/
|
||||
textPadding: Padding | Dimension;
|
||||
|
||||
/**
|
||||
* The localized padding of text in button.
|
||||
*
|
||||
* @type { ?LocalizedPadding }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
localizedTextPadding?: LocalizedPadding;
|
||||
|
||||
/**
|
||||
* The blurStyle of background.
|
||||
*
|
||||
@ -1389,6 +1443,16 @@ declare class SegmentButtonOptions {
|
||||
* @since 12
|
||||
*/
|
||||
static capsule(options: CapsuleSegmentButtonConstructionOptions): SegmentButtonOptions;
|
||||
|
||||
/**
|
||||
* Indicates the attribute of the current segment button direction.
|
||||
*
|
||||
* @type { ?Direction }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
direction?: Direction;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
8
api/@ohos.arkui.componentSnapshot.d.ts
vendored
8
api/@ohos.arkui.componentSnapshot.d.ts
vendored
@ -39,7 +39,7 @@ declare namespace componentSnapshot {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if id is not valid.
|
||||
* @throws { BusinessError } 100001 - Invalid ID.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -55,7 +55,7 @@ declare namespace componentSnapshot {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if id is not valid.
|
||||
* @throws { BusinessError } 100001 - Invalid ID.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -71,7 +71,7 @@ declare namespace componentSnapshot {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if builder is not a valid build function.
|
||||
* @throws { BusinessError } 100001 - The builder is not a valid build function.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -87,7 +87,7 @@ declare namespace componentSnapshot {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if builder is not a valid build function.
|
||||
* @throws { BusinessError } 100001 - The builder is not a valid build function.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
|
||||
12
api/@ohos.arkui.dragController.d.ts
vendored
12
api/@ohos.arkui.dragController.d.ts
vendored
@ -154,7 +154,7 @@ declare namespace dragController {
|
||||
* trigger drag action
|
||||
*
|
||||
* @returns { Promise<void> } A Promise can indicate the start result.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 11
|
||||
*/
|
||||
@ -162,7 +162,7 @@ declare namespace dragController {
|
||||
* trigger drag action
|
||||
*
|
||||
* @returns { Promise<void> } A Promise can indicate the start result.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -373,7 +373,7 @@ declare namespace dragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 10
|
||||
*/
|
||||
@ -390,7 +390,7 @@ declare namespace dragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 10
|
||||
*/
|
||||
@ -409,7 +409,7 @@ declare namespace dragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @since 11
|
||||
*/
|
||||
@ -424,7 +424,7 @@ declare namespace dragController {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if some internal handling failed.
|
||||
* @throws { BusinessError } 100001 - Internal handling failed.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
|
||||
4
api/@ohos.arkui.uiExtension.d.ts
vendored
4
api/@ohos.arkui.uiExtension.d.ts
vendored
@ -133,7 +133,7 @@ declare namespace uiExtension {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @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 } 1300005 - This window proxy is abnormal.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
@ -149,7 +149,7 @@ declare namespace uiExtension {
|
||||
* @returns { Promise<void> } - The promise returned by the function
|
||||
* @throws { BusinessError } 1300002 - The UIExtension window proxy is abnormal.
|
||||
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
|
||||
* @throws { BusinessError } 1300008 - The operation is on invalid display.
|
||||
* @throws { BusinessError } 1300008 - The display device is abnormal.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @systemapi
|
||||
* @since 12
|
||||
|
||||
40
api/@ohos.bundle.bundleResourceManager.d.ts
vendored
40
api/@ohos.bundle.bundleResourceManager.d.ts
vendored
@ -104,6 +104,25 @@ declare namespace bundleResourceManager {
|
||||
*/
|
||||
function getBundleResourceInfo(bundleName: string, resourceFlags?: number): BundleResourceInfo;
|
||||
|
||||
/**
|
||||
* Obtains the BundleResourceInfo of a specified bundle. Default resourceFlag is GET_RESOURCE_INFO_ALL.
|
||||
*
|
||||
* @permission ohos.permission.GET_BUNDLE_RESOURCES
|
||||
* @param { string } bundleName - Indicates the bundle name of the application.
|
||||
* @param { number } [resourceFlags] - Indicates the flag used to specify information contained in the BundleResourceInfo object that will be returned.
|
||||
* @param { number } [appIndex] - Indicates the index of the bundle.
|
||||
* @returns { BundleResourceInfo } Returns the BundleResourceInfo object.
|
||||
* @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 } 17700061 - AppIndex not in valid range or not found.
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 12
|
||||
*/
|
||||
function getBundleResourceInfo(bundleName: string, resourceFlags?: number, appIndex?: number): BundleResourceInfo;
|
||||
|
||||
/**
|
||||
* Obtains the LauncherAbilityResourceInfo of a specified bundle. Default resourceFlag is GET_RESOURCE_INFO_ALL.
|
||||
*
|
||||
@ -121,6 +140,25 @@ declare namespace bundleResourceManager {
|
||||
*/
|
||||
function getLauncherAbilityResourceInfo(bundleName: string, resourceFlags?: number): Array<LauncherAbilityResourceInfo>;
|
||||
|
||||
/**
|
||||
* Obtains the LauncherAbilityResourceInfo of a specified bundle. Default resourceFlag is GET_RESOURCE_INFO_ALL.
|
||||
*
|
||||
* @permission ohos.permission.GET_BUNDLE_RESOURCES
|
||||
* @param { string } bundleName - Indicates the bundle name of the application.
|
||||
* @param { number } [resourceFlags] - Indicates the flag used to specify information contained in the LauncherAbilityResourceInfo object that will be returned.
|
||||
* @param { number } [appIndex] - Indicates the index of the bundle.
|
||||
* @returns { Array<LauncherAbilityResourceInfo> } Returns a list of LauncherAbilityResourceInfo objects.
|
||||
* @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 } 17700061 - AppIndex not in valid range or not found.
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 12
|
||||
*/
|
||||
function getLauncherAbilityResourceInfo(bundleName: string, resourceFlags?: number, appIndex?: number): Array<LauncherAbilityResourceInfo>;
|
||||
|
||||
/**
|
||||
* Obtains BundleResourceInfo of all bundles available in the system.
|
||||
*
|
||||
@ -184,6 +222,7 @@ declare namespace bundleResourceManager {
|
||||
/**
|
||||
* Obtains resource info of a bundle.
|
||||
*
|
||||
* @typedef { _BundleResourceInfo }
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 11
|
||||
@ -193,6 +232,7 @@ declare namespace bundleResourceManager {
|
||||
/**
|
||||
* Obtains resource info of a ability.
|
||||
*
|
||||
* @typedef { _LauncherAbilityResourceInfo }
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 11
|
||||
|
||||
10
api/@ohos.connectedTag.d.ts
vendored
10
api/@ohos.connectedTag.d.ts
vendored
@ -159,7 +159,10 @@ declare namespace connectedTag {
|
||||
* @param { number[] } data Indicates the NDEF data to send, which is a byte array.
|
||||
* @returns { Promise<void> } The void.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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
|
||||
|
||||
118
api/@ohos.display.d.ts
vendored
118
api/@ohos.display.d.ts
vendored
@ -145,8 +145,8 @@ declare namespace display {
|
||||
*
|
||||
* @param { number } displayId Display id to query. This parameter should be greater than or equal to 0.
|
||||
* @returns { boolean } true means there is a privacy window on the current display
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -159,8 +159,8 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'add' | 'remove' | 'change' } type the event of display change
|
||||
* @param { Callback<number> } callback the display id of changed
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @since 7
|
||||
*/
|
||||
@ -171,8 +171,8 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'add' | 'remove' | 'change' } type the event of display change event
|
||||
* @param { Callback<number> } callback the display id of changed
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @since 7
|
||||
*/
|
||||
@ -183,8 +183,8 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'privateModeChange' } type the event of private mode changes
|
||||
* @param { Callback<boolean> } callback Callback used to return the result whether display is on private mode or not
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
@ -196,8 +196,8 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'privateModeChange' } type the event of private mode changes
|
||||
* @param { Callback<boolean> } callback Callback used to return the result whether display is on private mode or not
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
@ -208,7 +208,7 @@ declare namespace display {
|
||||
* Check whether the device is foldable.
|
||||
*
|
||||
* @returns { boolean } true means the device is foldable.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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
|
||||
@ -219,7 +219,7 @@ declare namespace display {
|
||||
* Get the current fold status of the foldable device.
|
||||
*
|
||||
* @returns { FoldStatus } fold status of device.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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
|
||||
@ -231,9 +231,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldStatusChange' } type the event of fold status changes
|
||||
* @param { Callback<FoldStatus> } 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 on this 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
|
||||
@ -245,9 +245,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldStatusChange' } type the event of fold status changes
|
||||
* @param { Callback<FoldStatus> } callback Callback used to return the current fold status of device
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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
|
||||
@ -259,9 +259,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldAngleChange' } type the event of fold angle changes.
|
||||
* @param { Callback<Array<number>> } callback Callback used to return the current fold angle of device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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 12
|
||||
@ -273,9 +273,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldAngleChange' } type the event of fold angle changes.
|
||||
* @param { Callback<Array<number>> } callback Callback used to return the current fold angle of device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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 12
|
||||
@ -287,9 +287,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'captureStatusChange' } type the event of capture status changes.
|
||||
* @param { Callback<boolean> } callback Callback used to return the device capture status.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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 12
|
||||
@ -301,9 +301,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'captureStatusChange' } type the event of capture status changes.
|
||||
* @param { Callback<boolean> } callback Callback used to return the device capture status.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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 12
|
||||
@ -315,7 +315,7 @@ declare namespace display {
|
||||
* Check whether the device is captured.
|
||||
*
|
||||
* @returns { boolean } true means the device is captured.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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 12
|
||||
@ -326,7 +326,7 @@ 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 on this 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
|
||||
@ -337,10 +337,10 @@ declare namespace display {
|
||||
* Change the display mode of the foldable device.
|
||||
*
|
||||
* @param { FoldDisplayMode } mode target display mode to change.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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.
|
||||
* <br>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.
|
||||
@ -353,9 +353,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldDisplayModeChange' } type the event of fold display mode changes
|
||||
* @param { Callback<FoldDisplayMode> } callback Callback used to return the current fold display mode
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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
|
||||
@ -367,9 +367,9 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'foldDisplayModeChange' } type the event of fold display mode changes
|
||||
* @param { Callback<FoldDisplayMode> } callback Callback used to return the current fold display mode
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>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
|
||||
@ -380,7 +380,7 @@ declare namespace display {
|
||||
* 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 on this 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
|
||||
@ -391,10 +391,10 @@ declare namespace display {
|
||||
* set fold status locked or not.
|
||||
*
|
||||
* @param { boolean } locked - fold status is locked or not.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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.
|
||||
* <br>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.
|
||||
@ -970,7 +970,7 @@ declare namespace display {
|
||||
* Check if current display has immersive window.
|
||||
*
|
||||
* @param { AsyncCallback<boolean> } callback
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
@ -983,7 +983,7 @@ declare namespace display {
|
||||
* Check if current display has immersive window.
|
||||
*
|
||||
* @returns { Promise<boolean> }
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
@ -996,8 +996,8 @@ declare namespace display {
|
||||
* Obtain the available area of the display.
|
||||
*
|
||||
* @returns { Promise<Rect> }
|
||||
* @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
||||
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.Window.SessionManager
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -1010,10 +1010,10 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'availableAreaChange' } type - the event of available area changes
|
||||
* @param { Callback<Rect> } callback - Callback used to return the available area
|
||||
* @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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.
|
||||
* <br>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.
|
||||
@ -1026,10 +1026,10 @@ declare namespace display {
|
||||
*
|
||||
* @param { 'availableAreaChange' } type - the event of available area changes
|
||||
* @param { Callback<Rect> } [callback] - Callback used to return the available area
|
||||
* @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this 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.
|
||||
* <br>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.
|
||||
|
||||
42
api/@ohos.enterprise.accountManager.d.ts
vendored
42
api/@ohos.enterprise.accountManager.d.ts
vendored
@ -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<void> } callback - the callback of disallowAddLocalAccount.
|
||||
* @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 } 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 } 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<void> } the promise returned by the disallowAddLocalAccount.
|
||||
* @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 } 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 } 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - 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; 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 } 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 - 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; 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<osAccount.OsAccountInfo> } information about the OS account added.
|
||||
* @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 } 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 } 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
|
||||
|
||||
126
api/@ohos.enterprise.adminManager.d.ts
vendored
126
api/@ohos.enterprise.adminManager.d.ts
vendored
@ -148,9 +148,9 @@ declare namespace adminManager {
|
||||
* @param { AsyncCallback<void> } 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 } 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
|
||||
@ -173,9 +173,9 @@ declare namespace adminManager {
|
||||
* @param { AsyncCallback<void> } 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 } 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
|
||||
@ -198,9 +198,9 @@ declare namespace adminManager {
|
||||
* @returns { Promise<void> } 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 } 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
|
||||
@ -219,8 +219,8 @@ declare namespace adminManager {
|
||||
* The admin must have the corresponding permission.
|
||||
* @param { AsyncCallback<void> } 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 } 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
|
||||
@ -240,8 +240,8 @@ declare namespace adminManager {
|
||||
* @param { number } userId - userId indicates the user ID.
|
||||
* @param { AsyncCallback<void> } 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 } 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
|
||||
@ -261,7 +261,7 @@ declare namespace adminManager {
|
||||
* @param { number } [userId] - userId indicates the user ID or do not pass user ID.
|
||||
* @returns { Promise<void> } 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 } 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
|
||||
@ -278,8 +278,8 @@ declare namespace adminManager {
|
||||
* @param { String } bundleName - bundleName indicates the administrator bundle information.
|
||||
* @param { AsyncCallback<void> } 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 } 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
|
||||
@ -297,8 +297,8 @@ declare namespace adminManager {
|
||||
* @param { String } bundleName - bundleName indicates the administrator bundle information.
|
||||
* @returns { Promise<void> } 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 } 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<boolean> } 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<boolean> } 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<boolean> } 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<EnterpriseInfo> } 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<EnterpriseInfo> } 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<void> } 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<void> } 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<boolean> } 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<boolean> } 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<ManagedEvent> } managedEvents - managedEvents indicates the managed events to subscribe.
|
||||
* @param { AsyncCallback<void> } 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<ManagedEvent> } managedEvents - managedEvents indicates the managed events to subscribe.
|
||||
* @returns { Promise<void> } 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<ManagedEvent> } managedEvents - managedEvents indicates the managed events to subscribe.
|
||||
* @param { AsyncCallback<void> } 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<ManagedEvent> } managedEvents - managedEvents indicates the managed events to subscribe.
|
||||
* @returns { Promise<void> } 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<void> } callback - the callback of authorizeAdmin.
|
||||
* @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 } 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 } 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<void> } the promise returned by the authorizeAdmin.
|
||||
* @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 } 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 } 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
|
||||
@ -597,9 +597,9 @@ declare namespace adminManager {
|
||||
* @permission ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
|
||||
* @param { Want } admin - admin indicates the administrator ability information.
|
||||
* @param { Array<ManagedEvent> } 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
|
||||
@ -614,9 +614,9 @@ declare namespace adminManager {
|
||||
* @permission ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
|
||||
* @param { Want } admin - admin indicates the administrator ability information.
|
||||
* @param { Array<ManagedEvent> } 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
|
||||
|
||||
78
api/@ohos.enterprise.applicationManager.d.ts
vendored
78
api/@ohos.enterprise.applicationManager.d.ts
vendored
@ -39,10 +39,10 @@ declare namespace applicationManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
|
||||
* cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of addDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of addDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the addDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -131,10 +131,10 @@ declare namespace applicationManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
|
||||
* cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of removeDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of removeDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the removeDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 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<Array<string>> } callback - the callback of getDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<Array<string>> } callback - the callback of getDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<Array<string>> } the promise returned by the getDisallowedRunningBundles.
|
||||
* @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 } 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 } 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<string> } ids of the bundle are disallowed to run.
|
||||
* @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 } 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 } 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<Want> } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -329,9 +329,9 @@ declare namespace applicationManager {
|
||||
* @param { Array<Want> } 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 } 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 - 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; 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<Want> } the information of auto start applications.
|
||||
* @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 } 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 } 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
|
||||
|
||||
30
api/@ohos.enterprise.bluetoothManager.d.ts
vendored
30
api/@ohos.enterprise.bluetoothManager.d.ts
vendored
@ -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 } 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 - 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; 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -141,10 +141,10 @@ declare namespace bluetoothManager {
|
||||
* The admin must have the corresponding permission.
|
||||
* @param { Array<string> } 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 } 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 conflicting policy has been configured.
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @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<string> } 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 } 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 - 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; 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<string> } IDs of the bluetooth devices in the list.
|
||||
* @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 } 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 } 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
|
||||
|
||||
26
api/@ohos.enterprise.browser.d.ts
vendored
26
api/@ohos.enterprise.browser.d.ts
vendored
@ -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<void> } callback - the callback of setPolicies.
|
||||
* @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 } 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 } 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<void> } the promise returned by the setPolicies.
|
||||
* @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 } 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 } 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<string> } 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<string> } 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 } 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 - 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; 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
|
||||
|
||||
248
api/@ohos.enterprise.bundleManager.d.ts
vendored
248
api/@ohos.enterprise.bundleManager.d.ts
vendored
@ -67,10 +67,10 @@ declare namespace bundleManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle that can be installed. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of addAllowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of addAllowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the addAllowedInstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -159,10 +159,10 @@ declare namespace bundleManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle that can be installed. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of removeAllowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of removeAllowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the removeAllowedInstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } the promise that contains the appid list.
|
||||
* @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 } 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 } 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<string> } ids of the bundle that can be installed.
|
||||
* @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 } 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 } 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<string> } appIds - ids of the bundle that can not be installed. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of addDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of addDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the addDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -428,10 +428,10 @@ declare namespace bundleManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle that can not be installed. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of removeDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of removeDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the removeDisallowedInstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } the promise that contains the appid list.
|
||||
* @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 } 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 } 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<string> } ids of the bundle that can not be installed.
|
||||
* @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 } 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 } 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<string> } appIds - ids of the bundle that can not be uninstalled. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of addDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of addDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the addDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -697,10 +697,10 @@ declare namespace bundleManager {
|
||||
* @param { Array<string> } appIds - ids of the bundle that can not be uninstalled. The size of the array after
|
||||
* setting cannot be greater than 200.
|
||||
* @param { AsyncCallback<void> } callback - the callback of removeDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<void> } callback - the callback of removeDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<void> } the promise returned by the removeDisallowedUninstallBundles.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - 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; 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } callback - the callback that contains the appid list.
|
||||
* @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 } 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 } 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<Array<string>> } the promise that contains the appid list.
|
||||
* @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 } 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 } 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<string> } ids of the bundle that can not be uninstalled.
|
||||
* @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 } 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 } 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<void> } callback - the callback of uninstalling application result.
|
||||
* @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 } 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 } 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<void> } callback - the callback of uninstalling application result.
|
||||
* @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 } 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 } 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<void> } callback - the callback of uninstalling application result.
|
||||
* @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 } 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 } 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<void> } callback - the callback of uninstalling application result.
|
||||
* @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 } 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 } 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<void> } the promise of uninstalling application result.
|
||||
* @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 } 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 } 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<string> } hapFilePaths - indicates the path of the application to be installed.
|
||||
* @param { AsyncCallback<void> } callback - the callback of installing application result.
|
||||
* @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 } 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 } 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<void> } callback - the callback of installing application result.
|
||||
* @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 } 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 } 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<void> } the promise of installing application result.
|
||||
* @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 } 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 } 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
|
||||
|
||||
36
api/@ohos.enterprise.dateTimeManager.d.ts
vendored
36
api/@ohos.enterprise.dateTimeManager.d.ts
vendored
@ -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<void> } callback - the callback of setDateTime.
|
||||
* @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 } 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 } 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<void> } the promise returned by the setDateTime.
|
||||
* @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 } 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 } 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<void> } callback - the callback of disallowModifyDateTime.
|
||||
* @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 } 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 } 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<void> } the promise returned by the disallowModifyDateTime.
|
||||
* @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 } 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 } 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<boolean> } callback - return true if modify datetime is not allowed.
|
||||
* @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 } 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 } 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<boolean> } return true if modify datetime is not allowed.
|
||||
* @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 } 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 } 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
|
||||
|
||||
34
api/@ohos.enterprise.deviceControl.d.ts
vendored
34
api/@ohos.enterprise.deviceControl.d.ts
vendored
@ -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<void> } callback - the callback of resetFactory.
|
||||
* @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 } 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 } 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<void> } the promise returned by the resetFactory.
|
||||
* @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 } 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 } 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
40
api/@ohos.enterprise.deviceInfo.d.ts
vendored
40
api/@ohos.enterprise.deviceInfo.d.ts
vendored
@ -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<string> } callback - the callback of getDeviceSerial.
|
||||
* @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 } 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 } 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<string> } the promise returned by the getDeviceSerial.
|
||||
* @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 } 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 } 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<string> } callback - the callback of getDisplayVersion.
|
||||
* @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 } 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 } 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<string> } the promise returned by the getDisplayVersion.
|
||||
* @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 } 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 } 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<string> } callback - the callback of getDeviceName.
|
||||
* @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 } 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 } 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<string> } the promise returned by the getDeviceName.
|
||||
* @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 } 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 } 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
70
api/@ohos.enterprise.deviceSettings.d.ts
vendored
70
api/@ohos.enterprise.deviceSettings.d.ts
vendored
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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<number> } callback - the callback of getScreenOffTime.
|
||||
* @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 } 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 } 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<number> } the promise returned by the getScreenOffTime.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - manage certificate failed
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system application.
|
||||
* @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<string> } 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 } 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 - manage certificate failed
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system application.
|
||||
* @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<void> } callback - the callback of uninstallUserCertificate.
|
||||
* @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 } 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 } 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<void> } the promise returned by the uninstallUserCertificate.
|
||||
* @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 } 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 } 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -389,9 +389,9 @@ 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -410,9 +410,9 @@ 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
8
api/@ohos.enterprise.locationManager.d.ts
vendored
8
api/@ohos.enterprise.locationManager.d.ts
vendored
@ -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 } 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 - 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; 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
172
api/@ohos.enterprise.networkManager.d.ts
vendored
172
api/@ohos.enterprise.networkManager.d.ts
vendored
@ -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<Array<string>> } callback - the callback of getAllNetworkInterfaces.
|
||||
* @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 } 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 } 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<Array<string>> } the promise returned by getAllNetworkInterfaces.
|
||||
* @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 } 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 } 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<string> } all the network interfaces of the device.
|
||||
* @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 } 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 } 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<string> } callback - the callback of getIpAddress.
|
||||
* @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 } 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 } 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<string> } the promise returned by getIpAddress.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<string> } callback - the callback of getMac.
|
||||
* @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 } 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 } 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<string> } the promise returned by getMac.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<boolean> } callback - the callback of isNetworkInterfaceDisabled.
|
||||
* @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 } 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 } 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<boolean> } the promise returned by isNetworkInterfaceDisabled.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<void> } callback - the callback of setNetworkInterfaceDisabled.
|
||||
* @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 } 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 } 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<void> } the promise returned setNetworkInterfaceDisabled.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<void> } callback - the callback of setGlobalProxy.
|
||||
* @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 } 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 } 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<void> } the promise returned by the setGlobalProxy.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<connection.HttpProxy> } callback - the callback carries the network global proxy configuration information.
|
||||
* @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 } 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 } 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<connection.HttpProxy> } the promise carries the network global proxy configuration information.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<void> } callback - the callback of addIptablesFilterRule.
|
||||
* @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 } 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 } 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<void> } the promise returned by the addIptablesFilterRule.
|
||||
* @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 } 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 } 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<void> } callback - the callback of removeIptablesFilterRule.
|
||||
* @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 } 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 } 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<void> } the promise returned by the removeIptablesFilterRule.
|
||||
* @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 } 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 } 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<string> } 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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<string> } the promise carries the iptables rules in the table filter.
|
||||
* @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 } 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 } 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 } 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 - 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; 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 } 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 - 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; 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<FirewallRule> } an array of added firewall rules.
|
||||
* @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 } 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 } 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 } 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 - 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; 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 } 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 - 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; 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<DomainFilterRule> } an array of added domain filter rules.
|
||||
* @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 } 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 } 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
|
||||
|
||||
80
api/@ohos.enterprise.restrictions.d.ts
vendored
80
api/@ohos.enterprise.restrictions.d.ts
vendored
@ -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<void> } callback - the callback of setPrinterDisabled.
|
||||
* @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 } 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 } 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<void> } the promise returned by the setPrinterDisabled.
|
||||
* @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 } 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 } 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<boolean> } callback - the callback of isPrinterDisabled.
|
||||
* @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 } 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 } 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<boolean> } the promise returned by the isPrinterDisabled.
|
||||
* @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 } 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 } 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<void> } callback - the callback of setHdcDisabled.
|
||||
* @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 } 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 } 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<void> } the promise returned by the setHdcDisabled.
|
||||
* @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 } 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 } 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<boolean> } callback - the callback of isHdcDisabled.
|
||||
* @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 } 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 } 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<boolean> } the promise returned by the isHdcDisabled.
|
||||
* @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 } 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 } 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - 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; 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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
46
api/@ohos.enterprise.securityManager.d.ts
vendored
46
api/@ohos.enterprise.securityManager.d.ts
vendored
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - 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; 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<string> } 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 } 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 - manage certificate failed
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @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<void> } the promise returned by the uninstallUserCertificate.
|
||||
* @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 } 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 } 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 } 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 - 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; 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 } the password policy of the device.
|
||||
* @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 } 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 } 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
|
||||
@ -225,7 +225,7 @@ declare namespace securityManager {
|
||||
* Gets the password policy of the device.
|
||||
*
|
||||
* @returns { PasswordPolicy } the password policy of the device.
|
||||
* @throws { BusinessError } 202 - not system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
* @systemapi
|
||||
* @stagemodelonly
|
||||
@ -240,9 +240,9 @@ declare namespace securityManager {
|
||||
* @param { Want } admin - admin indicates the administrator ability information.
|
||||
* @param { number } tokenId - tokenId indicates the token id of the application.
|
||||
* @param { ClipboardPolicy } policy - clipboard policy to be set.
|
||||
* @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 } 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 } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
||||
* @throws { BusinessError } 401 - invalid input parameter.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
* @stagemodelonly
|
||||
@ -257,9 +257,9 @@ declare namespace securityManager {
|
||||
* @param { Want } admin - admin indicates the administrator ability information.
|
||||
* @param { number } [tokenId] - tokenId indicates the token id of the application.
|
||||
* @returns { string } the json string of clipboard policy for each application of the device.
|
||||
* @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 } 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 } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
||||
* @throws { BusinessError } 401 - invalid input parameter.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
* @stagemodelonly
|
||||
|
||||
16
api/@ohos.enterprise.systemManager.d.ts
vendored
16
api/@ohos.enterprise.systemManager.d.ts
vendored
@ -202,9 +202,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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -221,9 +221,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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -240,9 +240,9 @@ declare namespace systemManager {
|
||||
* @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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
@ -259,9 +259,9 @@ declare namespace systemManager {
|
||||
* @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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
50
api/@ohos.enterprise.usbManager.d.ts
vendored
50
api/@ohos.enterprise.usbManager.d.ts
vendored
@ -105,10 +105,10 @@ declare namespace usbManager {
|
||||
* The admin must have the corresponding permission.
|
||||
* @param { UsbPolicy } usbPolicy - usb policy code.
|
||||
* @param { AsyncCallback<void> } callback - the callback of setUsbPolicy.
|
||||
* @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 } 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 } 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<void> } the promise returned setUsbPolicy.
|
||||
* @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 } 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 } 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 } 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 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 } 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -192,10 +192,10 @@ declare namespace usbManager {
|
||||
* The admin must have the corresponding permission.
|
||||
* @param { Array<UsbDeviceId> } 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 } 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 conflicting policy has been configured.
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @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<UsbDeviceId> } 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 } 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 - 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; 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<UsbDeviceId> } an array of the available USB device trust list.
|
||||
* @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 } 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 } 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 } 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 conflicting policy has been configured.
|
||||
* @throws { BusinessError } 201 - the application does not have permission to call this function.
|
||||
* @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 } 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 - 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; 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
||||
|
||||
44
api/@ohos.enterprise.wifiManager.d.ts
vendored
44
api/@ohos.enterprise.wifiManager.d.ts
vendored
@ -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<boolean> } callback - the callback of isWifiActive.
|
||||
* @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 } 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 } 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<boolean> } the promise returned by isWifiActive.
|
||||
* @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 } 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 } 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 } 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 - 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; 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<void> } callback - the callback of setWifiProfile.
|
||||
* @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 } 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 } 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<void> } the promise returned by setWifiProfile.
|
||||
* @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 } 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 } 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 } 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 - 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; 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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
@ -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 } 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 - the application does not have permission to call this function.
|
||||
* @throws { BusinessError } 202 - not system 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
|
||||
|
||||
6
api/@ohos.file.fs.d.ts
vendored
6
api/@ohos.file.fs.d.ts
vendored
@ -5753,7 +5753,8 @@ declare function writeSync(
|
||||
* @param { DfsListeners } listeners - The listeners of Distributed File System.
|
||||
* @returns { Promise<void> } The promise returned by the function.
|
||||
* @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;
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 13900045 - Connection failed.
|
||||
* @throws { BusinessError } 13900046 - Software caused connection abort.
|
||||
* @syscap SystemCapability.FileManagement.File.FileIO
|
||||
@ -5766,7 +5767,8 @@ declare function connectDfs(networkId: string, listeners: DfsListeners): Promise
|
||||
*
|
||||
* @param { string } networkId - The networkId of device.
|
||||
* @returns { Promise<void> } The promise returned by the function.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 201 - Permission denied.Possible causes:1.Mandatory parameters are left unspecified;
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @syscap SystemCapability.FileManagement.File.FileIO
|
||||
* @since 12
|
||||
|
||||
502
api/@ohos.file.photoAccessHelper.d.ts
vendored
502
api/@ohos.file.photoAccessHelper.d.ts
vendored
File diff suppressed because it is too large
Load Diff
88
api/@ohos.file.picker.d.ts
vendored
88
api/@ohos.file.picker.d.ts
vendored
@ -35,6 +35,15 @@ import { AsyncCallback, Callback } from './@ohos.base';
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Provide the capabilities to use different pickers.
|
||||
*
|
||||
* @namespace picker
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare namespace picker {
|
||||
/**
|
||||
* PhotoViewMIMETypes represents the type of media resource that photo picker selects.
|
||||
@ -324,6 +333,7 @@ declare namespace picker {
|
||||
*
|
||||
* @enum { number } DocumentSelectMode
|
||||
* @syscap SystemCapability.FileManagement.UserFileService.FolderSelection
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -338,6 +348,7 @@ declare namespace picker {
|
||||
* Indicates that only files are allowed to be selected.
|
||||
*
|
||||
* @syscap SystemCapability.FileManagement.UserFileService.FolderSelection
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -353,6 +364,7 @@ declare namespace picker {
|
||||
* Indicates that only folders are allowed to be selected.
|
||||
*
|
||||
* @syscap SystemCapability.FileManagement.UserFileService.FolderSelection
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -412,6 +424,7 @@ declare namespace picker {
|
||||
* DocumentSelectOptions Object.
|
||||
*
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -428,6 +441,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -445,6 +459,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?Array<string> }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -462,6 +477,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?number }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -479,6 +495,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?DocumentSelectMode }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService.FolderSelection
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -507,6 +524,7 @@ declare namespace picker {
|
||||
* DocumentSaveOptions Object
|
||||
*
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -523,6 +541,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?Array<string> }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -540,6 +559,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -582,6 +602,7 @@ declare namespace picker {
|
||||
* DocumentViewPicker Object
|
||||
*
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -600,6 +621,7 @@ declare namespace picker {
|
||||
* @param { DocumentSelectOptions } option - represents the options provided in select mode.
|
||||
* @returns { Promise<Array<string>> } Returns the uris for the selected files.
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -619,6 +641,7 @@ declare namespace picker {
|
||||
* @param { DocumentSelectOptions } option - represents the options provided in select mode.
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -636,6 +659,7 @@ declare namespace picker {
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -655,6 +679,7 @@ declare namespace picker {
|
||||
* @param { DocumentSaveOptions } option - represents the options provided in save mode.
|
||||
* @returns { Promise<Array<string>> } Returns the uris for the saved files.
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -674,6 +699,7 @@ declare namespace picker {
|
||||
* @param { DocumentSaveOptions } option - represents the options provided in save mode.
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -691,6 +717,7 @@ declare namespace picker {
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -715,6 +742,7 @@ declare namespace picker {
|
||||
*
|
||||
* @type { ?number }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
@ -735,6 +763,14 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* The names of the files to be saved.
|
||||
*
|
||||
* @type { ?Array<string> }
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
newFileNames?: Array<string>;
|
||||
}
|
||||
|
||||
@ -753,6 +789,15 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the selection mode.
|
||||
*
|
||||
* @param { AudioSelectOptions } option - represents the options provided in select mode.
|
||||
* @returns { Promise<Array<string>> } Returns the uris for the selected files.
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
select(option?: AudioSelectOptions): Promise<Array<string>>;
|
||||
|
||||
/**
|
||||
@ -763,6 +808,15 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the selection mode.
|
||||
*
|
||||
* @param { AudioSelectOptions } option - represents the options provided in select mode.
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
select(option: AudioSelectOptions, callback: AsyncCallback<Array<string>>): void;
|
||||
|
||||
/**
|
||||
@ -772,6 +826,14 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the selection mode.
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
select(callback: AsyncCallback<Array<string>>): void;
|
||||
|
||||
/**
|
||||
@ -782,6 +844,15 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the save mode.
|
||||
*
|
||||
* @param { AudioSaveOptions } option - represents the options provided in save mode.
|
||||
* @returns { Promise<Array<string>> } Returns the uris for the saved files.
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
save(option?: AudioSaveOptions): Promise<Array<string>>;
|
||||
|
||||
/**
|
||||
@ -792,6 +863,15 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the save mode.
|
||||
*
|
||||
* @param { AudioSaveOptions } option - represents the options provided in save mode.
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
save(option: AudioSaveOptions, callback: AsyncCallback<Array<string>>): void;
|
||||
|
||||
/**
|
||||
@ -801,6 +881,14 @@ declare namespace picker {
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Pull up the audio picker based on the save mode.
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback - callback
|
||||
* @syscap SystemCapability.FileManagement.UserFileService
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
save(callback: AsyncCallback<Array<string>>): void;
|
||||
}
|
||||
}
|
||||
|
||||
21
api/@ohos.fileshare.d.ts
vendored
21
api/@ohos.fileshare.d.ts
vendored
@ -167,7 +167,8 @@ declare namespace fileShare {
|
||||
* @param { AsyncCallback<void> } 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;
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 143000001 - IPC error
|
||||
* @syscap SystemCapability.FileManagement.AppFileService
|
||||
* @systemapi
|
||||
@ -190,7 +191,8 @@ declare namespace fileShare {
|
||||
* @returns { Promise<void> } 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;
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 143000001 - IPC error
|
||||
* @syscap SystemCapability.FileManagement.AppFileService
|
||||
* @systemapi
|
||||
@ -205,7 +207,8 @@ declare namespace fileShare {
|
||||
* @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs.
|
||||
* @returns { Promise<void> } 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;
|
||||
* <br>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<PolicyInfo> } policies - Policy information to grant permission on URIs.
|
||||
* @returns { Promise<void> } 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;
|
||||
* <br>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<PolicyInfo> } policies - Policy information to grant permission on URIs.
|
||||
* @returns { Promise<void> } 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;
|
||||
* <br>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<PolicyInfo> } policies - Policy information to grant permission on URIs.
|
||||
* @returns { Promise<void> } 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;
|
||||
* <br>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<PolicyInfo> } policies - Policy information to grant permission on URIs.
|
||||
* @returns { Promise<Array<boolean>> } 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;
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
* @throws { BusinessError } 13900042 - Unknown error
|
||||
* @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization
|
||||
|
||||
1
api/@ohos.multimedia.avsession.d.ts
vendored
1
api/@ohos.multimedia.avsession.d.ts
vendored
@ -2541,6 +2541,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;
|
||||
|
||||
253
api/@ohos.multimedia.camera.d.ts
vendored
253
api/@ohos.multimedia.camera.d.ts
vendored
@ -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
|
||||
@ -1361,6 +1362,19 @@ declare namespace camera {
|
||||
*/
|
||||
open(): Promise<void>;
|
||||
|
||||
/**
|
||||
* Open camera.
|
||||
*
|
||||
* @param { boolean } isSecureEnabled - Enable secure camera.
|
||||
* @returns { Promise<bigint> } 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<bigint>;
|
||||
|
||||
/**
|
||||
* Close camera.
|
||||
*
|
||||
@ -1444,7 +1458,15 @@ declare namespace camera {
|
||||
* @systemapi
|
||||
* @since 11
|
||||
*/
|
||||
NIGHT_PHOTO = 4
|
||||
NIGHT_PHOTO = 4,
|
||||
|
||||
/**
|
||||
* Secure camera mode.
|
||||
*
|
||||
* @syscap SystemCapability.Multimedia.Camera.Core
|
||||
* @since 12
|
||||
*/
|
||||
SECURE_PHOTO = 12,
|
||||
}
|
||||
|
||||
/**
|
||||
@ -2415,6 +2437,67 @@ declare namespace camera {
|
||||
enableMacro(enabled: boolean): 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<FocusState> } callback - Callback used to get the focus state change.
|
||||
* @syscap SystemCapability.Multimedia.Camera.Core
|
||||
* @since 12
|
||||
*/
|
||||
on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void;
|
||||
|
||||
/**
|
||||
* Unsubscribes from focus status change event callback.
|
||||
*
|
||||
* @param { 'focusStateChange' } type - Event type.
|
||||
* @param { AsyncCallback<FocusState> } callback - Callback used to get the focus state change.
|
||||
* @syscap SystemCapability.Multimedia.Camera.Core
|
||||
* @since 12
|
||||
*/
|
||||
off(type: 'focusStateChange', callback?: AsyncCallback<FocusState>): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Session object.
|
||||
*
|
||||
@ -3236,6 +3319,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 +3424,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 +3518,32 @@ declare namespace camera {
|
||||
* @since 11
|
||||
*/
|
||||
off(type: 'macroStatusChanged', callback?: AsyncCallback<boolean>): void;
|
||||
|
||||
/**
|
||||
* Subscribes to feature detection results.
|
||||
*
|
||||
* @param { 'featureDetection' } type - Event type.
|
||||
* @param { SceneFeatureType } featureType - Feature type.
|
||||
* @param { AsyncCallback<SceneFeatureDetectionResult> } 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<SceneFeatureDetectionResult>): void;
|
||||
|
||||
/**
|
||||
* Unsubscribes from feature detection result.
|
||||
*
|
||||
* @param { 'featureDetection' } type - Event type.
|
||||
* @param { SceneFeatureType } featureType - Feature type.
|
||||
* @param { AsyncCallback<SceneFeatureDetectionResult> } 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<SceneFeatureDetectionResult>): void;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -4671,6 +4877,26 @@ declare namespace camera {
|
||||
*/
|
||||
off(type: 'deferredPhotoProxyAvailable', callback?: AsyncCallback<DeferredPhotoProxy>): void;
|
||||
|
||||
/**
|
||||
* Subscribes photo asset event callback.
|
||||
*
|
||||
* @param { 'photoAssetAvailable' } type - Event type.
|
||||
* @param { AsyncCallback<photoAccessHelper.PhotoAsset> } callback - Callback used to get the asset.
|
||||
* @syscap SystemCapability.Multimedia.Camera.Core
|
||||
* @since 12
|
||||
*/
|
||||
on(type: 'photoAssetAvailable', callback: AsyncCallback<photoAccessHelper.PhotoAsset>): void;
|
||||
|
||||
/**
|
||||
* Unsubscribes photo asset event callback.
|
||||
*
|
||||
* @param { 'photoAssetAvailable' } type - Event type.
|
||||
* @param { AsyncCallback<photoAccessHelper.PhotoAsset> } callback - Callback used to get the asset.
|
||||
* @syscap SystemCapability.Multimedia.Camera.Core
|
||||
* @since 12
|
||||
*/
|
||||
off(type: 'photoAssetAvailable', callback?: AsyncCallback<photoAccessHelper.PhotoAsset>): void;
|
||||
|
||||
/**
|
||||
* Check whether to support mirror photo.
|
||||
*
|
||||
@ -4919,6 +5145,29 @@ declare namespace camera {
|
||||
* @since 10
|
||||
*/
|
||||
off(type: 'quickThumbnail', callback?: AsyncCallback<image.PixelMap>): 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;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
10
api/@ohos.multimedia.image.d.ts
vendored
10
api/@ohos.multimedia.image.d.ts
vendored
@ -5046,6 +5046,16 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<vo
|
||||
*/
|
||||
writeBufferToPixelsSync(src: ArrayBuffer): void;
|
||||
|
||||
/**
|
||||
* Convert pixelmap to standard dynamic range.
|
||||
*
|
||||
* @returns { Promise<void> } A Promise instance used to return the operation result. If the operation fails, an error message is returned.
|
||||
* @throws { BusinessError } 62980137 - Invalid image operation.
|
||||
* @syscap SystemCapability.Multimedia.Image.Core
|
||||
* @since 12
|
||||
*/
|
||||
toSdr(): Promise<void>;
|
||||
|
||||
/**
|
||||
* Obtains pixel map information about this image. This method uses a promise to return the information.
|
||||
*
|
||||
|
||||
12
api/@ohos.multimedia.media.d.ts
vendored
12
api/@ohos.multimedia.media.d.ts
vendored
@ -3557,6 +3557,18 @@ declare namespace media {
|
||||
* @since 12
|
||||
*/
|
||||
SPEED_FORWARD_1_50_X = 6,
|
||||
/**
|
||||
* playback at 0.25x normal speed
|
||||
* @syscap SystemCapability.Multimedia.Media.VideoPlayer
|
||||
* @since 12
|
||||
*/
|
||||
SPEED_FORWARD_0_25_X = 8,
|
||||
/**
|
||||
* playback at 0.125x normal speed
|
||||
* @syscap SystemCapability.Multimedia.Media.VideoPlayer
|
||||
* @since 12
|
||||
*/
|
||||
SPEED_FORWARD_0_125_X = 9,
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
50
api/@ohos.nfc.cardEmulation.d.ts
vendored
50
api/@ohos.nfc.cardEmulation.d.ts
vendored
@ -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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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
|
||||
|
||||
205
api/@ohos.nfc.tag.d.ts
vendored
205
api/@ohos.nfc.tag.d.ts
vendored
@ -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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } [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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<TagInfo> } [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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @syscap SystemCapability.Communication.NFC.Tag
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
|
||||
346
api/@ohos.notificationManager.d.ts
vendored
346
api/@ohos.notificationManager.d.ts
vendored
File diff suppressed because it is too large
Load Diff
42
api/@ohos.notificationSubscribe.d.ts
vendored
42
api/@ohos.notificationSubscribe.d.ts
vendored
@ -102,7 +102,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -119,7 +119,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -139,7 +139,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -163,7 +163,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -182,7 +182,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -200,7 +200,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -220,8 +220,8 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -247,8 +247,8 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -268,8 +268,8 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -289,7 +289,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -308,8 +308,8 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -328,7 +328,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -346,7 +346,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -364,7 +364,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -382,7 +382,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -401,7 +401,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
@ -420,7 +420,7 @@ declare namespace notificationSubscribe {
|
||||
* @throws { BusinessError } 401 - The parameter check 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
|
||||
|
||||
156
api/@ohos.request.d.ts
vendored
156
api/@ohos.request.d.ts
vendored
@ -4234,6 +4234,10 @@ declare namespace request {
|
||||
* @param { 'progress' } event event types.
|
||||
* @param { function } callback callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4244,6 +4248,10 @@ declare namespace request {
|
||||
* @param { 'progress' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4256,6 +4264,10 @@ declare namespace request {
|
||||
* @param { 'progress' } event event types.
|
||||
* @param { function } callback callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4266,6 +4278,10 @@ declare namespace request {
|
||||
* @param { 'progress' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4278,6 +4294,10 @@ declare namespace request {
|
||||
* @param { 'completed' } event event types.
|
||||
* @param { function } callback callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4288,6 +4308,10 @@ declare namespace request {
|
||||
* @param { 'completed' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4300,6 +4324,10 @@ declare namespace request {
|
||||
* @param { 'completed' } event event types.
|
||||
* @param { function } callback callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4310,6 +4338,10 @@ declare namespace request {
|
||||
* @param { 'completed' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4322,6 +4354,10 @@ declare namespace request {
|
||||
* @param { 'failed' } event event types.
|
||||
* @param { function } callback callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4332,6 +4368,10 @@ declare namespace request {
|
||||
* @param { 'failed' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4354,6 +4394,10 @@ declare namespace request {
|
||||
* @param { 'failed' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
@ -4366,6 +4410,10 @@ declare namespace request {
|
||||
* @param { 'pause' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
*/
|
||||
@ -4376,6 +4424,10 @@ declare namespace request {
|
||||
* @param { 'pause' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
*/
|
||||
@ -4386,6 +4438,10 @@ declare namespace request {
|
||||
* @param { 'resume' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
*/
|
||||
@ -4396,6 +4452,10 @@ declare namespace request {
|
||||
* @param { 'resume' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
*/
|
||||
@ -4406,6 +4466,10 @@ declare namespace request {
|
||||
* @param { 'remove' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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
|
||||
*/
|
||||
@ -4416,6 +4480,10 @@ declare namespace request {
|
||||
* @param { 'remove' } event - event types.
|
||||
* @param { function } callback - callback function with a `Progress` argument.
|
||||
* @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 +4493,11 @@ declare namespace request {
|
||||
*
|
||||
* @param { 'response' } event - event types.
|
||||
* @param { Callback<HttpResponse> } 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 +4508,11 @@ declare namespace request {
|
||||
*
|
||||
* @param { 'response' } event - event types.
|
||||
* @param { Callback<HttpResponse> } 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
|
||||
@ -4733,7 +4811,9 @@ declare namespace request {
|
||||
* @returns { Promise<Task> } the promise returned by the function.
|
||||
* @throws { BusinessError } 401 - parameter error.
|
||||
* Possible causes:
|
||||
* 1. Parameter verification failed
|
||||
* 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
|
||||
@ -4748,6 +4828,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @param { AsyncCallback<void> } callback callback function with a boolean argument indicating success or not.
|
||||
* @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
|
||||
@ -4760,6 +4844,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @param { AsyncCallback<void> } callback callback function with a boolean argument indicating success or not.
|
||||
* @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
|
||||
@ -4776,6 +4864,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @returns { Promise<void> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4788,6 +4880,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @returns { Promise<void> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4803,6 +4899,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @param { AsyncCallback<TaskInfo> } callback callback function with a `TaskInfo` argument for informations of the current task.
|
||||
* @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
|
||||
@ -4814,6 +4914,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @param { AsyncCallback<TaskInfo> } callback callback function with a `TaskInfo` argument for informations of the current task.
|
||||
* @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
|
||||
@ -4828,6 +4932,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @returns { Promise<TaskInfo> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4839,6 +4947,10 @@ declare namespace request {
|
||||
* @param { string } id the task id.
|
||||
* @returns { Promise<TaskInfo> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4854,6 +4966,10 @@ declare namespace request {
|
||||
* @param { string } token the in-application isolation key.
|
||||
* @param { AsyncCallback<TaskInfo> } callback callback function with a `TaskInfo` argument for informations of the current task.
|
||||
* @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
|
||||
@ -4867,7 +4983,9 @@ declare namespace request {
|
||||
* @param { AsyncCallback<TaskInfo> } callback callback function with a `TaskInfo` argument for informations of the current task.
|
||||
* @throws { BusinessError } 401 - parameter error.
|
||||
* Possible causes:
|
||||
* 1. Parameter verification failed
|
||||
* 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
|
||||
@ -4883,6 +5001,10 @@ declare namespace request {
|
||||
* @param { string } token the in-application isolation key.
|
||||
* @returns { Promise<TaskInfo> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4896,7 +5018,9 @@ declare namespace request {
|
||||
* @returns { Promise<TaskInfo> } the promise returned by the function.
|
||||
* @throws { BusinessError } 401 - parameter error.
|
||||
* Possible causes:
|
||||
* 1. Parameter verification failed
|
||||
* 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
|
||||
@ -4910,6 +5034,9 @@ declare namespace request {
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback callback function with a `Array<string>` argument contains task ids match filter.
|
||||
* @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
|
||||
@ -4919,6 +5046,9 @@ declare namespace request {
|
||||
*
|
||||
* @param { AsyncCallback<Array<string>> } callback callback function with a `Array<string>` argument contains task ids match filter.
|
||||
* @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
|
||||
@ -4932,6 +5062,9 @@ declare namespace request {
|
||||
* @param { Filter } filter an instance of `Filter`.
|
||||
* @param { AsyncCallback<Array<string>> } callback callback function with a `Array<string>` argument contains task ids match filter.
|
||||
* @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
|
||||
@ -4942,6 +5075,9 @@ declare namespace request {
|
||||
* @param { Filter } filter an instance of `Filter`.
|
||||
* @param { AsyncCallback<Array<string>> } callback callback function with a `Array<string>` argument contains task ids match filter.
|
||||
* @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
|
||||
@ -4955,6 +5091,9 @@ declare namespace request {
|
||||
* @param { Filter } filter an instance of `Filter`.
|
||||
* @returns { Promise<Array<string>> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4965,6 +5104,9 @@ declare namespace request {
|
||||
* @param { Filter } filter an instance of `Filter`.
|
||||
* @returns { Promise<Array<string>> } the promise returned by the function.
|
||||
* @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
|
||||
@ -4981,6 +5123,10 @@ declare namespace request {
|
||||
* @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.
|
||||
* 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
|
||||
@ -4998,6 +5144,10 @@ declare namespace request {
|
||||
* @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.
|
||||
* 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
|
||||
|
||||
32
api/@ohos.router.d.ts
vendored
32
api/@ohos.router.d.ts
vendored
@ -579,7 +579,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -593,7 +593,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -610,7 +610,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -624,7 +624,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -642,7 +642,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -657,7 +657,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -675,7 +675,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -690,7 +690,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @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
|
||||
@ -1149,7 +1149,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1164,7 +1164,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1182,7 +1182,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1197,7 +1197,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1216,7 +1216,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1232,7 +1232,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if UI execution context not found, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1251,7 +1251,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
@ -1267,7 +1267,7 @@ declare namespace router {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 100001 - if can not get the delegate, only throw in standard system.
|
||||
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
|
||||
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
|
||||
104
api/@ohos.screen.d.ts
vendored
104
api/@ohos.screen.d.ts
vendored
@ -57,8 +57,8 @@ declare namespace screen {
|
||||
* @param { 'connect' | 'disconnect' | 'change' } eventType the event of screen changes. This parameter is of string
|
||||
* type and cannot be empty.
|
||||
* @param { Callback<number> } callback Callback used to return the screen ID. This parameter is callable.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 9
|
||||
@ -72,8 +72,8 @@ declare namespace screen {
|
||||
* type and cannot be empty.
|
||||
* @param { Callback<number> } callback Callback used to return the screen ID. If this parameter is specified, it must
|
||||
* be a callback.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 9
|
||||
@ -87,8 +87,8 @@ declare namespace screen {
|
||||
* sure it's type of Array<ExpandOption>.
|
||||
* @param { AsyncCallback<number> } callback callback used to return the group ID of the expanded screens. It must
|
||||
* be a callback.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -102,8 +102,8 @@ declare namespace screen {
|
||||
* @param { Array<ExpandOption> } options Parameters for expanding the screen. The options must be valid, and make
|
||||
* sure it's type of Array<ExpandOption>.
|
||||
* @returns { Promise<number> } used to return the group ID of the expanded screens
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -117,8 +117,8 @@ declare namespace screen {
|
||||
* @param { Array<number> } expandScreen IDs of expand screens to stop. The size of the expandScreen Array should not
|
||||
* exceed 1000.
|
||||
* @param { AsyncCallback<void> } callback used to return the result
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -132,8 +132,8 @@ declare namespace screen {
|
||||
* @param { Array<number> } expandScreen IDs of expand screens to stop. The size of the expandScreen Array should not
|
||||
* exceed 1000.
|
||||
* @returns { Promise<void> } promise used to return the result
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -147,8 +147,8 @@ declare namespace screen {
|
||||
* @param { number } mainScreen ID of the primary screen. It's type should be int.
|
||||
* @param { Array<number> } mirrorScreen IDs of secondary screens
|
||||
* @param { AsyncCallback<number> } callback Callback used to return the group ID of the secondary screens
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -162,8 +162,8 @@ declare namespace screen {
|
||||
* @param { number } mainScreen ID of the primary screen. It's type should be int.
|
||||
* @param { Array<number> } mirrorScreen IDs of secondary screens
|
||||
* @returns { Promise<number> } Promise used to return the group ID of the secondary screens
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -177,8 +177,8 @@ declare namespace screen {
|
||||
* @param { Array<number> } mirrorScreen IDs of mirror screens to stop. The size of the mirrorScreen Array should not
|
||||
* exceed 1000.
|
||||
* @param { AsyncCallback<void> } callback used to return the result
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -192,8 +192,8 @@ declare namespace screen {
|
||||
* @param { Array<number> } mirrorScreen IDs of mirror screens to stop. The size of the mirrorScreen Array should not
|
||||
* exceed 1000.
|
||||
* @returns { Promise<void> } promise used to return the result
|
||||
* @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 } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -207,9 +207,9 @@ declare namespace screen {
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { VirtualScreenOption } options Indicates the options of the virtual screen.
|
||||
* @param { AsyncCallback<Screen> } callback Callback used to return the created virtual screen
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @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.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -223,9 +223,9 @@ declare namespace screen {
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { VirtualScreenOption } options Indicates the options of the virtual screen.
|
||||
* @returns { Promise<Screen> } Promise used to return the created virtual screen
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* 2.Incorrect parameter types.
|
||||
* @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 } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -238,8 +238,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } screenId Indicates the screen id of the virtual screen.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400002 - Unauthorized operation.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -252,8 +252,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } screenId Indicates the screen id of the virtual screen.
|
||||
* @returns { Promise<void> } Promise that returns no value.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400002 - Unauthorized operation.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -268,9 +268,9 @@ declare namespace screen {
|
||||
* @param { number } screenId Indicates the screen id of the virtual screen.
|
||||
* @param { string } surfaceId Indicates the surface id.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @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.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -285,9 +285,9 @@ declare namespace screen {
|
||||
* @param { number } screenId Indicates the screen id of the virtual screen.
|
||||
* @param { string } surfaceId Indicates the surface id.
|
||||
* @returns { Promise<void> } Promise that returns no value
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @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.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -320,8 +320,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { boolean } isLocked Indicates whether the screen rotation switch is locked.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 9
|
||||
@ -333,8 +333,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { boolean } isLocked Indicates whether the screen rotation switch is locked.
|
||||
* @returns { Promise<void> } Promise that returns no value.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 9
|
||||
@ -547,8 +547,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { Orientation } orientation Screen orientation. orientation value must from enum Orientation.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -561,8 +561,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { Orientation } orientation Screen orientation. orientation value must from enum Orientation.
|
||||
* @returns { Promise<void> } Promise that returns no value.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types. 3.Parameter verification failed.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -575,8 +575,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } modeIndex Index of the mode to set.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -589,8 +589,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } modeIndex Index of the mode to set.
|
||||
* @returns { Promise<void> } Promise that returns no value.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -603,8 +603,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } densityDpi Pixel density. The value ranges from 80 to 640.
|
||||
* @param { AsyncCallback<void> } callback Callback used to return the result.
|
||||
* @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.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
@ -617,8 +617,8 @@ declare namespace screen {
|
||||
*
|
||||
* @param { number } densityDpi Pixel density. The value ranges from 80 to 640.
|
||||
* @returns { Promise<void> } Promise that returns no value.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
|
||||
* <br>2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
|
||||
10
api/@ohos.screenshot.d.ts
vendored
10
api/@ohos.screenshot.d.ts
vendored
@ -43,7 +43,7 @@ declare namespace screenshot {
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { ScreenshotOptions } options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
||||
* @param { AsyncCallback<image.PixelMap> } callback Callback used to return a PixelMap object.
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @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.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
@ -56,8 +56,8 @@ declare namespace screenshot {
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { ScreenshotOptions } options - Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
||||
* @param { AsyncCallback<image.PixelMap> } callback - Callback used to return a PixelMap object.
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
||||
* @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.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
||||
@ -72,7 +72,7 @@ declare namespace screenshot {
|
||||
*
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { AsyncCallback<image.PixelMap> } callback Callback used to return a PixelMap object.
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 7
|
||||
@ -85,7 +85,7 @@ declare namespace screenshot {
|
||||
* @permission ohos.permission.CAPTURE_SCREEN
|
||||
* @param { ScreenshotOptions } options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
||||
* @returns { Promise<image.PixelMap> } Promise used to return a PixelMap object.
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @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.
|
||||
* <br>2.Incorrect parameter types.
|
||||
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
||||
|
||||
55
api/@ohos.secureElement.d.ts
vendored
55
api/@ohos.secureElement.d.ts
vendored
@ -37,7 +37,10 @@ declare namespace omapi {
|
||||
* @param { 'serviceState' } type nfc serviceState
|
||||
* @param { Callback<ServiceState> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<Channel> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } The response received, as a byte array.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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.
|
||||
|
||||
4
api/@ohos.uiExtensionHost.d.ts
vendored
4
api/@ohos.uiExtensionHost.d.ts
vendored
@ -147,7 +147,7 @@ declare namespace uiExtensionHost {
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported on this device.
|
||||
* @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 } 1300005 - This window proxy is abnormal.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
@ -164,7 +164,7 @@ declare namespace uiExtensionHost {
|
||||
* @returns { Promise<void> } - The promise returned by the function
|
||||
* @throws { BusinessError } 1300002 - The UIExtension window proxy is abnormal.
|
||||
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
|
||||
* @throws { BusinessError } 1300008 - The operation is on invalid display.
|
||||
* @throws { BusinessError } 1300008 - The display device is abnormal.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @systemapi
|
||||
* @since 12
|
||||
|
||||
2
api/@ohos.userIAM.faceAuth.d.ts
vendored
2
api/@ohos.userIAM.faceAuth.d.ts
vendored
@ -50,7 +50,7 @@ declare namespace faceAuth {
|
||||
* @param { string } surfaceId Indicates surface id for face enroll preview.
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 12700001 - The operation is failed.
|
||||
* @throws { BusinessError } 12700001 - Operation failed.
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.FaceAuth
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 9
|
||||
|
||||
24
api/@ohos.userIAM.userAuth.d.ts
vendored
24
api/@ohos.userIAM.userAuth.d.ts
vendored
@ -941,7 +941,7 @@ declare namespace userAuth {
|
||||
* @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.
|
||||
* @throws { BusinessError } 12500013 - Operation failed because of PIN expired.
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
* @since 12
|
||||
*/
|
||||
@ -1278,14 +1278,14 @@ declare namespace userAuth {
|
||||
* @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 } 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
|
||||
*/
|
||||
@ -1297,15 +1297,15 @@ declare namespace userAuth {
|
||||
* @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 } 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 } 12500013 - Indicates that current authentication failed because of PIN expired.
|
||||
* @throws { BusinessError } 12500011 - Switched to the custom authentication process.
|
||||
* @throws { BusinessError } 12500013 - Operation failed because of PIN expired.
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
* @since 12
|
||||
*/
|
||||
|
||||
39
api/@ohos.util.stream.d.ts
vendored
39
api/@ohos.util.stream.d.ts
vendored
@ -285,6 +285,34 @@ declare namespace stream {
|
||||
*/
|
||||
doFlush(callback: Function): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return readable options.
|
||||
*
|
||||
* @interface ReadableOptions
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
interface ReadableOptions {
|
||||
/**
|
||||
* Specifies the encoding format of the data. If this parameter is provided,
|
||||
* the readable stream decodes the data into a string in the specified encoding format. Default: utf8.
|
||||
* If an invalid string is entered, a 401 exception is thrown in the Readable constructor.
|
||||
* Supported encoding formats: utf-8, ibm866, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6,
|
||||
* iso-8859-7, iso-8859-8, iso-8859-8-i, iso-8859-10, iso-8859-13, iso-8859-14, iso-8859-15, koi8-r, koi8-u,
|
||||
* macintosh, windows-874, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255,
|
||||
* windows-1256, windows-1257, windows-1258, x-mac-cyrillic, gbk, gb18030, big5, euc-jp, iso-2022-jp, shift_jis,
|
||||
* euc-kr, utf-16be, utf-16le.
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
encoding?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* The stream from which data can be read.
|
||||
*
|
||||
@ -301,6 +329,17 @@ declare namespace stream {
|
||||
* @since 12
|
||||
*/
|
||||
constructor();
|
||||
/**
|
||||
* The Readable constructor.
|
||||
*
|
||||
* @param { ReadableOptions } options - Provide options.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes:
|
||||
* 1.Incorrect parameter types.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
constructor(options: ReadableOptions);
|
||||
/**
|
||||
* Reads a buffer of a specified size from the buffer. If the available buffer is sufficient, the result
|
||||
* of the specified size is returned. Otherwise, if Readable has ended, all remaining buffers are returned.
|
||||
|
||||
151
api/@ohos.web.webview.d.ts
vendored
151
api/@ohos.web.webview.d.ts
vendored
@ -1649,7 +1649,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the string value of the web message.
|
||||
* @returns { string } - Returns data of string type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1657,7 +1657,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the string value of the web message.
|
||||
* @returns { string } - Returns data of string type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1668,7 +1668,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the number value of the web message.
|
||||
* @returns { number } - Returns data of number type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1676,7 +1676,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the number value of the web message.
|
||||
* @returns { number } - Returns data of number type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1687,7 +1687,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the boolean value of the web message.
|
||||
* @returns { boolean } - Returns data of Boolean type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1695,7 +1695,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the boolean value of the web message.
|
||||
* @returns { boolean } - Returns data of Boolean type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1706,7 +1706,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array buffer value of the web message.
|
||||
* @returns { ArrayBuffer } - Returns data of ArrayBuffer type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1714,7 +1714,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array buffer value of the web message.
|
||||
* @returns { ArrayBuffer } - Returns data of ArrayBuffer type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1725,7 +1725,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array value of the web message.
|
||||
* @returns { Array<string | number | boolean> } - Returns data of Array type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1733,7 +1733,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array value of the web message.
|
||||
* @returns { Array<string | number | boolean> } - Returns data of Array type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1744,7 +1744,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the error value of the web message.
|
||||
* @returns { Error } - Returns data of Error type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1752,7 +1752,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the error value of the web message.
|
||||
* @returns { Error } - Returns data of Error type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the web message.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1764,7 +1764,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1773,7 +1773,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1785,7 +1785,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1794,7 +1794,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1806,7 +1806,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1815,7 +1815,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1827,7 +1827,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1836,7 +1836,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1848,7 +1848,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1857,7 +1857,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1869,7 +1869,7 @@ declare namespace webview {
|
||||
* Set the array value of the web message.
|
||||
* @param { Array<string | number | boolean> } 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 } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
@ -1877,7 +1877,7 @@ declare namespace webview {
|
||||
* Set the array value of the web message.
|
||||
* @param { Array<string | number | boolean> } 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 } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -1888,7 +1888,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
@ -1897,7 +1897,7 @@ 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 } 17100014 - The type and value of the message do not match.
|
||||
*
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
@ -1976,7 +1976,7 @@ 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 } 17100010 - Failed to post messages through the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -1984,7 +1984,7 @@ 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 } 17100010 - Failed to post messages through the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -1996,7 +1996,7 @@ 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 } 17100006 - Failed to register a message event for the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -2004,7 +2004,7 @@ 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 } 17100006 - Failed to register a message event for the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -2016,7 +2016,7 @@ 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 } 17100010 - Failed to post messages through the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
@ -2024,7 +2024,7 @@ 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 } 17100010 - Failed to post messages through the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2035,7 +2035,7 @@ 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 } 17100006 - Failed to register a message event for the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
@ -2043,7 +2043,7 @@ 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 } 17100006 - Failed to register a message event for the port.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2406,14 +2406,14 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the string value of the JavaScript code execution result.
|
||||
* @returns { string } - Returns data of string type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get the string value of the JavaScript code execution result.
|
||||
* @returns { string } - Returns data of string type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2423,14 +2423,14 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the number value of the JavaScript code execution result.
|
||||
* @returns { number } - Returns data of number type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get the number value of the JavaScript code execution result.
|
||||
* @returns { number } - Returns data of number type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2440,14 +2440,14 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the boolean value of the JavaScript code execution result.
|
||||
* @returns { boolean } - Returns data of Boolean type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get the boolean value of the JavaScript code execution result.
|
||||
* @returns { boolean } - Returns data of Boolean type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2457,14 +2457,14 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array buffer value of the JavaScript code execution result.
|
||||
* @returns { ArrayBuffer } - Returns data of ArrayBuffer
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get the array buffer value of the JavaScript code execution result.
|
||||
* @returns { ArrayBuffer } - Returns data of ArrayBuffer
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2474,14 +2474,14 @@ declare namespace webview {
|
||||
/**
|
||||
* Get the array value of the the JavaScript code execution result.
|
||||
* @returns { Array<string | number | boolean> } - Returns data of Array type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get the array value of the the JavaScript code execution result.
|
||||
* @returns { Array<string | number | boolean> } - Returns data of Array type
|
||||
* @throws { BusinessError } 17100014 - The type does not match with the value of the result.
|
||||
* @throws { BusinessError } 17100014 - The type and value of the message do not match.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -2583,7 +2583,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<string> }
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
@ -2592,7 +2592,7 @@ declare namespace webview {
|
||||
urlList: Array<string>,
|
||||
|
||||
/**
|
||||
* Arraybuffer of resource.
|
||||
* Arraybuffer of resource. Size must less than 10Mb and cannot be empty.
|
||||
*
|
||||
* @type { Uint8Array }
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
@ -3094,7 +3094,7 @@ declare namespace webview {
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -3105,7 +3105,7 @@ declare namespace webview {
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -3118,7 +3118,7 @@ declare namespace webview {
|
||||
*
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -3127,7 +3127,7 @@ declare namespace webview {
|
||||
*
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -3139,7 +3139,7 @@ declare namespace webview {
|
||||
*
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -3148,7 +3148,7 @@ declare namespace webview {
|
||||
*
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100004 - Function not enable.
|
||||
* @throws { BusinessError } 17100004 - Function not enabled.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -3434,7 +3434,7 @@ declare namespace webview {
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100008 - Cannot delete JavaScriptProxy.
|
||||
* @throws { BusinessError } 17100008 - Failed to delete JavaScriptProxy because it does not exist.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 9
|
||||
*/
|
||||
@ -3445,7 +3445,7 @@ declare namespace webview {
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100001 - Init error.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @throws { BusinessError } 17100008 - Cannot delete JavaScriptProxy.
|
||||
* @throws { BusinessError } 17100008 - Failed to delete JavaScriptProxy because it does not exist.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -4063,7 +4063,7 @@ declare namespace webview {
|
||||
* Register Web custom schemes.
|
||||
* @param { Array<WebCustomScheme> } schemes - Configuration of web custom scheme.
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100020 - Register custom schemes failed.
|
||||
* @throws { BusinessError } 17100020 - Failed to register custom schemes.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -4611,12 +4611,15 @@ declare namespace webview {
|
||||
* You can prefetch no more than 6 resources. If you want to prefetch the seventh resource, you can clear one of
|
||||
* the prefetched resources that you won't use any more. Otherwise the oldest resource you prefetched will be
|
||||
* cleared.
|
||||
* @param { RequestInfo } request - The information of the request.
|
||||
* @param { RequestInfo } request - The information of the request.
|
||||
* @param { Array<WebHeader> } [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
|
||||
@ -4628,6 +4631,7 @@ declare namespace webview {
|
||||
/**
|
||||
* Clear the resource that you prefetch to the memory cache using API{@link prefetchResource}.
|
||||
* @param { Array<string> } cacheKeyList - The keys for memory cache.
|
||||
* The key in cacheKeyList only support number and letters.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -4669,14 +4673,16 @@ 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<number> } - 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<number> } - 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.
|
||||
* The WebviewController must be associated with a Web component.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 12
|
||||
*/
|
||||
@ -4719,7 +4725,8 @@ declare namespace webview {
|
||||
/**
|
||||
* Inject offline resources into cache.
|
||||
*
|
||||
* @param { Array<OfflineResourceMap> } resourceMaps - array of offline resource info maps.
|
||||
* @param { Array<OfflineResourceMap> } resourceMaps - Array of offline resource info maps.
|
||||
* The count of array must between 1 and 30.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @since 12
|
||||
*/
|
||||
@ -5142,7 +5149,7 @@ declare namespace webview {
|
||||
|
||||
/**
|
||||
* Pause the web download.
|
||||
* @throws { BusinessError } 17100019 - The download has not been started yet.
|
||||
* @throws { BusinessError } 17100019 - The download task is not started yet.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -5153,7 +5160,7 @@ declare namespace webview {
|
||||
* Resume the web download.
|
||||
* Use WebDownloadManager.resumeDownload to resume deserialized downloads.
|
||||
* WebDownloadItem.resume is only used to resume the currently paused download.
|
||||
* @throws { BusinessError } 17100016 - The download is not paused.
|
||||
* @throws { BusinessError } 17100016 - The download task is not paused.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
@ -5282,7 +5289,7 @@ declare namespace webview {
|
||||
* Initialize data stream.
|
||||
*
|
||||
* @returns { Promise<void> } The promise of data stream is initialized.
|
||||
* @throws { BusinessError } 17100022 - The http body stream init failed.
|
||||
* @throws { BusinessError } 17100022 - Failed to initialize the HTTP body stream.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -5772,7 +5779,7 @@ declare namespace webview {
|
||||
*
|
||||
* @param { WebSchemeHandlerResponse } response - Set response header to intercept.
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100021 - Resource handler is invalid.
|
||||
* @throws { BusinessError } 17100021 - The resource handler is invalid.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -5783,7 +5790,7 @@ declare namespace webview {
|
||||
*
|
||||
* @param { ArrayBuffer } data - Set response body to intercept.
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100021 - Resource handler is invalid.
|
||||
* @throws { BusinessError } 17100021 - The resource handler is invalid.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -5792,7 +5799,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 - The resource handler is invalid.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
@ -5803,7 +5810,7 @@ declare namespace webview {
|
||||
*
|
||||
* @param { WebNetErrorList } code - Set response error code to intercept.
|
||||
* @throws { BusinessError } 401 - Invalid input parameter.
|
||||
* @throws { BusinessError } 17100021 - Resource handler is invalid.
|
||||
* @throws { BusinessError } 17100021 - The resource handler is invalid.
|
||||
* @syscap SystemCapability.Web.Webview.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
|
||||
1015
api/@ohos.window.d.ts
vendored
1015
api/@ohos.window.d.ts
vendored
File diff suppressed because it is too large
Load Diff
16
api/@ohos.zlib.d.ts
vendored
16
api/@ohos.zlib.d.ts
vendored
@ -1473,22 +1473,6 @@ declare namespace zlib {
|
||||
*/
|
||||
inflateValidate(strm: ZStream, check: number): Promise<ReturnStatus>;
|
||||
|
||||
/**
|
||||
* 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<ReturnStatus> } 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<ReturnStatus>;
|
||||
|
||||
/**
|
||||
* Find a synchronization point for the current decompressed stream.
|
||||
*
|
||||
|
||||
3
api/application/ApplicationContext.d.ts
vendored
3
api/application/ApplicationContext.d.ts
vendored
@ -456,6 +456,7 @@ export default class ApplicationContext extends Context {
|
||||
* @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 } 16000050 - Internal error.
|
||||
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
|
||||
* @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.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
@ -496,7 +497,7 @@ export default class ApplicationContext extends Context {
|
||||
* @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.
|
||||
* @throws { BusinessError } 16000200 - The supported process cache state cannot be set more than once.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @systemapi
|
||||
* @stagemodelonly
|
||||
|
||||
2
api/arkui/FrameNode.d.ts
vendored
2
api/arkui/FrameNode.d.ts
vendored
@ -439,7 +439,7 @@ export class FrameNode {
|
||||
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
|
||||
|
||||
11
api/bundleManager/BundleResourceInfo.d.ts
vendored
11
api/bundleManager/BundleResourceInfo.d.ts
vendored
@ -72,4 +72,15 @@ export interface BundleResourceInfo {
|
||||
* @since 12
|
||||
*/
|
||||
readonly drawableDescriptor: DrawableDescriptor;
|
||||
|
||||
/**
|
||||
* Indicates the index of the bundle
|
||||
*
|
||||
* @type { number }
|
||||
* @readonly
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 12
|
||||
*/
|
||||
readonly appIndex: number;
|
||||
}
|
||||
|
||||
@ -94,4 +94,15 @@ export interface LauncherAbilityResourceInfo {
|
||||
* @since 12
|
||||
*/
|
||||
readonly drawableDescriptor: DrawableDescriptor;
|
||||
|
||||
/**
|
||||
* Indicates the index of the bundle
|
||||
*
|
||||
* @type { number }
|
||||
* @readonly
|
||||
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
||||
* @systemapi
|
||||
* @since 12
|
||||
*/
|
||||
readonly appIndex: number;
|
||||
}
|
||||
|
||||
9
api/commonEvent/commonEventData.d.ts
vendored
9
api/commonEvent/commonEventData.d.ts
vendored
@ -104,6 +104,15 @@ export interface CommonEventData {
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The custom result data of the common event.
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.Notification.CommonEvent
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
data?: string;
|
||||
|
||||
/**
|
||||
|
||||
340
api/tag/nfctech.d.ts
vendored
340
api/tag/nfctech.d.ts
vendored
@ -302,7 +302,10 @@ export interface IsoDepTag extends TagSession {
|
||||
* @permission ohos.permission.NFC_TAG
|
||||
* @returns { Promise<boolean> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<boolean> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<boolean> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<boolean> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<NdefMessage> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<NdefMessage> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<NdefMessage> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<NdefMessage> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } The void
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<void> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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
|
||||
|
||||
30
api/tag/tagSession.d.ts
vendored
30
api/tag/tagSession.d.ts
vendored
@ -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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } 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:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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<number[]> } callback The callback.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 401 - The parameter check failed. Possible causes:
|
||||
* <br> 1. Mandatory parameters are left unspecified.
|
||||
* <br> 2. Incorrect parameters types.
|
||||
* <br> 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.
|
||||
|
||||
@ -809,6 +809,7 @@ screensaver
|
||||
scrolldown
|
||||
scrollup
|
||||
sdpi
|
||||
sdr
|
||||
searchsetter
|
||||
sece
|
||||
secinfo
|
||||
@ -1132,3 +1133,5 @@ ocsp
|
||||
encipherment
|
||||
reconfirmed
|
||||
subresource
|
||||
euc
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user