openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Signed-off-by: 任欣瑶 <renxinyao2@huawei.com>
This commit is contained in:
任欣瑶 2024-08-23 03:52:32 +00:00 committed by renxinyao
commit 0c4e85f8a1
1046 changed files with 42858 additions and 7767 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
.gitignore vendored Normal file
View File

@ -0,0 +1,22 @@
# 忽略node依赖包及相关安装
node_modules
package-lock.json
# 忽略编译sdk输出api
build-tools/api
# 忽略编译sdk输出kits
build-tools/kits
# 忽略编译sdk输出arkts
build-tools/arkts
# 忽略APIdiff工具提供资料结果
build-tools/dts_parser/diff合集
# 忽略APIcheck工具数据json结果
# build-tools/dts_parser/result.json
# 忽略API相关工具执行测试用例的输出数据
build-tools/dts_parser/test/output
#忽略API相关工具执行测试用例失败的相关输出文件
build-tools/dts_parser/mochawesome-report
#忽略本地typescript离线包
build-tools/dts_parser/deps/*

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

@ -148,6 +148,17 @@ declare enum ButtonType {
* @since 11
*/
Normal,
/**
* Rounded rectangle button.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 13
*/
ROUNDED_RECTANGLE = 3,
}
/**

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

@ -21,6 +21,7 @@
/**
* Import the drawing canvas type object for Canvas.
*
* @typedef { import('../api/@ohos.graphics.drawing').default.Canvas } DrawingCanvas
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -34,6 +35,7 @@ declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Can
* "evenodd": odd and even round rule
* "nonzero": (Default) Non-zero Wrap Rules
*
* @typedef { "evenodd" | "nonzero" } CanvasFillRule
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -43,6 +45,7 @@ declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Can
* "evenodd": odd and even round rule
* "nonzero": (Default) Non-zero Wrap Rules
*
* @typedef { "evenodd" | "nonzero" } CanvasFillRule
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -53,6 +56,7 @@ declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Can
* "evenodd": odd and even round rule
* "nonzero": (Default) Non-zero Wrap Rules
*
* @typedef { "evenodd" | "nonzero" } CanvasFillRule
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -64,6 +68,7 @@ declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Can
* "evenodd": odd and even round rule
* "nonzero": (Default) Non-zero Wrap Rules
*
* @typedef { "evenodd" | "nonzero" } CanvasFillRule
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -79,6 +84,7 @@ declare type CanvasFillRule = "evenodd" | "nonzero";
* "square": The end of the segment ends in a square, but a rectangular area is added that is the same width
* as the segment and is half the thickness of the segment.
*
* @typedef { "butt" | "round" | "square" } CanvasLineCap
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -89,6 +95,7 @@ declare type CanvasFillRule = "evenodd" | "nonzero";
* "square": The end of the segment ends in a square, but a rectangular area is added that is the same width
* as the segment and is half the thickness of the segment.
*
* @typedef { "butt" | "round" | "square" } CanvasLineCap
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -100,6 +107,7 @@ declare type CanvasFillRule = "evenodd" | "nonzero";
* "square": The end of the segment ends in a square, but a rectangular area is added that is the same width
* as the segment and is half the thickness of the segment.
*
* @typedef { "butt" | "round" | "square" } CanvasLineCap
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -112,6 +120,7 @@ declare type CanvasFillRule = "evenodd" | "nonzero";
* "square": The end of the segment ends in a square, but a rectangular area is added that is the same width
* as the segment and is half the thickness of the segment.
*
* @typedef { "butt" | "round" | "square" } CanvasLineCap
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -130,6 +139,7 @@ declare type CanvasLineCap = "butt" | "round" | "square";
* "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the
* connected section. The radius of the fillet is the width of the segment.
*
* @typedef { "bevel" | "miter" | "round" } CanvasLineJoin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -143,6 +153,7 @@ declare type CanvasLineCap = "butt" | "round" | "square";
* "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the
* connected section. The radius of the fillet is the width of the segment.
*
* @typedef { "bevel" | "miter" | "round" } CanvasLineJoin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -157,6 +168,7 @@ declare type CanvasLineCap = "butt" | "round" | "square";
* "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the
* connected section. The radius of the fillet is the width of the segment.
*
* @typedef { "bevel" | "miter" | "round" } CanvasLineJoin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -172,6 +184,7 @@ declare type CanvasLineCap = "butt" | "round" | "square";
* "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the
* connected section. The radius of the fillet is the width of the segment.
*
* @typedef { "bevel" | "miter" | "round" } CanvasLineJoin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -186,6 +199,7 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round";
* "ltr": The text direction is left to right.
* "rtl": The text direction is from right to left.
*
* @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -195,6 +209,7 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round";
* "ltr": The text direction is left to right.
* "rtl": The text direction is from right to left.
*
* @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -205,6 +220,7 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round";
* "ltr": The text direction is left to right.
* "rtl": The text direction is from right to left.
*
* @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -216,6 +232,7 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round";
* "ltr": The text direction is left to right.
* "rtl": The text direction is from right to left.
*
* @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -234,6 +251,7 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl";
* "start": (Default) Where the text snap line begins (Left alignment refers to the local from left to right,
* and right alignment refers to the local from right to left)
*
* @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -247,6 +265,7 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl";
* "start": (Default) Where the text snap line begins (Left alignment refers to the local from left to right,
* and right alignment refers to the local from right to left)
*
* @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -261,6 +280,7 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl";
* "start": (Default) Where the text snap line begins (Left alignment refers to the local from left to right,
* and right alignment refers to the local from right to left)
*
* @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -276,6 +296,7 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl";
* "start": (Default) Where the text snap line begins (Left alignment refers to the local from left to right,
* and right alignment refers to the local from right to left)
*
* @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -295,6 +316,7 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start";
* "middle": The text baseline is in the middle of the text block.
* "top": The text baseline is at the top of the text block.
*
* @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -309,6 +331,7 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start";
* "middle": The text baseline is in the middle of the text block.
* "top": The text baseline is at the top of the text block.
*
* @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -324,6 +347,7 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start";
* "middle": The text baseline is in the middle of the text block.
* "top": The text baseline is at the top of the text block.
*
* @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -340,6 +364,7 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start";
* "middle": The text baseline is in the middle of the text block.
* "top": The text baseline is at the top of the text block.
*
* @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -354,6 +379,7 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra
* "low": (default)low
* "medium": medium
*
* @typedef { "high" | "low" | "medium" } ImageSmoothingQuality
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
@ -363,6 +389,7 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra
* "low": (default)low
* "medium": medium
*
* @typedef { "high" | "low" | "medium" } ImageSmoothingQuality
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -373,6 +400,7 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra
* "low": (default)low
* "medium": medium
*
* @typedef { "high" | "low" | "medium" } ImageSmoothingQuality
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -384,6 +412,7 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra
* "low": (default)low
* "medium": medium
*
* @typedef { "high" | "low" | "medium" } ImageSmoothingQuality
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -4450,12 +4479,14 @@ declare class CanvasRenderer extends CanvasPath {
/**
* Text drawing direction. For details, see {@link CanvasDirection}.
*
* @type { CanvasDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Text drawing direction. For details, see {@link CanvasDirection}.
*
* @type { CanvasDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -4463,6 +4494,7 @@ declare class CanvasRenderer extends CanvasPath {
/**
* Text drawing direction. For details, see {@link CanvasDirection}.
*
* @type { CanvasDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -4471,6 +4503,7 @@ declare class CanvasRenderer extends CanvasPath {
/**
* Text drawing direction. For details, see {@link CanvasDirection}.
*
* @type { CanvasDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form

12
api/@internal/component/ets/column.d.ts vendored
View File

@ -226,6 +226,18 @@ declare class ColumnAttribute extends CommonMethod<ColumnAttribute> {
* @since 11
*/
pointLight(value: PointLightStyle): ColumnAttribute;
/**
* Called when the Main-Axis's direction is set reversed or not
*
* @param { Optional<boolean> } isReversed - If the main axis is reversed.
* @returns { ColumnAttribute } The attribute of the column.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
reverse(isReversed: Optional<boolean>): ColumnAttribute;
}
/**

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

@ -687,7 +687,7 @@ declare interface ProvideOptions {
declare const Provide: PropertyDecorator & ((value: string | ProvideOptions) => PropertyDecorator);
/**
* Defining Provider PropertyDecorator.
* Defining Provider PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -728,7 +728,8 @@ declare const Provider: (aliasName?: string) => PropertyDecorator;
declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator);
/**
* Defining Consumer PropertyDecorator.
* Defining Consumer PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName.
* And @Consumer will find the nearest @Provider.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1182,7 +1183,8 @@ declare const Concurrent: MethodDecorator;
* The Sendable decorator can be used only for classes. A class with this decorator is marked as sendable, and the class object can be shared globally.
* Since 12, the Sendable decorator can be used for function and typeAlias also.
* A function with this decorator is marked as sendable, and the function can be an shareable property of sendable-class object.
* A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables, and arguments that need to be assigned with sendable-function.
* A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables,
* and arguments that need to be assigned with sendable-function.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -1315,6 +1317,7 @@ declare const Reusable: ClassDecorator;
/**
* Get context.
*
* @typedef { import('../api/application/Context').default } Context
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @StageModelOnly
* @since 9
@ -1322,6 +1325,7 @@ declare const Reusable: ClassDecorator;
/**
* Get context.
*
* @typedef { import('../api/application/Context').default } Context
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @StageModelOnly
* @crossplatform
@ -1330,6 +1334,7 @@ declare const Reusable: ClassDecorator;
/**
* Get context.
*
* @typedef { import('../api/application/Context').default } Context
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @StageModelOnly
* @crossplatform
@ -2711,7 +2716,6 @@ declare interface GeometryTransitionOptions {
* @default TransitionHierarchyStrategy.ADAPTIVE
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @atomicservice
* @since 12
*/
hierarchyStrategy?: TransitionHierarchyStrategy
@ -2726,7 +2730,6 @@ declare interface GeometryTransitionOptions {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @atomicservice
* @since 12
*/
declare enum TransitionHierarchyStrategy {
@ -2736,7 +2739,6 @@ declare enum TransitionHierarchyStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @atomicservice
* @since 12
*/
NONE = 0,
@ -2748,7 +2750,6 @@ declare enum TransitionHierarchyStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @atomicservice
* @since 12
*/
ADAPTIVE = 1,
@ -3986,6 +3987,7 @@ declare enum TransitionEdge {
/**
* Defines all transition effects.
*
* @typedef { object } TransitionEffects
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -3994,6 +3996,7 @@ declare enum TransitionEdge {
/**
* Defines all transition effects.
*
* @typedef { object } TransitionEffects
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -4090,7 +4093,7 @@ declare class TransitionEffect<
Effect extends TransitionEffects[Type] = TransitionEffects[Type]
> {
/**
* Defines an identity transition effect
* Disables the transition effect
*
* @type { TransitionEffect<"identity"> }
* @readonly
@ -4101,7 +4104,7 @@ declare class TransitionEffect<
* @since 10
*/
/**
* Defines an identity transition effect
* Disables the transition effect
*
* @type { TransitionEffect<"identity"> }
* @readonly
@ -4115,7 +4118,7 @@ declare class TransitionEffect<
static readonly IDENTITY: TransitionEffect<"identity">;
/**
* Defines an opacity transition effect
* Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0).
*
* @type { TransitionEffect<"opacity"> }
* @readonly
@ -4126,7 +4129,7 @@ declare class TransitionEffect<
* @since 10
*/
/**
* Defines an opacity transition effect
* Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0).
*
* @type { TransitionEffect<"opacity"> }
* @readonly
@ -4179,7 +4182,10 @@ declare class TransitionEffect<
>;
/**
* Defines a slide & switch transition effect
* Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right,
* and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8.
* It comes with default animation parameters, which can also be overridden.
* The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0).
*
* @type { TransitionEffect<"slideSwitch"> }
* @readonly
@ -4190,7 +4196,10 @@ declare class TransitionEffect<
* @since 10
*/
/**
* Defines a slide & switch transition effect
* Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right,
* and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8.
* It comes with default animation parameters, which can also be overridden.
* The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0).
*
* @type { TransitionEffect<"slideSwitch"> }
* @readonly
@ -4230,6 +4239,16 @@ declare class TransitionEffect<
* Creates a rotation transition effect
*
* @param { RotateOptions } options - rotate options
* Set the rotation effect for component transitions when inserting and deleting.
* The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation.
* -x: Horizontal component of the rotational vector.
* -y: Vertical component of the rotational vector.
* -z: Vertical component of the rotational vector.
* -centerX, centerY specify the rotation center point, with default values of "50%",
* meaning that the default rotation center point is the center point of the component.
* -The center point of (0, 0) represents the upper-left corner of the component.
* -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0.
* -perspective indicates the visual distance. The perspective property does not support transition animation.
* @returns { TransitionEffect<"rotate"> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -4240,6 +4259,16 @@ declare class TransitionEffect<
* Creates a rotation transition effect
*
* @param { RotateOptions } options - rotate options
* Set the rotation effect for component transitions when inserting and deleting.
* The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation.
* -x: Horizontal component of the rotational vector.
* -y: Vertical component of the rotational vector.
* -z: Vertical component of the rotational vector.
* -centerX, centerY specify the rotation center point, with default values of "50%",
* meaning that the default rotation center point is the center point of the component.
* -The center point of (0, 0) represents the upper-left corner of the component.
* -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0.
* -perspective indicates the visual distance. The perspective property does not support transition animation.
* @returns { TransitionEffect<"rotate"> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -4275,7 +4304,7 @@ declare class TransitionEffect<
/**
* Creates an opacity transition effect with alpha value
*
* @param { number } alpha - opacity alpha value
* @param { number } alpha - opacity alpha value, value range [0, 1].
* @returns { TransitionEffect<"opacity"> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -4285,7 +4314,7 @@ declare class TransitionEffect<
/**
* Creates an opacity transition effect with alpha value
*
* @param { number } alpha - opacity alpha value
* @param { number } alpha - opacity alpha value, value range [0, 1].
* @returns { TransitionEffect<"opacity"> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -4293,6 +4322,18 @@ declare class TransitionEffect<
* @atomicservice
* @since 11
*/
/**
* Creates an opacity transition effect with alpha value
*
* @param { number } alpha - opacity alpha value, value range [0, 1].
* Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1.
* @returns { TransitionEffect<"opacity"> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
static opacity(alpha: number): TransitionEffect<"opacity">;
/**
@ -5175,12 +5216,14 @@ declare namespace focusControl {
/**
* Import the PointerStyle type object for setCursor.
*
* @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Import the PointerStyle type object for setCursor.
*
* @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
@ -6562,7 +6605,7 @@ declare interface BackgroundEffectOptions {
* Define the blurOptions of BackgroundEffect.
*
* @type { ?BlurOptions }
* @default { grayScale: [0,1] }
* @default { grayScale: [0,0] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -7864,6 +7907,17 @@ declare interface BaseEvent {
* @since 12
*/
getModifierKeyState?(keys: Array<string>): boolean;
/**
* Indicates the ID of the input device that triggers the current event.
*
* @type { ?number } [deviceId] The ID of the input device that triggers the current event
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
deviceId?: number;
}
/**
@ -9111,6 +9165,7 @@ declare interface TouchEvent extends BaseEvent {
* The value of oldValue is last size of the component.
* The value of newValue is new size of the component.
*
* @typedef { function } SizeChangeCallback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -9177,6 +9232,7 @@ declare type TransitionFinishCallback = (transitionIn: boolean) => void;
/**
* Defines the PixelMap type object for ui component.
*
* @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -9252,6 +9308,7 @@ declare enum DragBehavior {
/**
* Import the UnifiedData type object for ui component.
*
* @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -9259,6 +9316,7 @@ declare enum DragBehavior {
/**
* Import the UnifiedData type object for ui component.
*
* @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -9269,12 +9327,14 @@ declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').defaul
/**
* Import the Summary type object for ui component.
*
* @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Import the Summary type object for ui component.
*
* @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -9284,12 +9344,14 @@ declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Su
/**
* Import the UniformDataType type object for ui component.
*
* @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Import the UniformDataType type object for ui component.
*
* @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -10343,12 +10405,14 @@ declare interface DragEvent {
/**
* Import the IntentionCode type object for IntentionCode.
*
* @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Import the IntentionCode type object for IntentionCode.
*
* @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -11464,6 +11528,17 @@ declare interface SheetOptions extends BindOptions {
*/
onTypeDidChange?: Callback<SheetType>;
/**
* Set whether sheet is allowed to expand safe area in embedded mode
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
expandSafeAreaInEmbeddedMode?: boolean;
/**
* The UIContext that the sheet belongs to
*
@ -13063,6 +13138,7 @@ declare enum MenuPreviewMode {
/**
* Defines the animator range of start and end property.
*
* @typedef { [from: T, to: T] } AnimationRange<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
@ -13070,6 +13146,7 @@ declare enum MenuPreviewMode {
/**
* Defines the animator range of start and end property.
*
* @typedef { [from: T, to: T] } AnimationRange<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -13262,13 +13339,13 @@ declare interface ContextMenuOptions {
/**
* Defines the border radius of menu.
*
* @type { ?(Length | BorderRadiuses) }
* @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderRadius?: Length | BorderRadiuses;
borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses;
/**
* Callback function when the context menu appears.
@ -13882,6 +13959,7 @@ declare interface PixelStretchEffectOptions {
* right property. value range (-∞, ∞)
* If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels.
*
* @type { ?Length }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -13891,6 +13969,7 @@ declare interface PixelStretchEffectOptions {
* right property. value range (-∞, ∞)
* If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels.
*
* @type { ?Length }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -13957,6 +14036,29 @@ declare interface ClickEffect {
scale?: number;
}
/**
* Defines the fadingEdge options.
*
* @typedef FadingEdgeOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare interface FadingEdgeOptions {
/**
* The length of FadingEdge.
*
* @type { LengthMetrics }
* @default 32vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
fadingEdgeLength?: LengthMetrics;
}
/**
* Define nested scroll options
*
@ -14498,6 +14600,7 @@ declare enum MenuPolicy {
/**
* ImageModifier
*
* @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -14697,6 +14800,7 @@ declare interface InvertOptions {
/**
* Import the CircleShape type object for common method.
*
* @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -14708,6 +14812,7 @@ declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape;
/**
* Import the EllipseShape type object for common method.
*
* @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -14719,6 +14824,7 @@ declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape;
/**
* Import the PathShape type object for common method.
*
* @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -14730,6 +14836,7 @@ declare type PathShape = import('../api/@ohos.arkui.shape').PathShape;
/**
* Import the RectShape type object for common method.
*
* @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -16147,6 +16254,20 @@ declare class CommonMethod<T> {
*/
onClick(event: (event: ClickEvent) => void): T;
/**
* Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold.
*
* @param { function } event - this function callback executed when the click action is recognized
* @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
onClick(event: Callback<ClickEvent>, distanceThreshold: number): T;
/**
* Trigger a hover event.
*
@ -18268,7 +18389,7 @@ declare class CommonMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption]
* @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption
*/
useSizeType(value: {
xs?: number | { span: number; offset: number };
@ -18325,8 +18446,8 @@ declare class CommonMethod<T> {
/**
* Specifies the direction and style of chain in relative container
*
* @param { Axis } value - indicates direction of the chain
* @param { ChainStyle } value - indicates style of the chain
* @param { Axis } direction - indicates direction of the chain
* @param { ChainStyle } style - indicates style of the chain
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -19023,12 +19144,13 @@ declare class CommonMethod<T> {
blendMode(value: BlendMode, type?: BlendApplyType): T;
/**
* The parameter specifies whether to crop based on the edge contour.
* Whether to crop the sub components of the current component.
*
* @param { boolean } value
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
@ -19076,7 +19198,7 @@ declare class CommonMethod<T> {
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead common[CommonMethod]#clipShape
* @useinstead CommonMethod#clipShape
*/
clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T;
@ -19087,6 +19209,7 @@ declare class CommonMethod<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
@ -19142,7 +19265,7 @@ declare class CommonMethod<T> {
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead common[CommonMethod]#maskShape
* @useinstead CommonMethod#maskShape
*/
mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T;
@ -19153,6 +19276,7 @@ declare class CommonMethod<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
@ -20230,12 +20354,14 @@ declare const Common: CommonInterface;
/**
* Defines the CustomBuilder Type.
*
* @typedef { (() => any) | void } CustomBuilder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines the CustomBuilder Type.
*
* @typedef { (() => any) | void } CustomBuilder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -20243,6 +20369,7 @@ declare const Common: CommonInterface;
/**
* Defines the CustomBuilder Type.
*
* @typedef { (() => any) | void } CustomBuilder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -20251,6 +20378,7 @@ declare const Common: CommonInterface;
/**
* Defines the CustomBuilder Type.
*
* @typedef { (() => any) | void } CustomBuilder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -20433,6 +20561,7 @@ declare interface OverlayOffset {
* The second element means the stop position.
* The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position.
*
* @typedef { [ number, number ] } FractionStop
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
@ -21573,7 +21702,7 @@ declare interface Measurable {
/**
* Call this measure method in onMeasure callback to supply sub component size.
*
* @param { ConstraintSizeOptions } childConstraint
* @param { ConstraintSizeOptions } constraint
* @returns { MeasureResult }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -21582,7 +21711,7 @@ declare interface Measurable {
/**
* Call this measure method in onMeasure callback to supply sub component size.
*
* @param { ConstraintSizeOptions } childConstraint
* @param { ConstraintSizeOptions } constraint
* @returns { MeasureResult }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -21713,6 +21842,7 @@ declare interface MeasureResult extends SizeResult {
/**
* The navigation destination information.
*
* @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -21752,7 +21882,7 @@ declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.Navi
/**
* UIContext
*
* @typedef {import('../api/@ohos.arkui.UIContext').UIContext} UIContext
* @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -21763,6 +21893,7 @@ declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext;
/**
* DrawContext
*
* @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -22018,7 +22149,7 @@ declare class CustomComponent extends CommonAttribute {
* @form
* @since 9
* @deprecated since 10
* @useinstead common[CustomComponent]#onPlaceChildren
* @useinstead CustomComponent#onPlaceChildren
*/
onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void;
@ -22054,7 +22185,7 @@ declare class CustomComponent extends CommonAttribute {
* @form
* @since 9
* @deprecated since 10
* @useinstead common[CustomComponent]#onMeasureSize
* @useinstead CustomComponent#onMeasureSize
*/
onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void;
@ -22613,6 +22744,16 @@ declare abstract class TextContentControllerBase {
* @atomicservice
* @since 11
*/
/**
* CommonScrollableMethod
*
* @extends CommonMethod<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
/**
* Scrollbar status.
@ -22653,7 +22794,7 @@ declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
/**
* Edge scrolling effect.
*
* @param { EdgeEffect } value - edge scrolling effect.
* @param { EdgeEffect } edgeEffect - edge scrolling effect.
* @param { EdgeEffectOptions } options - edge scrolling effect options.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -22663,6 +22804,19 @@ declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
*/
edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T;
/**
* Called when setting whether to enable fading Edge effect.
*
* @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect
* @param { FadingEdgeOptions } [options] - The options of fadingEdge.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T;
/**
* Nested scrolling options.
*
@ -22709,6 +22863,8 @@ declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ScrollableCommonMethod#onDidScroll
*/
onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T;
@ -22732,6 +22888,7 @@ declare class ScrollableCommonMethod<T> extends CommonMethod<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
@ -22843,6 +23000,7 @@ declare type OnWillScrollCallback =
* @param { ScrollState } scrollState - current scroll state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
@ -23393,6 +23551,8 @@ declare interface Callback<T, V = void> {
* The value of event contains information about HoverEvent.
*
* @typedef HoverCallback
* @param { boolean } isHover
* @param { HoverEvent} event
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -23406,6 +23566,8 @@ declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void
* The value of event contains information about AccessibilityHoverEvent.
*
* @typedef { function }
* @param { boolean } isHover
* @param { AccessibilityHoverEvent } event
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

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

@ -784,6 +784,7 @@ declare abstract class SubscribedAbstractProperty<T> {
/**
* Private user ID.
*
* @type { any }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -793,6 +794,7 @@ declare abstract class SubscribedAbstractProperty<T> {
/**
* Private user information.
*
* @type { ?any }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1065,6 +1067,7 @@ interface IPropertySubscriber {
* Defines the state value.
*
* @extends SubscribedAbstractProperty<T>
* @implements ISinglePropertyChangeSubscriber<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1076,6 +1079,7 @@ declare class SyncedPropertyTwoWay<T>
/**
* Sources of synchronization attributes bidirectionally.
*
* @type { any }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1139,6 +1143,7 @@ declare class SyncedPropertyTwoWay<T>
* Defines the prop state value.
*
* @extends SubscribedAbstractProperty<T>
* @implements ISinglePropertyChangeSubscriber<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1150,6 +1155,7 @@ declare class SyncedPropertyOneWay<T>
/**
* Pack value for single-item binding.
*
* @type { any }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1159,6 +1165,7 @@ declare class SyncedPropertyOneWay<T>
/**
* Sources of synchronization attributes bidirectionally.
*
* @type { any }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7
@ -1249,6 +1256,7 @@ declare abstract class SubscribaleAbstract {
/**
* Returns the ownership attribute set by the.
*
* @type { Set<number> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 7

24
api/@internal/component/ets/component3d.d.ts vendored
View File

@ -26,7 +26,7 @@
* @atomicservice
* @since 12
*/
declare type Scene = import('../api/@ohos.graphics.scene').Scene
declare type Scene = import('../api/@ohos.graphics.scene').Scene;
/**
* The enum of model type
@ -65,14 +65,14 @@ declare enum ModelType {
*/
declare interface SceneOptions {
/**
* Resource type for 3D rendering, Scene type for 3d scene controlling
* ResourceStr type for 3D rendering, Scene type for 3d scene controlling
*
* @type { ?(Resource | Scene) }
* @type { ?(ResourceStr | Scene) }
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
scene?: Resource | Scene;
scene?: ResourceStr | Scene;
/**
* Scene type when 3D rendering
@ -117,47 +117,47 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
/**
* Load 3D model environment resource.
*
* @param { Resource } uri - The path of 3D environment resource
* @param { ResourceStr } uri - The path of 3D environment resource
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
environment(uri: Resource): Component3DAttribute;
environment(uri: ResourceStr): Component3DAttribute;
/**
* Set render pipeline of 3D scene render.
*
* @param { Resource } uri - The path of Render pipeline config file
* @param { ResourceStr } 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
* @atomicservice
* @since 12
*/
customRender(uri: Resource, selfRenderUpdate: boolean): Component3DAttribute;
customRender(uri: ResourceStr, selfRenderUpdate: boolean): Component3DAttribute;
/**
* Load shader uri.
*
* @param { Resource } uri - The path of custom shader
* @param { ResourceStr } uri - The path of custom shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
shader(uri: Resource): Component3DAttribute;
shader(uri: ResourceStr): Component3DAttribute;
/**
* Load shader texture uri.
*
* @param { Resource } uri - The path of texture used by shader
* @param { ResourceStr } uri - The path of texture used by shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
shaderImageTexture(uri: Resource): Component3DAttribute;
shaderImageTexture(uri: ResourceStr): Component3DAttribute;
/**
* Buffer input for shader animation

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

@ -126,6 +126,7 @@ declare enum DataPanelType {
*/
/**
* ColorStop type
* @typedef { object } ColorStop
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

2
api/@internal/component/ets/enums.d.ts vendored
View File

@ -9266,6 +9266,7 @@ declare enum EllipsisMode {
/**
* A type which can be undefined
*
* @typedef { T | undefined } Nullable<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
@ -9273,6 +9274,7 @@ declare enum EllipsisMode {
/**
* A type which can be undefined
*
* @typedef { T | undefined } Nullable<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

68
api/@internal/component/ets/gesture.d.ts vendored
View File

@ -997,12 +997,14 @@ interface FingerInfo {
/**
* Defines the Gesture Type.
*
* @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } PointerStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the Gesture Type.
*
* @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } PointerStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -1010,6 +1012,7 @@ interface FingerInfo {
/**
* Defines the Gesture Type.
*
* @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } PointerStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1804,6 +1807,48 @@ interface GestureInterface<T> {
allowedTypes(value: Array<SourceTool>): T;
}
/**
* Defines TapGesture parameters.
*
* @interface TapGestureParameters
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TapGestureParameters {
/**
* Number of consecutive clicks recognized. If the value is less than 1, the default value is used.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
count?: number;
/**
* The hand index that triggers the click. If the value is less than 1, the default value is used.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
fingers?: number;
/**
* The limited move distance of click. If the value is less than 0, the default value is used.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
distanceThreshold?: number;
}
/**
* Defines TapGesture interface.
*
@ -1862,7 +1907,18 @@ interface TapGestureInterface extends GestureInterface<TapGestureInterface> {
* @atomicservice
* @since 11
*/
(value?: { count?: number; fingers?: number }): TapGestureInterface;
/**
* Set the value.
* TapGestureParameters: The parameters of the tapGesture.
*
* @param { TapGestureParameters } value
* @returns { TapGestureInterface }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(value?: TapGestureParameters): TapGestureInterface;
/**
* Tap gesture recognition success callback.
@ -3031,6 +3087,7 @@ declare const GestureGroup: GestureGroupInterface;
/**
* Defines the gesture handler.
*
* @implements GestureInterface<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -3910,6 +3967,15 @@ declare class GestureRecognizer {
* @since 12
*/
getEventTargetInfo(): EventTargetInfo;
/**
* Returns whether the gesture recognizer is valid.
*
* @returns { boolean } - true is valid, false is invalid
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
isValid(): boolean;
}
/**

45
api/@internal/component/ets/grid.d.ts vendored
View File

@ -294,6 +294,39 @@ declare enum GridDirection {
ColumnReverse,
}
/**
* Declare grid item alignment status
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum GridItemAlignment {
/**
* Use the default alignment of the Grid.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT = 0,
/**
* The height of the tallest grid item in the current line
* will be used as the height for the other items in the same line
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
STRETCH = 1,
}
/**
* The attribute of scrollbar to compute scrollbar position and height.
*
@ -1107,6 +1140,18 @@ declare class GridAttribute extends ScrollableCommonMethod<GridAttribute> {
*/
friction(value: number | Resource): GridAttribute;
/**
* Set the alignment of grid items.
*
* @param { Optional<GridItemAlignment> } alignment - Items alignment
* @returns { GridAttribute } The attribute of the grid.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
alignItems(alignment: Optional<GridItemAlignment>): GridAttribute;
/**
* Called When sliding the grid.
*

12
api/@internal/component/ets/grid_container.d.ts vendored
View File

@ -25,7 +25,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption]
* @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption
*/
declare enum SizeType {
/**
@ -81,7 +81,7 @@ declare enum SizeType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColOptions] and grid_row/[GridRowOptions]
* @useinstead grid_col/GridColOptions and grid_row/GridRowOptions
*/
declare interface GridContainerOptions {
/**
@ -132,7 +132,7 @@ declare interface GridContainerOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColInterface] and grid_row/[GridRowInterface]
* @useinstead grid_col/GridColInterface and grid_row/GridRowInterface
*/
interface GridContainerInterface {
/**
@ -154,7 +154,7 @@ interface GridContainerInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColAttribute] and grid_row/[GridRowAttribute]
* @useinstead grid_col/GridColAttribute and grid_row/GridRowAttribute
*/
declare class GridContainerAttribute extends ColumnAttribute {}
@ -164,7 +164,7 @@ declare class GridContainerAttribute extends ColumnAttribute {}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption]
* @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption
*/
declare const GridContainer: GridContainerInterface
@ -174,6 +174,6 @@ declare const GridContainer: GridContainerInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead grid_col/[GridColAttribute] and grid_row/[GridRowAttribute]
* @useinstead grid_col/GridColAttribute and grid_row/GridRowAttribute
*/
declare const GridContainerInstance: GridContainerAttribute;

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

@ -194,6 +194,7 @@ declare interface GridRowSizeOption {
/**
* Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint
*
* @type { ?Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -201,6 +202,7 @@ declare interface GridRowSizeOption {
/**
* Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint
*
* @type { ?Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -209,6 +211,7 @@ declare interface GridRowSizeOption {
/**
* Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint
*
* @type { ?Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -394,6 +397,7 @@ declare interface GridRowColumnOption {
/**
* Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -401,6 +405,7 @@ declare interface GridRowColumnOption {
/**
* Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -409,6 +414,7 @@ declare interface GridRowColumnOption {
/**
* Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form

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

@ -27,6 +27,7 @@
/**
* Use the DrawableDescriptor class to get drawable image.
*
* @typedef { import ('../api/@ohos.arkui.drawableDescriptor').DrawableDescriptor } DrawableDescriptor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -54,6 +55,16 @@ declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').defaul
*/
declare type ResolutionQuality = import('../api/@ohos.multimedia.image').default.ResolutionQuality;
/**
* Lattice for dividing an image into grids.
*
* @typedef { import('../api/@ohos.graphics.drawing').default.Lattice } Lattice
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.Lattice;
/**
* @enum { number }
@ -1463,7 +1474,7 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
/**
* Enable image analyzer.
*
* @param { boolean} config
* @param { boolean} enable
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
@ -1471,7 +1482,7 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
/**
* Enable image analyzer.
*
* @param { boolean} config
* @param { boolean} enable
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
@ -1613,6 +1624,8 @@ declare const ImageInstance: ImageAttribute;
* @since 10
*/
/**
* @typedef { function } ImageErrorCallback
* @param { ImageError } error
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1759,4 +1772,15 @@ declare interface ResizableOptions {
* @since 12
*/
slice?: EdgeWidths;
/**
* Image lattice.
*
* @type { ?DrawingLattice }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lattice?: DrawingLattice;
}

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

@ -105,7 +105,7 @@ declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
colorFilter(filter: ColorFilter | DrawingColorFilter): ImageSpanAttribute;

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

@ -445,6 +445,7 @@ interface DataReloadOperation {
/**
* All data operation type
*
* @typedef { DataAddOperation | DataDeleteOperation | DataChangeOperation |DataMoveOperation | DataExchangeOperation | DataReloadOperation }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

66
api/@internal/component/ets/linearindicator.d.ts vendored
View File

@ -20,7 +20,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare class LinearIndicatorController {
/**
@ -29,7 +29,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
constructor();
@ -43,7 +43,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
setProgress(index: number, progress: number): void;
@ -54,7 +54,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
start(options?: LinearIndicatorStartOptions): void;
@ -65,7 +65,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
pause(): void;
@ -76,7 +76,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
stop(): void;
}
@ -88,7 +88,7 @@ declare class LinearIndicatorController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare interface LinearIndicatorStartOptions {
/**
@ -99,7 +99,7 @@ declare interface LinearIndicatorStartOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
interval?: number;
@ -107,11 +107,11 @@ declare interface LinearIndicatorStartOptions {
* The animation curve duration. The unit is ms.
*
* @type { ?number }
* @default The default value is 4000. if value is less than 0, the value will be 1.
* @default 4000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
duration?: number;
}
@ -123,7 +123,7 @@ declare interface LinearIndicatorStartOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare interface LinearIndicatorStyle {
/**
@ -134,7 +134,7 @@ declare interface LinearIndicatorStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
space?: LengthMetrics;
@ -146,7 +146,7 @@ declare interface LinearIndicatorStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
strokeWidth?: LengthMetrics;
@ -154,11 +154,11 @@ declare interface LinearIndicatorStyle {
* The stroke radius of linear indicator.
*
* @type { ?LengthMetrics }
* @default 1vp
* @default The default value is 1.0vp. if value is more than strokeWidth/2, the value will be strokeWidth/2.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
strokeRadius?: LengthMetrics;
@ -170,7 +170,7 @@ declare interface LinearIndicatorStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
trackBackgroundColor?: ColorMetrics;
@ -182,7 +182,7 @@ declare interface LinearIndicatorStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
trackColor?: ColorMetrics;
}
@ -194,7 +194,7 @@ declare interface LinearIndicatorStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
interface LinearIndicatorInterface {
/**
@ -203,11 +203,11 @@ interface LinearIndicatorInterface {
* @param { number } count - the number of progress in LinearIndicator. minimum value is 2(default is 5).
* if count is less than 2, the value will be 2.
* @param { LinearIndicatorController } controller - Controller of LinearIndicator.
* @returns { LinearIndicatorAttribute }
* @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
(count?: number, controller?: LinearIndicatorController): LinearIndicatorAttribute;
}
@ -219,30 +219,30 @@ interface LinearIndicatorInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare class LinearIndicatorAttribute extends CommonMethod<LinearIndicatorAttribute> {
/**
* Sets the indicator style.
*
* @param { Optional<LinearIndicatorStyle> } style
* @returns { LinearIndicatorAttribute }
* @param { Optional<LinearIndicatorStyle> } style - the style of LinearIndicator
* @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
indicatorStyle(style: Optional<LinearIndicatorStyle>): LinearIndicatorAttribute;
/**
* Sets whether indicator supports loop, default is true.
*
* @param { Optional<boolean> } loop
* @returns { LinearIndicatorAttribute }
* @param { Optional<boolean> } loop - indicate whether loop playback is supported
* @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
indicatorLoop(loop: Optional<boolean>): LinearIndicatorAttribute;
@ -250,11 +250,11 @@ declare class LinearIndicatorAttribute extends CommonMethod<LinearIndicatorAttri
* Called when progress value update.
*
* @param { Optional<OnLinearIndicatorChangeCallback> } callback - callback of the progress change event.
* @returns { LinearIndicatorAttribute }
* @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
onChange(callback: Optional<OnLinearIndicatorChangeCallback>): LinearIndicatorAttribute;
}
@ -268,7 +268,7 @@ declare class LinearIndicatorAttribute extends CommonMethod<LinearIndicatorAttri
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare type OnLinearIndicatorChangeCallback = (index: number, progress: number) => void;
@ -278,7 +278,7 @@ declare type OnLinearIndicatorChangeCallback = (index: number, progress: number)
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare const LinearIndicator: LinearIndicatorInterface;
@ -288,6 +288,6 @@ declare const LinearIndicator: LinearIndicatorInterface;
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
declare const LinearIndicatorInstance: LinearIndicatorAttribute;
declare const LinearIndicatorInstance: LinearIndicatorAttribute

42
api/@internal/component/ets/list.d.ts vendored
View File

@ -816,6 +816,24 @@ declare class ListScroller extends Scroller {
* @since 12
*/
closeAllSwipeActions(options?: CloseSwipeActionOptions): void;
/**
* Get visible list content info by position.
*
* @param { number } x - X coordinate relative to the upper left corner of the list's original area, in vp.
* @param { number } y - Y coordinate relative to the upper left corner of the list's original area, in vp.
* @returns { VisibleListContentInfo } Visible list content info of the position.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100004 - The controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
getVisibleListContentInfo(x: number, y: number): VisibleListContentInfo;
}
/**
@ -1108,18 +1126,6 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
*/
edgeEffect(value: EdgeEffect, options?: EdgeEffectOptions): ListAttribute;
/**
* Called when setting whether to enable fading Edge effect.
*
* @param { Optional<boolean> } value - Whether to turn on the edge fade effect
* @returns { ListAttribute } the attribute of the list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fadingEdge(value: Optional<boolean>): ListAttribute;
/**
* Called when need to decide contentStartOffset the list will show.
* @param { number } value - the value Of startOffset.
@ -1473,6 +1479,18 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
*/
childrenMainSize(value: ChildrenMainSize): ListAttribute;
/**
* Set maintain visible content position List.
*
* @param { boolean } enabled - maintain visible content position.
* @returns { ListAttribute } the attribute of the list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maintainVisibleContentPosition(enabled: boolean): ListAttribute;
/**
* Called when the offset and status callback of the slide are set.
*

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

@ -366,7 +366,6 @@ declare interface NavDestinationContext {
*/
navDestinationId?: string;
/**
* Get configuration of current Destination in module.json
*

15
api/@internal/component/ets/nav_router.d.ts vendored
View File

@ -34,6 +34,7 @@
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare interface RouteInfo {
/**
@ -52,6 +53,7 @@ declare interface RouteInfo {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
name: string;
@ -71,6 +73,7 @@ declare interface RouteInfo {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
param?: unknown;
}
@ -98,6 +101,7 @@ declare interface RouteInfo {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare interface NavRouterInterface {
/**
@ -123,6 +127,7 @@ declare interface NavRouterInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
(): NavRouterAttribute;
@ -144,6 +149,7 @@ declare interface NavRouterInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
(value: RouteInfo): NavRouterAttribute;
}
@ -164,6 +170,7 @@ declare interface NavRouterInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare enum NavRouteMode {
/**
@ -180,6 +187,7 @@ declare enum NavRouteMode {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
PUSH_WITH_RECREATE,
@ -197,6 +205,7 @@ declare enum NavRouteMode {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
PUSH,
@ -214,6 +223,7 @@ declare enum NavRouteMode {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
REPLACE
}
@ -241,6 +251,7 @@ declare enum NavRouteMode {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare class NavRouterAttribute extends CommonMethod<NavRouterAttribute> {
/**
@ -269,6 +280,7 @@ declare class NavRouterAttribute extends CommonMethod<NavRouterAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
onStateChange(callback: (isActivated: boolean) => void): NavRouterAttribute;
@ -290,6 +302,7 @@ declare class NavRouterAttribute extends CommonMethod<NavRouterAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
mode(mode: NavRouteMode): NavRouterAttribute;
}
@ -314,6 +327,7 @@ declare class NavRouterAttribute extends CommonMethod<NavRouterAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare const NavRouter: NavRouterInterface;
@ -337,5 +351,6 @@ declare const NavRouter: NavRouterInterface;
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare const NavRouterInstance: NavRouterAttribute;

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

@ -1162,6 +1162,18 @@ declare class NavPathStack {
*/
removeByName(name: string): number;
/**
* Remove the specified NavDestination by its navDestinationId.
*
* @param { string } navDestinationId - Indicates the navDestinationId of the NavDestination to be removed.
* @returns { boolean } Returns true if remove successfully, otherwise returns false.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeByNavDestinationId(navDestinationId: string): boolean;
/**
* Pops the top NavDestination out of the stack.
*
@ -1981,6 +1993,28 @@ declare interface NavigationTitleOptions {
* @since 12
*/
paddingEnd?: LengthMetrics;
/**
* Text modifier for main title.
*
* @type { ?TextModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
mainTitleModifier?: TextModifier;
/**
* Text modifier for sub title.
*
* @type { ?TextModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
subTitleModifier?: TextModifier;
}
/**

14
api/@internal/component/ets/navigator.d.ts vendored
View File

@ -41,6 +41,7 @@
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare enum NavigationType {
/**
@ -63,6 +64,7 @@ declare enum NavigationType {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
Push,
@ -86,6 +88,7 @@ declare enum NavigationType {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
Back,
@ -109,6 +112,7 @@ declare enum NavigationType {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
Replace,
}
@ -136,6 +140,7 @@ declare enum NavigationType {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
interface NavigatorInterface {
/**
@ -164,6 +169,7 @@ interface NavigatorInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
(value?: { target: string; type?: NavigationType }): NavigatorAttribute;
@ -190,6 +196,7 @@ interface NavigatorInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
(): NavigatorAttribute;
}
@ -217,6 +224,7 @@ interface NavigatorInterface {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
/**
@ -245,6 +253,7 @@ declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
active(value: boolean): NavigatorAttribute;
@ -274,6 +283,7 @@ declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
type(value: NavigationType): NavigatorAttribute;
@ -303,6 +313,7 @@ declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
target(value: string): NavigatorAttribute;
@ -332,6 +343,7 @@ declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
params(value: object): NavigatorAttribute;
}
@ -356,6 +368,7 @@ declare class NavigatorAttribute extends CommonMethod<NavigatorAttribute> {
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare const Navigator: NavigatorInterface;
@ -379,5 +392,6 @@ declare const Navigator: NavigatorInterface;
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 13
*/
declare const NavigatorInstance: NavigatorAttribute;

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

@ -355,7 +355,7 @@ interface EmitterProperty {
* @atomicservice
* @since 12
*/
index : number;
index: number;
/**
* Emitter emission rate.
@ -608,12 +608,16 @@ interface EmitterOptions<PARTICLE extends ParticleType> {
interface ParticlePropertyUpdaterConfigs<T> {
/**
* No effect of particle updater.
*
* @type { void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* No effect of particle updater.
*
* @type { void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -730,12 +734,16 @@ interface ParticlePropertyOptions<TYPE, UPDATER extends ParticleUpdater> {
interface ParticleColorPropertyUpdaterConfigs {
/**
* No effect of particle color property updater.
*
* @type { void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* No effect of particle color property updater.
*
* @type { void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1216,27 +1224,27 @@ declare enum ParticleUpdater {
CURVE = 'curve',
}
/**
/**
* Defines the SizeT type.
*
* @typedef { import('../../../../api/arkui/Graphics').SizeT<T> }
* @typedef { import('../api/arkui/Graphics').SizeT<T> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type SizeT<T> = import('../../../../api/arkui/Graphics').SizeT<T>;
declare type SizeT<T> = import('../api/arkui/Graphics').SizeT<T>;
/**
* Defines the PositionT type.
*
* @typedef { import('../../../../api/arkui/Graphics').PositionT<T> }
* @typedef { import('../api/arkui/Graphics').PositionT<T> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type PositionT<T> = import('../../../../api/arkui/Graphics').PositionT<T>;
declare type PositionT<T> = import('../api/arkui/Graphics').PositionT<T>;
/**
* Defines the Particle component attribute functions.
@ -1254,6 +1262,17 @@ declare type PositionT<T> = import('../../../../api/arkui/Graphics').PositionT<T
* @since 11
*/
declare class ParticleAttribute extends CommonMethod<ParticleAttribute> {
/**
* Particle disturbance Field.
*
* @param { Array<DisturbanceFieldOptions> } fields - particle disturbance Field params.
* @returns { ParticleAttribute } Returns the particle attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
disturbanceFields(fields: Array<DisturbanceFieldOptions>): ParticleAttribute;
/**
* Add particle animation component properties.
@ -1266,18 +1285,6 @@ declare class ParticleAttribute extends CommonMethod<ParticleAttribute> {
* @since 12
*/
emitter(value : Array<EmitterProperty>) : ParticleAttribute;
/**
* Particle disturbance Field.
*
* @param { Array<DisturbanceFieldOptions> } fields - particle disturbance Field params.
* @returns { ParticleAttribute } Returns the particle attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
disturbanceFields(fields: Array<DisturbanceFieldOptions>): ParticleAttribute;
}
/**

5
api/@internal/component/ets/progress.d.ts vendored
View File

@ -1206,6 +1206,7 @@ declare interface ProgressStyleMap {
/**
* Defines the map for Linear progress.
*
* @type { LinearStyleOptions | ProgressStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -1221,6 +1222,7 @@ declare interface ProgressStyleMap {
/**
* Defines the map for Ring progress.
*
* @type { RingStyleOptions | ProgressStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -1236,6 +1238,7 @@ declare interface ProgressStyleMap {
/**
* Defines the map for Eclipse progress.
*
* @type { EclipseStyleOptions | ProgressStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -1251,6 +1254,7 @@ declare interface ProgressStyleMap {
/**
* Defines the map for ScaleRing progress.
*
* @type { ScaleRingStyleOptions | ProgressStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -1266,6 +1270,7 @@ declare interface ProgressStyleMap {
/**
* Defines the map for Capsule progress.
*
* @type { CapsuleStyleOptions | ProgressStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11

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

@ -288,6 +288,17 @@ interface RefreshOptions {
* @since 11
*/
builder?: CustomBuilder;
/**
* Custom component to display during dragging.
*
* @type { ?ComponentContent }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
refreshingContent?: ComponentContent;
}
/**

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

@ -3364,6 +3364,18 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
*/
onIMEInputComplete(callback: Callback<RichEditorTextSpanResult>): RichEditorAttribute;
/**
* Called when ime input complete.
*
* @param { Callback<TextRange> } callback - The triggered function when text content has been inserted.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidIMEInput(callback: Callback<TextRange>): RichEditorAttribute;
/**
* Get text value information when about to delete.
*
@ -3585,7 +3597,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* Set richEditor placeholder.
*
* @param { ResourceStr } value - The value of placeholder.
* @param { PlaceholderStyle } options - The style of placeholder.
* @param { PlaceholderStyle } [style] - The style of placeholder.
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -3713,6 +3725,30 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @since 12
*/
editMenuOptions(editMenu: EditMenuOptions): RichEditorAttribute;
/**
* Sets whether request keyboard or not when on focus.
*
* @param { boolean } isEnabled - Whether enable request keyboard when on focus.
* @returns { RichEditorAttribute } Returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
enableKeyboardOnFocus(isEnabled: boolean): RichEditorAttribute;
/**
* Enable or disable haptic feedback.
*
* @param { boolean } isEnabled - Default value is true, set false to disable haptic feedback.
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
enableHapticFeedback(isEnabled: boolean): RichEditorAttribute;
}
/**

57
api/@internal/component/ets/rich_text.d.ts vendored
View File

@ -34,6 +34,14 @@
* @atomicservice
* @since 11
*/
/**
* Provides an interface for RichText component.
*
* @interface RichTextInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface RichTextInterface {
/**
* Set value.
@ -53,6 +61,15 @@ interface RichTextInterface {
* @atomicservice
* @since 11
*/
/**
* Set value.
*
* @param { string } content
* @returns { RichTextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
(content: string): RichTextAttribute;
}
@ -72,6 +89,14 @@ interface RichTextInterface {
* @atomicservice
* @since 11
*/
/**
* Defines the RichText attribute functions.
*
* @extends CommonMethod<RichTextAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare class RichTextAttribute extends CommonMethod<RichTextAttribute> {
/**
* Triggered when the RichText loading starts.
@ -91,6 +116,15 @@ declare class RichTextAttribute extends CommonMethod<RichTextAttribute> {
* @atomicservice
* @since 11
*/
/**
* Triggered when the RichText loading starts.
*
* @param { function } callback
* @returns { RichTextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onStart(callback: () => void): RichTextAttribute;
/**
@ -111,6 +145,15 @@ declare class RichTextAttribute extends CommonMethod<RichTextAttribute> {
* @atomicservice
* @since 11
*/
/**
* Triggered when the RichText loading ends.
*
* @param { function } callback
* @returns { RichTextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onComplete(callback: () => void): RichTextAttribute;
}
@ -128,6 +171,13 @@ declare class RichTextAttribute extends CommonMethod<RichTextAttribute> {
* @atomicservice
* @since 11
*/
/**
* Defines RichText Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare const RichText: RichTextInterface;
/**
@ -144,4 +194,11 @@ declare const RichText: RichTextInterface;
* @atomicservice
* @since 11
*/
/**
* Defines RichText Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare const RichTextInstance: RichTextAttribute;

12
api/@internal/component/ets/row.d.ts vendored
View File

@ -218,6 +218,18 @@ declare class RowAttribute extends CommonMethod<RowAttribute> {
* @since 11
*/
pointLight(value: PointLightStyle): RowAttribute;
/**
* Called when the Main-Axis's direction is set reversed or not
*
* @param { Optional<boolean> } isReversed - If the main axis is reversed.
* @returns { RowAttribute } The attribute of the row.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
reverse(isReversed: Optional<boolean>): RowAttribute;
}
/**

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

@ -661,7 +661,7 @@ declare class Scroller {
* @param { number } value - Index to jump to.
* @param { boolean } [smooth] - If true, scroll to index item with animation. If false, scroll to index item without animation.
* @param { ScrollAlign } [align] - Sets the alignment mode of a specified index.
* @param { options } [ScrollToIndexOptions] - Sets the options of a specified index, such as extra offset.
* @param { ScrollToIndexOptions } [options] - Sets the options of a specified index, such as extra offset.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -747,6 +747,24 @@ declare class Scroller {
* @since 12
*/
getItemRect(index: number): RectResult;
/**
* Get item index by position.
*
* @param { number } x - X coordinate relative to the upper left corner of the current component's original area, in vp.
* @param { number } y - Y coordinate relative to the upper left corner of the current component's original area, in vp.
* @returns { number } Index of the item.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100004 - The controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
getItemIndex(x: number, y: number): number;
}
/**

13
api/@internal/component/ets/scroll_bar.d.ts vendored
View File

@ -273,7 +273,18 @@ interface ScrollBarInterface {
* @atomicservice
* @since 11
*/
declare class ScrollBarAttribute extends CommonMethod<ScrollBarAttribute> {}
declare class ScrollBarAttribute extends CommonMethod<ScrollBarAttribute> {
/**
* Called when setting whether to enable nested scroll.
* @param { Optional<boolean> } enabled - Whether to enable nested scroll.
* @returns { ScrollBarAttribute } The attribute of the scroll bar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
enableNestedScroll(enabled: Optional<boolean>): ScrollBarAttribute;
}
/**
* Defines ScrollBar Component.

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

@ -321,15 +321,14 @@ declare interface ButtonStyle {
/**
* Set the button icon when sidebar status has changed
*
* @type { ?({shown: string | PixelMap | Resource;
* hidden: string | PixelMap | Resource;
* switching?: string | PixelMap | Resource;}) }
* @type { ?object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Set the button icon when sidebar status has changed
*
* @type { ?object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -337,6 +336,7 @@ declare interface ButtonStyle {
/**
* Set the button icon when sidebar status has changed
*
* @type { ?object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

152
api/@internal/component/ets/styled_string.d.ts vendored
View File

@ -108,6 +108,47 @@ declare class StyledString {
* @since 12
*/
subStyledString(start: number, length?: number): StyledString;
/**
* Returns StyledString from the provided HTML string.
*
* @param { string } html - the html text will be converted to a StyledString.
* @returns { Promise<StyledString> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
static fromHtml(html: string): Promise<StyledString>;
/**
* Returns ArrayBuffer from the serialized styled string.
*
* @param { StyledString } styledString - StyledString parameter.
* @returns { ArrayBuffer }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 13
*/
static marshalling(styledString: StyledString): ArrayBuffer;
/**
* Returns StyledString from the deserialized ArrayBuffer.
*
* @param { ArrayBuffer } buffer - The buffer will be deserialized to a StyledString.
* @returns { Promise<StyledString> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 13
*/
static unmarshalling(buffer: ArrayBuffer): Promise<StyledString>;
}
/**
@ -575,6 +616,40 @@ declare class TextShadowStyle {
readonly textShadow: Array<ShadowOptions>;
}
/**
* Defines Sets the property string background color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare class BackgroundColorStyle {
/**
* constructor.
*
* @param { TextBackgroundStyle } textBackgroundStyle - textBackgroundStyle value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
constructor(textBackgroundStyle: TextBackgroundStyle);
/**
* Get the textBackgroundStyle value of the StyledString.
*
* @type { TextBackgroundStyle } - the textBackgroundStyle value of the StyledString
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
readonly textBackgroundStyle: TextBackgroundStyle;
}
/**
* Defines GestureStyle.
*
@ -837,18 +912,67 @@ declare class LineHeightStyle {
readonly lineHeight: number;
}
/**
* Defines the URLStyle hyperlink that allows setting a URL string. When clicking on the text to
* which the span is attached, the URLStyle will try to open the URL.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare class UrlStyle {
/**
* Constructor.
*
* @param { string } url - URL value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
constructor(url: string);
/**
* Get the URL value of the StyledString.
*
* @type { string } - the URL value of the StyledString
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
readonly url: string;
}
/**
* Defines the Span Type.
*
* @typedef { TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle |
* GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | CustomSpan | UserDataSpan} StyledStringValue
* @typedef { TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle |
* GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | CustomSpan |
* UserDataSpan } StyledStringValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type StyledStringValue = TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle |
GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | CustomSpan | UserDataSpan;
/**
* Defines the Span Type.
*
* @typedef { TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle |
* GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | UrlStyle | CustomSpan |
* UserDataSpan | BackgroundColorStyle } StyledStringValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare type StyledStringValue = TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle |
TextShadowStyle | GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | UrlStyle | CustomSpan |
UserDataSpan | BackgroundColorStyle;
/**
* MutableStyledString
@ -1095,6 +1219,26 @@ declare enum StyledStringKey {
*/
LINE_HEIGHT = 5,
/**
* The key of BackgroundColorStyle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
BACKGROUND_COLOR = 6,
/**
* The key of UrlStyle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
URL = 7,
/**
* The key of GestureStyle.
*

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

@ -1483,7 +1483,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
vertical(value: boolean): SwiperAttribute;
/**
* Called when the size of the rotation chart is set.
* Sets the space between child components.
*
* @param { number | string } value
* @returns { SwiperAttribute }
@ -1491,7 +1491,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 7
*/
/**
* Called when the size of the rotation chart is set.
* Sets the space between child components.
*
* @param { number | string } value
* @returns { SwiperAttribute }
@ -1501,7 +1501,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 10
*/
/**
* Called when the size of the rotation chart is set.
* Sets the space between child components.
*
* @param { number | string } value
* @returns { SwiperAttribute }
@ -1545,7 +1545,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
displayMode(value: SwiperDisplayMode): SwiperAttribute;
/**
* Called when setting the cached count of the swiper container one side.
* Sets the number of child components to be cached.
*
* @param { number } value
* @returns { SwiperAttribute }
@ -1553,7 +1553,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 8
*/
/**
* Called when setting the cached count of the swiper container one side.
* Sets the number of child components to be cached.
*
* @param { number } value
* @returns { SwiperAttribute }
@ -1563,7 +1563,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 10
*/
/**
* Called when setting the cached count of the swiper container one side.
* Sets the number of child components to be cached.
*
* @param { number } value
* @returns { SwiperAttribute }
@ -1576,7 +1576,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
cachedCount(value: number): SwiperAttribute;
/**
* This command is invoked when the number of subcomponents is set.
* Sets the number of elements to display per page.
*
* @param { number | string } value
* @returns { SwiperAttribute }
@ -1584,7 +1584,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 8
*/
/**
* This command is invoked when the number of subcomponents is set.
* Sets the number of elements to display per page.
*
* @param { number | string | SwiperAutoFill } value
* @returns { SwiperAttribute }
@ -1594,7 +1594,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 10
*/
/**
* This command is invoked when the number of subcomponents is set.
* Sets the number of elements to display per page.
*
* If swipeByGroup is set to true:
* 1、All sub-items are grouped from index 0.
@ -1646,7 +1646,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
effectMode(value: EdgeEffect): SwiperAttribute;
/**
* Called when sliding is disableSwipe
* Sets whether to disable the swipe feature
*
* @param { boolean } value
* @returns { SwiperAttribute }
@ -1654,7 +1654,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 8
*/
/**
* Called when sliding is disableSwipe
* Sets whether to disable the swipe feature
*
* @param { boolean } value
* @returns { SwiperAttribute }
@ -1664,7 +1664,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 10
*/
/**
* Called when sliding is disableSwipe
* Sets whether to disable the swipe feature
*
* @param { boolean } value
* @returns { SwiperAttribute }
@ -1677,7 +1677,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
disableSwipe(value: boolean): SwiperAttribute;
/**
* Called when sliding is curve
* Sets the animation curve
*
* @param { Curve | string } value
* @returns { SwiperAttribute }
@ -1685,7 +1685,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 8
*/
/**
* Called when sliding is curve
* Sets the animation curve
* Curve is an enumeration type for common curves
* ICurve is a curve object
*
@ -1697,7 +1697,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 10
*/
/**
* Called when sliding is curve
* Sets the animation curve
* Curve is an enumeration type for common curves
* ICurve is a curve object
*
@ -1772,10 +1772,11 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 11
*/
/**
* The previous margin which can be used to expose a small portion of the previous item.
* When the previous item is empty, do not display blank space.
*
* @param { Length } value - The length of previous margin.
* @param { boolean } [ignoreBlank] - Ignoring blank space at the end of the page.
* @param { boolean } [ignoreBlank] - A boolean value determines whether to ignore blank space at the end of the page.
* @returns { SwiperAttribute } The attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -1803,10 +1804,11 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 11
*/
/**
* The next margin which can be used to expose a small portion of the latter item.
* When the next item is empty, do not display blank space.
*
* @param { Length } value - The length of next margin.
* @param { boolean } [ignoreBlank] - Ignoring blank space on homepage.
* @param { boolean } [ignoreBlank] - A boolean value determines whether to ignore blank space on homepage.
* @returns { SwiperAttribute } The attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform

12
api/@internal/component/ets/symbol_span.d.ts vendored
View File

@ -188,6 +188,18 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @since 12
*/
renderingStrategy(value: SymbolRenderingStrategy): SymbolSpanAttribute;
/**
* Sets the attribute modifier.
*
* @param { AttributeModifier<SymbolSpanAttribute> } modifier - The instance of symbol span modifier.
* @returns { SymbolSpanAttribute } the attribute of the SymbolSpanAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
attributeModifier(modifier: AttributeModifier<SymbolSpanAttribute>): SymbolSpanAttribute;
}
/**

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

@ -1522,7 +1522,7 @@ declare interface TabContentTransitionProxy {
* @crossplatform
* @form
* @atomicservice
* @since 112
* @since 12
*/
finishTransition(): void;
}

225
api/@internal/component/ets/text.d.ts vendored
View File

@ -142,6 +142,20 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
*/
font(value: Font): TextAttribute;
/**
* Called when the font is set.
*
* @param { Font } fontValue - the text font size and weight and family and style.
* @param { FontSettingOptions } options - font setting options.
* @returns { TextAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
font(fontValue: Font, options?: FontSettingOptions): TextAttribute;
/**
* Called when the font color is set.
*
@ -404,6 +418,20 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
*/
fontWeight(value: number | FontWeight | string): TextAttribute;
/**
* Called when the font weight is set.
*
* @param { number | FontWeight | string } weight
* @param { FontSettingOptions } options - font setting options.
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
fontWeight(weight: number | FontWeight | string, options?: FontSettingOptions): TextAttribute;
/**
* Set font line spacing.
*
@ -1071,35 +1099,12 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
fontFeature(value: string): TextAttribute;
/**
* Set the marquee options.
*
* @param { Optional<MarqueeOptions> } value
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marqueeOptions(value: Optional<MarqueeOptions>): TextAttribute;
/**
* Called when the text marquee state changes.
*
* @param { Callback<MarqueeState> } callback - callback of the marquee state change event.
* @returns { TextAttribute } returns the instance of the TextAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onMarqueeStateChange(callback: Callback<MarqueeState>): TextAttribute;
/**
* Whether to support sensitive privacy information
*
@ -1135,6 +1140,18 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @since 12
*/
editMenuOptions(editMenu: EditMenuOptions): TextAttribute;
/**
* Set the text with half leading.
*
* @param { boolean } halfLeading
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
halfLeading(halfLeading: boolean): TextAttribute;
}
/**
@ -1341,78 +1358,6 @@ declare enum TextResponseType {
SELECT = 2,
}
/**
* Defines marquee state.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum MarqueeState {
/**
* The marquee started.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 0,
/**
* The marquee a round finished and start next round.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BOUNCE = 1,
/**
* The marquee all finished.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FINISH = 2,
}
/**
* Defines marquee start policy.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum MarqueeStartPolicy {
/**
* Start marquee in any case. This is the default policy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT = 0,
/**
* Start marquee only when get focus.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ON_FOCUS = 1,
}
/**
* Defines the options of Text.
*
@ -1451,94 +1396,6 @@ declare interface TextOptions {
controller: TextController;
}
/**
* Defines the marquee options.
*
* @interface MarqueeOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface MarqueeOptions {
/**
* Is need start marquee.
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start: boolean;
/**
* The step size of the marquee.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
step?: number;
/**
* The rounds of the marquee.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
loop?: number;
/**
* The running direction of the marquee.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fromStart?: boolean;
/**
* The waiting time between each round of the marquee.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
delay?: number;
/**
* Set whether the text is faded out.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fadeout?: boolean;
/**
* The start policy for marquee.
*
* @type { ?MarqueeStartPolicy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marqueeStartPolicy?: MarqueeStartPolicy;
}
/**
* Defines the controller of Text.
*

106
api/@internal/component/ets/text_common.d.ts vendored
View File

@ -153,6 +153,26 @@ declare interface TextDataDetectorConfig {
* @since 12
*/
onDetectResultUpdate?: (result: string) => void
/**
* The color of AI entity.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
color?: ResourceColor,
/**
* The decoration of AI entity.
*
* @type { ?DecorationStyleInterface }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
decoration?: DecorationStyleInterface
}
/**
@ -590,6 +610,19 @@ declare interface LayoutManager {
* @since 12
*/
getLineMetrics(lineNumber: number): LineMetrics;
/**
* Get the rects for range.
* @param { TextRange } range - The range to set.
* @param { RectWidthStyle } widthStyle - Width style to set.
* @param { RectHeightStyle } heightStyle - Height style to set.
* @returns { Array<TextBox> } The rects for range.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
getRectsForRange(range: TextRange, widthStyle: RectWidthStyle, heightStyle: RectHeightStyle): Array<TextBox>;
}
/**
@ -647,6 +680,39 @@ declare type Affinity = import('../api/@ohos.graphics.text').default.Affinity;
*/
declare type LineMetrics = import('../api/@ohos.graphics.text').default.LineMetrics;
/**
* Define the RectWidthStyle type.
*
* @typedef { import('../api/@ohos.graphics.text').default.RectWidthStyle } RectWidthStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare type RectWidthStyle = import('../api/@ohos.graphics.text').default.RectWidthStyle;
/**
* Define the RectHeightStyle type.
*
* @typedef { import('../api/@ohos.graphics.text').default.RectHeightStyle } RectHeightStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare type RectHeightStyle = import('../api/@ohos.graphics.text').default.RectHeightStyle;
/**
* Define the TextBox type.
*
* @typedef { import('../api/@ohos.graphics.text').default.TextBox } TextBox
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
declare type TextBox = import('../api/@ohos.graphics.text').default.TextBox;
/**
* Defines the cursor style
*
@ -809,6 +875,18 @@ declare class TextMenuItemId {
* @since 12
*/
static readonly CAMERA_INPUT: TextMenuItemId;
/**
* Indicates the TextMenuItemId to help with text creation by invoking large models.
*
* @type { TextMenuItemId }
* @readonly
* @static
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
static readonly AI_WRITER: TextMenuItemId;
}
/**
@ -898,7 +976,7 @@ declare interface EditMenuOptions {
/**
* Passes the default menu, invokes before every display to generate a menu for triggering click events.
*
* @param { TextMenuItem } menuItem - current default menu array.
* @param { Array<TextMenuItem> } menuItems - current default menu array.
* @returns { Array<TextMenuItem> } - Return the menu after operations.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
@ -962,4 +1040,28 @@ interface DecorationStyleResult {
* @since 12
*/
style?: TextDecorationStyle;
}
}
/**
* Defines the options of font.
*
* @interface FontSettingOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare interface FontSettingOptions {
/**
* Define weather VariableFontWeight is supported.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
enableVariableFontWeight?: boolean;
}

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

@ -171,7 +171,7 @@ declare enum InputType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
NUMBER_PASSWORD = 8,

61
api/@internal/component/ets/units.d.ts vendored
View File

@ -21,6 +21,7 @@
/**
* Defines the data type of the interface restriction.
*
* @typedef { import('../api/global/resource').Resource } Resource
* @interface Resource
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
@ -28,6 +29,7 @@
/**
* Defines the data type of the interface restriction.
*
* @typedef { import('../api/global/resource').Resource } Resource
* @interface Resource
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
@ -36,6 +38,7 @@
/**
* Defines the data type of the interface restriction.
*
* @typedef { import('../api/global/resource').Resource } Resource
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -44,6 +47,7 @@
/**
* Defines the data type of the interface restriction.
*
* @typedef { import('../api/global/resource').Resource } Resource
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -55,12 +59,14 @@ declare type Resource = import('../api/global/resource').Resource;
/**
* Defines the length property with string, number and resource unit.
*
* @typedef { string | number | Resource } Length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the length property with string, number and resource unit.
*
* @typedef { string | number | Resource } Length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -68,6 +74,7 @@ declare type Resource = import('../api/global/resource').Resource;
/**
* Defines the length property with string, number and resource unit.
*
* @typedef { string | number | Resource } Length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -76,6 +83,7 @@ declare type Resource = import('../api/global/resource').Resource;
/**
* Defines the length property with string, number and resource unit.
*
* @typedef { string | number | Resource } Length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -87,12 +95,14 @@ declare type Length = string | number | Resource;
/**
* Defines the length property with number in units of px.
*
* @typedef { `${number}px` } PX
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the length property with number in units of px.
*
* @typedef { `${number}px` } PX
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -102,12 +112,14 @@ declare type PX = `${number}px`;
/**
* Defines the length property with number or number in units of vp.
*
* @typedef { `${number}vp` | number } VP
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the length property with number or number in units of vp.
*
* @typedef { `${number}vp` | number } VP
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -117,12 +129,14 @@ declare type VP = `${number}vp` | number;
/**
* Defines the length property with number in units of fp.
*
* @typedef { `${number}fp` } FP
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the length property with number in units of fp.
*
* @typedef { `${number}fp` } FP
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -132,12 +146,14 @@ declare type FP = `${number}fp`;
/**
* Defines the length property with number in units of lpx.
*
* @typedef { `${number}lpx` } LPX
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the length property with number in units of lpx.
*
* @typedef { `${number}lpx` } LPX
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -147,12 +163,14 @@ declare type LPX = `${number}lpx`;
/**
* Defines the length property with number in units of Percentage.
*
* @typedef { `${number}%` } Percentage
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the length property with number in units of Percentage.
*
* @typedef { `${number}%` } Percentage
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -162,12 +180,14 @@ declare type Percentage = `${number}%`;
/**
* Defines the angle property with number in units of deg.
*
* @typedef { `${number}deg` } Degree
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the angle property with number in units of deg.
*
* @typedef { `${number}deg` } Degree
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -177,12 +197,14 @@ declare type Degree = `${number}deg`;
/**
* Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource.
*
* @typedef { PX | VP | FP | LPX | Percentage | Resource } Dimension
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource.
*
* @typedef { PX | VP | FP | LPX | Percentage | Resource } Dimension
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
@ -192,12 +214,14 @@ declare type Dimension = PX | VP | FP | LPX | Percentage | Resource;
/**
* Defines the string which can use resource.
*
* @typedef { string | Resource } ResourceStr
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the string which can use resource.
*
* @typedef { string | Resource } ResourceStr
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -205,6 +229,7 @@ declare type Dimension = PX | VP | FP | LPX | Percentage | Resource;
/**
* Defines the string which can use resource.
*
* @typedef { string | Resource } ResourceStr
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -213,6 +238,7 @@ declare type Dimension = PX | VP | FP | LPX | Percentage | Resource;
/**
* Defines the string which can use resource.
*
* @typedef { string | Resource } ResourceStr
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -245,6 +271,7 @@ declare type ResourceStr = string | Resource;
/**
* Defines the padding property.
*
* @typedef { object } Padding
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -460,12 +487,14 @@ declare interface LocalizedPadding {
/**
* Defines the margin property.
*
* @typedef { Padding } Margin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the margin property.
*
* @typedef { Padding } Margin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -473,6 +502,7 @@ declare interface LocalizedPadding {
/**
* Defines the margin property.
*
* @typedef { Padding } Margin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -481,6 +511,7 @@ declare interface LocalizedPadding {
/**
* Defines the margin property.
*
* @typedef { Padding } Margin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -492,6 +523,7 @@ declare type Margin = Padding;
/**
* Defines the border width property.
*
* @typedef { EdgeWidths } EdgeWidth
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -499,6 +531,7 @@ declare type Margin = Padding;
/**
* Defines the border width property.
*
* @typedef { EdgeWidths } EdgeWidth
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -509,6 +542,7 @@ declare type EdgeWidth = EdgeWidths;
/**
* Defines the border width property.
*
* @typedef { object } EdgeWidths
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -516,6 +550,7 @@ declare type EdgeWidth = EdgeWidths;
/**
* Defines the border width property.
*
* @typedef { object } EdgeWidths
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -524,6 +559,7 @@ declare type EdgeWidth = EdgeWidths;
/**
* Defines the border width property.
*
* @typedef { object } EdgeWidths
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -719,6 +755,7 @@ declare interface LocalizedEdgeWidths {
/**
* Defines the outline width property.
*
* @typedef { object } EdgeOutlineWidths
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -814,6 +851,7 @@ declare type EdgeOutlineWidths = {
/**
* Defines the border radius property.
*
* @typedef { object } BorderRadiuses
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -821,6 +859,7 @@ declare type EdgeOutlineWidths = {
/**
* Defines the border radius property.
*
* @typedef { object } BorderRadiuses
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -829,6 +868,7 @@ declare type EdgeOutlineWidths = {
/**
* Defines the border radius property.
*
* @typedef { object } BorderRadiuses
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1016,6 +1056,7 @@ declare interface LocalizedBorderRadiuses {
/**
* Defines the outline radius property.
*
* @typedef { object } OutlineRadiuses
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1024,6 +1065,7 @@ declare interface LocalizedBorderRadiuses {
/**
* Defines the outline radius property.
*
* @typedef { object } OutlineRadiuses
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1119,6 +1161,7 @@ declare type OutlineRadiuses = {
/**
* Defines the border color property.
*
* @typedef { object } EdgeColors
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -1126,6 +1169,7 @@ declare type OutlineRadiuses = {
/**
* Defines the border color property.
*
* @typedef { object } EdgeColors
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1134,6 +1178,7 @@ declare type OutlineRadiuses = {
/**
* Defines the border color property.
*
* @typedef { object } EdgeColors
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1333,6 +1378,7 @@ declare type LocalizedMargin = LocalizedPadding;
/**
* Defines the border style property.
*
* @typedef { object } EdgeStyles
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -1340,6 +1386,7 @@ declare type LocalizedMargin = LocalizedPadding;
/**
* Defines the border style property.
*
* @typedef { object } EdgeStyles
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1348,6 +1395,7 @@ declare type LocalizedMargin = LocalizedPadding;
/**
* Defines the border style property.
*
* @typedef { object } EdgeStyles
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1475,6 +1523,7 @@ declare type EdgeStyles = {
/**
* Defines the outline style property.
*
* @typedef { object } EdgeOutlineStyles
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1483,6 +1532,7 @@ declare type EdgeStyles = {
/**
* Defines the outline style property.
*
* @typedef { object } EdgeOutlineStyles
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1578,12 +1628,14 @@ declare type EdgeOutlineStyles = {
/**
* Defines the offset property.
*
* @typedef { object } Offset
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the offset property.
*
* @typedef { object } Offset
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -1591,6 +1643,7 @@ declare type EdgeOutlineStyles = {
/**
* Defines the offset property.
*
* @typedef { object } Offset
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1653,12 +1706,14 @@ declare type Offset = {
/**
* Defines the color which can use resource.
*
* @typedef { Color | number | string | Resource } ResourceColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Defines the color which can use resource.
*
* @typedef { Color | number | string | Resource } ResourceColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -1666,6 +1721,7 @@ declare type Offset = {
/**
* Defines the color which can use resource.
*
* @typedef { Color | number | string | Resource } ResourceColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1674,6 +1730,7 @@ declare type Offset = {
/**
* Defines the color which can use resource.
*
* @typedef { Color | number | string | Resource } ResourceColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1685,6 +1742,7 @@ declare type ResourceColor = Color | number | string | Resource;
/**
* Defines the length constrain property.
*
* @typedef { object } LengthConstrain
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @since 9
@ -1692,6 +1750,7 @@ declare type ResourceColor = Color | number | string | Resource;
/**
* Defines the length constrain property.
*
* @typedef { object } LengthConstrain
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1700,6 +1759,7 @@ declare type ResourceColor = Color | number | string | Resource;
/**
* Defines the length constrain property.
*
* @typedef { object } LengthConstrain
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@ -1769,6 +1829,7 @@ declare type LengthConstrain = {
/**
* Defines VoidCallback.
*
* @typedef { function } VoidCallback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

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

@ -34,6 +34,7 @@
/**
* Provides methods for controlling the web controller.
*
* @typedef { import('../api/@ohos.web.webview').default.WebviewController }
* @syscap SystemCapability.Web.Webview.Core
* @crossplatform
* @atomicservice
@ -44,6 +45,8 @@ declare type WebviewController = import('../api/@ohos.web.webview').default.Webv
/**
* The callback of load committed.
*
* @typedef { function } OnNavigationEntryCommittedCallback
* @param { LoadCommittedDetails } loadCommittedDetails - callback information of onNavigationEntryCommitted.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
@ -53,7 +56,8 @@ type OnNavigationEntryCommittedCallback = (loadCommittedDetails: LoadCommittedDe
/**
* The callback of ssl error event.
*
* @typedef OnSslErrorEventCallback
* @typedef { function } OnSslErrorEventCallback
* @param { SslErrorEvent } sslErrorEvent - callback information of onSslErrorEvent.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -63,7 +67,8 @@ type OnSslErrorEventCallback = (sslErrorEvent: SslErrorEvent) => void;
/**
* The callback of largestContentfulPaint.
*
* @typedef OnLargestContentfulPaintCallback
* @typedef { function } OnLargestContentfulPaintCallback
* @param { LargestContentfulPaint } largestContentfulPaint - callback information of onLargestContentfulPaint.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -73,7 +78,8 @@ type OnLargestContentfulPaintCallback = (largestContentfulPaint: LargestContentf
/**
* The callback of firstMeaningfulPaint.
*
* @typedef OnFirstMeaningfulPaintCallback
* @typedef { function } OnFirstMeaningfulPaintCallback
* @param { FirstMeaningfulPaint } firstMeaningfulPaint - callback information of onFirstMeaningfulPaint.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -83,8 +89,11 @@ type OnFirstMeaningfulPaintCallback = (firstMeaningfulPaint: FirstMeaningfulPain
/**
* The callback of onOverrideUrlLoading.
* Should not call WebviewController.loadUrl with the request's URL and then return true.
* Returning true causes the current Web to abort loading the URL, false causes the Web to continue loading the url as usual.
*
* @typedef { function } OnOverrideUrlLoadingCallback
* @param { WebResourceRequest } webResourceRequest - callback information of onOverrideUrlLoading.
* @returns { boolean } - Returning true causes the current Web to abort loading the URL,
* false causes the Web to continue loading the url as usual.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -94,6 +103,8 @@ type OnOverrideUrlLoadingCallback = (webResourceRequest: WebResourceRequest) =>
/**
* The callback of Intelligent Tracking Prevention.
*
* @typedef { function } OnIntelligentTrackingPreventionCallback
* @param { IntelligentTrackingPreventionDetails } details - callback information of onIntelligentTrackingPrevention.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -133,8 +144,8 @@ declare interface NativeMediaPlayerConfig {
/**
* The callback of render process not responding.
*
* @typedef {function} OnRenderProcessNotRespondingCallback
* @param {RenderProcessNotRespondingData} data - details of onRenderProcessNotResponding.
* @typedef { function } OnRenderProcessNotRespondingCallback
* @param { RenderProcessNotRespondingData } data - details of onRenderProcessNotResponding.
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
@ -143,7 +154,7 @@ type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingDa
/**
* The callback of render process responding.
*
* @typedef {function} OnRenderProcessRespondingCallback
* @typedef { function } OnRenderProcessRespondingCallback
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
@ -152,8 +163,8 @@ type OnRenderProcessRespondingCallback = () => void;
/**
* The callback of ViewportFit Changed.
*
* @typedef {function} OnViewportFitChangedCallback
* @param {ViewportFit} viewportFit - details of OnViewportFitChangedCallback.
* @typedef { function } OnViewportFitChangedCallback
* @param { ViewportFit } viewportFit - details of OnViewportFitChangedCallback.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -163,7 +174,8 @@ type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void;
/**
* The callback of ads block
*
* @typedef {function} OnAdsBlockedCallback
* @typedef { function } OnAdsBlockedCallback
* @param { AdsBlockedDetails } details - details of OnAdsBlockedCallback.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -328,9 +340,9 @@ declare interface WebKeyboardCallbackInfo {
/**
* The callback of onInterceptKeyboardAttach event.
*
* @typedef {function} WebKeyboardCallback
* @param {WebKeyboardCallbackInfo} keyboardCallbackInfo - callback information of onInterceptKeyboardAttach.
* @returns {WebKeyboardOptions} Return the web keyboard options of this web component.
* @typedef { function } WebKeyboardCallback
* @param { WebKeyboardCallbackInfo } keyboardCallbackInfo - callback information of onInterceptKeyboardAttach.
* @returns { WebKeyboardOptions } Return the web keyboard options of this web component.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -500,6 +512,8 @@ declare enum MixedMode {
/**
* The callback of safe browsing check.
*
* @typedef { function } OnSafeBrowsingCheckResultCallback
* @param { ThreatType } threatType - callback information of onSafeBrowsingCheckResult.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
@ -1043,6 +1057,7 @@ declare interface FullScreenEnterEvent {
/**
* A function handle to exit full-screen mode.
*
* @type { FullScreenExitHandler }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -1051,6 +1066,7 @@ declare interface FullScreenEnterEvent {
/**
* The intrinsic width of the video if the fullscreen element contains video element, expressed in CSS pixels.
*
* @type { ?number }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -1059,6 +1075,7 @@ declare interface FullScreenEnterEvent {
/**
* The intrinsic height of the video if the fullscreen element contains video element, expressed in CSS pixels.
*
* @type { ?number }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -1069,6 +1086,8 @@ declare interface FullScreenEnterEvent {
/**
* The callback when the web component enter full screen mode.
*
* @typedef { function } OnFullScreenEnterCallback
* @param { FullScreenEnterEvent } event - callback information of onFullScreenEnter.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -1170,6 +1189,7 @@ declare enum RenderExitReason {
/**
* The callback of custom hide of the context menu.
*
* @typedef { function } OnContextMenuHideCallback
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
@ -2470,7 +2490,7 @@ declare enum NativeEmbedStatus {
DESTROY = 2,
/**
* The embed tag enter backforwardcache.
* The embed tag enter backforward cache.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
@ -2479,13 +2499,29 @@ declare enum NativeEmbedStatus {
ENTER_BFCACHE = 3,
/**
* The embed tag leave backforwardcache.
* The embed tag leave backforward cache.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
LEAVE_BFCACHE = 4,
/**
* The embed tag visible.
*
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
VISIBLE = 5,
/**
* The embed tag hidden.
*
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
HIDDEN = 6,
}
/**
@ -5993,7 +6029,7 @@ declare interface JavaScriptProxy {
/**
* The async method of the application side JavaScript object participating in the registration.
*
* @type { Array<string> }
* @type { ?Array<string> }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -7791,7 +7827,7 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
/**
* Set the default text encodingFormat value of webview. The default value is UTF-8.
*
* @param { string } default text encodingFormat.
* @param { string } textEncodingFormat text encodingFormat.
* @returns { WebAttribute }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
@ -8259,7 +8295,17 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
* @atomicservice
* @since 11
*/
nestedScroll(value: NestedScrollOptions): WebAttribute;
/**
* Called to setting the nested scroll options.
*
* @param { NestedScrollOptions | NestedScrollOptionsExt } value - options for
* nested scrolling.
* @returns { WebAttribute } the attribute of the scroll.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
nestedScroll(value: NestedScrollOptions|NestedScrollOptionsExt): WebAttribute;
/**
* Sets the enable native embed mode for web.
@ -8440,6 +8486,16 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
* @since 12
*/
keyboardAvoidMode(mode: WebKeyboardAvoidMode): WebAttribute;
/**
* Set the custom text menu.
*
* @param { EditMenuOptions } editMenu - Customize text menu options.
* @returns { WebAttribute }
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
editMenuOptions(editMenu: EditMenuOptions): WebAttribute;
}
/**
@ -8459,6 +8515,7 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
/**
* Defines Web Component.
*
* @constant
* @syscap SystemCapability.Web.Webview.Core
* @crossplatform
* @atomicservice
@ -8475,6 +8532,7 @@ declare const Web: WebInterface;
/**
* Defines Web Component instance.
*
* @constant
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 11
@ -8493,6 +8551,7 @@ declare interface SslErrorEvent {
/**
* Notifies the user of the operation behavior of the web component.
*
* @type { SslErrorHandler }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8501,6 +8560,7 @@ declare interface SslErrorEvent {
/**
* Error codes.
*
* @type { SslError }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8509,6 +8569,7 @@ declare interface SslErrorEvent {
/**
* Request url.
*
* @type { string }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8517,6 +8578,7 @@ declare interface SslErrorEvent {
/**
* Original url.
*
* @type { string }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8525,6 +8587,7 @@ declare interface SslErrorEvent {
/**
* Referrer.
*
* @type { string }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8533,6 +8596,7 @@ declare interface SslErrorEvent {
/**
* Whether the error is fatal.
*
* @type { boolean }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8541,6 +8605,7 @@ declare interface SslErrorEvent {
/**
* Whether the request is main frame.
*
* @type { boolean }
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
@ -8585,3 +8650,48 @@ declare interface ExpandedMenuItemOptions {
*/
action: (selectedText: {plainText: string}) => void;
}
/**
* Define nested scroll options
*
* @interface NestedScrollOptionsExt
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
declare interface NestedScrollOptionsExt {
/**
* Set NestedScrollMode when the scrollable component scrolls up
*
* @type { ?NestedScrollMode }
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
scrollUp?: NestedScrollMode;
/**
* Set NestedScrollMode when the scrollable component scrolls down
*
* @type { ?NestedScrollMode }
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
scrollDown?: NestedScrollMode;
/**
* Set NestedScrollMode when the scrollable component scrolls right
*
* @type { ?NestedScrollMode }
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
scrollRight?: NestedScrollMode;
/**
* Set NestedScrollMode when the scrollable component scrolls left
*
* @type { ?NestedScrollMode }
* @syscap SystemCapability.Web.Webview.Core
* @since 12
*/
scrollLeft?: NestedScrollMode;
}

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

@ -65,7 +65,7 @@ export default class InputMethodExtensionContext extends ExtensionContext {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.

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

@ -21,6 +21,7 @@
import type BaseContext from './application/BaseContext';
import type { Callback } from './@ohos.base';
import { NodeController } from '@kit.ArkUI';
import { typeNode } from './arkui/FrameNode';
/**
* Picture In Picture Window Manager
@ -62,8 +63,8 @@ declare namespace PiPWindow {
* the context and componentController in config should not be null. If templateType is specified, make sure
* it's type of PiPTemplateType. If controlGroups is specified, make sure it correspond to the templateType.
* @returns { Promise<PiPController> } - The promise returned by the function
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* 3. Parameter verification failed
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
@ -76,8 +77,8 @@ declare namespace PiPWindow {
* the context and componentController in config should not be null. If templateType is specified, make sure
* it's type of PiPTemplateType. If controlGroups is specified, make sure it correspond to the templateType.
* @returns { Promise<PiPController> } - The promise returned by the function
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* 3. Parameter verification failed
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
@ -86,6 +87,25 @@ declare namespace PiPWindow {
*/
function create(config: PiPConfiguration): Promise<PiPController>;
/**
* Create picture-in-picture controller
*
* @param { PiPConfiguration } config - Params for picture-in-picture controller creation. The config must be valid,
* the context and componentController in config should not be null. If templateType is specified, make sure
* it's type of PiPTemplateType. If controlGroups is specified, make sure it correspond to the templateType.
* @param { typeNode.XComponent } contentNode - Params for picture-in-picture controller creation.
* Indicates the node which display the content of pip window.
* @returns { Promise<PiPController> } - The promise returned by the function
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function create(config: PiPConfiguration, contentNode: typeNode.XComponent): Promise<PiPController>;
/**
* PiPConfiguration
*
@ -403,7 +423,7 @@ declare namespace PiPWindow {
/**
* Describe PiP window custom controls.
*
*
* @typedef { VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup | VideoLiveControlGroup }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
@ -528,7 +548,7 @@ declare namespace PiPWindow {
* @atomicservice
* @since 12
*/
MICROPHONE_SWITCH = 304,
MICROPHONE_SWITCH = 304,
}
/**
@ -784,7 +804,7 @@ declare namespace PiPWindow {
/**
* Describe picture-in-picture control panel action event callback.
*
*
* @typedef { function } ControlPanelActionEventCallback
* @param { PiPActionEventType } event - the event from controlPanel
* @param { number } [status] - the status of control button
@ -904,7 +924,7 @@ declare namespace PiPWindow {
* Update source content size to adjust PiP window aspect ratio.
* @param { number } width - Indicate the width of the content. The width can consist of only digits and above 0.
* @param { number } height - Indicate the height of the content. The height can consist of only digits and above 0.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @syscap SystemCapability.Window.SessionManager
* @since 11
@ -913,7 +933,7 @@ declare namespace PiPWindow {
* Update source content size to adjust PiP window aspect ratio.
* @param { number } width - Indicate the width of the content. The width can consist of only digits and above 0.
* @param { number } height - Indicate the height of the content. The height can consist of only digits and above 0.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
@ -1035,4 +1055,4 @@ declare namespace PiPWindow {
}
}
export default PiPWindow;
export default PiPWindow;

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

@ -45,6 +45,7 @@ declare namespace ability {
/**
* DataAbilityHelper
*
* @typedef { _DataAbilityHelper }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 9
@ -54,6 +55,7 @@ declare namespace ability {
/**
* Defines a PacMap object for storing a series of values.
*
* @typedef { _PacMap }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 9
@ -61,6 +63,7 @@ declare namespace ability {
/**
* Defines a PacMap object for storing a series of values.
*
* @typedef { _PacMap }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @since 11
*/
@ -70,6 +73,7 @@ declare namespace ability {
* DataAbilityOperation secondary module.Define the DataAbility data operation method,
* which can be used as an input parameter for [executeBatch] to manipulate database information.
*
* @typedef { _DataAbilityOperation }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 9
@ -81,6 +85,7 @@ declare namespace ability {
* When operating the database through [executeBatch], the operation result is returned
* using the DataAbility Result object.
*
* @typedef { _DataAbilityResult }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 9
@ -93,6 +98,7 @@ declare namespace ability {
* up and exited can be obtained through [startAbilityForResult], and the ability object pulled up
* by startAbilityForResult can be returned through [terminateSelfWithResult].
*
* @typedef { _AbilityResult }
* @syscap SystemCapability.Ability.AbilityBase
* @FAModelOnly
* @since 9
@ -103,6 +109,7 @@ declare namespace ability {
* ConnectOptions secondary module.As an input parameter when connecting to a specified backend service,
* used to receive state changes during the connection process
*
* @typedef { _ConnectOptions }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @FAModelOnly
* @since 9

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

@ -536,7 +536,7 @@ declare namespace abilityAccessCtrl {
*
* @param { Context } context - The context that initiates the permission request.
* <br> The context must belong to the Stage model and only supports UIAbilityContext and UIExtensionContext.
* @param { Array<Permissions> } permissionNameList - Indicates the list of permission to be requested. This parameter cannot be null or empty.
* @param { Array<Permissions> } permissionList - Indicates the list of permission to be requested. This parameter cannot be null or empty.
* @returns { Promise<Array<GrantStatus>> } Returns the list of status of the specified permission.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 12100001 - Invalid parameter. Possible causes: 1. The context is invalid because it does not belong to the application itself;
@ -549,7 +549,7 @@ declare namespace abilityAccessCtrl {
* @atomicservice
* @since 12
*/
requestPermissionOnSetting(context: Context, permissionNameList: Array<Permissions>): Promise<Array<GrantStatus>>;
requestPermissionOnSetting(context: Context, permissionList: Array<Permissions>): Promise<Array<GrantStatus>>;
/**
* Requests certain global switch status on setting from the user.

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

@ -33,6 +33,7 @@ export declare class GesturePath {
* @param { number } durationTime - Indicates the duration of the gesture.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
constructor(durationTime: number);
/**

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

@ -32,6 +32,7 @@ export declare class GesturePoint {
* @param { number } positionY - Indicates the Y coordinate of point.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
constructor(positionX: number, positionY: number);
/**

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

@ -288,6 +288,8 @@ declare namespace config {
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
* @param { 'enabledAccessibilityExtensionListChange' } type Indicates the type of event.
* @param { Callback<void> } callback Indicates the listener.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
@ -305,6 +307,8 @@ declare namespace config {
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
* @param { 'installedAccessibilityListChange' } type Indicates the type of event.
* @param { Callback<void> } callback Indicates the listener.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
@ -322,6 +326,8 @@ declare namespace config {
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
* @param { 'enabledAccessibilityExtensionListChange' } type Indicates the type of event.
* @param { Callback<void> } callback Indicates the listener.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
@ -339,6 +345,8 @@ declare namespace config {
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
* @param { 'installedAccessibilityListChange' } type Indicates the type of event.
* @param { Callback<void> } callback Indicates the listener.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
@ -414,8 +422,6 @@ declare namespace config {
* Getting configuration value.
*
* @param { AsyncCallback<T> } callback
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
@ -446,6 +452,8 @@ declare namespace config {
*
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
* @param { Callback<T> } callback Indicates the listener.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
@ -457,6 +465,7 @@ declare namespace config {
/**
* Indicates the type of daltonization color filter.
*
* @typedef {'Normal' | 'Protanomaly' | 'Deuteranomaly' | 'Tritanomaly'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 9
@ -466,6 +475,7 @@ declare namespace config {
/**
* Indicates the type of click response time.
*
* @typedef {'Short' | 'Medium' | 'Long'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 11
@ -475,6 +485,7 @@ declare namespace config {
/**
* Indicates the type of ignore repeat click interval.
*
* @typedef {'Shortest' | 'Short' | 'Medium' | 'Long' | 'Longest'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 11

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

@ -48,6 +48,7 @@ declare namespace accessibility {
* The type of the Ability app.
*
* { 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all' }
* @typedef {'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
@ -69,6 +70,7 @@ declare namespace accessibility {
* 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' |
* 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common' }
*
* @typedef {'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' | 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
@ -95,6 +97,7 @@ declare namespace accessibility {
* 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' |
* 'announceForAccessibility' }
*
* @typedef {'accessibilityFocus' | 'accessibilityFocusClear' | 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | 'announceForAccessibility'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
@ -107,6 +110,7 @@ declare namespace accessibility {
* The change type of the windowsChange event.
* It's used when received the {@code windowsChange} event.
*
* @typedef {'add' | 'remove' | 'bounds' | 'active' | 'focus'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
@ -115,6 +119,7 @@ declare namespace accessibility {
/**
* The type of the ability state.
*
* @typedef {'enable' | 'disable' | 'install'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
@ -129,6 +134,7 @@ declare namespace accessibility {
* filterKeyEvents: Describes the capability to request to filter key events.
* fingerprintGesture: Describes the capability to request to fingerprint gesture.
*
* @typedef {'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
@ -137,6 +143,7 @@ declare namespace accessibility {
/**
* The granularity of text move.
*
* @typedef {'char' | 'word' | 'line' | 'page' | 'paragraph'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
@ -415,6 +422,7 @@ declare namespace accessibility {
* @returns { CaptionsManager } Returns the captions manager.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
function getCaptionsManager(): CaptionsManager;
@ -429,6 +437,7 @@ declare namespace accessibility {
/**
* Indicates whether captions are enabled.
*
* @type {boolean}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
@ -436,6 +445,7 @@ declare namespace accessibility {
/**
* Indicates the style of captions.
*
* @type {CaptionsStyle}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
@ -452,6 +462,7 @@ declare namespace accessibility {
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
on(type: 'enableChange', callback: Callback<boolean>): void;
@ -466,6 +477,7 @@ declare namespace accessibility {
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
on(type: 'styleChange', callback: Callback<CaptionsStyle>): void;
@ -480,6 +492,7 @@ declare namespace accessibility {
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
off(type: 'enableChange', callback?: Callback<boolean>): void;
@ -494,6 +507,7 @@ declare namespace accessibility {
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void;
}
@ -501,6 +515,7 @@ declare namespace accessibility {
/**
* Indicates the edge type of the captions font.
*
* @typedef {'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow'}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
@ -508,10 +523,11 @@ declare namespace accessibility {
/**
* Indicates the font family of captions.
*
* @typedef {'default' | 'monospacedSerif' | 'serif' | 'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals'}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
type CaptionsFontFamily = 'default' | 'monospacedSerif' | 'serif' |
type CaptionsFontFamily = 'default' | 'monospacedSerif' | 'serif' |
'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals';
/**
* Indicates the style of captions.
@ -524,6 +540,7 @@ declare namespace accessibility {
/**
* Indicates the font family of captions.
*
* @type {CaptionsFontFamily}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/

8
api/@ohos.animator.d.ts vendored
View File

@ -493,6 +493,8 @@ export interface AnimatorResult {
/**
* Trigger when vSync callback.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -524,6 +526,8 @@ export interface AnimatorResult {
/**
* The animation is finished.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -555,6 +559,8 @@ export interface AnimatorResult {
/**
* The animation is canceled.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -586,6 +592,8 @@ export interface AnimatorResult {
/**
* The animation is repeated.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

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

@ -660,7 +660,6 @@ declare namespace AbilityConstant {
* Full screen mode.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/

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

@ -25,9 +25,8 @@ import type print from './@ohos.print';
* class of print extensionAbility.
*
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
export default class PrintExtensionAbility {
@ -36,9 +35,8 @@ export default class PrintExtensionAbility {
* @param { Want } want - call print page want params.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onCreate(want: Want): void;
@ -46,9 +44,8 @@ export default class PrintExtensionAbility {
* Called once to start to discover the printers connected with the device.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onStartDiscoverPrinter(): void;
@ -56,9 +53,8 @@ export default class PrintExtensionAbility {
* Called once to stop discovering the printer.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onStopDiscoverPrinter(): void;
@ -67,9 +63,8 @@ export default class PrintExtensionAbility {
* @param { number } printerId - connect the printerId.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onConnectPrinter(printerId: number): void;
@ -78,9 +73,8 @@ export default class PrintExtensionAbility {
* @param { number } printerId - connect the printerId.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onDisconnectPrinter(printerId: number): void;
@ -90,7 +84,7 @@ export default class PrintExtensionAbility {
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @stagemodelonly
* @since 10
*/
onStartPrintJob(jobInfo: print.PrintJob): void;
@ -101,7 +95,7 @@ export default class PrintExtensionAbility {
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @stagemodelonly
* @since 10
*/
onCancelPrintJob(jobInfo: print.PrintJob): void;
@ -113,7 +107,7 @@ export default class PrintExtensionAbility {
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @stagemodelonly
* @since 10
*/
onRequestPrinterCapability(printerId: number): print.PrinterCapability;
@ -125,7 +119,7 @@ export default class PrintExtensionAbility {
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @stagemodelonly
* @since 10
*/
onRequestPreview(jobInfo: print.PrintJob): string;
@ -134,9 +128,8 @@ export default class PrintExtensionAbility {
* Called once to finalize the extensionAbility.
* @throws { BusinessError } 202 - not system application
* @syscap SystemCapability.Print.PrintFramework
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 10
* @stagemodelonly
* @since 12
*/
onDestroy(): void;
}

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

@ -127,7 +127,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
@ -199,7 +199,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
@ -235,7 +235,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
@ -307,7 +307,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
@ -343,7 +343,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
@ -415,7 +415,7 @@ export default class UIExtensionContentSession {
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation flag is forbidden.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.

140
api/@ohos.app.ability.UIServiceExtensionAbility.d.ts vendored Normal file
View File

@ -0,0 +1,140 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import ExtensionAbility from './@ohos.app.ability.ExtensionAbility';
import type Want from './@ohos.app.ability.Want';
import type UIServiceExtensionContext from './application/UIServiceExtensionContext';
import type UIServiceHostProxy from './application/UIServiceHostProxy';
import window from './@ohos.window';
/**
* The class of UI service extension ability.
*
* @extends ExtensionAbility
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
export default class UIServiceExtensionAbility extends ExtensionAbility {
/**
* Indicates configuration information about an UI service extension ability context.
*
* @type { UIServiceExtensionContext }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
context: UIServiceExtensionContext;
/**
* Called back when an UI service extension is started for initialization.
*
* @param { Want } want - Indicates the want of created UI service extension.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onCreate(want: Want): void;
/**
* Called back when a UI service extension is started.
*
* @param { Want } want - Indicates the want of UI service extension to start.
* @param { number } startId - Indicates the number of times the UI service extension has been started.
* The {@code startId} is incremented by 1 every time the UI service extension is started.
* For example, if the UI service extension has been started for six times.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onRequest(want: Want, startId: number): void;
/**
* Called back when a UI service extension is connected to an ability.
*
* @param { Want } want - Indicates connection information about the UI service ability.
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onConnect(want: Want, proxy: UIServiceHostProxy): void;
/**
* Called back when ability connected to a UI service extension is disconnected.
*
* @param { Want } want - Indicates disconnection information about the UI service extension.
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onDisconnect(want: Want, proxy: UIServiceHostProxy): void;
/**
* Called back when a window will create.
*
* @param { window.ExtensionWindowConfig } config - Indicates the extension window config.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onWindowWillCreate(config: window.ExtensionWindowConfig): void;
/**
* Called back when a window is created.
*
* @param { window.Window } window - Indicates the created Window.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onWindowDidCreate(window: window.Window): void;
/**
* Called back when data is sent.
*
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @param { Record<string, Object> } data - Indicates the received data.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onData(proxy: UIServiceHostProxy, data: Record<string, Object>): void;
/**
* Called back before a UI service extension is destroyed.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onDestroy(): void;
}

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

@ -366,6 +366,7 @@ declare namespace abilityManager {
* @param { number } requestCode - Request code defined by the user.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
@ -382,6 +383,7 @@ declare namespace abilityManager {
* @param { number } requestCode - Request code defined by the user.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
@ -477,6 +479,7 @@ declare namespace abilityManager {
/**
* The class of an ability running information.
*
* @typedef { _AbilityRunningInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 9
@ -486,6 +489,7 @@ declare namespace abilityManager {
/**
* The ability state data.
*
* @typedef { _AbilityStateData.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 11
@ -495,6 +499,7 @@ declare namespace abilityManager {
/**
* The class of an extension running information.
*
* @typedef { _ExtensionRunningInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 9
@ -504,6 +509,7 @@ declare namespace abilityManager {
/**
* The ability foreground state observer.
*
* @typedef { _AbilityForegroundStateObserver.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 11

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

@ -402,6 +402,23 @@ declare namespace appManager {
* @systemapi
* @since 9
*/
/**
* Kill process with account.
*
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.KILL_APP_PROCESSES
* or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES
* @param { string } bundleName - The process bundle name.
* @param { number } accountId - The account id.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
*/
function killProcessWithAccount(bundleName: string, accountId: number): Promise<void>;
/**
@ -419,7 +436,7 @@ declare namespace appManager {
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
* @since 13
*/
function killProcessWithAccount(bundleName: string, accountId: number, clearPageStack: boolean, appIndex?: number):
Promise<void>;
@ -440,6 +457,23 @@ declare namespace appManager {
* @systemapi
* @since 9
*/
/**
* Kill process with account.
*
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.KILL_APP_PROCESSES
* or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES
* @param { string } bundleName - The process bundle name.
* @param { number } accountId - The account id.
* @param { AsyncCallback<void> } callback - The callback of killProcessWithAccount.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
*/
function killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback<void>): void;
/**
@ -499,6 +533,21 @@ declare namespace appManager {
* @systemapi
* @since 9
*/
/**
* Kill processes by bundle name
*
* @permission ohos.permission.KILL_APP_PROCESSES or ohos.permission.CLEAN_BACKGROUND_PROCESSES
* @param { string } bundleName - bundle name.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
*/
function killProcessesByBundleName(bundleName: string): Promise<void>;
/**
@ -515,7 +564,7 @@ declare namespace appManager {
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
* @since 13
*/
function killProcessesByBundleName(bundleName: string, clearPageStack: boolean, appIndex?: number): Promise<void>;
@ -534,6 +583,21 @@ declare namespace appManager {
* @systemapi
* @since 9
*/
/**
* Kill processes by bundle name
*
* @permission ohos.permission.KILL_APP_PROCESSES or ohos.permission.CLEAN_BACKGROUND_PROCESSES
* @param { string } bundleName - bundle name.
* @param { AsyncCallback<void> } callback - The callback of killProcessesByBundleName.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
*/
function killProcessesByBundleName(bundleName: string, callback: AsyncCallback<void>);
/**
@ -954,13 +1018,49 @@ declare namespace appManager {
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000073 - The app clone index does not exist.
* @throws { BusinessError } 16000073 - The app clone index is invalid.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 12
*/
function clearUpAppData(bundleName: string, appCloneIndex?: number): Promise<void>;
/**
* Terminate the mission of a UIAbility and back to caller.
*
* @permission ohos.permission.KILL_APP_PROCESSES
* @param { number } missionId - The mission id of the UIAbility need to be terminated.
* @returns { Promise<void> } Returns the result of terminateMission.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 13
*/
function terminateMission(missionId: number): Promise<void>;
/**
* Get pids of processes which belong to specific bundle name and support process cache feature.
*
* @permission ohos.permission.GET_RUNNING_INFO
* @param { string } bundleName - bundle name.
* @returns { Promise<Array<number>> } Returns the list of pid.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
function getSupportedProcessCachePids(bundleName : string): Promise<Array<number>>;
/**
* The ability or extension state data.
*
@ -1053,7 +1153,6 @@ declare namespace appManager {
* @typedef { _RunningMultiAppInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @atomicservice
* @since 12
*/
export type RunningMultiAppInfo = _RunningMultiAppInfo;

96
api/@ohos.app.ability.application.d.ts vendored Normal file
View File

@ -0,0 +1,96 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import ApplicationContext from './application/ApplicationContext';
import Context from './application/Context';
/**
* This module provides application basic functions.
*
* @namespace application
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 12
*/
declare namespace application {
/**
* Create a module context
*
* @param { Context } context - Indicates current context.
* @param { string } moduleName - Indicates the module name.
* @returns { Promise<Context> } Returns the application context.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 12
*/
export function createModuleContext(context: Context, moduleName: string): Promise<Context>;
/**
* Create a module context
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Context } context - Indicates current context.
* @param { string } bundleName - Indicates the bundle name.
* @param { string } moduleName - Indicates the module name.
* @returns { Promise<Context> } Returns the application context.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
export function createModuleContext(context: Context, bundleName: string, moduleName: string): Promise<Context>;
/**
* Create a bundle context
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Context } context - Indicates current context.
* @param { string } bundleName - Indicates the bundle name.
* @returns { Promise<Context> } Returns the application context.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
export function createBundleContext(context: Context, bundleName: string): Promise<Context>;
/**
* Get application context.
*
* @returns { ApplicationContext } Returns the application context.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 13
*/
export function getApplicationContext(): ApplicationContext;
}
export default application;

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

@ -141,7 +141,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type ViewData = _ViewData.default;
@ -161,7 +160,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type PageNodeInfo = _PageNodeInfo.default;
@ -180,7 +178,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export { AutoFillType };
@ -200,7 +197,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type FillRequest = _AutoFillRequest.FillRequest;
@ -220,7 +216,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type SaveRequest = _AutoFillRequest.SaveRequest;
@ -232,7 +227,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type UpdateRequest = _AutoFillRequest.UpdateRequest;
@ -252,7 +246,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type FillResponse = _AutoFillRequest.FillResponse;
@ -272,7 +265,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type FillRequestCallback = _AutoFillRequest.FillRequestCallback;
@ -292,7 +284,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type SaveRequestCallback = _AutoFillRequest.SaveRequestCallback;
@ -315,7 +306,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type AutoFillRect = _AutoFillRect.default;
@ -327,7 +317,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type AutoFillPopupConfig = _AutoFillPopupConfig.default;
@ -339,7 +328,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export type PopupSize = _AutoFillPopupConfig.PopupSize;
@ -350,7 +338,6 @@ declare namespace autoFillManager {
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @systemapi
* @stagemodelonly
* @atomicservice
* @since 12
*/
export { PopupPlacement };

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

@ -113,6 +113,27 @@ declare namespace childProcessManager {
*/
function startArkChildProcess(srcEntry: string, args: ChildProcessArgs, options?: ChildProcessOptions): Promise<number>;
/**
* Start native child process with the given args and options.
*
* @permission ohos.permission.START_NATIVE_CHILD_PROCESS
* @param { string } entryPoint - Indicates entry point of child process, consisting of library and entry function, such as "libEntry.so:Main".
* @param { ChildProcessArgs } args - Indicates args to pass to child process.
* @param { ChildProcessOptions } [options] - Indicates options for starting child process.
* @returns { Promise<number> } Returns the started child process pid.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000061 - Operation not supported. The API cannot be called in a child process.
* @throws { BusinessError } 16000062 - The number of native child process exceeds upper bound.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 13
*/
function startNativeChildProcess(entryPoint: string, args: ChildProcessArgs, options?: ChildProcessOptions): Promise<number>;
}
export default childProcessManager;

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

@ -38,13 +38,17 @@ import type { AutoStartupCallback as _AutoStartupCallback } from './application/
import type { AutoStartupInfo as _AutoStartupInfo } from './application/AutoStartupInfo';
import type * as _EmbeddableUIAbilityContext from './application/EmbeddableUIAbilityContext';
import type * as _PhotoEditorExtensionContext from './application/PhotoEditorExtensionContext';
import * as _UIServiceExtensionContext from './application/UIServiceExtensionContext';
import * as _UIServiceProxy from './application/UIServiceProxy';
import * as _UIServiceHostProxy from './application/UIServiceHostProxy';
import * as _UIServiceExtensionConnectCallback from './application/UIServiceExtensionConnectCallback';
/**
* This module provides application context classes and common data structures.
*
* @namespace common
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
@ -52,7 +56,7 @@ import type * as _PhotoEditorExtensionContext from './application/PhotoEditorExt
*
* @namespace common
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -70,14 +74,14 @@ declare namespace common {
* The context of an ability. It allows access to ability-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The context of an ability. It allows access to ability-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -86,7 +90,7 @@ declare namespace common {
*
* @typedef { _UIAbilityContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
@ -97,14 +101,14 @@ declare namespace common {
* The context of an abilityStage. It allows access to abilityStage-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The context of an abilityStage. It allows access to abilityStage-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -113,7 +117,7 @@ declare namespace common {
*
* @typedef { _AbilityStageContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
@ -124,14 +128,14 @@ declare namespace common {
* The context of an application. It allows access to application-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The context of an application. It allows access to application-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -140,7 +144,7 @@ declare namespace common {
*
* @typedef { _ApplicationContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
@ -151,14 +155,14 @@ declare namespace common {
* The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -167,7 +171,7 @@ declare namespace common {
*
* @typedef { _BaseContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
@ -179,7 +183,7 @@ declare namespace common {
* application-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
@ -187,7 +191,7 @@ declare namespace common {
* application-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @since 10
*/
@ -197,7 +201,7 @@ declare namespace common {
*
* @typedef { _Context.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
@ -208,14 +212,15 @@ declare namespace common {
* The context of an extension. It allows access to extension-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The context of an extension. It allows access to extension-specific resources.
*
* @typedef { _ExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @atomicservice
* @since 11
*/
@ -226,7 +231,7 @@ declare namespace common {
* formExtension-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
@ -235,7 +240,7 @@ declare namespace common {
*
* @typedef { _FormExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @atomicservice
* @since 11
*/
@ -248,7 +253,7 @@ declare namespace common {
* @typedef { _ServiceExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
export type ServiceExtensionContext = _ServiceExtensionContext.default;
@ -257,20 +262,21 @@ declare namespace common {
* The event center of a context, support the subscription and publication of events.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* The event center of a context, support the subscription and publication of events.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @atomicservice
* @since 11
*/
/**
* The event center of a context, support the subscription and publication of events.
*
* @typedef { _EventHub.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @crossplatform
@ -283,12 +289,13 @@ declare namespace common {
* Defines a PacMap object for storing a series of values.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* Defines a PacMap object for storing a series of values.
*
* @typedef { _PacMap }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 11
@ -299,14 +306,15 @@ declare namespace common {
* Indicates the result of startAbility.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
/**
* Indicates the result of startAbility.
*
* @typedef { _AbilityResult }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @atomicservice
* @since 11
*/
@ -315,8 +323,9 @@ declare namespace common {
/**
* Indicates the callback of connection
*
* @typedef { _ConnectOptions }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
export type ConnectOptions = _ConnectOptions;
@ -327,7 +336,7 @@ declare namespace common {
*
* @typedef { _UIExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @since 10
*/
export type UIExtensionContext = _UIExtensionContext.default;
@ -339,7 +348,7 @@ declare namespace common {
* @typedef { _AutoFillExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @stagemodelonly
* @since 11
*/
export type AutoFillExtensionContext = _AutoFillExtensionContext.default;
@ -347,8 +356,9 @@ declare namespace common {
/**
* The function Called when some error occurred except disconnected from UIAbility or UIExtensionAbility
*
* @typedef { _AbilityStartCallback }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @stagemodelonly
* @atomicservice
* @since 11
*/
@ -357,9 +367,10 @@ declare namespace common {
/**
* The class of auto startup info.
*
* @typedef { _AutoStartupInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @stagemodelonly
* @since 11
*/
export type AutoStartupInfo = _AutoStartupInfo;
@ -370,7 +381,7 @@ declare namespace common {
* @typedef { _AutoStartupCallback }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @stagemodelonly
* @since 11
*/
export type AutoStartupCallback = _AutoStartupCallback;
@ -380,6 +391,7 @@ declare namespace common {
* vpnExtension-specific resources.
* The class of auto startup info.
*
* @typedef { _VpnExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @since 11
@ -406,6 +418,50 @@ declare namespace common {
* @since 12
*/
export type PhotoEditorExtensionContext = _PhotoEditorExtensionContext.default;
/**
* The context of a UI service ability.
*
* @typedef { _UIServiceExtensionContext.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
export type UIServiceExtensionContext = _UIServiceExtensionContext.default;
/**
* The UI service proxy.
*
* @typedef { _UIServiceProxy.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 13
*/
export type UIServiceProxy = _UIServiceProxy.default;
/**
* The UI service host proxy.
*
* @typedef { _UIServiceHostProxy.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
export type UIServiceHostProxy = _UIServiceHostProxy.default;
/**
* The UI service extension connect callback.
*
* @typedef { _UIServiceExtensionConnectCallback.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 13
*/
export type UIServiceExtensionConnectCallback = _UIServiceExtensionConnectCallback.default;
}
export default common;

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

@ -20,6 +20,7 @@
import type { AsyncCallback } from './@ohos.base';
import type Want from './@ohos.app.ability.Want';
import type { MultiAppMode } from './bundleManager/ApplicationInfo';
/**
* This module provides the capability to manage dialog session.
@ -130,6 +131,28 @@ declare namespace dialogSession {
* @since 12
*/
visible: boolean;
/**
* Index of an application clone. It takes effect only for cloned applications.
*
* @type { number }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
appIndex: number;
/**
* The mode of the multi-application.
*
* @type { MultiAppMode }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
multiAppMode: MultiAppMode;
}
/**

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

@ -186,6 +186,7 @@ declare namespace errorManager {
/**
* The observer will be called by system when an error occurs.
*
* @typedef { _ErrorObserver.default }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 11
@ -194,6 +195,7 @@ declare namespace errorManager {
/**
* The observer will be called when application main thread execute timeout.
*
* @typedef { _LoopObserver }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
@ -202,6 +204,7 @@ declare namespace errorManager {
/**
* The observer will be called by system when an unhandled rejection occurs.
*
* @typedef { function }
* { Error | any } reason - the reason of the rejection, typically of Error type
* { Promise<any> } promise - the promise that is rejected
* @syscap SystemCapability.Ability.AbilityRuntime.Core

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

@ -28,7 +28,6 @@ import StartOptions from './@ohos.app.ability.StartOptions';
* This module provides the capability to manage abilities and obtaining system task information.
*
* @namespace missionManager
* @permission ohos.permission.MANAGE_MISSIONS
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
* @systemapi
* @since 9
@ -500,7 +499,7 @@ declare namespace missionManager {
/**
* Mission information corresponding to ability.
*
* @permission ohos.permission.MANAGE_MISSIONS
* @typedef { _MissionInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
* @systemapi
* @since 9
@ -510,7 +509,7 @@ declare namespace missionManager {
/**
* MissionListener registered by app.
*
* @permission ohos.permission.MANAGE_MISSIONS
* @typedef { _MissionListener }
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
* @systemapi
* @since 9
@ -520,7 +519,7 @@ declare namespace missionManager {
/**
* Mission snapshot corresponding to mission.
*
* @permission ohos.permission.MANAGE_MISSIONS
* @typedef { _MissionSnapshot }
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
* @systemapi
* @since 9

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

@ -384,7 +384,17 @@ declare namespace wantAgent {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
SEND_COMMON_EVENT
SEND_COMMON_EVENT,
/**
* Starts a service extension.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
START_SERVICE_EXTENSION = 6
}
/**

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

@ -246,6 +246,15 @@ declare namespace wantConstant {
* @since 12
*/
APP_CLONE_INDEX_KEY = 'ohos.extra.param.key.appCloneIndex',
/**
* Indicates the param of caller's request code.
*
* @syscap SystemCapability.Ability.AbilityBase
* @atomicservice
* @since 12
*/
CALLER_REQUEST_CODE = 'ohos.extra.param.key.callerRequestCode',
/**
* Indicates the param of page path.

1
api/@ohos.app.businessAbilityRouter.d.ts vendored
View File

@ -139,6 +139,7 @@ declare namespace businessAbilityRouter {
/**
* Obtains business ability info.
*
* @typedef { _BusinessAbilityInfo.BusinessAbilityInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @since 10

16
api/@ohos.application.AccessibilityExtensionAbility.d.ts vendored
View File

@ -35,6 +35,7 @@ import type * as _AccessibilityExtensionContext from './application/Accessibilit
* Indicates an accessibility element.
* Supports querying element attributes, requesting execution actions, and finding child elements by condition.
*
* @typedef {_AccessibilityElement}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -43,6 +44,7 @@ export type AccessibilityElement = _AccessibilityElement;
/**
* Indicates the possible attributes of the element and the type of the attribute value.
*
* @typedef {_ElementAttributeValues}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -51,6 +53,7 @@ export type ElementAttributeValues = _ElementAttributeValues;
/**
* Indicates the direction of the search focus.
*
* @typedef {_FocusDirection}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -59,6 +62,7 @@ export type FocusDirection = _FocusDirection;
/**
* Indicates the key of the attribute value.
*
* @typedef {keyof ElementAttributeValues}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -67,6 +71,7 @@ export type ElementAttributeKeys = keyof ElementAttributeValues;
/**
* Indicates the type of the focus.
*
* @typedef {_FocusType}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -75,6 +80,7 @@ export type FocusType = _FocusType;
/**
* Indicates the type of the window.
*
* @typedef {_WindowType}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -83,6 +89,7 @@ export type WindowType = _WindowType;
/**
* Indicates rectangle.
*
* @typedef {_Rect}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -91,6 +98,7 @@ export type Rect = _Rect;
/**
* The accessibility extension context. Used to configure, query information, and inject gestures.
*
* @typedef {_AccessibilityExtensionContext.default}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
@ -107,6 +115,7 @@ export default class AccessibilityExtensionAbility {
/**
* Indicates accessibility extension ability context.
*
* @type {AccessibilityExtensionContext}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
@ -117,6 +126,7 @@ export default class AccessibilityExtensionAbility {
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
onConnect(): void;
@ -125,6 +135,7 @@ export default class AccessibilityExtensionAbility {
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
onDisconnect(): void;
@ -134,6 +145,7 @@ export default class AccessibilityExtensionAbility {
* @param { AccessibilityEvent } event Indicates an accessibility event.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
onAccessibilityEvent(event: AccessibilityEvent): void;
@ -144,6 +156,7 @@ export default class AccessibilityExtensionAbility {
* @returns { boolean }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
* @deprecated since 12
*/
onKeyEvent(keyEvent: KeyEvent): boolean;
}
@ -224,6 +237,7 @@ declare interface AccessibilityEvent {
* 'fourFingerDoubleTapAndHold' | 'fourFingerTripleTap' | 'fourFingerTripleTapAndHold' |
* 'threeFingerSwipeUp' | 'threeFingerSwipeDown' | 'threeFingerSwipeLeft' | 'threeFingerSwipeRight' |
* 'fourFingerSwipeUp' | 'fourFingerSwipeDown' | 'fourFingerSwipeLeft' | 'fourFingerSwipeRight' }
* @typedef {'left' | 'leftThenRight' | 'leftThenUp' | 'leftThenDown' | 'right' | 'rightThenLeft' | 'rightThenUp' | 'rightThenDown' | 'up' | 'upThenLeft' | 'upThenRight' | 'upThenDown' | 'down' | 'downThenLeft' | 'downThenRight' | 'downThenUp' | 'twoFingerSingleTap' | 'twoFingerDoubleTap' | 'twoFingerDoubleTapAndHold' | 'twoFingerTripleTap' | 'twoFingerTripleTapAndHold' | 'threeFingerSingleTap' | 'threeFingerDoubleTap' | 'threeFingerDoubleTapAndHold' | 'threeFingerTripleTap' | 'threeFingerTripleTapAndHold' | 'fourFingerSingleTap' | 'fourFingerDoubleTap' | 'fourFingerDoubleTapAndHold' | 'fourFingerTripleTap' | 'fourFingerTripleTapAndHold' | 'threeFingerSwipeUp' | 'threeFingerSwipeDown' | 'threeFingerSwipeLeft' | 'threeFingerSwipeRight' | 'fourFingerSwipeUp' | 'fourFingerSwipeDown' | 'fourFingerSwipeLeft' | 'fourFingerSwipeRight'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 11
*/
@ -241,6 +255,7 @@ type GestureType = 'left' | 'leftThenRight' | 'leftThenUp' | 'leftThenDown' |
/**
* Indicates the page update type.
*
* @typedef {'pageContentUpdate' | 'pageStateUpdate'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
@ -249,6 +264,7 @@ type PageUpdateType = 'pageContentUpdate' | 'pageStateUpdate';
/**
* Indicates the type of touch event during touch browsing.
*
* @typedef {'touchBegin' | 'touchEnd'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/

11
api/@ohos.application.BackupExtensionAbility.d.ts vendored
View File

@ -137,4 +137,15 @@ export default class BackupExtensionAbility {
* @since 12
*/
getBackupInfo(): string;
/**
* Callback to be called when getting backup/restore process info.
* Developer could override this method to provide the backup/restore process info.
*
* @returns { string } Return the backup/restore process info.
* @syscap SystemCapability.FileManagement.StorageService.Backup
* @StageModelOnly
* @since 12
*/
onProcess(): string;
}

1
api/@ohos.application.DataShareExtensionAbility.d.ts vendored
View File

@ -28,6 +28,7 @@ import dataShare from './@ohos.data.dataShare';
/**
* Struct for a batch update operation.
*
* @typedef { dataShare.UpdateOperation }
* @syscap SystemCapability.DistributedDataManager.DataShare.Provider
* @systemapi
* @stagemodelonly

2
api/@ohos.application.WindowExtensionAbility.d.ts vendored
View File

@ -35,6 +35,7 @@ export default class WindowExtensionAbility {
/**
* Indicates window extension ability context.
*
* @type { WindowExtensionContext }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi hide for inner use.
* @StageModelOnly
@ -80,6 +81,7 @@ export default class WindowExtensionAbility {
* The context of window extension. It allows access to
* windowExtension-specific resources.
*
* @typedef { _WindowExtensionContext }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @stagemodelonly

14
api/@ohos.arkui.StateManagement.d.ts vendored
View File

@ -214,4 +214,18 @@ export declare class UIUtils {
* @since 12
*/
static getTarget<T extends object>(source: T): T;
/**
* Make non-observed data into observed data.
* Support non-observed class, JSON.parse Object and Sendable class.
*
* @param { T } source input source object data.
* @returns { T } proxy object from the source object data.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
static makeObserved<T extends object>(source: T): T;
}

113
api/@ohos.arkui.UIContext.d.ts vendored
View File

@ -972,7 +972,7 @@ export class PromptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
openToast(options: promptAction.ShowToastOptions): Promise<number>;
@ -988,7 +988,7 @@ export class PromptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @since 13
*/
closeToast(toastId: number): void;
@ -1190,6 +1190,39 @@ export class PromptAction {
* @since 12
*/
closeCustomDialog<T extends Object>(dialogContent: ComponentContent<T>): Promise<void>;
/**
* Open the custom dialog.
*
* @param { promptAction.CustomDialogOptions } options - Options.
* @returns { Promise<number> } return the dialog id that will be used by closeCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
openCustomDialog(options: promptAction.CustomDialogOptions): Promise<number>;
/**
* Close the custom dialog.
*
* @param { number } dialogId - the dialog id that returned by openCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
closeCustomDialog(dialogId: number): void;
}
/**
@ -2287,13 +2320,25 @@ export abstract class FrameCallback {
* @atomicservice
* @since 12
*/
abstract onFrame(frameTimeInNano: number): void;
onFrame(frameTimeInNano: number): void;
/**
* Called at the end of the next idle frame. If there is no next frame, will request one automatically.
*
* @param { number } timeLeftInNano - The remaining time from the deadline for this frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onIdle(timeLeftInNano: number): void;
}
/**
* The base context of an ability or an application. It allows access to
* application-specific resources.
*
* @typedef { common.Context } Context
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @crossplatform
@ -2358,6 +2403,8 @@ export class ComponentSnapshot {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @throws { BusinessError } 160001 - An image component in builder is not ready for taking a snapshot. The check for
* the ready state is required when the checkImageStatus option is enabled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -2379,6 +2426,8 @@ export class ComponentSnapshot {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @throws { BusinessError } 160001 - An image component in builder is not ready for taking a snapshot. The check for
* the ready state is required when the checkImageStatus option is enabled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -2386,6 +2435,27 @@ export class ComponentSnapshot {
*/
createFromBuilder(builder: CustomBuilder, delay?: number,
checkImageStatus?: boolean, options?: componentSnapshot.SnapshotOptions): Promise<image.PixelMap>;
/**
* Take a screenshot of the specified component in synchronous mode,
* this mode will block the main thread, please use it with caution, the maximum
* waiting time of the interface is 3s, if it does not return after 3s, an exception will be thrown.
*
* @param { string } id - Target component ID, set by developer through .id attribute.
* @param { componentSnapshot.SnapshotOptions } [options] - Define the snapshot options.
* @returns { image.PixelMap } The snapshot result in PixelMap format.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Invalid ID.
* @throws { BusinessError } 160002 - Timeout.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getSync(id: string, options?: componentSnapshot.SnapshotOptions): image.PixelMap;
}
/**
@ -2841,6 +2911,18 @@ export class UIContext {
*/
getFrameNodeById(id: string): FrameNode | null;
/**
* Get the FrameNode attached to current window by id.
*
* @param { string } id - The id of FrameNode.
* @returns { FrameNode | null } The instance of FrameNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getAttachedFrameNodeById(id: string): FrameNode | null;
/**
* Get FrameNode by uniqueId.
*
@ -3129,10 +3211,31 @@ export class UIContext {
* @throws { BusinessError } 202 - The caller is not a system application.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @atomicservice
* @since 12
*/
clearResourceCache(): void;
/**
* Checks whether current font scale follows the system.
*
* @returns { boolean } Returns true if current font scale follows the system; returns false otherwise.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
isFollowingSystemFontScale(): boolean;
/**
* Get the max font scale.
*
* @returns { number } The max font scale.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 13
*/
getMaxFontScale(): number;
}
/**
@ -3191,4 +3294,4 @@ export const enum SwiperDynamicSyncSceneType {
* @since 12
*/
ANIMATION = 1
}
}

9
api/@ohos.arkui.advanced.ComposeTitleBar.d.ets
View File

@ -49,6 +49,15 @@ export declare class ComposeTitleBarMenuItem {
*/
value: ResourceStr;
/**
* Icon label for this menu item.
* @type { ?ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
label?: ResourceStr;
/**
* Whether to enable this menu item.
* @type { ?boolean }.

57
api/@ohos.arkui.advanced.Dialog.d.ets
View File

@ -837,60 +837,3 @@ export declare struct CustomContentDialog {
*/
themeColorMode?: ThemeColorMode;
}
/**
* Declare struct PopupDialog
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
export declare struct PopupDialog {
/**
* Sets the PopupDialog Visible Status.
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Link
show: boolean;
/**
* Sets the PopupDialog options.
*
* @type { PopupDialogOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
popup: PopupDialogOptions;
/**
* Sets the targetBuilder content.
*
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@BuilderParam targetBuilder: Callback<void>;
}
/**
* Defines PopupDialog Options
*
* @interface PopupDialogOptions
* @extends CustomPopupOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare interface PopupDialogOptions extends CustomPopupOptions {
}

2
api/@ohos.arkui.advanced.FoldSplitContainer.d.ets
View File

@ -98,7 +98,7 @@ export interface ExpandedRegionLayoutOptions {
/**
* The layout options for the container when the foldable screen is in hover mode.
*
* @interface SemiFoldedRegionLayoutOptions
* @typedef HoverModeRegionLayoutOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12

81
api/@ohos.arkui.advanced.InnerFullScreenLaunchComponent.d.ets Normal file
View File

@ -0,0 +1,81 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file Defines the inner fullScreen launch component for system applications
* @kit ArkUI
*/
import AtomicServiceOptions from '@ohos.app.ability.AtomicServiceOptions';
import Callback from '@ohos.base';
/**
* Declare component InnerFullScreenLaunchComponent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
@Component
export declare struct InnerFullScreenLaunchComponent {
/**
* Sets the component content.
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
@BuilderParam content: Callback<void>;
/**
* Sets the component Controller.
* @type { LaunchController }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
controller: LaunchController;
}
/**
* Declare type LaunchController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
export declare class LaunchController {
/**
* Function to launch atomicservice.
*
* @type { LaunchAtomicServiceCallback }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
**/
public launchAtomicService: LaunchAtomicServiceCallback;
}
/**
* Callback for launch atomicservice.
*
* @typedef { function } LaunchAtomicServiceCallback
* @param { string } appId - appId of atomicservice.
* @param { AtomicServiceOptions } [options] - options that could be empty.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
**/
export declare type LaunchAtomicServiceCallback = (appId: string, options?: AtomicServiceOptions) => void;

9
api/@ohos.arkui.advanced.SelectTitleBar.d.ets
View File

@ -49,6 +49,15 @@ export declare class SelectTitleBarMenuItem {
*/
value: ResourceStr;
/**
* Icon label for this menu item.
* @type { ?ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
label?: ResourceStr;
/**
* Whether to enable this menu item.
* @type { ?boolean }.

9
api/@ohos.arkui.advanced.TabTitleBar.d.ets
View File

@ -49,6 +49,15 @@ export declare class TabTitleBarMenuItem {
*/
value: ResourceStr;
/**
* Icon label for this menu item.
* @type { ?ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
label?: ResourceStr;
/**
* Whether to enable this menu item.
* @type { ?boolean }.

140
api/@ohos.arkui.advanced.ToolBar.d.ets
View File

@ -21,7 +21,8 @@
import { SymbolGlyphModifier, DividerModifier } from './@ohos.arkui.modifier';
import { LengthMetrics } from './@ohos.arkui.node';
/**
* Declare enum ItemState
* @enum { ItemState }
@ -74,6 +75,37 @@ export declare enum ItemState {
ACTIVATE = 3
}
/**
* Defines toolBar symbolGlyph options.
*
* @interface ToolBarSymbolGlyphOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
export interface ToolBarSymbolGlyphOptions {
/**
* Modifier of toolbar's normal symbol.
*
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
normal?: SymbolGlyphModifier;
/**
* Modifier of toolbar's activated symbol.
*
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
activated?: SymbolGlyphModifier;
}
/**
* Declare type ToolBarOption
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -143,6 +175,47 @@ export declare class ToolBarOption {
* @since 11
*/
state?: ItemState;
/**
* Define text fontColor.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
textColor?: ResourceColor;
/**
* Text fontColor when the item is activated.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
activatedTextColor?: ResourceColor;
/**
* Define icon fillColor.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
iconColor?: ResourceColor;
/**
* Icon fillColor when the item is activated.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
activatedIconColor?: ResourceColor;
/**
* Item symbol icon.
*
* @type { ?ToolBarSymbolGlyphOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
toolBarSymbolOptions?: ToolBarSymbolGlyphOptions;
}
/**
@ -160,6 +233,55 @@ export declare class ToolBarOption {
export declare class ToolBarOptions extends Array<ToolBarOption> {
}
/**
* Declare ToolBarModifier use in ToolBar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
export declare class ToolBarModifier {
/**
* Sets the height of the toolBar.
*
* @param { LengthMetrics } height - toolBar's height.
* @returns { ToolBarModifier } returns the instance of the ToolBarModifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
height(height: LengthMetrics): ToolBarModifier;
/**
* Sets the backgroundColor of the toolBar.
*
* @param { ResourceColor } backgroundColor - toolBar's backgroundColor.
* @returns { ToolBarModifier } returns the instance of the ToolBarModifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
backgroundColor(backgroundColor: ResourceColor): ToolBarModifier;
/**
* Sets the left and right padding of the toolbar.
*
* @param { LengthMetrics } padding - left and right padding.
* @returns { ToolBarModifier } returns the instance of the ToolBarModifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
padding(padding: LengthMetrics): ToolBarModifier;
/**
* Sets whether or not to display the press status effect.
*
* @param { boolean } stateEffect - press status effect.
* @returns { ToolBarModifier } returns the instance of the ToolBarModifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
stateEffect(stateEffect: boolean): ToolBarModifier;
}
/**
* Declare Component ToolBar
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -215,4 +337,20 @@ export declare struct ToolBar {
* @since 11
*/
controller: TabsController;
/**
* Define divider Modifier.
* @type { ?DividerModifier }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
@Prop dividerModifier?: DividerModifier;
/**
* Define toolbar modifier.
* @type { ?ToolBarModifier }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 13
*/
@Prop toolBarModifier?: ToolBarModifier;
}

25
api/@ohos.arkui.componentSnapshot.d.ts vendored
View File

@ -163,6 +163,8 @@ declare namespace componentSnapshot {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @throws { BusinessError } 160001 - An image component in builder is not ready for taking a snapshot. The check for
* the ready state is required when the checkImageStatus option is enabled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -198,6 +200,8 @@ declare namespace componentSnapshot {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @throws { BusinessError } 160001 - An image component in builder is not ready for taking a snapshot. The check for
* the ready state is required when the checkImageStatus option is enabled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -205,6 +209,27 @@ declare namespace componentSnapshot {
*/
function createFromBuilder(builder: CustomBuilder, delay?: number,
checkImageStatus?: boolean, options?: SnapshotOptions): Promise<image.PixelMap>;
/**
* Take a screenshot of the specified component in synchronous mode,
* this mode will block the main thread, please use it with caution, the maximum
* waiting time of the interface is 3s, if it does not return after 3s, an exception will be thrown.
*
* @param { string } id - Target component ID, set by developer through .id attribute.
* @param { SnapshotOptions } [options] - Define the snapshot options.
* @returns { image.PixelMap } The snapshot result in PixelMap format.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Invalid ID.
* @throws { BusinessError } 160002 - Timeout.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function getSync(id: string, options?: SnapshotOptions): image.PixelMap;
}
export default componentSnapshot;

4
api/@ohos.arkui.componentUtils.d.ts vendored
View File

@ -785,18 +785,20 @@ declare namespace componentUtils {
/**
* The matrix is column-first fourth-order matrix.
* @typedef Matrix4Result
* @typedef { [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] } Matrix4Result
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* The matrix is column-first fourth-order matrix.
* @typedef { [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] } Matrix4Result
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 11
*/
/**
* The matrix is column-first fourth-order matrix.
* @typedef { [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] } Matrix4Result
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

22
api/@ohos.arkui.modifier.d.ts vendored
View File

@ -596,4 +596,24 @@ export { AttributeUpdater } from './arkui/AttributeUpdater';
* @atomicservice
* @since 12
*/
export { ContainerSpanModifier } from './arkui/ContainerSpanModifier';
export { ContainerSpanModifier } from './arkui/ContainerSpanModifier';
/**
* Export ContainerSpanModifier, which is used to expose applyNormalAttribute function.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { SymbolSpanModifier } from './arkui/SymbolSpanModifier';
/**
* Export ParticleModifier, which is used to expose applyNormalAttribute function.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { ParticleModifier } from './arkui/ParticleModifier';

9
api/@ohos.arkui.node.d.ts vendored
View File

@ -33,6 +33,15 @@
*/
export { NodeRenderType, RenderOptions, BuilderNode } from './arkui/BuilderNode';
/**
* Export BuildOptions which is used to create a node trees by builder function and manage the update of the tree.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { BuildOptions } from './arkui/BuilderNode';
/**
* Export NodeController, which defines the controller of node container. Provides lifecycle callbacks for the associated NodeContainer
* and methods to control the child node of the NodeContainer.

30
api/@ohos.arkui.shape.d.ts vendored
View File

@ -27,6 +27,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface ShapeSize {
@ -35,6 +36,7 @@ interface ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
width?: number | string;
@ -44,6 +46,7 @@ interface ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
height?: number | string;
@ -56,6 +59,7 @@ interface ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface RectShapeOptions extends ShapeSize {
@ -64,6 +68,7 @@ interface RectShapeOptions extends ShapeSize {
* @type { ? (number | string | Array<number | string>) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radius?: number | string | Array<number | string>;
@ -76,6 +81,7 @@ interface RectShapeOptions extends ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface RoundRectShapeOptions extends ShapeSize {
@ -84,6 +90,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radiusWidth?: number | string;
@ -93,6 +100,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radiusHeight?: number | string;
@ -105,6 +113,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface PathShapeOptions {
@ -113,6 +122,7 @@ interface PathShapeOptions {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
commands?: string;
@ -124,6 +134,7 @@ interface PathShapeOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare class CommonShapeMethod<T> {
@ -135,6 +146,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
offset(offset: Position): T;
@ -147,6 +159,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
fill(color: ResourceColor): T;
@ -159,6 +172,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
position(position: Position): T;
@ -171,6 +185,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare class BaseShape<T> extends CommonShapeMethod<T> {
@ -182,6 +197,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
width(width: Length): T;
@ -194,6 +210,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
height(height: Length): T;
@ -206,6 +223,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
size(size: SizeOptions): T;
@ -218,6 +236,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class RectShape extends BaseShape<RectShape> {
@ -228,6 +247,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: RectShapeOptions | RoundRectShapeOptions);
@ -240,6 +260,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radiusWidth(rWidth: number | string): RectShape;
@ -252,6 +273,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radiusHeight(rHeight: number | string): RectShape;
@ -264,6 +286,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radius(radius: number | string | Array<number | string>): RectShape;
@ -276,6 +299,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class CircleShape extends BaseShape<CircleShape> {
@ -286,6 +310,7 @@ export declare class CircleShape extends BaseShape<CircleShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: ShapeSize);
@ -298,6 +323,7 @@ export declare class CircleShape extends BaseShape<CircleShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class EllipseShape extends BaseShape<EllipseShape> {
@ -308,6 +334,7 @@ export declare class EllipseShape extends BaseShape<EllipseShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: ShapeSize);
@ -320,6 +347,7 @@ export declare class EllipseShape extends BaseShape<EllipseShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class PathShape extends CommonShapeMethod<PathShape> {
@ -330,6 +358,7 @@ export declare class PathShape extends CommonShapeMethod<PathShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: PathShapeOptions);
@ -342,6 +371,7 @@ export declare class PathShape extends CommonShapeMethod<PathShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
commands(commands: string): PathShape;

11
api/@ohos.arkui.uiExtension.d.ts vendored
View File

@ -27,6 +27,7 @@ import window from './@ohos.window';
*
* @namespace uiExtension
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare namespace uiExtension {
@ -35,6 +36,7 @@ declare namespace uiExtension {
*
* @interface WindowProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface WindowProxy {
@ -48,6 +50,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getWindowAvoidArea(type: window.AvoidAreaType): window.AvoidArea;
@ -62,6 +65,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
on(type: 'avoidAreaChange', callback: Callback<AvoidAreaInfo>): void;
@ -76,6 +80,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
off(type: 'avoidAreaChange', callback?: Callback<AvoidAreaInfo>): void;
@ -90,6 +95,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
on(type: 'windowSizeChange', callback: Callback<window.Size>): void;
@ -104,6 +110,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
off(type: 'windowSizeChange', callback?: Callback<window.Size>): void;
@ -138,6 +145,7 @@ declare namespace uiExtension {
* @throws { BusinessError } 1300005 - This window proxy is abnormal.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @StageModelOnly
* @atomicservice
* @since 12
*/
createSubWindowWithOptions(name: string, subWindowOptions: window.SubWindowOptions): Promise<window.Window>;
@ -162,6 +170,7 @@ declare namespace uiExtension {
*
* @interface AvoidAreaInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface AvoidAreaInfo {
@ -170,6 +179,7 @@ declare namespace uiExtension {
*
* @type { window.AvoidAreaType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type: window.AvoidAreaType;
@ -179,6 +189,7 @@ declare namespace uiExtension {
*
* @type { window.AvoidArea }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
area: window.AvoidArea;

1
api/@ohos.atomicservice.AtomicServiceNavigation.d.ets
View File

@ -189,6 +189,7 @@ export interface TitleOptions {
* @type { ?BarStyle }
* @default BarStyle.STANDARD
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
barStyle?: BarStyle;

287
api/@ohos.atomicservice.AtomicServiceWeb.d.ets
View File

@ -38,6 +38,46 @@ export declare struct AtomicServiceWeb {
* @since 12
*/
src: ResourceStr;
/**
* Sets the controller of the AtomicServiceWeb.
*
* @type { AtomicServiceWebController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@ObjectLink
controller: AtomicServiceWebController;
/**
* Sets how to load HTTP and HTTPS content.
*
* @type { ?MixedMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Prop
mixedMode?: MixedMode;
/**
* Sets the dark mode of Web.
*
* @type { ?WebDarkMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Prop
darkMode?: WebDarkMode;
/**
* Sets whether to enable forced dark algorithm when the web is in dark mode.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Prop
forceDarkAccess?: boolean;
/**
* The navPathStack to control page route in Navigation and NavDestination.
*
@ -92,6 +132,34 @@ export declare struct AtomicServiceWeb {
* @since 12
*/
onPageEnd?: Callback<OnPageEndEvent>;
/**
* Triggered when The controller is bound to the web component, this controller must be a WebviewController.
* This callback can not use the interface about manipulating web pages.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onControllerAttached?: Callback<void>;
/**
* Triggered when the resources loading is intercepted.
*
* @type { ?OnLoadInterceptCallback }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onLoadIntercept?: OnLoadInterceptCallback;
/**
* Triggered when the page loading progress changes.
*
* @type { ?Callback<OnProgressChangeEvent> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onProgressChange?: Callback<OnProgressChangeEvent>;
}
/**
@ -213,3 +281,222 @@ export declare interface OnPageEndEvent {
*/
url: string;
}
/**
* Load intercept event when the resources loading is intercepted.
*
* @typedef OnLoadInterceptEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare interface OnLoadInterceptEvent {
/**
* Web resource request of event.
*
* @type { WebResourceRequest }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data: WebResourceRequest;
}
/**
* Progress change event when the page loading progress changes.
*
* @typedef OnProgressChangeEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare interface OnProgressChangeEvent {
/**
* The new progress of the page.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
newProgress: number;
}
/**
* Provides methods for controlling the AtomicServiceWeb controller.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Observed
export declare class AtomicServiceWebController {
/**
* Gets the default user agent.
*
* @returns { string } Return user agent information.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getUserAgent(): string;
/**
* Get custom user agent.
*
* @returns { string } Get custom User agent information.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getCustomUserAgent(): string;
/**
* Set custom user agent.
*
* @param { string } userAgent - User custom agent information.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
setCustomUserAgent(userAgent: string): void;
/**
* Refreshes the current URL.
*
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
refresh(): void;
/**
* Goes forward in the history of the web page.
*
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
forward(): void;
/**
* Goes back in the history of the web page.
*
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
backward(): void;
/**
* Checks whether the web page can go forward.
*
* @returns { boolean } True if the web page can go forward else false.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
accessForward(): boolean;
/**
* Checks whether the web page can go back.
*
* @returns { boolean } True if the web page can go back else false.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
accessBackward(): boolean;
/**
* Checks whether the web page can go back or forward the given number of steps.
*
* @param { number } step - The number of steps.
* @returns { boolean } True if the web page can go back else false.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3.Parameter verification failed.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
accessStep(step: number): boolean;
/**
* Loads the URL.
*
* @param { string | Resource } url - The URL to load.
* @param { Array<WebHeader> } [headers] - Additional HTTP request header for URL.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3.Parameter verification failed.
* @throws { BusinessError } 17100001 - Init error. The AtomicServiceWebController must be associated with a
* AtomicServiceWeb component.
* @throws { BusinessError } 17100002 - Invalid url.
* @throws { BusinessError } 17100003 - Invalid resource path or file type.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
loadUrl(url: string | Resource, headers?: Array<WebHeader>): void;
}
/**
* Defines the Web's request/response header.
*
* @typedef WebHeader
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare interface WebHeader {
/**
* Gets the key of the request/response header.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
headerKey: string;
/**
* Gets the value of the request/response header.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
headerValue: string;
}
/**
* Callback for OnLoadIntercept
*
* @typedef { function } OnLoadIntercept Function.
* @param { OnLoadInterceptEvent } event - the load intercept event when the resources loading is intercepted.
* @returns { boolean } True if the load is intercepted else false.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export type OnLoadInterceptCallback = (event: OnLoadInterceptEvent) => boolean;

229
api/@ohos.atomicservice.NavPushPathHelper.d.ets Normal file
View File

@ -0,0 +1,229 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file Defines provides a push method for the target page in the routing table.
* @kit ArkUI
*/
/**
* provides a push method for the target page in the routing table.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare class NavPushPathHelper {
/**
* The constructor used to create a NavPushPathHelper object.
*
* @param { NavPathStack } navPathStack - The stack of the route table.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
constructor(navPathStack: NavPathStack);
/**
* Pushes the route page into the stack.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushPath(moduleName: string, info: NavPathInfo, animated?: boolean): Promise<void>;
/**
* Pushes the NavDestination into the stack.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the NavDestination to be pushed.
* @param { NavigationOptions } [options] - Indicates options of stack operation.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushPath(moduleName: string, info: NavPathInfo, options?: NavigationOptions): Promise<void>;
/**
* Pushes the route page into the stack.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushDestination(moduleName: string, info: NavPathInfo, animated?: boolean): Promise<void>;
/**
* Pushes the NavDestination into the stack.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the NavDestination to be pushed.
* @param { NavigationOptions } [options] - Indicates options of stack operation.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameters types.
* 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushDestination(moduleName: string, info: NavPathInfo, options?: NavigationOptions): Promise<void>;
/**
* Pushes the specified route page into the stack.
*
* @param { string } moduleName - Module name
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { unknown } param - Indicates the detailed parameter of the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushPathByName(moduleName: string, name: string, param: unknown, animated?: boolean): Promise<void>;
/**
* Pushes the specified route page into the stack.
*
* @param { string } moduleName - Module name
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { Callback<PopInfo> } onPop - The callback when next page returns.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushPathByName(moduleName: string, name: string, param: Object,
onPop: Callback<PopInfo>, animated?: boolean): Promise<void>;
/**
* Pushes the specified route page into the stack.
*
* @param { string } moduleName - Module name
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushDestinationByName(moduleName: string, name: string, param: Object, animated?: boolean): Promise<void>;
/**
* Pushes the specified route page into the stack.
*
* @param { string } moduleName - Module name
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { Callback<PopInfo> } onPop - The callback when next page returns.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pushDestinationByName(moduleName: string, name: string, param: Object,
onPop: Callback<PopInfo>, animated?: boolean): Promise<void>;
/**
* replace the current page with the specific one.The current page will be destroyed.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the the new route page in top of the stack.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
replacePath(moduleName: string, info: NavPathInfo, animated?: boolean): Promise<void>;
/**
* Replace the current NavDestination with the specific one.The current NavDestination will be destroyed.
*
* @param { string } moduleName - Module name
* @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack.
* @param { NavigationOptions } [options] - Indicates options of stack operation.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
replacePath(moduleName: string, info: NavPathInfo, options?: NavigationOptions): Promise<void>;
/**
* replace the current page with the specific one.The current page will be destroyed.
*
* @param { string } moduleName - Module name
* @param { string } name - Indicates name of the new route page in top of stack.
* @param { Object } param - Indicates the detailed parameter of the new route page in top of the stack.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 300001 - hsp silent install fail.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
replacePathByName(moduleName: string, name: string, param: Object, animated?: boolean): Promise<void>;
}

4
api/@ohos.bluetooth.a2dp.d.ts vendored
View File

@ -391,6 +391,7 @@ declare namespace a2dp {
/**
* codec type
*
* @type { CodecType }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 11
*/
@ -398,6 +399,7 @@ declare namespace a2dp {
/**
* codec bits per sample.
*
* @type { CodecBitsPerSample }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 11
*/
@ -405,6 +407,7 @@ declare namespace a2dp {
/**
* codec channel mode.
*
* @type { CodecChannelMode }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 11
*/
@ -412,6 +415,7 @@ declare namespace a2dp {
/**
* codec sample rate.
*
* @type { CodecSampleRate }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 11
*/

2
api/@ohos.bluetooth.baseProfile.d.ts vendored
View File

@ -136,6 +136,7 @@ declare namespace baseProfile {
/**
* The address of device
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -144,6 +145,7 @@ declare namespace baseProfile {
/**
* Profile state value
*
* @type { ProfileConnectionState }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/

175
api/@ohos.bluetooth.ble.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

29
api/@ohos.bluetooth.connection.d.ts vendored
View File

@ -839,21 +839,6 @@ declare namespace connection {
*/
function disconnectAllowedProfiles(deviceId: string): Promise<void>;
/**
* Modify remote device name.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @param { string } name - New device name. Max length is 64 bytes.
* @returns { Promise<void> } Returns the promise object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
/**
* Modify remote device name.
*
@ -1098,6 +1083,7 @@ declare namespace connection {
/**
* Address of a Bluetooth device.
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1105,6 +1091,7 @@ declare namespace connection {
/**
* Profile connection state of the device.
*
* @type { BondState }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1112,6 +1099,7 @@ declare namespace connection {
/**
* Cause of unbond.
*
* @type { UnbondCause }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
@ -1129,6 +1117,7 @@ declare namespace connection {
/**
* ID of the device to pair.
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1136,6 +1125,7 @@ declare namespace connection {
/**
* Key for the device pairing.
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1143,6 +1133,7 @@ declare namespace connection {
/**
* Indicates the pairing type to a peer device.
*
* @type { PinType }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
@ -1161,6 +1152,7 @@ declare namespace connection {
/**
* Major classes of Bluetooth devices.
*
* @type { MajorClass }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1168,6 +1160,7 @@ declare namespace connection {
/**
* Major and minor classes of Bluetooth devices.
*
* @type { MajorMinorClass }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1175,6 +1168,7 @@ declare namespace connection {
/**
* Class of the device.
*
* @type { number }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -1404,6 +1398,7 @@ declare namespace connection {
/**
* Identify of the discovery device
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
@ -1412,6 +1407,7 @@ declare namespace connection {
/**
* RSSI of the remote device
*
* @type { number }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
@ -1420,6 +1416,7 @@ declare namespace connection {
/**
* The local name of the device
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
@ -1428,6 +1425,7 @@ declare namespace connection {
/**
* The class of the device
*
* @type { DeviceClass }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
@ -1446,6 +1444,7 @@ declare namespace connection {
/**
* Identify of the discovery device.
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12

3
api/@ohos.bluetooth.socket.d.ts vendored
View File

@ -169,6 +169,7 @@ declare namespace socket {
/**
* Indicates the UUID in the SDP record.
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -176,6 +177,7 @@ declare namespace socket {
/**
* Indicates secure channel or not
*
* @type { boolean }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
@ -183,6 +185,7 @@ declare namespace socket {
/**
* Spp link type
*
* @type { SppType }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/

20
api/@ohos.buffer.d.ts vendored
View File

@ -46,12 +46,14 @@ declare namespace buffer {
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -59,6 +61,7 @@ declare namespace buffer {
/**
* This parameter specifies the type of a common encoding format.
*
* @typedef { 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -91,7 +94,9 @@ declare namespace buffer {
*/
/**
* TypedArray inherits the features and methods of Int8Array
*
* @interface TypedArray
* @extends Int8Array
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -719,6 +724,7 @@ declare namespace buffer {
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -726,6 +732,7 @@ declare namespace buffer {
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -734,6 +741,7 @@ declare namespace buffer {
/**
* Returns the number of bytes in buf
*
* @type { number }
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -745,6 +753,7 @@ declare namespace buffer {
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -752,6 +761,7 @@ declare namespace buffer {
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -760,6 +770,7 @@ declare namespace buffer {
/**
* The underlying ArrayBuffer object based on which this Buffer object is created.
*
* @type { ArrayBuffer }
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -771,6 +782,7 @@ declare namespace buffer {
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @since 9
@ -778,6 +790,7 @@ declare namespace buffer {
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -786,6 +799,7 @@ declare namespace buffer {
/**
* The byteOffset of the Buffers underlying ArrayBuffer object
*
* @type { number }
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
@ -3369,12 +3383,14 @@ declare namespace buffer {
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -3382,6 +3398,7 @@ declare namespace buffer {
/**
* The total size of the Blob in bytes
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
@ -3392,12 +3409,14 @@ declare namespace buffer {
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
@ -3405,6 +3424,7 @@ declare namespace buffer {
/**
* The content-type of the Blob
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice

55
api/@ohos.bundle.appDomainVerify.d.ts vendored Normal file
View File

@ -0,0 +1,55 @@
/*
* Copyright (c) Huawei Technologies Co., Ltd. 2024-2024. All rights reserved.
*/
/**
* @file Define capabilities to access app domain verification info.
* @kit AbilityKit
*/
/**
* This module provides app domain verification info.
*
* @namespace appDomainVerify
* @syscap SystemCapability.BundleManager.AppDomainVerify
* @systemapi
* @stagemodelonly
* @since 12
*/
declare namespace appDomainVerify {
/**
* query domains verify associated with bundleName.
* @permission ohos.permission.GET_APP_DOMAIN_BUNDLE_INFO
* @param { string } bundleName - app bundleName.
* @returns { string[] } Result domains.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - System API accessed by non-system app.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 29900001 - Internal error.
* @syscap SystemCapability.BundleManager.AppDomainVerify
* @systemapi
* @stagemodelonly
* @since 12
*/
function queryAssociatedDomains(bundleName: string): string[];
/**
* query bundleNames associated with domain.
* @permission ohos.permission.GET_APP_DOMAIN_BUNDLE_INFO
* @param { string } domain - Parameters related to the function.
* @returns { string[] } Result bundleNames.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - System API accessed by non-system app.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 29900001 - Internal error.
* @syscap SystemCapability.BundleManager.AppDomainVerify
* @systemapi
* @stagemodelonly
* @since 12
*/
function queryAssociatedBundleNames(domain: string): string[];
}
export default appDomainVerify;

65
api/@ohos.bundle.bundleManager.d.ts vendored
View File

@ -256,6 +256,32 @@ declare namespace bundleManager {
* @since 12
*/
GET_BUNDLE_INFO_WITH_SKILL = 0x00000800,
/**
* Used to return only the applications that have an icon displayed on the homescreen.
* Only effective on {@link getAllBundleInfo}
*
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
GET_BUNDLE_INFO_ONLY_WITH_LAUNCHER_ABILITY = 0x00001000,
/**
* Used to obtain the bundleInfo only if any user installed
*
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
GET_BUNDLE_INFO_OF_ANY_USER = 0x00002000,
/**
* Used to return all applications that exclude app clone information.
* Only effective on {@link getAllBundleInfo}
*
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
GET_BUNDLE_INFO_EXCLUDE_CLONE = 0x00004000,
}
/**
@ -1367,6 +1393,25 @@ declare namespace bundleManager {
APP_CLONE = 2,
}
/**
* This enumeration value is used to identify various flags of application
*
* @enum { number }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
export enum ApplicationInfoFlag {
/**
* Indicates The application is currently installed for the calling user.
*
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
FLAG_INSTALLED = 0x00000001,
}
/**
* Obtains own bundleInfo.
*
@ -3604,16 +3649,6 @@ declare namespace bundleManager {
*/
export type RecoverableApplicationInfo = _RecoverableApplicationInfo;
/**
* Indicates the information of preinstalled application.
*
* @typedef { _PreinstalledApplicationInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
export type PreinstalledApplicationInfo = _PreinstalledApplicationInfo;
/**
* Obtains configuration information about an skill
*
@ -3633,6 +3668,16 @@ declare namespace bundleManager {
* @since 12
*/
export type SkillUrl = _Skill.SkillUri;
/**
* Indicates the information of preinstalled application.
*
* @typedef { _PreinstalledApplicationInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
export type PreinstalledApplicationInfo = _PreinstalledApplicationInfo;
}
export default bundleManager;

1
api/@ohos.bundle.bundleMonitor.d.ts vendored
View File

@ -70,6 +70,7 @@ declare namespace bundleMonitor {
/**
* Indicates the event type of bundle change
*
* @typedef { 'add' | 'update' | 'remove' }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 9

1
api/@ohos.bundle.d.ts vendored
View File

@ -332,6 +332,7 @@ declare namespace bundle {
/**
* Indicates the user id
*
* @type { ?number }
* @syscap SystemCapability.BundleManager.BundleFramework
* @since 7
* @deprecated since 9

1
api/@ohos.bundle.distributedBundleManager.d.ts vendored
View File

@ -201,6 +201,7 @@ declare namespace distributedBundleManager {
/**
* Contains basic remote ability information.
*
* @typedef { _RemoteAbilityInfo }
* @syscap SystemCapability.BundleManager.DistributedBundleFramework
* @systemapi
* @since 9

12
api/@ohos.bundle.freeInstall.d.ts vendored
View File

@ -257,6 +257,7 @@ declare namespace freeInstall {
/**
* The dispatch info class.
*
* @typedef { _DispatchInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -266,6 +267,7 @@ declare namespace freeInstall {
/**
* The bundle pack info class.
*
* @typedef { _PackInfo.BundlePackInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -275,6 +277,7 @@ declare namespace freeInstall {
/**
* The package info class.
*
* @typedef { _PackInfo.PackageConfig }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -284,6 +287,7 @@ declare namespace freeInstall {
/**
* The package summary class.
*
* @typedef { _PackInfo.PackageSummary }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -293,6 +297,7 @@ declare namespace freeInstall {
/**
* The bundle summary class.
*
* @typedef { _PackInfo.BundleConfigInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -302,6 +307,7 @@ declare namespace freeInstall {
/**
* The extension ability forms class.
*
* @typedef { _PackInfo.ExtensionAbility }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -311,6 +317,7 @@ declare namespace freeInstall {
/**
* The module summary of a bundle.
*
* @typedef { _PackInfo.ModuleConfigInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -320,6 +327,7 @@ declare namespace freeInstall {
/**
* The bundle info summary class.
*
* @typedef { _PackInfo.ModuleDistroInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -329,6 +337,7 @@ declare namespace freeInstall {
/**
* The ability info of a module.
*
* @typedef { _PackInfo.ModuleAbilityInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -338,6 +347,7 @@ declare namespace freeInstall {
/**
* The form info of an ability.
*
* @typedef { _PackInfo.AbilityFormInfo }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -347,6 +357,7 @@ declare namespace freeInstall {
/**
* The bundle version class.
*
* @typedef { _PackInfo.Version }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9
@ -356,6 +367,7 @@ declare namespace freeInstall {
/**
* The bundle Api version class.
*
* @typedef { _PackInfo.ApiVersion }
* @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall
* @systemapi
* @since 9

1
api/@ohos.bundle.innerBundleManager.d.ts vendored
View File

@ -184,6 +184,7 @@ declare namespace innerBundleManager {
/**
* Contains basic Ability information, which uniquely identifies a launcher StatusCallback.
*
* @typedef { _BundleStatusCallback }
* @syscap SystemCapability.BundleManager.BundleFramework
* @systemapi Hide this for inner system use
* @since 8

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