openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-03-06 00:07:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of gitee.com:openharmony/interface_sdk-js into master

Browse Source 
Signed-off-by: Aurora <liuxiyao223@huawei.com>
This commit is contained in:
Aurora 2024-01-09 07:30:23 +00:00 committed by Gitee
commit 3c44c5f33a
457 changed files with 13918 additions and 2539 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
BUILD.gn
View File

@ -39,6 +39,17 @@ template("ohos_copy_internal") {
}
}
ohos_copy("bundle_kits") {
if (sdk_build_public || product_name == "ohos-sdk") {
sources = [ "//out/sdk-public/public_interface/sdk-js/kits" ]
} else {
sources = [ "//interface/sdk-js/kits" ]
}
outputs = [ target_out_dir + "/$target_name" ]
module_source_dir = target_out_dir + "/$target_name"
module_install_name = ""
}
ohos_copy_internal("ets_internal_api") {
iv_input = "//interface/sdk-js/api/@internal/ets"
}

189
api/@internal/component/ets/alert_dialog.d.ts vendored
View File

@ -820,6 +820,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Enable switch of confirmation button
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
enabled?: boolean;
/**
@ -830,6 +839,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Default focus switch of confirmation button
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
defaultFocus?: boolean;
/**
@ -840,6 +858,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Style of confirmation button.
* @type { ?DialogButtonStyle }
* @default DialogButtonStyle.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
style?: DialogButtonStyle;
/**
@ -857,6 +884,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text content of the confirmation button.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
value: ResourceStr;
/**
@ -874,6 +910,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
fontColor?: ResourceColor;
/**
@ -891,6 +936,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Background color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
backgroundColor?: ResourceColor;
/**
@ -908,6 +962,15 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Method executed by the callback.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
action: () => void;
};
}
@ -970,6 +1033,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Enable switch of primaryButton
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
enabled?: boolean;
/**
@ -980,6 +1052,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Default focus switch of primaryButton button
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
defaultFocus?: boolean;
/**
@ -990,6 +1071,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Style of primaryButton button.
* @type { ?DialogButtonStyle }
* @default DialogButtonStyle.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
style?: DialogButtonStyle;
/**
@ -1007,6 +1097,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text content of the confirmation button.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
value: ResourceStr;
/**
@ -1024,6 +1123,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
fontColor?: ResourceColor;
/**
@ -1041,6 +1149,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Background color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
backgroundColor?: ResourceColor;
/**
@ -1058,6 +1175,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Method executed by the callback.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
action: () => void;
};
@ -1094,6 +1220,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Enable switch of secondaryButton
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
enabled?: boolean;
/**
@ -1104,6 +1239,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Default focus switch of secondaryButton button
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
defaultFocus?: boolean;
/**
@ -1114,6 +1258,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Style of secondaryButton button.
* @type { ?DialogButtonStyle }
* @default DialogButtonStyle.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
style?: DialogButtonStyle;
/**
@ -1131,6 +1284,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text content of the confirmation button.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
value: ResourceStr;
/**
@ -1148,6 +1310,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Text color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
fontColor?: ResourceColor;
/**
@ -1165,6 +1336,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Background color of the confirmation button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
backgroundColor?: ResourceColor;
/**
@ -1182,6 +1362,15 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam {
* @crossplatform
* @since 10
*/
/**
* Method executed by the callback.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
action: () => void;
};
}

4
api/@internal/component/ets/badge.d.ts vendored
View File

@ -420,14 +420,14 @@ declare interface BadgeParam {
/**
* Set the display position of the prompt point.
*
* @type { ?(BadgePosition | Position) }
* @type { ?(BadgePosition) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Set the display position of the prompt point.
*
* @type { ?(BadgePosition | Position) }
* @type { ?(BadgePosition) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
* @form

34
api/@internal/component/ets/canvas.d.ts vendored
View File

@ -5638,6 +5638,40 @@ interface CanvasInterface {
(context?: CanvasRenderingContext2D): CanvasAttribute;
}
/**
* Provides attribute for Canvas.
*
* @extends CommonMethod<CanvasAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Provides attribute for Canvas.
*
* @extends CommonMethod<CanvasAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
* @form
*/
/**
* Provides attribute for Canvas.
*
* @extends CommonMethod<CanvasAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
* @form
*/
/**
* Provides attribute for Canvas.
*
* @extends CommonMethod<CanvasAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class CanvasAttribute extends CommonMethod<CanvasAttribute> {
/**
* Event notification after the canvas component is constructed. You can draw the canvas at this time.

133
api/@internal/component/ets/common.d.ts vendored
View File

@ -1784,7 +1784,7 @@ declare interface AnimateParam {
finishCallbackType?: FinishCallbackType;
/**
* Set the animation drawing FPS.
* Indicates expectedFrameRateRange including minimum、maximum and expected frame rate.
*
* @type { ?ExpectedFrameRateRange }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -8651,6 +8651,17 @@ declare interface SheetOptions extends BindOptions {
* @since 11
*/
shouldDismiss?: (sheetDismiss: SheetDismiss) => void;
/**
* Set whether interaction is allowed outside the sheet
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
enableOutsideInteractive?: boolean;
}
/**
@ -12943,6 +12954,18 @@ declare class CommonMethod<T> {
*/
hueRotate(value: number | string): T;
/**
* Add an attribute to control whether the shadows of the child nodes overlap each other.
*
* @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @since 11
*/
useShadowBatching(value: boolean): T;
/**
* Sets whether the component should apply the effects template defined by the parent effectComponent.
* If multiple parent effectComponents are found, the nearest one will be used.
@ -15376,7 +15399,7 @@ declare const Common: CommonInterface;
* Defines the CustomBuilder Type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @since 8
*/
/**
* Defines the CustomBuilder Type.
@ -17032,7 +17055,7 @@ declare class CustomComponent extends CommonAttribute {
* @crossplatform
* @since 11
*/
getUIContext?(): UIContext;
getUIContext(): UIContext;
/**
* Queries the navigation destination information.
@ -17042,7 +17065,7 @@ declare class CustomComponent extends CommonAttribute {
* @crossplatform
* @since 11
*/
queryNavDestinationInfo?(): NavDestinationInfo | undefined;
queryNavDestinationInfo(): NavDestinationInfo | undefined;
}
/**
@ -17431,6 +17454,19 @@ declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
* @since 11
*/
onScrollStop(event: () => void): T;
/**
* Limit the max speed when fling.
*
* @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited.
* The unit is vp/s.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
flingSpeedLimit(speedLimit: number): T;
}
declare module "SpecialEvent" {
@ -17443,7 +17479,7 @@ declare module "SpecialEvent" {
declare module "AnimateToParam" {
module "AnimateToParam" {
// @ts-ignore
export { AnimateParam };
export type { AnimateParam, KeyframeAnimateParam, KeyframeState };
}
}
@ -17643,3 +17679,90 @@ declare module "wrappedBuilderObject" {
export { WrappedBuilder };
}
}
/**
* Defines the overall animation parameters of the keyframe animation.
*
* @interface KeyframeAnimateParam
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface KeyframeAnimateParam {
/**
* Animation delay time, in ms.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
delay?: number;
/**
* Animation iterations.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
iterations?: number;
/**
* Callback invoked when the whole keyframe animation is complete.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
onFinish?: () => void;
}
/**
* Defines a keyframe state.
*
* @interface KeyframeState
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface KeyframeState {
/**
* Animation duration of this keyframe, in ms.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
duration: number;
/**
* Animation curve of this keyframe.
*
* @type { ?(Curve | string | ICurve) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
curve?: Curve | string | ICurve;
/**
* The closure function to specify the terminating state of this keyframe.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
event: () => void;
}
declare module 'touchEvent'{
module 'touchEvent' {
// @ts-ignore
export { TouchEvent };
}
}

16
api/@internal/component/ets/common_ts_ets_api.d.ts vendored
View File

@ -161,26 +161,30 @@ declare class AppStorage {
static SetAndProp<S>(propName: string, defaultValue: S): SubscribedAbstractProperty<S>;
/**
*
* Like @see prop(), will create and initialize a new source property in AppStorage if missing
* Same as see LocalStorage.setAndProp()
*
* @param { string } propName - name of source property in AppStorage
* @param { T } defaultValue - value to be used for initializing if new creating new property in AppStorage.
* default value must be of type T, must not be undefined or null.
* @returns { SubscribedAbstractProperty<T> } instance of SubscribedAbstractProperty<T>
* return undefined if named property does not already exist in AppStorage.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* Like @see prop(), will create and initialize a new source property in AppStorage if missing
* Same as see LocalStorage.setAndProp()
* @crossplatform
* @since 10
*/
/**
*
* Like @see prop(), will create and initialize a new source property in AppStorage if missing
* Same as see LocalStorage.setAndProp()
*
* @param { string } propName - name of source property in AppStorage
* @param { T } defaultValue - value to be used for initializing if new creating new property in AppStorage.
* default value must be of type T, must not be undefined or null.
* @returns { SubscribedAbstractProperty<T> } instance of SubscribedAbstractProperty<T>
* return undefined if named property does not already exist in AppStorage.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* Like @see prop(), will create and initialize a new source property in AppStorage if missing
* Same as see LocalStorage.setAndProp()
* @crossplatform
* @atomicservice
* @since 11
@ -314,7 +318,7 @@ declare class AppStorage {
/**
* Set value of given property, if it exists, see set() .
* Add property if no property with given name in AppStorage,. yet, and initialize with given value.
* Do nothing and return false if newValue is undefined or null
* Do nothing if newValue is undefined or null
* see LocalStorage.setOrCreate()
*
* @param { string } propName
@ -326,7 +330,7 @@ declare class AppStorage {
/**
* Set value of given property, if it exists, see set() .
* Add property if no property with given name in AppStorage,. yet, and initialize with given value.
* Do nothing and return false if newValue is undefined or null
* Do nothing if newValue is undefined or null
* see LocalStorage.setOrCreate()
*
* @param { string } propName

198
api/@internal/component/ets/component3d.d.ts vendored Normal file
View File

@ -0,0 +1,198 @@
/*
* Copyright (c) 2023-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The enum of model type
* @enum { number }
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
declare enum ModelType {
/**
* Render to texture, gpu would compose this texture to screen.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
TEXTURE = 0,
/**
* Render to surface, special hardware would compose this surface to screen.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
SURFACE = 1,
}
/**
* Scene options used by 3D scene control
*
* @interface SceneOptions
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
declare interface SceneOptions {
/**
* Scene resource when 3D rendering
*
* @type { ?Resource }
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
scene?: Resource;
/**
* Scene type when 3D rendering
*
* @type { ?ModelType }
* @default ModelType.SURFACE
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
modelType?: ModelType;
}
/**
* Defines Component3D.
*
* @interface Component3DInterface
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
interface Component3DInterface {
/**
* SceneOptions used by constructor
*
* @param { SceneOptions } sceneOptions - The 3D scene controller
* @returns { Component3DAttribute }
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
(sceneOptions?: SceneOptions): Component3DAttribute;
}
/**
* @extends CommonMethod<Component3DAttribute>
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
/**
* Load 3D model environment resource.
*
* @param { Resource } uri - The path of 3D environment resource
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
environment(uri: Resource): Component3DAttribute;
/**
* Set render pipeline of 3D scene render.
*
* @param { Resource } uri - The path of Render pipeline config file
* @param { boolean } selfRenderUpdate - Trigger rendering every frame
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
customRender(uri: Resource, selfRenderUpdate: boolean): Component3DAttribute;
/**
* Load shader uri.
*
* @param { Resource } uri - The path of custom shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
shader(uri: Resource): Component3DAttribute;
/**
* Load shader texture uri.
*
* @param { Resource } uri - The path of texture used by shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
shaderImageTexture(uri: Resource): Component3DAttribute;
/**
* Buffer input for shader animation
*
* @param { Array<number> } buffer - The uniform buffer of shader input
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
shaderInputBuffer(buffer: Array<number>): Component3DAttribute;
/**
* Set render width resolution.
*
* @param { Dimension } value - Width of gpu render target, target would upscale or downscale to view's width.
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
renderWidth(value: Dimension): Component3DAttribute;
/**
* Set render height resolution.
*
* @param { Dimension } value - Height of gpu render target, target would upscale or downscale to view's height.
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
renderHeight(value: Dimension): Component3DAttribute;
}
/**
* Defines Component3D component.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
declare const Component3D: Component3DInterface;
/**
* Defines Component3D instance.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @systemapi
* @since 11
*/
declare const Component3DInstance: Component3DAttribute;

72
api/@internal/component/ets/container_span.d.ts vendored Normal file
View File

@ -0,0 +1,72 @@
/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Span container interface.
*
* @interface ContainerSpanInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
interface ContainerSpanInterface {
/**
* Called when container is entered in span.
*
* @returns { ContainerSpanAttribute } The attribute of the container span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
(): ContainerSpanAttribute;
}
/**
* Define the ContainerSpan attribute functions.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare class ContainerSpanAttribute {
/**
* Span background style.
*
* @param { TextBackgroundStyle } style - The background style of span.
* @returns { ContainerSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
textBackgroundStyle(style: TextBackgroundStyle): ContainerSpanAttribute;
}
/**
* Defines ContainerSpan Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare const ContainerSpan: ContainerSpanInterface;
/**
* Defines ContainerSpan Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare const ContainerSpanInstance: ContainerSpanAttribute;

27
api/@internal/component/ets/grid_col.d.ts vendored
View File

@ -393,6 +393,33 @@ interface GridColInterface {
(option?: GridColOptions): GridColAttribute;
}
/**
* Defines the GridContainer attribute functions.
*
* @extends CommonMethod<GridColAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
* @form
*/
/**
* Defines the GridContainer attribute functions.
*
* @extends CommonMethod<GridColAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
* @form
*/
/**
* Defines the GridContainer attribute functions.
*
* @extends CommonMethod<GridColAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class GridColAttribute extends CommonMethod<GridColAttribute> {
/**
* Sets the span of current gird-container item.

27
api/@internal/component/ets/grid_row.d.ts vendored
View File

@ -955,6 +955,33 @@ interface GridRowInterface {
(option?: GridRowOptions): GridRowAttribute;
}
/**
* Defines the GridRow attribute functions.
*
* @extends CommonMethod<GridRowAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
* @form
*/
/**
* Defines the GridRow attribute functions.
*
* @extends CommonMethod<GridRowAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
* @form
*/
/**
* Defines the GridRow attribute functions.
*
* @extends CommonMethod<GridRowAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class GridRowAttribute extends CommonMethod<GridRowAttribute> {
/**
* Callback triggered when the breakpoint changes

44
api/@internal/component/ets/image.d.ts vendored
View File

@ -915,6 +915,19 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
*/
pointLight(value: PointLightStyle): ImageAttribute;
/**
* SVG anti-aliasing.
* The range of the parameter values is (0.333, 1.333].
* Default value is 0.0.
*
* @param { number } value - The degree of anti-aliasing.
* @returns { ImageAttribute } The attribute of the image.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 11
*/
edgeAntialiasing(value: number): ImageAttribute;
/**
* This callback is triggered when an image is successfully loaded.
* The size of the image source that is successfully loaded is returned, in pixels.
@ -1070,6 +1083,17 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @since 11
*/
analyzerConfig(config: ImageAnalyzerConfig): ImageAttribute;
/**
* Set image resizable options.
*
* @param { ResizableOptions } value - Indicates the resizable options.
* @returns { ImageAttribute } Returns the instance of the ImageAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
resizable(value: ResizableOptions): ImageAttribute;
}
/**
@ -1259,3 +1283,23 @@ declare interface ImageError {
*/
message: string
}
/**
* Image resizable options
*
* @interface ResizableOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface ResizableOptions {
/**
* Image slice widths.
*
* @type { ?EdgeWidths }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
slice?: EdgeWidths;
}

4
api/@internal/component/ets/image_span.d.ts vendored
View File

@ -64,13 +64,13 @@ interface ImageSpanInterface {
/**
* Define the ImageSpan attribute functions.
*
* @extends CommonMethod<ImageSpanAttribute>
* @extends BaseSpan<ImageSpanAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare class ImageSpanAttribute extends CommonMethod<ImageSpanAttribute> {
declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
/**
* Called when the alignment of image span is set.
*

4
api/@internal/component/ets/index-full.d.ts vendored
View File

@ -104,6 +104,8 @@
/// <reference path="./stepper.d.ts" />
/// <reference path="./stepper_item.d.ts" />
/// <reference path="./swiper.d.ts" />
/// <reference path="./symbolglyph.d.ts" />
/// <reference path="./symbol_span.d.ts" />
/// <reference path="./tabs.d.ts" />
/// <reference path="./tab_content.d.ts" />
/// <reference path="./text.d.ts" />
@ -131,3 +133,5 @@
/// <reference path="./image_span.d.ts" />
/// <reference path="./effect_component.d.ts" />
/// <reference path="./ui_extension_component.d.ts" />
/// <reference path="./component3d.d.ts" />
/// <reference path="./container_span.d.ts" />

11
api/@internal/component/ets/nav_destination.d.ts vendored
View File

@ -405,6 +405,17 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @since 11
*/
mode(value: NavDestinationMode): NavDestinationAttribute;
/**
* Set back button icon.
*
* @param { ResourceStr | PixelMap } value - Indicates icon of back button.
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
backButtonIcon(value: ResourceStr | PixelMap): NavDestinationAttribute;
}
/**

199
api/@internal/component/ets/navigation.d.ts vendored
View File

@ -435,6 +435,23 @@ declare enum NavigationTitleMode {
Mini,
}
/**
* Navigation menu item, include menu icon and menu info
*
* @interface NavigationMenuItem
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigation menu item, include menu icon and menu info
*
* @interface NavigationMenuItem
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare interface NavigationMenuItem {
/**
* The value of navigation menu item.
@ -591,6 +608,21 @@ declare class NavPathInfo {
param?: unknown;
}
/**
* Indicates the information of route page.Providers methods for controlling destination page in the stack
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Indicates the information of route page.Providers methods for controlling destination page in the stack
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare class NavPathStack {
/**
* Creates an instance of NavPathStack.
@ -1047,6 +1079,43 @@ declare enum ToolbarItemStatus {
ACTIVE = 2,
}
/**
* Defines the operation of current navigation transition.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare enum NavigationOperation {
/**
* Push operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
PUSH = 1,
/**
* Pop operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
POP = 2,
/**
* Replace operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
REPLACE = 3,
}
/**
* Defines configurable parameters for toolbar item.
*
@ -1690,6 +1759,136 @@ declare class NavigationAttribute extends CommonMethod<NavigationAttribute> {
* @since 11
*/
navDestination(builder: (name: string, param: unknown) => void): NavigationAttribute;
/**
* Set custom navigation content transition animation.
*
* @param { function } delegate - Custom transition delegate.
* @returns { NavigationAttribute } Returns the instance of the NavigationAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
customNavContentTransition(delegate: (from: NavContentInfo, to: NavContentInfo, operation: NavigationOperation) => NavigationAnimatedTransition | undefined): NavigationAttribute;
}
/**
* Navigation transition animation protocol.
*
* @interface NavigationAnimatedTransition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface NavigationAnimatedTransition {
/**
* This method is called after the transition ends to notify whether the transition was successful.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
onTransitionEnd?: (success: boolean) => void
/**
* Define the limit duration of the transition animation.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
timeout?: number;
/**
* Configure the animations associated with custom transition.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
transition: (transitionProxy: NavigationTransitionProxy) => void
}
/**
* Navigation transition proxy.
*
* @interface NavigationTransitionProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface NavigationTransitionProxy {
/**
* From navigation content info.
*
* @type { NavContentInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
from: NavContentInfo;
/**
* To navigation content info.
*
* @type { NavContentInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
to: NavContentInfo;
/**
* Notification system transition animation completed.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
finishTransition(): void;
}
/**
* Navigation content info.
*
* @interface NavContentInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface NavContentInfo {
/**
* Navigation content name.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
name?: string;
/**
* Navigation content index.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
index: number;
/**
* Navigation content mode.
*
* @type { ?NavDestinationMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
mode?: NavDestinationMode;
}
/**

89
api/@internal/component/ets/particle.d.ts vendored
View File

@ -301,7 +301,15 @@ interface ParticleConfigs {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Point-like Particle.
* @type { PointParticleParameters }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleType.POINT]: PointParticleParameters;
/**
@ -310,7 +318,15 @@ interface ParticleConfigs {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Image-like Particle.
* @type { ImageParticleParameters }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleType.IMAGE]: ImageParticleParameters;
}
@ -522,7 +538,14 @@ interface ParticlePropertyUpdaterConfigs<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* No effect of particle updater.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.NONE]: void;
/**
@ -531,7 +554,15 @@ interface ParticlePropertyUpdaterConfigs<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Random effect of particle updater.
* @type { [T, T] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.RANDOM]: [T, T];
/**
@ -540,7 +571,15 @@ interface ParticlePropertyUpdaterConfigs<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Curve effect of particle updater.
* @type { Array<ParticlePropertyAnimation<T>> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.CURVE]: Array<ParticlePropertyAnimation<T>>;
}
@ -621,7 +660,14 @@ interface ParticleColorPropertyUpdaterConfigs {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* No effect of particle color property updater.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.NONE]: void;
/**
@ -630,7 +676,15 @@ interface ParticleColorPropertyUpdaterConfigs {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Random effect of particle color property updater.
* @type { object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.RANDOM]: {
r: [number, number];
g: [number, number];
@ -645,7 +699,16 @@ interface ParticleColorPropertyUpdaterConfigs {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
*/
/**
* Curve effect of particle color property updater.
*
* @type { Array<ParticlePropertyAnimation<ResourceColor>> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
[ParticleUpdater.CURVE]: Array<ParticlePropertyAnimation<ResourceColor>>;
}
@ -832,6 +895,16 @@ interface ParticleInterface {
* @crossplatform
* @since 10
*/
/**
* create a particle array.
* @param { object } value - Particle value
* particles - list of ParticleOptions.
* @returns { ParticleAttribute } Returns the particle attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
<
PARTICLE extends ParticleType,
COLOR_UPDATER extends ParticleUpdater,

34
api/@internal/component/ets/polygon.d.ts vendored
View File

@ -113,6 +113,40 @@ interface PolygonInterface {
(value?: { width?: string | number; height?: string | number }): PolygonAttribute;
}
/**
* Provides attribute for Polygon.
*
* @extends CommonShapeMethod<PolygonAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Provides attribute for Polygon.
*
* @extends CommonShapeMethod<PolygonAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
* @form
*/
/**
* Provides attribute for Polygon.
*
* @extends CommonShapeMethod<PolygonAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
* @form
*/
/**
* Provides attribute for Polygon.
*
* @extends CommonShapeMethod<PolygonAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class PolygonAttribute extends CommonShapeMethod<PolygonAttribute> {
/**
* Called when the vertex coordinate list of a polygon is set.

136
api/@internal/component/ets/rich_editor.d.ts vendored
View File

@ -25,6 +25,7 @@
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -39,6 +40,7 @@ declare enum RichEditorDeleteDirection {
* Delete backward.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -54,6 +56,7 @@ declare enum RichEditorDeleteDirection {
* Delete forward.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -72,6 +75,7 @@ declare enum RichEditorDeleteDirection {
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -86,6 +90,7 @@ declare enum RichEditorSpanType {
* text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -101,6 +106,7 @@ declare enum RichEditorSpanType {
* image.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -116,6 +122,7 @@ declare enum RichEditorSpanType {
* mixed.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -171,6 +178,7 @@ declare enum RichEditorResponseType {
*
* @interface RichEditorSpanPosition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -187,6 +195,7 @@ declare interface RichEditorSpanPosition {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -204,6 +213,7 @@ declare interface RichEditorSpanPosition {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -222,6 +232,7 @@ declare interface RichEditorSpanPosition {
*
* @interface RichEditorTextStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -238,6 +249,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -255,6 +267,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?(Length | number) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -272,6 +285,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?FontStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -289,6 +303,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?(number | FontWeight | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -306,6 +321,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -323,6 +339,7 @@ declare interface RichEditorTextStyle {
*
* @type { ?object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -345,6 +362,7 @@ declare interface RichEditorTextStyle {
*
* @interface LeadingMarginPlaceholder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface LeadingMarginPlaceholder {
@ -353,6 +371,7 @@ declare interface LeadingMarginPlaceholder {
*
* @type { PixelMap }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
pixelMap: PixelMap;
@ -362,6 +381,7 @@ declare interface LeadingMarginPlaceholder {
*
* @type { [Dimension, Dimension] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
size: [Dimension, Dimension];
@ -372,6 +392,7 @@ declare interface LeadingMarginPlaceholder {
*
* @interface RichEditorParagraphStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface RichEditorParagraphStyle {
@ -380,6 +401,7 @@ declare interface RichEditorParagraphStyle {
*
* @type { ?TextAlign }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
textAlign?: TextAlign;
@ -389,6 +411,7 @@ declare interface RichEditorParagraphStyle {
*
* @type { ?(Dimension | LeadingMarginPlaceholder) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
leadingMargin?: Dimension | LeadingMarginPlaceholder;
@ -399,6 +422,7 @@ declare interface RichEditorParagraphStyle {
*
* @interface PasteEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface PasteEvent {
@ -425,6 +449,7 @@ declare interface PasteEvent {
*
* @interface RichEditorTextSpan
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -441,6 +466,7 @@ declare interface RichEditorTextSpan {
*
* @type { RichEditorSpanPosition }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -458,6 +484,7 @@ declare interface RichEditorTextSpan {
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -475,6 +502,7 @@ declare interface RichEditorTextSpan {
*
* @type { ?RichEditorTextStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -523,6 +551,7 @@ interface RichEditorLayoutStyle {
*
* @interface RichEditorImageSpanStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -539,6 +568,7 @@ declare interface RichEditorImageSpanStyle {
*
* @type { ?[Dimension, Dimension] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -556,6 +586,7 @@ declare interface RichEditorImageSpanStyle {
*
* @type { ?ImageSpanAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -573,6 +604,7 @@ declare interface RichEditorImageSpanStyle {
*
* @type { ?ImageFit }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -661,6 +693,7 @@ declare interface RichEditorSymbolSpanStyle {
*
* @interface RichEditorTextStyleResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -677,6 +710,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -694,6 +728,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -711,6 +746,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { FontStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -728,6 +764,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -745,6 +782,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -762,6 +800,7 @@ declare interface RichEditorTextStyleResult {
*
* @type { object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -773,6 +812,7 @@ declare interface RichEditorTextStyleResult {
*
* @interface RichEditorParagraphResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface RichEditorParagraphResult {
@ -781,6 +821,7 @@ declare interface RichEditorParagraphResult {
*
* @type { RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
style: RichEditorParagraphStyle;
@ -790,6 +831,7 @@ declare interface RichEditorParagraphResult {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
range: [number, number];
@ -867,6 +909,7 @@ declare interface RichEditorSymbolSpanStyleResult {
*
* @interface RichEditorTextSpanResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -883,6 +926,7 @@ declare interface RichEditorTextSpanResult {
*
* @type { RichEditorSpanPosition }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -900,6 +944,7 @@ declare interface RichEditorTextSpanResult {
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -917,6 +962,7 @@ declare interface RichEditorTextSpanResult {
*
* @type { RichEditorTextStyleResult }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -934,6 +980,7 @@ declare interface RichEditorTextSpanResult {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -972,6 +1019,7 @@ declare interface RichEditorTextSpanResult {
*
* @interface RichEditorImageSpanStyleResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -988,6 +1036,7 @@ declare interface RichEditorImageSpanStyleResult {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1005,6 +1054,7 @@ declare interface RichEditorImageSpanStyleResult {
*
* @type { ImageSpanAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1022,6 +1072,7 @@ declare interface RichEditorImageSpanStyleResult {
*
* @type { ImageFit }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1040,6 +1091,7 @@ declare interface RichEditorImageSpanStyleResult {
*
* @interface RichEditorImageSpanResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1056,6 +1108,7 @@ declare interface RichEditorImageSpanResult {
*
* @type { RichEditorSpanPosition }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1073,6 +1126,7 @@ declare interface RichEditorImageSpanResult {
*
* @type { ?PixelMap }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1090,6 +1144,7 @@ declare interface RichEditorImageSpanResult {
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1107,6 +1162,7 @@ declare interface RichEditorImageSpanResult {
*
* @type { RichEditorImageSpanStyleResult }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1124,6 +1180,7 @@ declare interface RichEditorImageSpanResult {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1142,6 +1199,7 @@ declare interface RichEditorImageSpanResult {
*
* @interface RichEditorImageSpan
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1158,6 +1216,7 @@ declare interface RichEditorImageSpan {
*
* @type { RichEditorSpanPosition }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1175,6 +1234,7 @@ declare interface RichEditorImageSpan {
*
* @type { PixelMap | ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1192,6 +1252,7 @@ declare interface RichEditorImageSpan {
*
* @type { ?RichEditorImageSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1210,6 +1271,7 @@ declare interface RichEditorImageSpan {
*
* @interface RichEditorRange
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1228,6 +1290,7 @@ declare interface RichEditorRange {
* @type { ?number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1247,6 +1310,7 @@ declare interface RichEditorRange {
* @type { ?number }
* @default text length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1295,6 +1359,7 @@ declare interface RichEditorGesture {
*
* @interface RichEditorTextSpanOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1311,6 +1376,7 @@ declare interface RichEditorTextSpanOptions {
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1328,6 +1394,7 @@ declare interface RichEditorTextSpanOptions {
*
* @type { ?RichEditorTextStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1338,6 +1405,7 @@ declare interface RichEditorTextSpanOptions {
*
* @type { ?RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
paragraphStyle?: RichEditorParagraphStyle;
@ -1365,6 +1433,7 @@ declare interface RichEditorTextSpanOptions {
*
* @interface RichEditorImageSpanOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1381,6 +1450,7 @@ declare interface RichEditorImageSpanOptions {
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1398,6 +1468,7 @@ declare interface RichEditorImageSpanOptions {
*
* @type { ?RichEditorImageSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1446,6 +1517,7 @@ declare interface RichEditorBuilderSpanOptions {
*
* @interface RichEditorSpanStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1456,6 +1528,7 @@ declare interface RichEditorSpanStyleOptions extends RichEditorRange { }
*
* @interface RichEditorParagraphStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
@ -1464,6 +1537,7 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
*
* @type { RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
style: RichEditorParagraphStyle;
@ -1481,6 +1555,7 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
*
* @interface RichEditorUpdateTextSpanStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1497,6 +1572,7 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty
*
* @type { RichEditorTextStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1515,6 +1591,7 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty
*
* @interface RichEditorUpdateImageSpanStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1531,6 +1608,7 @@ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanSt
*
* @type { RichEditorImageSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1569,12 +1647,12 @@ declare interface RichEditorSymbolSpanOptions {
/**
* The offset that add custom symbol span at.
*
* @type { ?[number, number] }
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
offset?: [number, number];
offset?: number;
/**
* The style that add custom symbol span at.
@ -1599,6 +1677,7 @@ declare interface RichEditorSymbolSpanOptions {
*
* @interface RichEditorSelection
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1615,6 +1694,7 @@ declare interface RichEditorSelection {
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1632,6 +1712,7 @@ declare interface RichEditorSelection {
*
* @type { Array<RichEditorTextSpanResult | RichEditorImageSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1650,6 +1731,7 @@ declare interface RichEditorSelection {
*
* @interface RichEditorInsertValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1666,6 +1748,7 @@ declare interface RichEditorInsertValue {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1683,6 +1766,7 @@ declare interface RichEditorInsertValue {
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1701,6 +1785,7 @@ declare interface RichEditorInsertValue {
*
* @interface RichEditorDeleteValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1717,6 +1802,7 @@ declare interface RichEditorDeleteValue {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1734,6 +1820,7 @@ declare interface RichEditorDeleteValue {
*
* @type { RichEditorDeleteDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1751,6 +1838,7 @@ declare interface RichEditorDeleteValue {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1768,6 +1856,7 @@ declare interface RichEditorDeleteValue {
*
* @type { Array<RichEditorTextSpanResult | RichEditorImageSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1785,6 +1874,7 @@ declare interface RichEditorDeleteValue {
*
* @interface RichEditorOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1801,6 +1891,7 @@ declare interface RichEditorOptions {
*
* @type { RichEditorController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1864,6 +1955,19 @@ declare interface SelectionMenuOptions {
onDisappear?: () => void;
}
/**
* Provides Controller for RichEditor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Provides Controller for RichEditor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
declare class RichEditorController {
/**
* Get caret offset from controller.
@ -1877,6 +1981,7 @@ declare class RichEditorController {
*
* @returns { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1896,6 +2001,7 @@ declare class RichEditorController {
* @param { number } offset - caret offset.
* @returns { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1917,6 +2023,7 @@ declare class RichEditorController {
* @param { RichEditorTextSpanOptions } [options] - span info.
* @returns { number } span index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1938,6 +2045,7 @@ declare class RichEditorController {
* @param { RichEditorImageSpanOptions } [options] - image span info.
* @returns { number } span index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1958,14 +2066,14 @@ declare class RichEditorController {
/**
* Add a symbol span.
*
* @param { ResourceStr } value - symbol span value
* @param { Resource } value - symbol span value
* @param { RichEditorSymbolSpanOptions } [options] - symbol span option.
* @returns { number } symbol span index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
addSymbolSpan(value: ResourceStr, options?: RichEditorSymbolSpanOptions ): number;
addSymbolSpan(value: Resource, options?: RichEditorSymbolSpanOptions ): number;
/**
* Modify span style.
@ -1979,6 +2087,7 @@ declare class RichEditorController {
*
* @param { RichEditorUpdateTextSpanStyleOptions | RichEditorUpdateImageSpanStyleOptions | RichEditorUpdateSymbolSpanStyleOptions } value
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -1989,6 +2098,7 @@ declare class RichEditorController {
*
* @param { RichEditorParagraphStyleOptions } value
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
updateParagraphStyle(value: RichEditorParagraphStyleOptions): void;
@ -2005,6 +2115,7 @@ declare class RichEditorController {
*
* @param { RichEditorRange } [value] - range for deleting.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2024,6 +2135,7 @@ declare class RichEditorController {
* @param { RichEditorRange } [value] - range for getting span info.
* @returns { Array<RichEditorImageSpanResult | RichEditorTextSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2035,6 +2147,7 @@ declare class RichEditorController {
* @param { RichEditorRange } [value] - range for getting span info.
* @returns { Array<RichEditorParagraphResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
getParagraphs(value?: RichEditorRange): Array<RichEditorParagraphResult>;
@ -2049,6 +2162,7 @@ declare class RichEditorController {
* close the select menu when menu is on.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2108,6 +2222,7 @@ declare class RichEditorController {
*
* @extends CommonMethod<RichEditorAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2126,6 +2241,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when rich editor is ready.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2145,6 +2261,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when select text.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2164,6 +2281,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when text content is about to insert.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2183,6 +2301,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when text content has been inserted.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2202,6 +2321,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when text content is about to delete.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2221,6 +2341,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { function } callback - The triggered function when text content has been deleted.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2291,6 +2412,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { CustomBuilder } value
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2313,6 +2435,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { boolean } enable - Enable data detector.
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
enableDataDetector(enable: boolean): RichEditorAttribute;
@ -2323,6 +2446,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @param { TextDataDetectorConfig } config - The config of text data detector.
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
dataDetectorConfig(config: TextDataDetectorConfig): RichEditorAttribute;
@ -2340,6 +2464,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
*
* @interface RichEditorInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2358,6 +2483,7 @@ interface RichEditorInterface {
* @param { RichEditorOptions } value
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2374,6 +2500,7 @@ interface RichEditorInterface {
* Defines RichEditor Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
@ -2389,6 +2516,7 @@ declare const RichEditorInstance: RichEditorAttribute;
* Defines RichEditor Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/

23
api/@internal/component/ets/scroll.d.ts vendored
View File

@ -535,11 +535,21 @@ declare class Scroller {
getItemRect(index: number): RectResult;
}
/*
/**
* Define scroll snap options
*
* @interface ScrollSnapOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Define scroll snap options
*
* @interface ScrollSnapOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
declare interface ScrollSnapOptions {
/**
* Set scroll snap alignment.
@ -1083,6 +1093,17 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @since 11
*/
scrollSnap(value: ScrollSnapOptions): ScrollAttribute;
/**
* Determines whether the scroll view stops on multiples of the content size when the user scrolls.
*
* @param { boolean } value - A boolean value determines whether paging is enabled for scroll.
* @returns { ScrollAttribute } the attribute of the scroll.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
enablePaging(value: boolean): ScrollAttribute;
}
/**

59
api/@internal/component/ets/search.d.ts vendored
View File

@ -246,6 +246,33 @@ declare enum SearchType {
* @since 11
*/
interface SearchInterface {
/**
* The options of SearchInterface
*
* @param { object } options
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* The options of SearchInterface
*
* @param { object } options
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The options of SearchInterface
*
* @param { object } options
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
(options?: {
/**
* Text input in the search text box
@ -254,6 +281,14 @@ interface SearchInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Text input in the search text box
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
value?: string;
/**
@ -270,6 +305,14 @@ interface SearchInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Text displayed when there is no input
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
placeholder?: ResourceStr;
/**
@ -279,6 +322,14 @@ interface SearchInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Path to the search icon
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
icon?: string;
/**
@ -288,6 +339,14 @@ interface SearchInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Controller of the <Search> component
*
* @type { ?SearchController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
controller?: SearchController
}): SearchAttribute;
}

1
api/@internal/component/ets/select.d.ts vendored
View File

@ -666,6 +666,7 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
menuAlign(alignType: MenuAlignType, offset?: Offset): SelectAttribute;

23
api/@internal/component/ets/sidebar.d.ts vendored
View File

@ -199,6 +199,7 @@ declare enum SideBarPosition {
declare interface ButtonStyle {
/**
* Set the left of control button
* default value is 16vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -206,6 +207,7 @@ declare interface ButtonStyle {
*/
/**
* Set the left of control button
* default value is 16vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -214,6 +216,7 @@ declare interface ButtonStyle {
*/
/**
* Set the left of control button
* default value is 16vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -225,6 +228,7 @@ declare interface ButtonStyle {
/**
* Set the top of control button
* default value is 48vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -232,6 +236,7 @@ declare interface ButtonStyle {
*/
/**
* Set the top of control button
* default value is 48vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -240,6 +245,7 @@ declare interface ButtonStyle {
*/
/**
* Set the top of control button
* default value is 48vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -251,6 +257,7 @@ declare interface ButtonStyle {
/**
* Set the width of control button
* default value is 32vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -258,6 +265,7 @@ declare interface ButtonStyle {
*/
/**
* Set the width of control button
* default value is 24vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -266,6 +274,7 @@ declare interface ButtonStyle {
*/
/**
* Set the width of control button
* default value is 24vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -277,6 +286,7 @@ declare interface ButtonStyle {
/**
* Set the height of control button
* default value is 32vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -284,6 +294,7 @@ declare interface ButtonStyle {
*/
/**
* Set the height of control button
* default value is 24vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -292,6 +303,7 @@ declare interface ButtonStyle {
*/
/**
* Set the height of control button
* default value is 24vp.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -626,6 +638,7 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
/**
* Sets the length of sidebar.
* default value is 200vp.
*
* @param { number } value
* @returns { SideBarContainerAttribute }
@ -634,6 +647,7 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
*/
/**
* Sets the length of sidebar.
* default value is 240vp.
*
* @param { number } value
* @returns { SideBarContainerAttribute }
@ -643,6 +657,7 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
*/
/**
* Sets the length of sidebar.
* default value is 240vp.
*
* @param { number } value
* @returns { SideBarContainerAttribute }
@ -664,7 +679,7 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
*/
/**
* Sets the min length of sidebar.
* default value is 200vp.
* default value is 240vp.
*
* @param { number } value
* @returns { SideBarContainerAttribute }
@ -674,7 +689,7 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
*/
/**
* Sets the min length of sidebar.
* default value is 200vp.
* default value is 240vp.
*
* @param { number } value
* @returns { SideBarContainerAttribute }
@ -897,6 +912,8 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
/**
* Sets the min length of content.
* default value is 360vp.
*
* @param { Dimension } value - min length of content.
* @returns { SideBarContainerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -905,6 +922,8 @@ declare class SideBarContainerAttribute extends CommonMethod<SideBarContainerAtt
*/
/**
* Sets the min length of content.
* default value is 360vp.
*
* @param { Dimension } value - min length of content.
* @returns { SideBarContainerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full

56
api/@internal/component/ets/span.d.ts vendored
View File

@ -13,6 +13,57 @@
* limitations under the License.
*/
/**
* Define the background style of span.
*
* @interface TextBackgroundStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare interface TextBackgroundStyle {
/**
* Background color of span.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
color?: ResourceColor;
/**
* Background radius of span.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
radius?: Dimension | BorderRadiuses;
}
/**
* Define the BaseSpan class, contains the common methods of span.
*
* @extends CommonMethod<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
declare class BaseSpan<T> extends CommonMethod<T> {
/**
* Span background style.
*
* @param { TextBackgroundStyle } style - The background style of span.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
textBackgroundStyle(style: TextBackgroundStyle): T;
}
/**
* Provide text decoration.
*
@ -108,14 +159,14 @@ interface SpanInterface {
* @form
*/
/**
* @extends CommonMethod<SpanAttribute>
* @extends BaseSpan<SpanAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class SpanAttribute extends CommonMethod<SpanAttribute> {
declare class SpanAttribute extends BaseSpan<SpanAttribute> {
/**
* Called when the font is set.
*
@ -470,6 +521,7 @@ declare class SpanAttribute extends CommonMethod<SpanAttribute> {
* @param { Length } value - The line height of the span.
* @returns { SpanAttribute } The attribute of the span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/

26
api/@internal/component/ets/swiper.d.ts vendored
View File

@ -522,6 +522,14 @@ declare type SwiperAutoFill = {
* @since 10
* @form
*/
/**
* Set minSize size.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
* @form
*/
minSize: VP;
};
@ -721,7 +729,7 @@ declare interface ArrowStyle {
* The size of the arrow is three-quarters of the background size, when the background is displayed.
*
* @type { ?Length }
* @default 24vp
* @default When isSidebarMiddle is false, the default value is 24vp, Otherwise,the default value is 32vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
@ -730,7 +738,7 @@ declare interface ArrowStyle {
* The size of the arrow is three-quarters of the background size, when the background is displayed.
*
* @type { ?Length }
* @default 24vp
* @default When isSidebarMiddle is false, the default value is 24vp, Otherwise,the default value is 32vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -742,7 +750,7 @@ declare interface ArrowStyle {
* The arrow background background color.
*
* @type { ?ResourceColor }
* @default #19182431
* @default When isSidebarMiddle is false, the default value is #00000000, Otherwise,the default value is #19182431
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
@ -750,7 +758,7 @@ declare interface ArrowStyle {
* The arrow background background color.
*
* @type { ?ResourceColor }
* @default #19182431
* @default When isSidebarMiddle is false, the default value is #00000000, Otherwise, the default value is #19182431
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -764,7 +772,7 @@ declare interface ArrowStyle {
* The size of the arrow is three-quarters of the background size, when the background is displayed.
*
* @type { ?Length }
* @default 18vp
* @default When isSidebarMiddle is false, the default value is 18vp, Otherwise, the default value is 24vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
@ -774,7 +782,7 @@ declare interface ArrowStyle {
* The size of the arrow is three-quarters of the background size, when the background is displayed.
*
* @type { ?Length }
* @default 18vp
* @default When isSidebarMiddle is false, the default value is 18vp, Otherwise, the default value is 24vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1270,7 +1278,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
/**
* Called when you set whether the navigation point indicator is enabled.
*
* @param { DotIndicator | DigitIndicator | boolean } value - show indicator of the swiper indicator.
* @param { boolean } value - show indicator of the swiper indicator.
* @returns { SwiperAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
@ -1507,7 +1515,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
/**
* This command is invoked when the number of subcomponents is set.
*
* @param { number | string | SwiperAutoFill } value
* @param { number | string } value
* @returns { SwiperAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
@ -1600,7 +1608,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
/**
* Called when sliding is curve
*
* @param { Curve | string | ICurve } value
* @param { Curve | string } value
* @returns { SwiperAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8

10
api/@internal/component/ets/tab_content.d.ts vendored
View File

@ -890,11 +890,19 @@ declare class TabContentAttribute extends CommonMethod<TabContentAttribute> {
/**
* Called when tabbar is entered.
*
* @param { string | Resource | CustomBuilder | { icon?: string | Resource; text?: string | Resource } } value
* @param { string | Resource | { icon?: string | Resource; text?: string | Resource } } value
* @returns { TabContentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Called when tabbar is entered.
*
* @param { string | Resource | CustomBuilder | { icon?: string | Resource; text?: string | Resource } } value
* @returns { TabContentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Called when tabbar is entered.
*

27
api/@internal/component/ets/tabs.d.ts vendored
View File

@ -228,13 +228,22 @@ declare enum LayoutStyle {
}
/**
* Provides methods for switching tabs.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Provides methods for switching tabs.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Provides methods for switching tabs.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
@ -849,6 +858,15 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
*/
barMode(value: BarMode, options?: ScrollableBarModeOptions): TabsAttribute;
/**
* Called when the width of the bar graph is set.
* Notice: barWidth only supports Number type.
*
* @param { number } value
* @returns { TabsAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Called when the width of the bar graph is set.
* Notice: barWidth only supports Number type on 7, supports Length type since 8.
@ -881,6 +899,15 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
*/
barWidth(value: Length): TabsAttribute;
/**
* Called when the height of the bar graph is set.
* Notice: barHeight only supports Number type.
*
* @param { number } value
* @returns { TabsAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Called when the height of the bar graph is set.
* Notice: barHeight only supports Number type on 7, supports Length type since 8.

22
api/@internal/component/ets/text_area.d.ts vendored
View File

@ -413,6 +413,17 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
*/
placeholderFont(value: Font): TextAreaAttribute;
/**
* Called when the type of soft keyboard input button is set.
*
* @param { EnterKeyType } value: the type of soft keyboard
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
enterKeyType(value: EnterKeyType): TextAreaAttribute;
/**
* Called when the alignment of the contents of a multiline text box is set.
*
@ -648,6 +659,17 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
*/
inputFilter(value: ResourceStr, error?: (value: string) => void): TextAreaAttribute;
/**
* Called when submitted.
*
* @param { function } callback
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
onSubmit(callback: (enterKey: EnterKeyType) => void): TextAreaAttribute;
/**
* Called when the input changes.
*

25
api/@internal/component/ets/text_clock.d.ts vendored
View File

@ -170,6 +170,31 @@ interface TextClockInterface {
(options?: { timeZoneOffset?: number; controller?: TextClockController }): TextClockAttribute;
}
/**
* Provides attribute for TextClock.
*
* @extends CommonMethod<TextClockAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Provides attribute for TextClock.
*
* @extends CommonMethod<TextClockAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Provides attribute for TextClock.
*
* @extends CommonMethod<TextClockAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @form
*/
declare class TextClockAttribute extends CommonMethod<TextClockAttribute> {
/**
* set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".

18
api/@internal/component/ets/text_input.d.ts vendored
View File

@ -336,6 +336,24 @@ declare enum EnterKeyType {
* @since 11
*/
Done,
/**
* Showed as 'previous' pattern.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
PREVIOUS = 7,
/**
* Showed as 'new line' pattern.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
NEW_LINE = 8,
}
/**

78
api/@internal/component/ets/web.d.ts vendored
View File

@ -184,6 +184,15 @@ declare enum MixedMode {
None,
}
/**
* The callback of safe browsing check.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
type OnSafeBrowsingCheckResultCallback = (threatType: ThreatType) => void;
/**
* Enum type supplied to {@link getHitTest} for indicating the cursor node HitTest.
*
@ -517,6 +526,53 @@ declare enum WebCaptureMode {
HOME_SCREEN = 0,
}
/**
* Enum type supplied to {@link threatType} for the website's threat type.
*
* @enum { number }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
declare enum ThreatType {
/**
* Illegal websites.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
THREAT_ILLEGAL = 0,
/**
* Fraud websites.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
THREAT_FRAUD = 1,
/**
* Websites with security risks.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
THREAT_RISK = 2,
/**
* Websites suspected of containing unhealthy content.
* ArkWeb will not intercept this type of website and apps could handle it themselves.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
THREAT_WARNING = 3,
}
/**
* Defines the Media Options.
*
@ -2034,7 +2090,7 @@ declare enum ContextMenuEditStateFlags {
* @atomicservice
* @since 11
*/
declare enum NavigationType {
declare enum WebNavigationType {
/**
* Unknown type.
*
@ -3646,12 +3702,12 @@ declare interface LoadCommittedDetails {
/**
* The type of the navigation.
*
* @type { NavigationType }
* @type { WebNavigationType }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
navigationType: NavigationType;
navigationType: WebNavigationType;
/**
* The url to navigate.
@ -3730,11 +3786,11 @@ declare interface NativeEmbedInfo {
/**
* The embed id.
*
* @type { ?number }
* @type { ?string }
* @syscap SystemCapability.Web.Webview.Core
* @since 11
*/
id?: number;
id?: string;
/**
* Only when enableEmbedMode is true and type is marked as native/xxx will be recognized as a same layer component.
*
@ -5939,6 +5995,18 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
*/
onOverScroll(callback: (event: { xOffset: number, yOffset: number }) => void): WebAttribute;
/**
* Called when received website security risk check result.
*
* @param { OnSafeBrowsingCheckResultCallback } callback - Function triggered when received website security risk check result.
* @returns { WebAttribute }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
*/
onSafeBrowsingCheckResult(callback: OnSafeBrowsingCheckResultCallback): WebAttribute;
/**
* Called when the load committed.
*

2
api/@ohos.InputMethodExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit IME Kit
* @kit InputMethodKit
*/
import Want from './@ohos.app.ability.Want';

2
api/@ohos.InputMethodExtensionContext.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit IME Kit
* @kit InputMethodKit
*/
import { AsyncCallback } from './@ohos.base';

2
api/@ohos.InputMethodSubtype.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit IME Kit
* @kit InputMethodKit
*/
/**

69
api/@ohos.PiPWindow.d.ts vendored
View File

@ -18,7 +18,6 @@
* @kit ArkUI
*/
import type AsyncCallback from './@ohos.base';
import type BaseContext from './application/BaseContext';
/**
@ -50,18 +49,6 @@ declare namespace PiPWindow {
*/
function create(config: PiPConfiguration): Promise<PiPController>;
/**
* Create picture-in-picture controller
*
* @param { PiPConfiguration } config - Params for picture-in-picture controller creation
* @param { AsyncCallback<PiPController> } callback - Callback used to return the PiPController created
* @throws { BusinessError } 401 - Params error, invalid or illegal parameter in PiPConfiguration
* @throws { BusinessError } 801 - Capability not supported
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
function create(config: PiPConfiguration, callback: AsyncCallback<PiPController>): void;
/**
* PiPConfiguration
*
@ -153,6 +140,13 @@ declare namespace PiPWindow {
* @since 11
*/
VIDEO_MEETING,
/**
* Indicates the content to show in picture-in-picture window is video live
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
VIDEO_LIVE,
}
/**
@ -218,13 +212,33 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
type PiPActionEventType = PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent;
type PiPActionEventType = PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent | PiPLiveActionEvent;
type PiPVideoActionEvent = 'playbackStateChanged' | 'nextVideo' | 'previousVideo';
type PiPCallActionEvent = 'hangUp';
/**
* Describe picture-in-picture call template action event type.
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
type PiPCallActionEvent = 'hangUp' | 'micStateChanged' | 'videoStateChanged';
type PiPMeetingActionEvent = 'hangUp';
/**
* Describe picture-in-picture meeting template action event type.
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
type PiPMeetingActionEvent = 'hangUp' | 'voiceStateChanged' | 'videoStateChanged';
/**
* Describe picture-in-picture live template action event type.
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
type PiPLiveActionEvent = 'playbackStateChanged';
/**
* PiPController
@ -247,18 +261,6 @@ declare namespace PiPWindow {
*/
startPiP(): Promise<void>;
/**
* Start picture-in-picture
* @param { AsyncCallback<void> } callback - Callback after PiP start finish
* @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
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
startPiP(callback: AsyncCallback<void>): void;
/**
* Stop picture-in-picture.
* @returns { Promise<void> } - The promise returned by the function.
@ -270,17 +272,6 @@ declare namespace PiPWindow {
*/
stopPiP(): Promise<void>;
/**
* Stop picture-in-picture.
* @param { AsyncCallback<void> } callback - Callback after PiP stop finish
* @throws { BusinessError } 1300011 - Stop PiP window failed.
* @throws { BusinessError } 1300012 - If PiP window state is abnormal.
* @throws { BusinessError } 1300015 - If window is stopping
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
stopPiP(callback: AsyncCallback<void>): void;
/**
* Set if auto start picture-in-picture when back home
* @param { boolean } enable - Enable auto start picture-in-picture when back home

204
api/@ohos.UiTest.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Test Kit
* @kit TestKit
*/
import { Callback } from './@ohos.base';
@ -1321,8 +1321,8 @@ declare interface UIEventObserver {
/**
* Listen for toast show once
*
* @param { 'toastShow' } type 'toastShow'.
* @param { Callback<UIElementInfo> } callback function, returns the monitored UIElementInfo.
* @param { 'toastShow' } type -'toastShow'.
* @param { Callback<UIElementInfo> } callback - function, returns the monitored UIElementInfo.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
* @atomicservice
@ -1344,8 +1344,8 @@ declare interface UIEventObserver {
/**
* Listen for dialog show once
*
* @param { 'dialogShow' } type 'dialogShow'.
* @param { Callback<UIElementInfo> } callback function, returns the monitored UIElementInfo.
* @param { 'dialogShow' } type - 'dialogShow'.
* @param { Callback<UIElementInfo> } callback - function, returns the monitored UIElementInfo.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
* @atomicservice
@ -1543,8 +1543,8 @@ declare class On {
/**
* Specifies the text for the target Component.
*
* @param { string } txt The text value.
* @param { MatchPattern } pattern The {@link MatchPattern} of the text value,default to {@link MatchPattern.EQUALS}.Set it default if null or undefined.
* @param { string } txt - the text value.
* @param { MatchPattern } [pattern] - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1579,7 +1579,7 @@ declare class On {
/**
* Specifies the id of the target Component.
*
* @param { string } id The id value.
* @param { string } id - the id value.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1614,7 +1614,7 @@ declare class On {
/**
* Specifies the type of the target Component.
*
* @param { string } tp The type value.
* @param { string } tp - The type value.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1649,7 +1649,7 @@ declare class On {
/**
* Specifies the clickable status of the target Component.
*
* @param { boolean } b The clickable status,default to true.Set it default if null or undefined.
* @param { boolean } [b] - the clickable status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1684,7 +1684,7 @@ declare class On {
/**
* Specifies the longClickable status of the target Component.
*
* @param { boolean } b The longClickable status,default to true.Set it default if null or undefined.
* @param { boolean } [b] - the longClickable status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1719,7 +1719,7 @@ declare class On {
/**
* Specifies the scrollable status of the target Component.
*
* @param { boolean } b The scrollable status,default to true.Set it default if null or undefined.
* @param { boolean } [b] - the scrollable status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1754,7 +1754,7 @@ declare class On {
/**
* Specifies the enabled status of the target Component.
*
* @param { boolean } b The enabled status,default to true.Set it default if null or undefined.
* @param { boolean } [b] - the enabled status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1789,7 +1789,7 @@ declare class On {
/**
* Specifies the focused status of the target Component.
*
* @param { boolean } b The focused status,default to true.Set it default if null or undefined.
* @param { boolean } [b] - the focused status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1824,7 +1824,7 @@ declare class On {
/**
* Specifies the selected status of the target Component.
*
* @param { boolean } b The selected status,default to true.Set it default if null or undefined.
* @param { boolean } [b] the - selected status,default to true.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1859,7 +1859,7 @@ declare class On {
/**
* Specifies the checked status of the target Component.
*
* @param { boolean } b The checked status,default to false.Set it default if null or undefined.
* @param { boolean } [b] - the checked status,default to false.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1894,7 +1894,7 @@ declare class On {
/**
* Specifies the checkable status of the target Component.
*
* @param { boolean } b The checkable status,default to false.Set it default if null or undefined.
* @param { boolean } [b] - the checkable status,default to false.Set it default if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1920,7 +1920,7 @@ declare class On {
* Requires that the target Component which is before another Component that specified by the given {@link On}
* object,used to locate Component relatively.
*
* @param { On } on Describes the attribute requirements of Component which the target one is in front of.
* @param { On } on - describes the attribute requirements of Component which the target one is in front of.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1946,7 +1946,7 @@ declare class On {
* Requires that the target Component which is after another Component that specified by the given {@link On}
* object,used to locate Component relatively.
*
* @param { On } on Describes the attribute requirements of Component which the target one is in back of.
* @param { On } on - describes the attribute requirements of Component which the target one is in back of.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1972,7 +1972,7 @@ declare class On {
* Requires that the target Component which is inside of another Component that specified by the given {@link On}
* object,used to locate Component relatively.
*
* @param { On } on Describes the attribute requirements of Component which the target one is inside of.
* @param { On } on - describes the attribute requirements of Component which the target one is inside of.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -1996,7 +1996,7 @@ declare class On {
/**
* Specifies the bundleName of the application which the window that the target Component is located belongs.
*
* @param { string } bundleName The bundleName of the specified window.
* @param { string } bundleName - the bundleName of the specified window.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -2009,8 +2009,8 @@ declare class On {
/**
* Specifies the description for the target Component.
*
* @param { string } val The description value.
* @param { MatchPattern } pattern The {@link MatchPattern} of the description value, default to {@link MatchPattern.EQUALS}
* @param { string } val - the description value.
* @param { MatchPattern } [pattern] - the {@link MatchPattern} of description value,set it default {@link MatchPattern.EQUALS} if null or undefined.
* @returns { On } this {@link On} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -2555,7 +2555,7 @@ declare class Component {
/**
* Inject text to this {@link Component},applicable to TextInput.
*
* @param { string } text The text to inject.
* @param { string } text - the text to inject.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2631,7 +2631,7 @@ declare class Component {
/**
* Scroll on this {@link Component} to the top,applicable to scrollable one.
*
* @param { number } speed The speed of swipe(pixels per second),default is 600,ranges from 200 to 40000.Set it default if out of range or null or undefined.
* @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000.Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2672,7 +2672,7 @@ declare class Component {
/**
* Scroll on this {@link Component} to the bottom,applicable to scrollable one.
*
* @param { number } speed The speed of swipe(pixels per second),default is 600,ranges from 200 to 40000.Set it default if out of range or null or undefined.
* @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2713,7 +2713,7 @@ declare class Component {
/**
* Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one.
*
* @param { On } on The attribute requirements of the target {@link Component}.
* @param { On } on - the attribute requirements of the target {@link Component}.
* @returns { Promise<Component> } the found result,or undefined if not found.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2799,7 +2799,7 @@ declare class Component {
/**
* Drag this {@link Component} to the bounds rect of target Component.
*
* @param { Component } target The target {@link Component}.
* @param { Component } target - the target {@link Component}.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2826,7 +2826,7 @@ declare class Component {
/**
* Pinch enlarge this {@link Component} to the target scale.
*
* @param { number } scale The scale of the pinch enlarge this {@link Component}'s size.
* @param { number } scale - the scale of the pinch enlarge this {@link Component}'s size.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2854,7 +2854,7 @@ declare class Component {
/**
* Pinch shrink this {@link Component} to the target scale.
*
* @param { number } scale The scale of the pinch shrink this {@link Component}'s size.
* @param { number } scale - the scale of the pinch shrink this {@link Component}'s size.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2957,7 +2957,7 @@ declare class Driver {
/**
* Delay with specified duration.
*
* @param { number } duration The delay duration in milliseconds.
* @param { number } duration - the delay duration in milliseconds.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -2995,7 +2995,7 @@ declare class Driver {
/**
* Find the first matched {@link Component} on current UI.
*
* @param { On } on The attribute requirements of the target {@link Component}.
* @param { On } on - the attribute requirements of the target {@link Component}.
* @returns { Promise<Component> } the first matched {@link Component} or undefined.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3021,7 +3021,7 @@ declare class Driver {
/**
* Find the first matched {@link UiWindow} window.
*
* @param { WindowFilter } filter The filer condition of the target {@link UiWindow}.
* @param { WindowFilter } filter - the filer condition of the target {@link UiWindow}.
* @returns { Promise<UiWindow> } the first matched {@link UiWindow} or undefined.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3047,8 +3047,8 @@ declare class Driver {
/**
* Find the first matched {@link Component} on current UI during the time given.
*
* @param { On } on The attribute requirements of the target {@link Component}.
* @param { number } time Duration of finding in milliseconds
* @param { On } on - the attribute requirements of the target {@link Component}.
* @param { number } time - duration of finding in milliseconds
* @returns { Promise<Component> } the first matched {@link Component} or undefined.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3085,7 +3085,7 @@ declare class Driver {
/**
* Find all the matched {@link Component}s on current UI.
*
* @param { On } on The attribute requirements of the target {@link Component}.
* @param { On } on - the attribute requirements of the target {@link Component}.
* @returns { Promise<Array<Component>> } the matched {@link Component}s list.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3125,7 +3125,7 @@ declare class Driver {
/**
* Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised.
*
* @param { On } on The attribute requirements of the target {@link Component}.
* @param { On } on - the attribute requirements of the target {@link Component}.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3184,7 +3184,7 @@ declare class Driver {
/**
* Press the specified key.
*
* @param { number } keyCode the target keyCode.
* @param { number } keyCode - the target keyCode.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3212,9 +3212,9 @@ declare class Driver {
/**
* Press two or three key combinations
*
* @param { number } key0 the first keyCode.
* @param { number } key1 the second keyCode.
* @param { number } key2 the third keyCode.
* @param { number } [key0] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key1] - the second keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the third keyCode,set it default 0 if null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3254,8 +3254,8 @@ declare class Driver {
/**
* Click on the specified location on the screen.
*
* @param { number } x The x-coordinate.
* @param { number } y The y-coordinate.
* @param { number } x - the x-coordinate.
* @param { number } y - the y-coordinate.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3295,8 +3295,8 @@ declare class Driver {
/**
* DoubleClick on the specified location on the screen.
*
* @param { number } x The x-coordinate.
* @param { number } y The y-coordinate.
* @param { number } x - the x-coordinate.
* @param { number } y - the y-coordinate.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3336,8 +3336,8 @@ declare class Driver {
/**
* LongClick on the specified location on the screen.
*
* @param { number } x The x-coordinate.
* @param { number } y The y-coordinate.
* @param { number } x - the x-coordinate.
* @param { number } y - the y-coordinate.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3383,11 +3383,11 @@ declare class Driver {
/**
* Swipe on the screen between the specified points.
*
* @param { number } startx The x-coordinate of the starting point.
* @param { number } starty The y-coordinate of the starting point.
* @param { number } endx The x-coordinate of the ending point.
* @param { number } endy The y-coordinate of the ending point.
* @param { number } speed The speed of swipe(pixels per second),default is 600,ranges from 200 to 40000.Set it default if out of range or null or undefined.
* @param { number } startx - the x-coordinate of the starting point.
* @param { number } starty - the y-coordinate of the starting point.
* @param { number } endx - the x-coordinate of the ending point.
* @param { number } endy - the y-coordinate of the ending point.
* @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3417,11 +3417,11 @@ declare class Driver {
/**
* Drag on the screen between the specified points.
*
* @param { number } startx The x-coordinate of the starting point.
* @param { number } starty The y-coordinate of the starting point.
* @param { number } endx The x-coordinate of the ending point.
* @param { number } endy The y-coordinate of the ending point.
* @param { number } speed The speed of drag(pixels per second),default is 600,ranges from 200 to 40000.Set it default if out of range or null or undefined.
* @param { number } startx - the x-coordinate of the starting point.
* @param { number } starty - the y-coordinate of the starting point.
* @param { number } endx - the x-coordinate of the ending point.
* @param { number } endy - the y-coordinate of the ending point.
* @param { number } [speed] the speed of drag(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3446,7 +3446,7 @@ declare class Driver {
/**
* Capture current screen and save as picture which PNG format.
*
* @param { string } savePath the path where to store the picture.
* @param { string } savePath - the path where to store the picture.
* @returns { Promise<boolean> } true if screen-capturing and file-storing are completed successfully,false otherwise.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3471,7 +3471,7 @@ declare class Driver {
/**
* Set the rotation of the device display.
*
* @param { DisplayRotation } rotation The target rotation to set.
* @param { DisplayRotation } rotation - the target rotation to set.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3517,7 +3517,7 @@ declare class Driver {
/**
* Enable/disable the rotation of device display.
*
* @param { boolean } enabled Enable the rotation or not.
* @param { boolean } enabled - enable the rotation or not.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3627,8 +3627,8 @@ declare class Driver {
/**
* Wait for the UI become idle.
*
* @param { number } idleTime the threshold of UI idle time, in millisecond.
* @param { number } timeout The maximum time to wait for idle, in millisecond.
* @param { number } idleTime - the threshold of UI idle time, in millisecond.
* @param { number } timeout - the maximum time to wait for idle, in millisecond.
* @returns { Promise<boolean> } true if wait for idle succeed in the timeout, false otherwise.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3671,10 +3671,10 @@ declare class Driver {
/**
* Inject fling on the device display.
*
* @param { Point } from The coordinate point where the finger touches the screen.
* @param { Point } to The coordinate point where the finger leaves the screen.
* @param { number } stepLen the length of each step, in pixels.
* @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range.
* @param { Point } from - the coordinate point where the finger touches the screen.
* @param { Point } to - the coordinate point where the finger leaves the screen.
* @param { number } stepLen - the length of each step, in pixels.
* @param { number } [speed] - the speed of fling(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3701,8 +3701,8 @@ declare class Driver {
/**
* Inject multi-pointer action on the device display.
*
* @param { PointerMatrix } pointers The two-dimensional array of pointers to inject.
* @param { number } speed The speed of swipe(pixels per second),default is 600,ranges from 200 to 40000.Set it default if out of range or null or undefined.
* @param { PointerMatrix } pointers - the two-dimensional array of pointers to inject.
* @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined.
* @returns { Promise<boolean> } true if the operation finished, false
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3729,8 +3729,8 @@ declare class Driver {
/**
* Inject fling on the device display.
*
* @param { UiDirection } direction The direction of this action.
* @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range.
* @param { UiDirection } direction - the direction of this action.
* @param { number } speed - the speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3758,10 +3758,10 @@ declare class Driver {
/**
* Click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary.
*
* @param { Point } p The coordinate of the specified location.
* @param { MouseButton } btnId The button of Mouse.
* @param { number } key1 the first keyCode.
* @param { number } key2 the second keyCode.
* @param { Point } p - the coordinate of the specified location.
* @param { MouseButton } btnId - the button of Mouse.
* @param { number } [key1] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the second keyCode,set it default 0 if null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3786,7 +3786,7 @@ declare class Driver {
/**
* Move the mouse cursor to the specified location.
*
* @param { Point } p The coordinate of the specified location.
* @param { Point } p - the coordinate of the specified location.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3815,11 +3815,11 @@ declare class Driver {
/**
* The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary.
*
* @param { Point } p The coordinate of the specified location.
* @param { boolean } down Whether the mouse wheel rolls down.
* @param { number } d The number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels.
* @param { number } key1 the first keyCode.
* @param { number } key2 the second keyCode.
* @param { Point } p - the coordinate of the specified location.
* @param { boolean } down - whether the mouse wheel rolls down.
* @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels.
* @param { number } [key1] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the second keyCode,set it default 0 if null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3835,9 +3835,9 @@ declare class Driver {
* @param { Point } p - the coordinate of the specified location.
* @param { boolean } down - whether the mouse wheel rolls down.
* @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels.
* @param { number } key1 - the first keyCode.
* @param { number } key2 - the second keyCode.
* @param { number } speed - the speed at which mouse wheel rolls(cells per second),default is 20,the value ranges from 1 to 500,set it 20 if out of range.
* @param { number } [key1] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the second keyCode,set it default 0 if null or undefined.
* @param { number } [speed] - The Speed of mouse wheel rolls(cells per second),ranges from 1 to 500.Set it default 20 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3852,7 +3852,7 @@ declare class Driver {
* Capture the specified area of current screen and save as picture which PNG format.
*
* @param { string } savePath the path where to store the picture.
* @param { Rect } rect The specified area of current screen, default full screen.
* @param { Rect } rect The specified area of current screen, default to full screen.
* @returns { Promise<boolean> } true if screen-capturing and file-storing are completed successfully,false otherwise.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3863,8 +3863,8 @@ declare class Driver {
/**
* Capture the specified area of current screen and save as picture which PNG format.
*
* @param { string } savePath the path where to store the picture.
* @param { Rect } rect The specified area of current screen, default full screen.
* @param { string } savePath - the path where to store the picture.
* @param { Rect } [rect] - the specified area of current screen, default to full screen.Set it default if null or undefined.
* @returns { Promise<boolean> } true if screen-capturing and file-storing are completed successfully,false otherwise.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3901,8 +3901,8 @@ declare class Driver {
*
* @param { Point } p - the coordinate of the specified location.
* @param { MouseButton } btnId - the button of Mouse.
* @param { number } key1 - the first keyCode.
* @param { number } key2 - the second keyCode.
* @param { number } [key1] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the second keyCode,set it default 0 if null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3918,8 +3918,8 @@ declare class Driver {
*
* @param { Point } p - the coordinate of the specified location.
* @param { MouseButton } btnId - the button of Mouse.
* @param { number } key1 - the first keyCode.
* @param { number } key2 - the second keyCode.
* @param { number } [key1] - the first keyCode,set it default 0 if null or undefined.
* @param { number } [key2] - the second keyCode,set it default 0 if null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3935,7 +3935,7 @@ declare class Driver {
*
* @param { Point } from - the starting point.
* @param { Point } to - the ending point.
* @param { number } speed - the speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range.
* @param { number } [speed] - speed of swipe (pixels per second),the value ranges from 200 to 40000.Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -3951,7 +3951,7 @@ declare class Driver {
*
* @param { Point } from - the starting point.
* @param { Point } to - the ending point.
* @param { number } speed - the speed of drag (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range.
* @param { number } [speed] - speed of drag (pixels per second),the value ranges from 200 to 40000,Set it default 600 if out of range or null or undefined.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -4164,8 +4164,8 @@ declare class UiWindow {
/**
* Move this {@link UiWindow} to the specified points.
*
* @param { number } x The x coordinate of destination.
* @param { number } y The y coordinate of destination.
* @param { number } x - the x coordinate of destination.
* @param { number } y - the y coordinate of destination.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -4196,9 +4196,9 @@ declare class UiWindow {
/**
* Resize this {@link UiWindow} to the specified size for the specified direction.
*
* @param { number } wide The expected wide of the window after resizing.
* @param { number } height The expected height of the window after resizing.
* @param { ResizeDirection } direction The expected direction of the window after resizing.
* @param { number } wide - the expected wide of the window after resizing.
* @param { number } height - the expected height of the window after resizing.
* @param { ResizeDirection } direction - the expected direction of the window after resizing.
* @returns { Promise<void> }
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 17000002 - if the async function was not called with await.
@ -4373,8 +4373,8 @@ declare class PointerMatrix {
/**
* Create an {@link PointerMatrix} object.
*
* @param { number } fingers The number of fingers.
* @param { number } steps The number of steps of each finger trace.
* @param { number } fingers - the number of fingers.
* @param { number } steps - the number of steps of each finger trace.
* @returns { PointerMatrix } the {@link PointerMatrix} object.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
@ -4399,9 +4399,9 @@ declare class PointerMatrix {
/**
* Set the point value of an element in the PointerMatrix.
*
* @param { number } finger The index of target finger to set.
* @param { number } step The index of target step to set.
* @param { Point } point The coordinate of target step to set.
* @param { number } finger - the index of target finger to set.
* @param { number } step - the index of target step to set.
* @param { Point } point - the coordinate of target step to set.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Test.UiTest
* @crossplatform

2
api/@ohos.WallpaperExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Basic Services Kit
* @kit BasicServicesKit
*/
/**

2
api/@ohos.WorkSchedulerExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Background Tasks Kit
* @kit BackgroundTasksKit
*/
import workScheduler from './@ohos.resourceschedule.workScheduler';

2
api/@ohos.ability.ability.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { DataAbilityHelper as _DataAbilityHelper } from './ability/dataAbilityHelper';

2
api/@ohos.ability.dataUriUtils.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.ability.errorCode.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.ability.featureAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

2
api/@ohos.ability.particleAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

2
api/@ohos.ability.wantConstant.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.abilityAccessCtrl.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback, Callback } from './@ohos.base';

2
api/@ohos.accessibility.GesturePath.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Accessibility Kit
* @kit AccessibilityKit
*/
import type { GesturePoint } from './@ohos.accessibility.GesturePoint';

2
api/@ohos.accessibility.GesturePoint.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Accessibility Kit
* @kit AccessibilityKit
*/
/**

2
api/@ohos.accessibility.config.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Accessibility Kit
* @kit AccessibilityKit
*/
import type accessibility from './@ohos.accessibility';

36
api/@ohos.accessibility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Accessibility Kit
* @kit AccessibilityKit
*/
import type { AsyncCallback } from './@ohos.base';
@ -28,6 +28,14 @@ import type { Callback } from './@ohos.base';
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* Accessibility
*
* @namespace accessibility
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @atomicservice
* @since 11
*/
declare namespace accessibility {
/**
* The type of the Ability app.
@ -494,17 +502,25 @@ declare namespace accessibility {
*/
readonly id: string;
/* The ability name.
/**
* The ability name.
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly name: string;
/* The bundle name of the ability.
/**
* The bundle name of the ability.
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly bundleName: string;
/* The target bundle name for the observation.
/**
* The target bundle name for the observation.
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
readonly targetBundleNames: Array<string>;
@ -550,6 +566,16 @@ declare namespace accessibility {
*/
class EventInfo {
constructor(jsonObject);
/**
* A constructor used to create a EventInfo object.
*
* @param { EventType } type - The type of the accessibility event.
* @param { string } bundleName - The name of the bundle.
* @param { Action } triggerAction - The action that the ability can execute.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 11
*/
constructor(type: EventType, bundleName: string, triggerAction: Action);
/**
* The type of an accessibility event.
*

36
api/@ohos.account.appAccount.d.ts vendored
View File

@ -15,12 +15,12 @@
/**
* @file
* @kit Basic Services Kit
* @kit BasicServicesKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
import Want from './@ohos.app.ability.Want';
import rpc from './@ohos.rpc';
import type { AsyncCallback, Callback } from './@ohos.base';
import type Want from './@ohos.app.ability.Want';
import type rpc from './@ohos.rpc';
/**
* This module provides the capability to manage application accounts.
@ -1160,7 +1160,7 @@ declare namespace appAccount {
* @param { string } name - Indicates the account name of your application or third-party applications.
* @param { string } owner - Indicates the account owner of your application or third-party applications.
* @param { string } authType - Indicates the authentication type.
* @param { object } options - Indicates the authenticator-specific options for the request.
* @param { Record<string, Object> } options - Indicates the authenticator-specific options for the request.
* @param { AuthCallback } callback - Indicates the authenticator callback.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 12300001 - System service exception.
@ -1176,7 +1176,7 @@ declare namespace appAccount {
name: string,
owner: string,
authType: string,
options: { [key: string]: Object },
options: Record<string, Object>,
callback: AuthCallback
): void;
@ -2141,11 +2141,11 @@ declare namespace appAccount {
* The custom data for creating an account,
* which can be further modified by function setCustomData.
*
* @type { ?object }
* @type { ?Record<string, string> }
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
customData?: { [key: string]: string };
customData?: Record<string, string>;
}
/**
@ -2180,11 +2180,11 @@ declare namespace appAccount {
* 1. Constants.KEY_CALLER_BUNDLE_NAME;
* The above parameters are set by the appAccount management service and can be used for identify the caller.
*
* @type { ?object }
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
parameters?: { [key: string]: Object };
parameters?: Record<string, Object>;
}
/**
@ -2255,11 +2255,11 @@ declare namespace appAccount {
* 1. Constants.KEY_CALLER_BUNDLE_NAME;
* The above parameters are set by the appAccount management service and can be used for identify the caller.
*
* @type { ?object }
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
parameters?: { [key: string]: Object };
parameters?: Record<string, Object>;
}
/**
@ -2273,11 +2273,11 @@ declare namespace appAccount {
/**
* The properties to be set.
*
* @type { ?object }
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
properties?: { [key: string]: Object };
properties?: Record<string, Object>;
/**
* The authenticator-specific parameters.
@ -2285,11 +2285,11 @@ declare namespace appAccount {
* 1. Constants.KEY_CALLER_BUNDLE_NAME;
* The above parameters are set by the appAccount management service and can be used for identify the caller.
*
* @type { ?object }
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
parameters?: { [key: string]: Object };
parameters?: Record<string, Object>;
}
/**
@ -2747,12 +2747,12 @@ declare namespace appAccount {
*
* @param { string } name - Indicates the account name.
* @param { string } authType - Indicates the authentication type.
* @param { object } options - Indicates the authenticator-specific options for the request.
* @param { Record<string, Object> } options - Indicates the authenticator-specific options for the request.
* @param { AuthCallback } callback - Indicates the authenticator callback.
* @syscap SystemCapability.Account.AppAccount
* @since 9
*/
auth(name: string, authType: string, options: { [key: string]: Object }, callback: AuthCallback): void;
auth(name: string, authType: string, options: Record<string, Object>, callback: AuthCallback): void;
/**
* Verifies the credential to ensure the user is the owner of the specified application account.

4
api/@ohos.account.distributedAccount.d.ts vendored
View File

@ -15,10 +15,10 @@
/**
* @file
* @kit Basic Services Kit
* @kit BasicServicesKit
*/
import { AsyncCallback } from './@ohos.base';
import type { AsyncCallback } from './@ohos.base';
/**
* This module provides the capability to manage distributed accounts.

18
api/@ohos.account.osAccount.d.ts vendored
View File

@ -15,11 +15,11 @@
/**
* @file
* @kit Basic Services Kit
* @kit BasicServicesKit
*/
import distributedAccount from './@ohos.account.distributedAccount';
import { AsyncCallback, Callback } from './@ohos.base';
import type distributedAccount from './@ohos.account.distributedAccount';
import type { AsyncCallback, Callback } from './@ohos.base';
/**
* This module provides the capability to manage os accounts.
@ -2338,12 +2338,12 @@ declare namespace osAccount {
/**
* Indicates the business parameters.
*
* @type { object }
* @type { Record<string, Object> }
* @syscap SystemCapability.Account.OsAccount
* @systemapi Hide this for inner system use.
* @since 10
*/
businessParams: { [key: string]: object };
businessParams: Record<string, Object>;
/**
* Indicates caller UID.
@ -2825,7 +2825,7 @@ declare namespace osAccount {
/**
* Gets the business access token of the current domain account.
*
* @param { object } businessParams - Indicates the business parameters.
* @param { Record<string, Object> } businessParams - Indicates the business parameters.
* @param { AsyncCallback<Uint8Array> } callback - Indicates the result callback.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - The parameter check failed.
@ -2841,12 +2841,12 @@ declare namespace osAccount {
* @systemapi Hide this for inner system use.
* @since 11
*/
static getAccessToken(businessParams: { [key: string]: Object }, callback: AsyncCallback<Uint8Array>): void;
static getAccessToken(businessParams: Record<string, Object>, callback: AsyncCallback<Uint8Array>): void;
/**
* Gets the business access token for the current domain account.
*
* @param { object } businessParams - Indicates the business parameters.
* @param { Record<string, Object> } businessParams - Indicates the business parameters.
* @returns { Promise<Uint8Array> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - The parameter check failed.
@ -2862,7 +2862,7 @@ declare namespace osAccount {
* @systemapi Hide this for inner system use.
* @since 11
*/
static getAccessToken(businessParams: { [key: string]: Object }): Promise<Uint8Array>;
static getAccessToken(businessParams: Record<string, Object>): Promise<Uint8Array>;
}
/**

2
api/@ohos.advertising.AdComponent.d.ets
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ads Kit
* @kit AdsKit
*/
import advertising from './@ohos.advertising';

4
api/@ohos.advertising.AdsServiceExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ads Kit
* @kit AdsKit
*/
import type advertising from './@ohos.advertising';
@ -64,7 +64,7 @@ export interface RespCallback {
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
(respData: Map<string, Array<advertising.Advertisement>>);
(respData: Map<string, Array<advertising.Advertisement>>): void;
}

2
api/@ohos.advertising.AutoAdComponent.d.ets
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ads Kit
* @kit AdsKit
*/
import advertising from './@ohos.advertising';

2
api/@ohos.advertising.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ads Kit
* @kit AdsKit
*/
import type common from './@ohos.app.ability.common';

2
api/@ohos.ai.intelligentVoice.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit MindSpore Lite Kit
* @kit MindSporeLiteKit
*/
import type { AsyncCallback, Callback } from './@ohos.base';

2
api/@ohos.ai.mindSporeLite.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit MindSpore Lite Kit
* @kit MindSporeLiteKit
*/
import { Callback } from './@ohos.base';

2
api/@ohos.app.ability.Ability.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import AbilityConstant from './@ohos.app.ability.AbilityConstant';

2
api/@ohos.app.ability.AbilityConstant.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.AbilityLifecycleCallback.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIAbility from './@ohos.app.ability.UIAbility';

2
api/@ohos.app.ability.AbilityStage.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import AbilityConstant from './@ohos.app.ability.AbilityConstant';

2
api/@ohos.app.ability.ActionExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility';

2
api/@ohos.app.ability.ApplicationStateChangeCallback.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.AutoFillExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import ExtensionAbility from './@ohos.app.ability.ExtensionAbility';

2
api/@ohos.app.ability.ChildProcess.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.Configuration.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import ConfigurationConstant from './@ohos.app.ability.ConfigurationConstant';

2
api/@ohos.app.ability.ConfigurationConstant.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.DriverExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Driver Development Kit
* @kit DriverDevelopmentKit
*/
import type rpc from './@ohos.rpc';

11
api/@ohos.app.ability.EnvironmentCallback.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import AbilityConstant from './@ohos.app.ability.AbilityConstant';
@ -36,6 +36,15 @@ export default class EnvironmentCallback {
* @StageModelOnly
* @since 9
*/
/**
* Called when the system configuration is updated.
*
* @param { Configuration } config - Indicates the updated configuration.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
* @atomicservice
* @since 11
*/
onConfigurationUpdated(config: Configuration): void;
/**

2
api/@ohos.app.ability.ExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import Ability from './@ohos.app.ability.Ability';

5
api/@ohos.app.ability.InsightIntentContext.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AsyncCallback } from './@ohos.base';
@ -26,6 +26,7 @@ import type Want from './@ohos.app.ability.Want';
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
export default class InsightIntentContext {
@ -53,6 +54,7 @@ export default class InsightIntentContext {
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
startAbility(want: Want, callback: AsyncCallback<void>): void;
@ -81,6 +83,7 @@ export default class InsightIntentContext {
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
startAbility(want: Want): Promise<void>;

8
api/@ohos.app.ability.InsightIntentExecutor.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type window from './@ohos.window';
@ -28,6 +28,7 @@ import type UIExtensionContentSession from './@ohos.app.ability.UIExtensionConte
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
export default class InsightIntentExecutor {
@ -37,6 +38,7 @@ export default class InsightIntentExecutor {
* @type { InsightIntentContext }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
context: InsightIntentContext;
@ -50,6 +52,7 @@ export default class InsightIntentExecutor {
* @returns { insightIntent.ExecuteResult | Promise<insightIntent.ExecuteResult> } The result of insight intent execution, support promise.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
* @atomicservice
* @since 11
*/
onExecuteInUIAbilityForegroundMode(name: string, param: Record<string, Object>, pageLoader: window.WindowStage):
@ -63,6 +66,7 @@ export default class InsightIntentExecutor {
* @returns { insightIntent.ExecuteResult | Promise<insightIntent.ExecuteResult> } The result of insight intent execution, support promise.
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
* @atomicservice
* @since 11
*/
onExecuteInUIAbilityBackgroundMode(name: string, param: Record<string, Object>):
@ -77,6 +81,7 @@ export default class InsightIntentExecutor {
* @returns { insightIntent.ExecuteResult | Promise<insightIntent.ExecuteResult> } The result of insight intent execution, support promise.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
onExecuteInUIExtensionAbility(name: string, param: Record<string, Object>, pageLoader: UIExtensionContentSession):
@ -90,6 +95,7 @@ export default class InsightIntentExecutor {
* @returns { insightIntent.ExecuteResult | Promise<insightIntent.ExecuteResult> } The result of insight intent execution, support promise.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
onExecuteInServiceExtensionAbility(name: string, param: Record<string, Object>):

2
api/@ohos.app.ability.MediaControlExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility';

2
api/@ohos.app.ability.PrintExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Basic Services Kit
* @kit BasicServicesKit
*/
import type Want from './@ohos.application.Want';

2
api/@ohos.app.ability.ServiceExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import rpc from './@ohos.rpc';

2
api/@ohos.app.ability.ShareExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility';

2
api/@ohos.app.ability.StartOptions.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.UIAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import Ability from './@ohos.app.ability.Ability';

2
api/@ohos.app.ability.UIExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import ExtensionAbility from './@ohos.app.ability.ExtensionAbility';

18
api/@ohos.app.ability.UIExtensionContentSession.d.ts vendored
View File

@ -15,15 +15,16 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AbilityResult } from './ability/abilityResult';
import type { AbilityStartCallback } from './application/AbilityStartCallback';
import type AbilityStartCallback from './application/AbilityStartCallback';
import type { AsyncCallback } from './@ohos.base';
import type { LocalStorage } from 'StateManagement';
import type Want from './@ohos.app.ability.Want';
import type StartOptions from './@ohos.app.ability.StartOptions';
import type uiExtensionHost from './@ohos.uiExtensionHost';
/**
* class of ui extension content session.
@ -551,4 +552,17 @@ export default class UIExtensionContentSession {
*/
startAbilityByType(type: string, wantParam: Record<string, Object>,
abilityStartCallback: AbilityStartCallback): Promise<void>;
/**
* Get the UIExtension Host Window proxy.
*
* @returns { uiExtensionHost.UIExtensionHostWindowProxy } Returns the UIExtension Host Window proxy.
* @throws { BusinessError } 202 - Not System App. Interface caller is not a system app.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 11
*/
getUIExtensionHostWindowProxy(): uiExtensionHost.UIExtensionHostWindowProxy;
}

2
api/@ohos.app.ability.UserAuthExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility';

55
api/@ohos.app.ability.VpnExtensionAbility.d.ts vendored Normal file
View File

@ -0,0 +1,55 @@
/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type VpnExtensionContext from './application/VpnExtensionContext';
import type Want from './@ohos.app.ability.Want';
/**
* class of vpn extension ability.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
*/
export default class VpnExtensionAbility {
/**
* Indicates service extension ability context.
*
* @type { VpnExtensionContext }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
*/
context: VpnExtensionContext;
/**
* Called back when a vpn extension is started for initialization.
*
* @param { Want } want - Indicates the want of created service extension.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
*/
onCreate(want: Want): void;
/**
* Called back before a vpn extension is destroyed.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
*/
onDestroy(): void;
}

2
api/@ohos.app.ability.Want.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.abilityDelegatorRegistry.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Test Kit
* @kit TestKit
*/
import { AbilityDelegator as _AbilityDelegator } from './application/AbilityDelegator';

2
api/@ohos.app.ability.abilityManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AbilityResult } from './ability/abilityResult';

2
api/@ohos.app.ability.appManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

2
api/@ohos.app.ability.appRecovery.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import UIAbilityContext from './application/UIAbilityContext';

2
api/@ohos.app.ability.autoFillManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { UIContext } from './@ohos.arkui.UIContext';

26
api/@ohos.app.ability.autoStartupManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AutoStartupCallback } from './application/AutoStartupCallback';
@ -34,8 +34,11 @@ declare namespace autoStartupManager {
/**
* Register the listener that watches for all applications auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { 'systemAutoStartup' } type - Indicates the type of event.
* @param { AutoStartupCallback } callback - Auto startup callback.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -48,8 +51,11 @@ declare namespace autoStartupManager {
/**
* Unregister listener that watches for all applications auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { 'systemAutoStartup' } type - Indicates the type of event.
* @param { AutoStartupCallback } [callback] - Auto startup callback.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -62,8 +68,11 @@ declare namespace autoStartupManager {
/**
* Set application auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { AutoStartupInfo } info - The application info.
* @param { AsyncCallback<void> } callback - The callback of setApplicationAutoStartup.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -76,8 +85,11 @@ declare namespace autoStartupManager {
/**
* Set application auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { AutoStartupInfo } info - The application info.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -90,8 +102,11 @@ declare namespace autoStartupManager {
/**
* Cancel application auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { AutoStartupInfo } info - The application info.
* @param { AsyncCallback<void> } callback - The callback of cancelApplicationAutoStartup.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -104,8 +119,11 @@ declare namespace autoStartupManager {
/**
* Cancel application auto startup state.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { AutoStartupInfo } info - The application info.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -118,8 +136,11 @@ declare namespace autoStartupManager {
/**
* Query the current auto startup status of all applications.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @param { AsyncCallback<Array<AutoStartupInfo>> } callback - The callback is used to return the array of
* AutoStartupInfo.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -132,7 +153,10 @@ declare namespace autoStartupManager {
/**
* Query the current auto startup status of all applications.
*
* @permission ohos.permission.MANAGE_APP_BOOT
* @returns { Promise<Array<AutoStartupInfo>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied, interface caller does not have permission
* "ohos.permission.MANAGE_APP_BOOT".
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core

2
api/@ohos.app.ability.childProcessManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AsyncCallback } from './@ohos.base';

46
api/@ohos.app.ability.common.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import * as _UIAbilityContext from './application/UIAbilityContext';
@ -31,8 +31,11 @@ import * as _ServiceExtensionContext from './application/ServiceExtensionContext
import * as _EventHub from './application/EventHub';
import { PacMap as _PacMap } from './ability/dataAbilityHelper';
import { AbilityResult as _AbilityResult } from './ability/abilityResult';
import type { AbilityStartCallback as _AbilityStartCallback } from './application/AbilityStartCallback';
import type _AbilityStartCallback from './application/AbilityStartCallback';
import { ConnectOptions as _ConnectOptions } from './ability/connectOptions';
import type * as _VpnExtensionContext from './application/VpnExtensionContext';
import type { AutoStartupCallback as _AutoStartupCallback } from './application/AutoStartupCallback';
import type { AutoStartupInfo as _AutoStartupInfo } from './application/AutoStartupInfo';
/**
* This module provides application context classes and common data structures.
@ -57,6 +60,7 @@ import { ConnectOptions as _ConnectOptions } from './ability/connectOptions';
* @namespace common
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace common {
@ -315,6 +319,15 @@ declare namespace common {
* @StageModelOnly
* @since 10
*/
/**
* The context of UI extension. It allows access to
* UIExtension-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
export type UIExtensionContext = _UIExtensionContext.default;
/**
@ -337,6 +350,35 @@ declare namespace common {
* @since 11
*/
export type AbilityStartCallback = _AbilityStartCallback;
/**
* The class of auto startup info.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 11
*/
export type AutoStartupInfo = _AutoStartupInfo;
/**
* The class of auto startup callback.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 11
*/
export type AutoStartupCallback = _AutoStartupCallback;
/**
* The context of vpn extension. It allows access to
* vpnExtension-specific resources.
* The class of auto startup info.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
*/
export type VpnExtensionContext = _VpnExtensionContext.default;
}
export default common;

2
api/@ohos.app.ability.contextConstant.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.dataUriUtils.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**

2
api/@ohos.app.ability.dialogRequest.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import Want from './@ohos.app.ability.Want';

7
api/@ohos.app.ability.dialogSession.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AsyncCallback } from './@ohos.base';
@ -33,7 +33,7 @@ import type Want from './@ohos.app.ability.Want';
declare namespace dialogSession {
/**
* Dialog ability info
* Indicates the ability information displayed in the picker dialog, including bundleName, moduleName, and abilityName.
*
* @typedef DialogAbilityInfo
* @syscap SystemCapability.Ability.AbilityRuntime.Core
@ -171,7 +171,6 @@ declare namespace dialogSession {
*
* @param { string } dialogSessionId - Query information by dialog session id.
* @returns { DialogSessionInfo } Returns the session info.
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
* @throws { BusinessError } 202 - The application is not system-app, can not use system-api.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
@ -191,7 +190,6 @@ declare namespace dialogSession {
* @param { Want } targetWant - The selection target ability to start.
* @param { boolean } isAllowed - allowed or disallowed to start target ability.
* @returns { Promise<void> } The promise returned by the sendDialogResult.
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
* @throws { BusinessError } 202 - The application is not system-app, can not use system-api.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
@ -211,7 +209,6 @@ declare namespace dialogSession {
* @param { Want } targetWant - The selection target ability to start.
* @param { boolean } isAllowed - allowed or disallowed to start target ability.
* @param { AsyncCallback<void> } callback - The callback of sendDialogResult.
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
* @throws { BusinessError } 202 - The application is not system-app, can not use system-api.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.

2
api/@ohos.app.ability.errorManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

5
api/@ohos.app.ability.insightIntent.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
/**
@ -53,6 +53,7 @@ declare namespace insightIntent {
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
UI_ABILITY_BACKGROUND = 1,
@ -62,6 +63,7 @@ declare namespace insightIntent {
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @atomicservice
* @since 11
*/
UI_EXTENSION_ABILITY = 2,
@ -72,6 +74,7 @@ declare namespace insightIntent {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
SERVICE_EXTENSION_ABILITY = 3,

12
api/@ohos.app.ability.insightIntentDriver.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import type { AsyncCallback } from './@ohos.base';
@ -28,6 +28,7 @@ import type insightIntent from './@ohos.app.ability.insightIntent';
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
declare namespace insightIntentDriver {
@ -38,6 +39,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
interface ExecuteParam {
@ -48,6 +50,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
bundleName: string;
@ -59,6 +62,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
moduleName: string;
@ -70,6 +74,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
abilityName: string;
@ -81,6 +86,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
insightIntentName: string;
@ -92,6 +98,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
insightIntentParam: Record<string, Object>;
@ -103,6 +110,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
executeMode: insightIntent.ExecuteMode;
@ -136,6 +144,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
function execute(param: ExecuteParam, callback: AsyncCallback<insightIntent.ExecuteResult>): void;
@ -168,6 +177,7 @@ declare namespace insightIntentDriver {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @atomicservice
* @since 11
*/
function execute(param: ExecuteParam): Promise<insightIntent.ExecuteResult>;

2
api/@ohos.app.ability.missionManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

2
api/@ohos.app.ability.quickFixManager.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit Ability Kit
* @kit AbilityKit
*/
import { AsyncCallback } from './@ohos.base';

Some files were not shown because too many files have changed in this diff Show More