diff --git a/api/@internal/component/ets/action_sheet.d.ts b/api/@internal/component/ets/action_sheet.d.ts index 3f404fc1b2c0d3d518dff90d9ea4c39c1e511e0a..4b191b89bd2eac63dd5667a0fbd8df5dd9c06d95 100644 --- a/api/@internal/component/ets/action_sheet.d.ts +++ b/api/@internal/component/ets/action_sheet.d.ts @@ -121,6 +121,7 @@ interface SheetInfo { */ /** * Callback method after the operation. + * Anonymous Object Rectification. * * @type { VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -191,6 +192,17 @@ interface ActionSheetButtonOptions { * @atomicservice * @since 11 */ + /** + * Enable switch of confirmation button + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @default true + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ enabled?: boolean; /** @@ -210,6 +222,17 @@ interface ActionSheetButtonOptions { * @atomicservice * @since 11 */ + /** + * Default focus switch of confirmation button + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @default false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ defaultFocus?: boolean; /** @@ -229,6 +252,17 @@ interface ActionSheetButtonOptions { * @atomicservice * @since 11 */ + /** + * Style of confirmation button. + * Anonymous Object Rectification. + * + * @type { ?DialogButtonStyle } + * @default DialogButtonStyle.DEFAULT + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ style?: DialogButtonStyle; /** @@ -255,6 +289,16 @@ interface ActionSheetButtonOptions { * @atomicservice * @since 11 */ + /** + * Text content of the confirmation button. + * Anonymous Object Rectification. + * + * @type { string | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ value: string | Resource; /** @@ -283,6 +327,7 @@ interface ActionSheetButtonOptions { */ /** * Method executed by the callback. + * Anonymous Object Rectification. * * @type { VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -305,6 +350,7 @@ interface ActionSheetButtonOptions { interface ActionSheetOffset { /** * Dx of the pop-up window relative to the alignment position. + * Anonymous Object Rectification. * * @type { number | string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -315,6 +361,7 @@ interface ActionSheetOffset { dx: number | string | Resource; /** * Dy of the pop-up window relative to the alignment position. + * Anonymous Object Rectification. * * @type { number | string | Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -468,6 +515,7 @@ interface ActionSheetOptions */ /** * Invoke the commit function. + * Anonymous Object Rectification. * * @type { ?ActionSheetButtonOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -503,6 +551,7 @@ interface ActionSheetOptions */ /** * Execute Cancel Function. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -616,6 +665,7 @@ interface ActionSheetOptions */ /** * Offset of the pop-up window relative to the alignment position. + * Anonymous Object Rectification. * * @type { ?ActionSheetOffset } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -726,28 +776,6 @@ interface ActionSheetOptions */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the actionSheet's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the actionSheet's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Callback function when the actionSheet interactive dismiss * @@ -871,50 +899,6 @@ interface ActionSheetOptions */ hoverModeArea?: HoverModeAreaType; - /** - * Callback function when the dialog appears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidAppear?: Callback; - - /** - * Callback function when the dialog disappears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidDisappear?: Callback; - - /** - * Callback function before the dialog openAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillAppear?: Callback; - - /** - * Callback function before the dialog closeAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillDisappear?: Callback; - /** * Determine the display level of the dialog. * diff --git a/api/@internal/component/ets/alert_dialog.d.ts b/api/@internal/component/ets/alert_dialog.d.ts index 313499a3e3c02d16e527db5466377665d732dcfa..17b32a62ec372e3d79fb06c02801187b984a7f49 100644 --- a/api/@internal/component/ets/alert_dialog.d.ts +++ b/api/@internal/component/ets/alert_dialog.d.ts @@ -373,6 +373,17 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Enable switch of button. + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @default true + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ enabled?: boolean; /** @@ -394,6 +405,17 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Default focus switch of button. + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @default false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ defaultFocus?: boolean; /** @@ -415,6 +437,17 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Style of button. + * Anonymous Object Rectification. + * + * @type { ?DialogButtonStyle } + * @default - + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ style?: DialogButtonStyle; /** @@ -434,6 +467,16 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Text content of button. + * Anonymous Object Rectification. + * + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ value: ResourceStr; /** @@ -453,6 +496,16 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Text color of button. + * Anonymous Object Rectification. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ fontColor?: ResourceColor; /** @@ -472,6 +525,16 @@ declare interface AlertDialogButtonBaseOptions { * @atomicservice * @since 11 */ + /** + * Background color of button. + * Anonymous Object Rectification. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ backgroundColor?: ResourceColor; /** @@ -493,6 +556,7 @@ declare interface AlertDialogButtonBaseOptions { */ /** * Method executed by the callback. + * Anonymous Object Rectification. * * @type { VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -542,6 +606,16 @@ declare interface AlertDialogButtonOptions extends AlertDialogButtonBaseOptions * @atomicservice * @since 12 */ + /** + * Define whether the button responds to Enter/Space key by default. + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ primary?: boolean; } @@ -724,6 +798,7 @@ declare interface AlertDialogParam { */ /** * Execute Cancel Function. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -912,28 +987,6 @@ declare interface AlertDialogParam { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the alertDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the alertDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Callback function when the dialog interactive dismiss * @@ -1068,50 +1121,6 @@ declare interface AlertDialogParam { */ hoverModeArea?: HoverModeAreaType; - /** - * Callback function when the dialog appears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidAppear?: Callback; - - /** - * Callback function when the dialog disappears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidDisappear?: Callback; - - /** - * Callback function before the dialog openAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillAppear?: Callback; - - /** - * Callback function before the dialog closeAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillDisappear?: Callback; - /** * Determine the display level of the dialog. * @@ -1214,6 +1223,7 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { */ /** * Invoke the commit function. + * Anonymous Object Rectification. * * @type { ?AlertDialogButtonBaseOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1311,6 +1321,7 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { */ /** * First button. + * Anonymous Object Rectification. * * @type { AlertDialogButtonBaseOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1346,6 +1357,7 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { */ /** * Second button. + * Anonymous Object Rectification. * * @type { AlertDialogButtonBaseOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@internal/component/ets/alphabet_indexer.d.ts b/api/@internal/component/ets/alphabet_indexer.d.ts index 46a27282cbdcd4c7c115ce73dd1ee562bc781ea4..c809c09254f1853b50106f97f4de2125743f9bab 100644 --- a/api/@internal/component/ets/alphabet_indexer.d.ts +++ b/api/@internal/component/ets/alphabet_indexer.d.ts @@ -144,6 +144,16 @@ interface AlphabetIndexerOptions { * @atomicservice * @since 11 */ + /** + * Alphabetical index string array. + * Anonymous Object Rectification. + * + * @type { Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ arrayValue: Array; /** * ID of the selected item. @@ -169,6 +179,16 @@ interface AlphabetIndexerOptions { * @atomicservice * @since 11 */ + /** + * ID of the selected item. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ selected: number; } @@ -230,6 +250,7 @@ interface AlphabetIndexerInterface { /** * Construct the alphabet indexer component. * Called when the alphabet indexer component is used. + * Anonymous Object Rectification. * * @param { AlphabetIndexerOptions } options - alphabet indexer options * @returns { AlphabetIndexerAttribute } @@ -754,6 +775,7 @@ declare class AlphabetIndexerAttribute extends CommonMethod } callback - callback for selected date changed. * @returns { CalendarPickerAttribute } the attribute of the CalendarPicker. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -315,18 +305,6 @@ declare class CalendarPickerAttribute extends CommonMethod>): CalendarPickerAttribute; - - /** - * Defines whether the calendar picker marks today. - * - * @param { boolean } enabled - whether the calendar picker marks today. - * @returns { CalendarPickerAttribute } the attribute of the calendar picker. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - markToday(enabled: boolean): CalendarPickerAttribute; } /** @@ -364,6 +342,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Called when the OK button in the dialog is clicked. + * Anonymous Object Rectification. * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -389,6 +368,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Called when the Cancel button in the dialog is clicked. + * Anonymous Object Rectification. * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -414,6 +394,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * This event is triggered when a date is selected in dialog. + * Anonymous Object Rectification. * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -464,28 +445,6 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the calendarPickerDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the calendarPickerDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Style of accept button. * @@ -519,6 +478,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function when the dialog appears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -539,6 +499,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function when the dialog disappears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -559,6 +520,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function before the dialog openAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -579,6 +541,7 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function before the dialog closeAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -622,18 +585,6 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @since 14 */ hoverModeArea?: HoverModeAreaType; - - /** - * Defines the calendar picker marks today. - * - * @type { ?boolean } - * @default false - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - markToday?: boolean; } /** diff --git a/api/@internal/component/ets/checkbox.d.ts b/api/@internal/component/ets/checkbox.d.ts index 8a2718bdf318093a455b61ae2f33bb963f569f02..10261869716ca770c8a0fa1bf81aa97e006c9bd2 100644 --- a/api/@internal/component/ets/checkbox.d.ts +++ b/api/@internal/component/ets/checkbox.d.ts @@ -264,6 +264,7 @@ interface CheckboxInterface { /** * Defines a Checkbox callback when onChange. + * Anonymous Object Rectification. * * @typedef { function } OnCheckboxChangeCallback * @param { boolean } value - selected status @@ -558,6 +559,7 @@ declare class CheckboxAttribute extends CommonMethod { */ /** * Called when the selection status changes. + * Anonymous Object Rectification. * * @param { OnCheckboxChangeCallback } callback * @returns { CheckboxAttribute } diff --git a/api/@internal/component/ets/checkboxgroup.d.ts b/api/@internal/component/ets/checkboxgroup.d.ts index 73155224395b0ad57e5aff8ebed347ebb946fd12..7d33b8fd86c87ac39076badec21bfbc102fb1940 100644 --- a/api/@internal/component/ets/checkboxgroup.d.ts +++ b/api/@internal/component/ets/checkboxgroup.d.ts @@ -405,6 +405,7 @@ interface CheckboxGroupInterface { /** * Defines a CheckboxGroup callback when onChange. + * Anonymous Object Rectification. * * @typedef { function } OnCheckboxGroupChangeCallback * @param { CheckboxGroupResult } value - checkbox group result @@ -663,6 +664,7 @@ declare class CheckboxGroupAttribute extends CommonMethod } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ propagation: Callback; @@ -11681,7 +11644,7 @@ declare interface AxisEvent extends BaseEvent { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ getHorizontalAxisValue(): number; @@ -11691,7 +11654,7 @@ declare interface AxisEvent extends BaseEvent { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ getVerticalAxisValue(): number; } @@ -14426,7 +14389,6 @@ declare interface SheetOptions extends BindOptions { * Called when detents of the sheet changed * * @type { ?Callback } - * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -14548,18 +14510,6 @@ declare interface SheetOptions extends BindOptions { */ detentSelection?: SheetSize | Length; - /** - * Whether to display in the sub window - * - * @type { ?boolean } - * @default false - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - showInSubWindow?: boolean; - /** * The placement of popup sheet type. * Supports all positions defined in Placement. @@ -14976,6 +14926,7 @@ declare interface DismissPopupAction { declare interface PopupStateChangeParam { /** * is Visible. + * Anonymous Object Rectification. * * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -15010,6 +14961,7 @@ declare type PopupStateChangeCallback = (event: PopupStateChangeParam) => void; declare interface PopupMaskType { /** * Color. + * Anonymous Object Rectification. * * @type { ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -15287,109 +15239,6 @@ declare interface PopupCommonOptions { followTransformOfTarget?: boolean; } -/** - * Defines the Tips options. - * - * @interface TipsOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface TipsOptions { - - /** - * Defines the delay time for appearing. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - appearingTime?: number; - - /** - * Defines the delay time for disappearing. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - disappearingTime?: number; - - /** - * Define the delay time for the appearance of continuous operations. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - appearingTimeWithContinuousOperation?: number; - - /** - * Define the delay time for the disappearance of continuous operations. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - disappearingTimeWithContinuousOperation?: number; - - /** - * whether show arrow - * - * @type { ?boolean } - * @default true - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - enableArrow?: boolean; - - /** - * The position of the sharp corner of Tips. - * - * @type { ?ArrowPointPosition } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - arrowPointPosition?: ArrowPointPosition; - - /** - * The width of the arrow. - * - * @type { ?Dimension } - * @default 16.0_vp. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - arrowWidth?: Dimension; - - /** - * The height of the arrow. - * - * @type { ?Dimension } - * @default 8.0_vp. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - arrowHeight?: Dimension; -} - /** * Defines the popup options. * @@ -16748,17 +16597,6 @@ interface ContextMenuAnimationOptions { hoverScale?: AnimationRange; } -/** - * Defines the type of border radius. - * - * @typedef { Length | BorderRadiuses | LocalizedBorderRadiuses } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -type BorderRadiusType = Length | BorderRadiuses | LocalizedBorderRadiuses; - /** * Defines the menu haptic feedback mode. * @@ -16919,17 +16757,6 @@ declare interface ContextMenuOptions { */ preview?: MenuPreviewMode | CustomBuilder; - /** - * Defines the border radius for preview of menu. - * - * @type { BorderRadiusType } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - previewBorderRadius?: BorderRadiusType; - /** * Defines the border radius of menu. * @@ -18263,51 +18090,6 @@ declare enum DragPreviewMode { * @since 18 */ ENABLE_MULTI_TILE_EFFECT = 6, - /** - * Enable the touch point calculation position based on final preview rect. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - ENABLE_TOUCH_POINT_CALCULATION_BASED_ON_FINAL_PREVIEW = 7, -} - -/** - * Define drag start animation effect from drag preview to the handle drag image - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ -declare enum DraggingSizeChangeEffect { - /** - * Default effect, no transition. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - DEFAULT = 0, - - /** - * Only scaled transition, this parameter take effect when PREVIEW_MODE is not DISABLE_SCALE. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - SIZE_TRANSITION = 1, - - /** - * Scaled and content transition together, this size transition take effect when PREVIEW_MODE is not DISABLE_SCALE. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - SIZE_CONTENT_TRANSITION = 2, } /** @@ -18460,16 +18242,6 @@ declare interface DragPreviewOptions { * @since 18 */ numberBadge?: boolean | number; - - /** - * Drag start animation effect from drag preview to the handle drag image. - * - * @type { ?DraggingSizeChangeEffect } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - sizeChangeEffect?: DraggingSizeChangeEffect; } /** @@ -18502,24 +18274,24 @@ declare interface DragInteractionOptions { defaultAnimationBeforeLifting?: boolean; /** - * Config if auto scrolling should be triggered when the drag hovered on a scrollable controller's edge. + * Define whether to enable the haptic feedback when dragging, the default value is false. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice * @since 18 */ - enableEdgeAutoScroll?: boolean; + enableHapticFeedback?: boolean; /** - * Define whether to enable the haptic feedback when dragging, the default value is false. + * Config if auto scrolling should be triggered when the drag hovered on a scrollable controller's edge. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice * @since 18 */ - enableHapticFeedback?: boolean; + enableEdgeAutoScroll?: boolean; /** * Define whether to lifting trigger drag by finger. @@ -18719,17 +18491,6 @@ declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; */ declare type Optional = T | undefined; -/** - * Defines the TipsMessageType property with ResourceStr and StyledString. - * - * @typedef { ResourceStr | StyledString } TipsMessageType - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type TipsMessageType = ResourceStr | StyledString; - /** * Define the options for background image. * @@ -19701,7 +19462,6 @@ declare class CommonMethod { */ foregroundEffect(options: ForegroundEffectOptions): T; - /** * Unified visual effect interface. * @@ -20603,7 +20363,7 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ onAxisEvent(event: Callback): T; @@ -23468,10 +23228,7 @@ declare class CommonMethod { */ /** * Linear Gradient - * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; - * colors: Color description for gradients. - * repeating: repeating. The default value is false + * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. * * @param { object } value * @returns { T } @@ -23585,12 +23342,12 @@ declare class CommonMethod { /** * Angle Gradient * center:is the center point of the angle gradient - * start:Start point of angle gradient. The default value is 0 - * end:End point of angle gradient. The default value is 0 + * start:Start point of angle gradient + * end:End point of angle gradient * number:number - * rotating:rotating. The default value is 0 + * rotating:rotating * colors:Color description for gradients - * repeating:repeating. The default value is false + * repeating:repeating * * @param { object } value * @returns { T } @@ -23696,9 +23453,9 @@ declare class CommonMethod { /** * Radial Gradient * center:Center point of radial gradient - * radius:Radius of Radial Gradient. value range [0, +∞) + * radius:Radius of Radial Gradient * colors:Color description for gradients - * repeating: Refill. The default value is false + * repeating: Refill * * @param { object } value * @returns { T } @@ -24183,19 +23940,6 @@ declare class CommonMethod { */ geometryTransition(id: string, options?: GeometryTransitionOptions): T; - /** - * Tips control - * - * @param { TipsMessageType } message - * @param { TipsOptions } [options] - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - bindTips(message: TipsMessageType, options?: TipsOptions): T; - /** * Popup control * @@ -24524,7 +24268,7 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since 17 */ onVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; @@ -25189,19 +24933,6 @@ declare class CommonMethod { * @since 12 */ onSizeChange(event: SizeChangeCallback): T; - - /** - * Accessibility focus draw level, and the default value is FocusDrawLevel.SELF. - * - * @param { FocusDrawLevel } drawLevel - indicates accessibility focus draw level. - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - accessibilityFocusDrawLevel(drawLevel: FocusDrawLevel): T; } /** @@ -27108,7 +26839,7 @@ declare class CustomComponent extends BaseCustomComponent { */ onMeasure?(children: Array, constraint: ConstraintSizeOptions): void; } - + /** * Custom ComponentV2 * @@ -27131,7 +26862,7 @@ declare class CustomComponentV2 extends BaseCustomComponent { */ aboutToReuse?(): void; } - + /** * Custom Component base class and it is migrated from class CustomComponent. * @@ -27143,7 +26874,7 @@ declare class CustomComponentV2 extends BaseCustomComponent { * @since 18 */ declare class BaseCustomComponent extends CommonAttribute { - /** + /** * Customize the pop-up content constructor . * * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -27789,17 +27520,6 @@ declare class BaseCustomComponent extends CommonAttribute { * @since 18 */ getDialogController(): PromptActionDialogController | undefined; - - /** - * Triggered when the Entry custom component has been pushed with singleton mode. - * - * @param { ESObject } param - New parameters pushed with singleton mode. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onNewParam?(param: ESObject): void; } /** * View @@ -28135,21 +27855,9 @@ declare abstract class TextContentControllerBase { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ clearPreviewText(): void; - - /** - * Gets the text content of the selected range. - * - * @param { TextRange } [range] - selected range. - * @returns { string } text content of the selected range. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @atomicservice - * @since 18 - */ - getText(range?: TextRange): string; } /** @@ -28514,61 +28222,6 @@ declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) */ declare type OnMoveHandler = (from: number, to: number) => void; -/** - * Define item drag event handler. - * - * @interface ItemDragEventHandler - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface ItemDragEventHandler { - /** - * This callback is triggered when the item is long pressed. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onLongPress?: Callback; - - /** - * This callback is triggered when the item is dragged. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDragStart?: Callback; - - /** - * This callback is triggered when an item is moved through other items. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onMoveThrough?: OnMoveHandler; - - /** - * This callback is triggered when the item is dropped. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDrop?: Callback; -} - /** * Define DynamicNode. * @@ -28589,19 +28242,6 @@ declare class DynamicNode { * @since 12 */ onMove(handler: Optional): T; - - /** - * Set the move action. - * - * @param { Optional } handler - * @param { ItemDragEventHandler } eventHandler - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onMove(handler: Optional, eventHandler: ItemDragEventHandler): T; } /** @@ -29049,17 +28689,6 @@ declare interface KeyframeAnimateParam { * @since 12 */ onFinish?: () => void; - - /** - * Indicates expectedFrameRateRange of keyframe animation. - * - * @type { ?ExpectedFrameRateRange } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - expectedFrameRateRange?: ExpectedFrameRateRange; } /** @@ -29190,7 +28819,7 @@ declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void * @atomicservice * @since 12 */ -declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void +declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; /** * Defines the options about VisibleAreaEvent. @@ -29622,36 +29251,3 @@ declare enum HoverModeAreaType { */ BOTTOM_SCREEN = 1, } - -/** - * Defines a range of dates. - * - * @interface DateRange - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface DateRange { - /** - * Defines the start date of the date range. - * - * @type { ?Date } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - start?: Date; - - /** - * Defines the end date of the date range. - * - * @type { ?Date } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - end?: Date; -} diff --git a/api/@internal/component/ets/counter.d.ts b/api/@internal/component/ets/counter.d.ts index 0331a32e75de4ef8ff57b97a4e82836c4f0c8a38..9fb6cf9cc9fa2759b59f405ff41a7123d2f7594c 100644 --- a/api/@internal/component/ets/counter.d.ts +++ b/api/@internal/component/ets/counter.d.ts @@ -165,6 +165,7 @@ declare class CounterAttribute extends CommonMethod { */ /** * Listen to the event that the value increases. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { CounterAttribute } @@ -172,7 +173,7 @@ declare class CounterAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ onInc(event: VoidCallback): CounterAttribute; @@ -216,6 +217,7 @@ declare class CounterAttribute extends CommonMethod { */ /** * Listens to the number decrease event. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { CounterAttribute } @@ -223,7 +225,7 @@ declare class CounterAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ onDec(event: VoidCallback): CounterAttribute; diff --git a/api/@internal/component/ets/custom_dialog_controller.d.ts b/api/@internal/component/ets/custom_dialog_controller.d.ts index d0a5591578d84d418678b5ffb3589bbfa79b3f5a..29bfc9396c812c12ac364a438f61d09fd7911995 100644 --- a/api/@internal/component/ets/custom_dialog_controller.d.ts +++ b/api/@internal/component/ets/custom_dialog_controller.d.ts @@ -467,28 +467,6 @@ declare interface CustomDialogControllerOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the customDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the customDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Defines the customDialog's keyboard avoid mode * @@ -525,50 +503,6 @@ declare interface CustomDialogControllerOptions { */ hoverModeArea?: HoverModeAreaType; - /** - * Callback function when the dialog appears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidAppear?: Callback; - - /** - * Callback function when the dialog disappears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidDisappear?: Callback; - - /** - * Callback function before the dialog openAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillAppear?: Callback; - - /** - * Callback function before the dialog closeAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillDisappear?: Callback; - /** * Defines the distance between the customDialog and system keyboard. * @@ -626,18 +560,6 @@ declare interface CustomDialogControllerOptions { * @since 18 */ levelOrder?: LevelOrder; - - /** - * Specifies whether to get focus when the custom dialog is displayed. - * - * @type { ?boolean } - * @default true - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - focusable?: boolean; } /** diff --git a/api/@internal/component/ets/date_picker.d.ts b/api/@internal/component/ets/date_picker.d.ts index b6de0092d21dcddb303c211af8854ca2bfc0254e..2f610e1a9e5ec19fb398fa1bee262ec3edf5b639 100644 --- a/api/@internal/component/ets/date_picker.d.ts +++ b/api/@internal/component/ets/date_picker.d.ts @@ -531,6 +531,7 @@ declare class DatePickerAttribute extends CommonMethod { */ /** * This event is triggered when a DatePicker date or time is selected. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { DatePickerAttribute } @@ -916,6 +917,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Called when the Cancel button in the dialog is clicked. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -955,6 +957,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Called when the OK button in the dialog is clicked. + * Anonymous Object Rectification. * * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -983,6 +986,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * This event is triggered when a DatePicker date or time is selected in dialog. + * Anonymous Object Rectification. * * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1034,28 +1038,6 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the datePickerDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the datePickerDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Callback function when the dialog appears. * @@ -1067,6 +1049,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function when the dialog appears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1087,6 +1070,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function when the dialog disappears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1107,6 +1091,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function before the dialog openAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1127,6 +1112,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function before the dialog closeAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@internal/component/ets/ellipse.d.ts b/api/@internal/component/ets/ellipse.d.ts index f2c2fde0182f9e1ac85da1bb66c9935e7e474a09..83e60fe94e78d27809aa3eb2ff8054ff976986e5 100644 --- a/api/@internal/component/ets/ellipse.d.ts +++ b/api/@internal/component/ets/ellipse.d.ts @@ -63,6 +63,17 @@ interface EllipseOptions { * @atomicservice * @since 11 */ + /** + * Set width. + * Anonymous Object Rectification. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: string | number; /** @@ -99,6 +110,17 @@ interface EllipseOptions { * @atomicservice * @since 11 */ + /** + * Set height. + * Anonymous Object Rectification. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: string | number; } @@ -177,6 +199,7 @@ interface EllipseInterface { */ /** * use new function to set the value. + * Anonymous Object Rectification. * * @param { EllipseOptions } [options] - ellipse options * @returns { EllipseAttribute } @@ -228,6 +251,7 @@ interface EllipseInterface { */ /** * Set the value. + * Anonymous Object Rectification. * * @param { EllipseOptions } [options] - ellipse options * @returns { EllipseAttribute } diff --git a/api/@internal/component/ets/enums.d.ts b/api/@internal/component/ets/enums.d.ts index 696ed14fa7d51fc83237adee80c5205c6c875b25..ea23fd49c464ae5958896ebf0f85b71b4878cb8a 100644 --- a/api/@internal/component/ets/enums.d.ts +++ b/api/@internal/component/ets/enums.d.ts @@ -5089,6 +5089,39 @@ declare enum PixelRoundCalcPolicy { FORCE_FLOOR = 2, } +/** + * Pixel Round Mode + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ +declare enum PixelRoundMode { + /** + * Do pixel round on layout finish. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ + PIXEL_ROUND_ON_LAYOUT_FINISH = 0, + /** + * Do pixel round after measure. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ + PIXEL_ROUND_AFTER_MEASURE = 1, +} + /** * FlexWrap enumeration description * @@ -9412,7 +9445,7 @@ declare enum WordBreak { * @atomicservice * @since 12 */ -declare enum LineBreakStrategy { +declare enum LineBreakStrategy { /** * By default. Display as many characters as possible on each line until no more characters * can be displayed on that line, and do not automatically add hyphens under this strategy @@ -9433,7 +9466,7 @@ declare enum LineBreakStrategy { * @atomicservice * @since 12 */ - HIGH_QUALITY = 1, + HIGH_QUALITY = 1, /** * Balanced folding. We will try our best to ensure that the width of each line in a paragraph @@ -9444,7 +9477,7 @@ declare enum LineBreakStrategy { * @atomicservice * @since 12 */ - BALANCED = 2, + BALANCED = 2, } /** @@ -9808,7 +9841,7 @@ declare enum EmbeddedType { * @atomicservice * @since 12 */ -declare enum MarqueeUpdateStrategy { +declare enum MarqueeUpdateStrategy { /** * Reset scroll position and restart scroll. * @@ -10158,40 +10191,6 @@ declare enum AxisModel { ABS_HAT0Y = 7, } -/** - * Page flip mode of Swiper and Tabs on mouse wheel event. - - * @enum { number } PageFlipMode - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 15 - */ -declare enum PageFlipMode { - /** - * Turn pages continuously according to the number of mouse wheel events. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 15 - */ - CONTINUOUS = 0, - - /** - * The page-turning animation remains unresponsive to other mouse wheel events until it completes. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 15 - */ - SINGLE = 1, -} - /** * Rotating crown event behavior. * @@ -10266,13 +10265,47 @@ declare enum CrownSensitivity { HIGH = 2 } +/** + * Page flip mode of Swiper and Tabs on mouse wheel event. + + * @enum { number } PageFlipMode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 15 + */ +declare enum PageFlipMode { + /** + * Turn pages continuously according to the number of mouse wheel events. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 15 + */ + CONTINUOUS = 0, + + /** + * The page-turning animation remains unresponsive to other mouse wheel events until it completes. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 15 + */ + SINGLE = 1, +} + /** * Type of axis action. * * @enum {number} * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ declare enum AxisAction { /** @@ -10280,7 +10313,7 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ NONE = 0, @@ -10289,7 +10322,7 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ BEGIN = 1, @@ -10298,7 +10331,7 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ UPDATE = 2, @@ -10307,7 +10340,7 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ END = 3, @@ -10316,72 +10349,7 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since 17 */ CANCEL = 4, -} - -/** - * Type of focus draw level. - * - * @enum {number} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - declare enum FocusDrawLevel { - /** - * Draw focus on node self level. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - SELF = 0, - - /** - * Draw focus on top level. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - TOP = 1, -} - -/** - * Menu divider mode. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare enum DividerMode { - /** - * Menu divider mode floating above menu. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - FLOATING_ABOVE_MENU = 0, - - /** - * Menu divider mode embedded in menu. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - EMBEDDED_IN_MENU = 1, } \ No newline at end of file diff --git a/api/@internal/component/ets/folder_stack.d.ts b/api/@internal/component/ets/folder_stack.d.ts index 75c5045da64d85e7531eff1152a6d2300aed9d51..0c93809ea69c22d58fd3ab6a78022366d2dcddde 100644 --- a/api/@internal/component/ets/folder_stack.d.ts +++ b/api/@internal/component/ets/folder_stack.d.ts @@ -35,7 +35,7 @@ declare type WindowStatusType = import('../api/@ohos.window').default.WindowStat * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface FolderStackOptions { /** @@ -55,6 +55,16 @@ interface FolderStackOptions { * @atomicservice * @since 12 */ + /** + * Define the IDs of the sub component that will be moved to the upper half screen when hovering. + * + * Anonymous Object Rectification + * @type { ?Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ upperItems?: Array; } @@ -99,12 +109,13 @@ interface FolderStackInterface { /** * Defines the constructor of folderStack. * + * Anonymous Object Rectification * @param { FolderStackOptions } [options] - id of children need to be show in upperItem * @returns { FolderStackAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ (options?: FolderStackOptions): FolderStackAttribute; } @@ -116,7 +127,7 @@ interface FolderStackInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface OnFoldStatusChangeInfo { /** @@ -136,29 +147,41 @@ interface OnFoldStatusChangeInfo { * @atomicservice * @since 12 */ + /** + * Folder state. + * + * Anonymous Object Rectification + * @type { FoldStatus } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ foldStatus: FoldStatus } /** * Callback when onStateChangeCallback. * + * Anonymous Object Rectification * @typedef { function } OnFoldStatusChangeCallback * @param { OnFoldStatusChangeInfo } event - the folding information of the current device * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare type OnFoldStatusChangeCallback = (event: OnFoldStatusChangeInfo) => void; /** * Callback when onHoverStatusChange. * + * Anonymous Object Rectification * @typedef { function } OnHoverStatusChangeCallback * @param { HoverEventParam } param - hover event param * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since 18 */ declare type OnHoverStatusChangeCallback = (param: HoverEventParam) => void; @@ -220,12 +243,13 @@ declare class FolderStackAttribute extends CommonMethod { /** * Callback folderState when the folderState changes * + * Anonymous Object Rectification * @param { OnFoldStatusChangeCallback } callback - executed when folderStatus changed * @returns { FolderStackAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ onFolderStateChange(callback: OnFoldStatusChangeCallback): FolderStackAttribute; @@ -242,11 +266,12 @@ declare class FolderStackAttribute extends CommonMethod { /** * Callback hoverStatus|folderStatus|rotation|windowMode when the hoverStatus changes * + * Anonymous Object Rectification * @param { OnHoverStatusChangeCallback } handler - executed when hoverStatus changed * @returns { FolderStackAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since 18 */ onHoverStatusChange(handler: OnHoverStatusChangeCallback): FolderStackAttribute; diff --git a/api/@internal/component/ets/form_component.d.ts b/api/@internal/component/ets/form_component.d.ts index 377a00f12c6454047f0196f4acca4be1ae4f8244..e5974bfc56c5dc698e278f4ad982050f8b3350b1 100644 --- a/api/@internal/component/ets/form_component.d.ts +++ b/api/@internal/component/ets/form_component.d.ts @@ -364,6 +364,70 @@ interface FormCallbackInfo { idString: string; } +/** + * Defines the size of Form. + * + * @typedef FormSize + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ +interface FormSize { + /** + * The width of the form. + * Anonymous Object Rectification + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + width: number; + + /** + * The height of the form. + * Anonymous Object Rectification + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + height: number; +} + +/** + * Defines error information for card loading. + * + * @typedef ErrorInformation + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ +interface ErrorInformation { + /** + * Error code. + * Anonymous Object Rectification + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + errcode: number; + + /** + * Error information. + * Anonymous Object Rectification + * + * @type { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + msg: string; +} + /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -380,7 +444,17 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + /** + * Card loading error. + * Anonymous Object Rectification + * + * @param { Callback } callback + * @returns { FormComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + onError(callback: Callback): FormComponentAttribute; /** * Card to be redirected. @@ -468,7 +552,17 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + /** + * Card to be redirected. + * Anonymous Object Rectification + * + * @param { Callback } callback + * @returns { FormComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + onRouter(callback: Callback): FormComponentAttribute; /** * Uninstall Card. @@ -499,7 +593,17 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + /** + * Card to be loaded. + * Anonymous Object Rectification + * + * @param { VoidCallback } callback + * @returns { FormComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ + onLoad(callback: VoidCallback): FormComponentAttribute; } /** diff --git a/api/@internal/component/ets/gauge.d.ts b/api/@internal/component/ets/gauge.d.ts index 5ec51b4b5af5c7a2243b309eb9140e62d6cc120a..9b39da9c99f24917745844fb511e953d9b0e56c7 100644 --- a/api/@internal/component/ets/gauge.d.ts +++ b/api/@internal/component/ets/gauge.d.ts @@ -26,7 +26,7 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ interface GaugeOptions { /** @@ -63,6 +63,17 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current data value. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ value: number; /** @@ -99,6 +110,17 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current segment minimum value. + * Anonymous Object Rectification. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ min?: number; /** @@ -135,6 +157,17 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current segment maximum value. + * Anonymous Object Rectification. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ max?: number; } @@ -221,6 +254,7 @@ interface GaugeInterface { */ /** * Called when the gauge component is used. + * Anonymous Object Rectification. * * @param { GaugeOptions } options - Gauge options. * @returns { GaugeAttribute } @@ -228,7 +262,7 @@ interface GaugeInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ (options: GaugeOptions): GaugeAttribute; } diff --git a/api/@internal/component/ets/image.d.ts b/api/@internal/component/ets/image.d.ts index 91556380e156347a24d10ed63159cf1a59deec20..94e0f4fed78874d95c119c0ec3da81b8cd886bcd 100644 --- a/api/@internal/component/ets/image.d.ts +++ b/api/@internal/component/ets/image.d.ts @@ -53,7 +53,7 @@ declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').defaul * @systemapi * @since 12 */ -declare type ResolutionQuality = import('../api/@ohos.multimedia.image').default.ResolutionQuality; +declare type ResolutionQuality = import('../api/@ohos.multimedia.image').default.ResolutionQuality; /** * Lattice for dividing an image into grids. @@ -64,7 +64,7 @@ declare type ResolutionQuality = import('../api/@ohos.multimedia.image').defaul * @atomicservice * @since 12 */ -declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.Lattice; +declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.Lattice; /** * Object matrix used for setting image transformations. @@ -543,7 +543,7 @@ interface ImageInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ interface ImageSourceSize { @@ -581,6 +581,17 @@ interface ImageSourceSize { * @atomicservice * @since 11 */ + /** + * Set width. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width: number; /** @@ -617,6 +628,17 @@ interface ImageSourceSize { * @atomicservice * @since 11 */ + /** + * Set height. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height: number; } @@ -1121,6 +1143,7 @@ declare class ImageAttribute extends CommonMethod { /** * Specifies the picture decoding size. * The original picture is decoded into a picture of a specified size. The unit of the number type is px. + * Anonymous Object Rectification. * * @param { ImageSourceSize } value - Image source size. * @returns { ImageAttribute } @@ -1128,7 +1151,7 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ sourceSize(value: ImageSourceSize): ImageAttribute; @@ -1748,27 +1771,27 @@ declare class ImageAttribute extends CommonMethod { resizable(value: ResizableOptions): ImageAttribute; /** - * Whether to support sensitive privacy information + * Set the quality enhancement level of image. * - * @param { boolean } supported - Whether to support sensitive privacy information. + * @param { ResolutionQuality } imageQuality * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @form - * @atomicservice + * @systemapi * @since 12 */ - privacySensitive(supported: boolean): ImageAttribute; + enhancedImageQuality(imageQuality: ResolutionQuality): ImageAttribute; /** - * Set the quality enhancement level of image. + * Whether to support sensitive privacy information * - * @param { ResolutionQuality } imageQuality + * @param { boolean } supported - Whether to support sensitive privacy information. * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi + * @form + * @atomicservice * @since 12 */ - enhancedImageQuality(imageQuality: ResolutionQuality): ImageAttribute; + privacySensitive(supported: boolean): ImageAttribute; /** * Set the rotation angle of image. diff --git a/api/@internal/component/ets/image_animator.d.ts b/api/@internal/component/ets/image_animator.d.ts index 20e66c9792e8d697e2de9bbb697810f460f07a98..9104d927fff4c779e05d3c98d1cf1bf7963f856f 100644 --- a/api/@internal/component/ets/image_animator.d.ts +++ b/api/@internal/component/ets/image_animator.d.ts @@ -541,7 +541,7 @@ declare class ImageAnimatorAttribute extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare class LazyGridLayoutAttribute extends CommonMethod { - /** - * The spacing between rows. - * - * @param { Length } value - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - rowsGap(value: LengthMetrics): T; - - /** - * The spacing between columns. - * - * @param { Length } value - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - columnsGap(value: LengthMetrics): T; -} - -/** - * Defines the lazy vertical grid layout attribute. - * - * @extends LazyGridLayoutAttribute - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare class LazyVGridLayoutAttribute extends LazyGridLayoutAttribute { - /** - * This parameter specifies the number of columns in the current grid layout. - * - * @param { string } value - * @returns { LazyVGridLayoutAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - columnsTemplate(value: string): LazyVGridLayoutAttribute; -} - -/** - * Defines the lazy vertical grid layout component. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare const LazyVGridLayout: LazyVGridLayoutInterface - -/** - * Defines the lazy vertical grid layout component instance. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare const LazyVGridLayoutInstance: LazyVGridLayoutAttribute; - \ No newline at end of file diff --git a/api/@internal/component/ets/line.d.ts b/api/@internal/component/ets/line.d.ts index 29245a77bdb934c6b3dc60afcbd58c1c42fa29be..6279eedc0942525bda7094034bfffab81eb93bbb 100644 --- a/api/@internal/component/ets/line.d.ts +++ b/api/@internal/component/ets/line.d.ts @@ -63,6 +63,17 @@ interface LineOptions { * @atomicservice * @since 11 */ + /** + * Width of the rectangle where the line resides. + * Anonymous Object Rectification. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: string | number; /** @@ -99,6 +110,17 @@ interface LineOptions { * @atomicservice * @since 11 */ + /** + * Height of the rectangle where the line resides. + * Anonymous Object Rectification. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: string | number; } @@ -185,6 +207,7 @@ interface LineInterface { */ /** * Uses new to create the line. + * Anonymous Object Rectification. * * @param { LineOptions } [options] - Line options * @returns { LineAttribute } @@ -244,6 +267,7 @@ interface LineInterface { */ /** * The return value of the parameter is Line. + * Anonymous Object Rectification. * * @param { LineOptions } [options] - Line options * @returns { LineAttribute } diff --git a/api/@internal/component/ets/linearindicator.d.ts b/api/@internal/component/ets/linearindicator.d.ts deleted file mode 100644 index 879083cf95bf9b58094526e20f389776005193f5..0000000000000000000000000000000000000000 --- a/api/@internal/component/ets/linearindicator.d.ts +++ /dev/null @@ -1,298 +0,0 @@ -/* - * Copyright (c) 2024 Huawei Device Co., Ltd. - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** - * @file - * @kit ArkUI - */ - -/** - * Defines the LinearIndicator Controller. - * - * @interface LinearIndicatorController - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare class LinearIndicatorController { - /** - * constructor. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - constructor(); - - /** - * Sets the progress of indicator. - * - * @param { number } index - the index of current indicator, value range: [0, count - 1]. - * If index value is out of range, do nothing. - * @param { number } progress - current indicator progress value, value range: [0, 100]. - * If the progress value is out of range, do nothing. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - setProgress(index: number, progress: number): void; - - /** - * Start indicator auto play. - * - * @param { LinearIndicatorStartOptions } [options] - the options of indicator auto play. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - start(options?: LinearIndicatorStartOptions): void; - - /** - * Pause indicator auto play. - * Start auto play will be resumed from this paused position. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - pause(): void; - - /** - * Stop indicator auto play. - * Start auto play will restart from the very beginning. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - stop(): void; -} - -/** - * Provides options of indicator auto play. - * - * @interface LinearIndicatorAutoPlayOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface LinearIndicatorStartOptions { - /** - * The interval between twice auto play. The unit is ms. - * - * @type { ?number } - * @default The default value is 0. if value is less than 0, the value will be 0. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - interval?: number; - - /** - * The animation curve duration. The unit is ms. - * - * @type { ?number } - * @default 4000 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - duration?: number; -} - -/** - * Provides linear indicator style. - * - * @interface LinearIndicatorStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface LinearIndicatorStyle { - /** - * The space of two linear indicator. - * - * @type { ?LengthMetrics } - * @default The default value is 4.0vp. if value is less than 0, the value will be 4.0vp. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - space?: LengthMetrics; - - /** - * Stroke width of the progress indicator. - * - * @type { ?LengthMetrics } - * @default The default value is 2.0vp. if value is less than 0, the value will be 2.0vp. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - strokeWidth?: LengthMetrics; - - /** - * The stroke radius of linear indicator. - * - * @type { ?LengthMetrics } - * @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 18 - */ - strokeRadius?: LengthMetrics; - - /** - * The track background color of linear indicator. - * - * @type { ?ColorMetrics } - * @default comp_background_tertiary - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - trackBackgroundColor?: ColorMetrics; - - /** - * The track color of linear indicator. - * - * @type { ?ColorMetrics } - * @default comp_background_emphasize - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - trackColor?: ColorMetrics; -} - -/** - * Provides an interface for indicator. - * - * @interface LinearIndicatorInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -interface LinearIndicatorInterface { - /** - * Constructor parameters - * - * @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 } return the instance of the LinearIndicatorAttribute - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - (count?: number, controller?: LinearIndicatorController): LinearIndicatorAttribute; -} - -/** - * Defines the Indicator attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare class LinearIndicatorAttribute extends CommonMethod { - /** - * Sets the indicator style. - * - * @param { Optional } style - the style of LinearIndicator - * @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - indicatorStyle(style: Optional): LinearIndicatorAttribute; - - /** - * Sets whether indicator supports loop, default is true. - * - * @param { Optional } loop - indicate whether loop playback is supported - * @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - indicatorLoop(loop: Optional): LinearIndicatorAttribute; - - /** - * Called when progress value update. - * - * @param { Optional } callback - callback of the progress change event. - * @returns { LinearIndicatorAttribute } return the instance of the LinearIndicatorAttribute - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onChange(callback: Optional): LinearIndicatorAttribute; -} - -/** - * Defines the callback type used in the indicator progress change event. - * - * @typedef { function } OnLinearIndicatorChangeCallback - * @param { number } index - index of current indicator. - * @param { number } progress - current indicator progress value. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type OnLinearIndicatorChangeCallback = (index: number, progress: number) => void; - -/** - * Defines Indicator Component. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare const LinearIndicator: LinearIndicatorInterface; - -/** - * Defines Indicator Component instance. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare const LinearIndicatorInstance: LinearIndicatorAttribute diff --git a/api/@internal/component/ets/list.d.ts b/api/@internal/component/ets/list.d.ts index 18bfbbdedaa2824343496cf5759c1f1d14228ced..32f57f41458360c81a0caf87ebd5f1a60cf4b20d 100644 --- a/api/@internal/component/ets/list.d.ts +++ b/api/@internal/component/ets/list.d.ts @@ -881,6 +881,17 @@ interface ListOptions { * @atomicservice * @since 11 */ + /** + * Set initialIndex. + * Anonymous Object Rectification. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ initialIndex?: number; /** * Set space. @@ -916,6 +927,17 @@ interface ListOptions { * @atomicservice * @since 11 */ + /** + * Set space. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ space?: number | string; /** * Set scroller. @@ -951,6 +973,17 @@ interface ListOptions { * @atomicservice * @since 11 */ + /** + * Set scroller. + * Anonymous Object Rectification. + * + * @type { ?Scroller } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ scroller?: Scroller; } @@ -1029,6 +1062,7 @@ interface ListInterface { */ /** * Called when interface data is called. + * Anonymous Object Rectification. * * @param { ListOptions } [options] - list options * @returns { ListAttribute } @@ -1086,6 +1120,17 @@ declare interface ListDividerOptions { * @atomicservice * @since 11 */ + /** + * Set strokeWidth. + * Anonymous Object Rectification. + * + * @type { Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ strokeWidth: Length; /** * Set color. @@ -1121,6 +1166,17 @@ declare interface ListDividerOptions { * @atomicservice * @since 11 */ + /** + * Set color. + * Anonymous Object Rectification. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ color?: ResourceColor; /** * Set startMargin. @@ -1156,6 +1212,17 @@ declare interface ListDividerOptions { * @atomicservice * @since 11 */ + /** + * Set startMargin. + * Anonymous Object Rectification. + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ startMargin?: Length; /** * Set endMargin. @@ -1191,6 +1258,17 @@ declare interface ListDividerOptions { * @atomicservice * @since 11 */ + /** + * Set endMargin. + * Anonymous Object Rectification. + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ endMargin?: Length; } @@ -1408,6 +1486,7 @@ declare class ListAttribute extends ScrollableCommonMethod { */ edgeEffect(value: EdgeEffect, options?: EdgeEffectOptions): ListAttribute; + /** * Called when need to decide contentStartOffset the list will show. * @param { number } value - the value Of startOffset. @@ -1486,6 +1565,7 @@ declare class ListAttribute extends ScrollableCommonMethod { */ /** * Called when the ListItem split line style is set. + * Anonymous Object Rectification. * * @param { ListDividerOptions | null } value * @returns { ListAttribute } @@ -1793,18 +1873,6 @@ declare class ListAttribute extends ScrollableCommonMethod { */ maintainVisibleContentPosition(enabled: boolean): ListAttribute; - /** - * Sets the layout of the List component from the end. - * - * @param { boolean } enabled - Indicates whether the List is layout from the end. - * @returns { ListAttribute } the attribute of the list. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - stackFromEnd(enabled: boolean): ListAttribute; - /** * Called when the offset and status callback of the slide are set. * diff --git a/api/@internal/component/ets/list_item_group.d.ts b/api/@internal/component/ets/list_item_group.d.ts index 0e2a3a86ab32198b211dd7c56926bf0a9b818c69..1033ca2cd06f270becb7cd3008d9d0c02ac887d2 100644 --- a/api/@internal/component/ets/list_item_group.d.ts +++ b/api/@internal/component/ets/list_item_group.d.ts @@ -336,6 +336,7 @@ declare class ListItemGroupAttribute extends CommonMethod | CustomBuilder): NavDestinationAttribute; - /** - * NavDestination title bar's menus - * - * @param { Array | CustomBuilder } items - * @param { NavigationMenuOptions } [options] - Indicates the options of menu. - * @returns { NavDestinationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - menus(items: Array | CustomBuilder, options?: NavigationMenuOptions): NavDestinationAttribute; - /** * Configure toolbar with default style parameter or custom parameter. * @@ -1103,7 +1077,7 @@ declare class NavDestinationAttribute extends CommonMethod>): NavDestinationAttribute; @@ -1115,7 +1089,7 @@ declare class NavDestinationAttribute extends CommonMethod>): NavDestinationAttribute; @@ -1130,18 +1104,6 @@ declare class NavDestinationAttribute extends CommonMethod> } callback - Indicates callback when destination be pushed with singleton mode. - * @returns { NavDestinationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onNewParam(callback: Optional>): NavDestinationAttribute; } /** diff --git a/api/@internal/component/ets/navigation.d.ts b/api/@internal/component/ets/navigation.d.ts index 1e8932386f0cc6700300d1c9a04dafc32ce4b643..f721c8ee43bc03d166eab7c01a846fc33f291587 100644 --- a/api/@internal/component/ets/navigation.d.ts +++ b/api/@internal/component/ets/navigation.d.ts @@ -2034,28 +2034,6 @@ declare interface NavigationTitleOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Background blur style options. - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Background effect options. - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Set title bar style. * @@ -2200,39 +2178,6 @@ declare interface NavigationToolbarOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Background blur style options. - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Background effect options. - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - - /** - * More button options. - * - * @type { ?MoreButtonOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - moreButtonOptions?: MoreButtonOptions; - /** * Set tool bar style. * @@ -2244,84 +2189,6 @@ declare interface NavigationToolbarOptions { * @since 14 */ barStyle?: BarStyle; - - /** - * Set whether toolbar displays text. - * - * @type { ?boolean } - * @default false - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - hideItemValue?: boolean -} - -/** - * Indicates the options of Navigation's Menu. - * - * @interface NavigationMenuOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface NavigationMenuOptions { -/** - * More button options. - * - * @type { ?MoreButtonOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - moreButtonOptions?: MoreButtonOptions; -} - -/** - * Indicates the options of Navigation's Menu. - * - * @interface MoreButtonOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface MoreButtonOptions { - /** - * Background blur style. - * - * @type { ?BlurStyle } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyle?: BlurStyle; - - /** - * Background blur style options. - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Background effect options. - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; } /** @@ -2517,19 +2384,6 @@ declare class NavigationAttribute extends CommonMethod { */ backButtonIcon(value: string | PixelMap | Resource | SymbolGlyphModifier): NavigationAttribute; - /** - * Sets the back button icon and accessibility broadcast content. - * - * @param { string | PixelMap | Resource | SymbolGlyphModifier } icon - Indicates icon of back button - * @param { ResourceStr } accessibilityText - Indicates content needs to broadcast. - * @returns { NavigationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backButtonIcon(icon: string | PixelMap | Resource | SymbolGlyphModifier, accessibilityText?: ResourceStr): NavigationAttribute; - /** * Hide the NavBar, which includes title bar, the child of Navigation and tool bar. Supported in split mode. * @@ -2739,19 +2593,6 @@ declare class NavigationAttribute extends CommonMethod { */ menus(value: Array | CustomBuilder): NavigationAttribute; - /** - * Navigation title bar's menus - * - * @param { Array | CustomBuilder } items - * @param { NavigationMenuOptions } [options] - Indicates the options of menu. - * @returns { NavigationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - menus(items: Array | CustomBuilder, options?: NavigationMenuOptions): NavigationAttribute; - /** * Tool bar * @@ -2828,18 +2669,6 @@ declare class NavigationAttribute extends CommonMethod { */ hideToolBar(hide: boolean, animated: boolean): NavigationAttribute; - /** - * Enable tool bar adaptation - * - * @param { Optional } enable - Enable or disable tool bar adaptation. - * @returns { NavigationAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - enableToolBarAdaptation(enable: Optional): NavigationAttribute; - /** * Trigger callback when title mode change finished at free mode. * diff --git a/api/@internal/component/ets/page_transition.d.ts b/api/@internal/component/ets/page_transition.d.ts index eeb29f55a0b52032f6e8147f88475269d1dea969..1ee6c15fac5035805d5b306b9d36fde7df14bbf9 100644 --- a/api/@internal/component/ets/page_transition.d.ts +++ b/api/@internal/component/ets/page_transition.d.ts @@ -355,12 +355,13 @@ declare class CommonTransition { /** * Called when the translation effect of page transition is set. * + * Anonymous Object Rectification. * @param { TranslateOptions } value * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ translate(value: TranslateOptions): T; @@ -394,12 +395,13 @@ declare class CommonTransition { /** * Called when setting the zoom effect of page transition. * + * Anonymous Object Rectification. * @param { ScaleOptions } value * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ scale(value: ScaleOptions): T; @@ -563,7 +565,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare type PageTransitionCallback = (type: RouteType, progress: number) => void; @@ -657,12 +659,13 @@ interface PageTransitionEnterInterface extends CommonTransition = [T1, T2]; @@ -36,7 +36,7 @@ declare type ParticleTuple = [T1, T2]; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare interface VelocityOptions { /** @@ -54,6 +54,16 @@ declare interface VelocityOptions { * @atomicservice * @since 11 */ + /** + * Particle speed. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ speed: ParticleTuple; /** @@ -71,6 +81,16 @@ declare interface VelocityOptions { * @atomicservice * @since 11 */ + /** + * Angle of particle's direction. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ angle: ParticleTuple; } @@ -81,7 +101,7 @@ declare interface VelocityOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare interface AccelerationOptions< ACC_SPEED_UPDATER extends ParticleUpdater, @@ -102,6 +122,16 @@ declare interface AccelerationOptions< * @atomicservice * @since 11 */ + /** + * Speed property options. + * + * Anonymous Object Rectification. + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ speed?: ParticlePropertyOptions; /** @@ -119,6 +149,16 @@ declare interface AccelerationOptions< * @atomicservice * @since 11 */ + /** + * Angle property options. + * + * Anonymous Object Rectification. + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ angle?: ParticlePropertyOptions; } @@ -239,12 +279,14 @@ interface ParticleOptions< */ /** * Particle velocity. + * + * Anonymous Object Rectification. * @type { ?VelocityOptions } * @default {speed:[0,0];angle:[0,0]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ velocity?: VelocityOptions; @@ -267,12 +309,14 @@ interface ParticleOptions< */ /** * Particle acceleration. + * + * Anonymous Object Rectification. * @type { ?AccelerationOptions } * @default {speed:{range:[0,0]};angle:{range:[0,0]}} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ acceleration?: AccelerationOptions; @@ -380,11 +424,13 @@ interface ImageParticleParameters { */ /** * Particle image size. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ size: ParticleTuple; @@ -522,7 +568,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface EmitterParticleOptions { /** @@ -540,6 +586,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle type. + * + * Anonymous Object Rectification. + * @type { PARTICLE } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: PARTICLE; /** * Particle config. @@ -556,6 +612,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle config. + * + * Anonymous Object Rectification. + * @type { ParticleConfigs[PARTICLE] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticleConfigs[PARTICLE]; /** @@ -573,6 +639,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle count. + * + * Anonymous Object Rectification. + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ count: number; /** @@ -592,6 +668,17 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle lifetime. + * + * Anonymous Object Rectification. + * @type { ?number } + * @default 1000 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ lifetime?: number; /** @@ -604,6 +691,18 @@ interface EmitterParticleOptions { * @atomicservice * @since 12 */ + /** + * Particle lifetimeRange,value range [0, ∞). + * when lifetimeRange>lifetime,minimum lifetime is 0. + * + * Anonymous Object Rectification. + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ lifetimeRange?: number; } @@ -640,11 +739,13 @@ interface EmitterOptions { */ /** * Set particle config. + * + * Anonymous Object Rectification. * @type { EmitterParticleOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ particle: EmitterParticleOptions; @@ -711,12 +812,14 @@ interface EmitterOptions { * Position of emitter. * The first element means X-axis location. * The second element means the Y-axis location. + * + * Anonymous Object Rectification. * @type { ?ParticleTuple } * @default [0,0] * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ position?: ParticleTuple; @@ -745,12 +848,14 @@ interface EmitterOptions { * Size of emitter. * The first element means emitter width. * The second element means emitter height. + * + * Anonymous Object Rectification. * @type { ?ParticleTuple } * @default ['100%','100%'] * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ size?: ParticleTuple; } @@ -807,11 +912,13 @@ interface ParticlePropertyUpdaterConfigs { */ /** * Random effect of particle updater. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ [ParticleUpdater.RANDOM]: ParticleTuple; @@ -840,7 +947,7 @@ interface ParticlePropertyUpdaterConfigs { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface ParticleUpdaterOptions { /** @@ -858,6 +965,16 @@ interface ParticleUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Particle updater type. + * + * Anonymous Object Rectification. + * @type { UPDATER } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: UPDATER; /** @@ -875,6 +992,16 @@ interface ParticleUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Particle updater configuration. + * + * Anonymous Object Rectification. + * @type { ParticlePropertyUpdaterConfigs[UPDATER] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticlePropertyUpdaterConfigs[UPDATER]; } @@ -885,7 +1012,7 @@ interface ParticleUpdaterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface ParticleColorOptions { /** @@ -903,6 +1030,16 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Red component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ r: ParticleTuple; /** @@ -920,6 +1057,16 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Green component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ g: ParticleTuple; /** @@ -937,6 +1084,16 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Blue component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ b: ParticleTuple; /** @@ -954,6 +1111,16 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Opacity component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ a: ParticleTuple; } @@ -964,7 +1131,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface ParticleColorUpdaterOptions { /** @@ -982,6 +1149,16 @@ interface ParticleColorUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Color updater. + * + * Anonymous Object Rectification. + * @type { UPDATER } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: UPDATER; /** @@ -999,6 +1176,16 @@ interface ParticleColorUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Color updater configuration. + * + * Anonymous Object Rectification. + * @type { ParticleColorPropertyUpdaterConfigs[UPDATER] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticleColorPropertyUpdaterConfigs[UPDATER]; } @@ -1035,11 +1222,13 @@ interface ParticlePropertyOptions { */ /** * Initial range, within which the initial value are randomly generated. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ range: ParticleTuple; @@ -1062,12 +1251,14 @@ interface ParticlePropertyOptions { */ /** * Particle property updater. + * + * Anonymous Object Rectification. * @type { ?ParticleUpdaterOptions } * @default {type:UPDATER.NONE;config:ParticlePropertyUpdaterConfigs[UPDATER.NONE]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ updater?: ParticleUpdaterOptions; } @@ -1124,11 +1315,13 @@ interface ParticleColorPropertyUpdaterConfigs { */ /** * Random effect of particle color property updater. + * + * Anonymous Object Rectification. * @type { ParticleColorOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ [ParticleUpdater.RANDOM]: ParticleColorOptions; @@ -1185,11 +1378,13 @@ interface ParticleColorPropertyOptions { */ /** * Initial color range, within which the initial color is randomly generated. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ range: ParticleTuple; @@ -1223,12 +1418,14 @@ interface ParticleColorPropertyOptions { */ /** * Particle color property updater. + * + * Anonymous Object Rectification. * @type { ?ParticleColorUpdaterOptions } * @default {type:UPDATER.NONE;config:ParticleColorPropertyUpdaterConfigs[UPDATER.NONE]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ updater?: ParticleColorUpdaterOptions; } @@ -1344,7 +1541,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface Particles< PARTICLE extends ParticleType, @@ -1370,6 +1567,16 @@ interface Particles< * @atomicservice * @since 11 */ + /** + * Array of particles. + * + * Anonymous Object Rectification. + * @type { Array> } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ particles: Array< ParticleOptions< PARTICLE, @@ -1420,13 +1627,15 @@ interface ParticleInterface { */ /** * create a particle array. + * + * Anonymous Object Rectification. * @param { Particles } particles - Array of particles. * @returns { ParticleAttribute } Returns the particle attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ < PARTICLE extends ParticleType, diff --git a/api/@internal/component/ets/path.d.ts b/api/@internal/component/ets/path.d.ts index 520a2a2daba4affd10e84ea30e7483d2e9fa4470..6cf8525b2207214e549924a55508444bf7a5e907 100644 --- a/api/@internal/component/ets/path.d.ts +++ b/api/@internal/component/ets/path.d.ts @@ -59,6 +59,17 @@ declare interface PathOptions { * @atomicservice * @since 11 */ + /** + * Width option. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: number | string; /** @@ -91,6 +102,17 @@ declare interface PathOptions { * @atomicservice * @since 11 */ + /** + * Height option. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: number | string; /** @@ -123,6 +145,17 @@ declare interface PathOptions { * @atomicservice * @since 11 */ + /** + * Commands option. + * Anonymous Object Rectification. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ commands?: string } @@ -201,6 +234,7 @@ interface PathInterface { */ /** * Use new to create Path. + * Annonymous Object Rectification. * * @param { PathOptions } [options] - path options * @returns { PathAttribute } @@ -252,6 +286,7 @@ interface PathInterface { */ /** * Called when drawing path. + * Anonymous Object Rectification. * * @param { PathOptions } [options] - path options * @returns { PathAttribute } diff --git a/api/@internal/component/ets/plugin_component.d.ts b/api/@internal/component/ets/plugin_component.d.ts index 47db459dc188115646507bda91c92250ae90d02e..62733df68dffaaa268b70e83c2f9b191c9f474a5 100644 --- a/api/@internal/component/ets/plugin_component.d.ts +++ b/api/@internal/component/ets/plugin_component.d.ts @@ -49,11 +49,12 @@ interface PluginComponentTemplate { /** * Define options used to construct a plugin component. + * AnonyMous Object Rectification * * @interface PluginComponentOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since 18 */ declare interface PluginComponentOptions { /** @@ -63,6 +64,14 @@ declare interface PluginComponentOptions { * @systemapi * @since 9 */ + /** + * Plugin component template. + * AnonyMous Object Rectification + * @type { PluginComponentTemplate } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ template: PluginComponentTemplate; /** @@ -72,16 +81,25 @@ declare interface PluginComponentOptions { * @systemapi * @since 9 */ + /** + * Plugin component data. + * AnonyMous Object Rectification + * @type { any } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ data: any; } /** * Data provided when an error occurs. + * AnonyMous Object Rectification * * @interface PluginErrorData * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since 18 */ declare interface PluginErrorData { /** @@ -91,6 +109,14 @@ declare interface PluginErrorData { * @systemapi * @since 9 */ + /** + * Error code. + * AnonyMous Object Rectification + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ errcode: number; /** @@ -100,17 +126,26 @@ declare interface PluginErrorData { * @systemapi * @since 9 */ + /** + * Error message. + * AnonyMous Object Rectification + * @type { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 18 + */ msg: string; } /** * Callback invoked when an error occurs. + * AnonyMous Object Rectification * * @typedef { function } PluginErrorCallback * @param { PluginErrorData } info - Plugin error data * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since 18 */ declare type PluginErrorCallback = (info: PluginErrorData) => void; @@ -134,12 +169,13 @@ interface PluginComponentInterface { */ /** * Called when setting the plugin. + * AnonyMous Object Rectification * * @param { PluginComponentOptions } options - Plugin component options * @returns { PluginComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since 18 */ (options: PluginComponentOptions): PluginComponentAttribute; } @@ -164,12 +200,13 @@ declare class PluginComponentAttribute extends CommonMethod { */ /** * Called when a picture is set. + * Anonymous Object Rectification. * * @param { StarStyleOptions } options - star style options * @returns { RatingAttribute } diff --git a/api/@internal/component/ets/rect.d.ts b/api/@internal/component/ets/rect.d.ts index e1f1784e6da36a45d7baa3fbe74c982c711c16b2..8c1f9e1d1da5c65972297c446798da9bf805acd8 100644 --- a/api/@internal/component/ets/rect.d.ts +++ b/api/@internal/component/ets/rect.d.ts @@ -63,6 +63,17 @@ declare interface RectOptions { * @atomicservice * @since 11 */ + /** + * Rectangle width. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: number | string; /** @@ -99,6 +110,17 @@ declare interface RectOptions { * @atomicservice * @since 11 */ + /** + * Rectangle height. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: number | string; /** @@ -135,6 +157,17 @@ declare interface RectOptions { * @atomicservice * @since 11 */ + /** + * Corner radius of the rectangle. + * Anonymous Object Rectification. + * + * @type { ?(number | string | Array) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ radius?: number | string | Array; } @@ -183,6 +216,17 @@ declare interface RoundedRectOptions { * @atomicservice * @since 11 */ + /** + * Rectangle width. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: number | string; /** @@ -219,6 +263,17 @@ declare interface RoundedRectOptions { * @atomicservice * @since 11 */ + /** + * Rectangle height. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: number | string; /** @@ -255,6 +310,17 @@ declare interface RoundedRectOptions { * @atomicservice * @since 11 */ + /** + * Width of the corner radius. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ radiusWidth?: number | string; /** @@ -291,6 +357,17 @@ declare interface RoundedRectOptions { * @atomicservice * @since 11 */ + /** + * Height of the corner radius. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ radiusHeight?: number | string; } @@ -369,6 +446,7 @@ interface RectInterface { */ /** * Use new function to create Rect. + * Anonymous Object Rectification. * * @param { RectOptions | RoundedRectOptions } [options] - Rect options * @returns { RectAttribute } @@ -426,6 +504,7 @@ interface RectInterface { */ /** * Called when a rectangle is created. + * Anonymous Object Rectification. * * @param { RectOptions | RoundedRectOptions } [options] - Rect options * @returns { RectAttribute } diff --git a/api/@internal/component/ets/repeat.d.ts b/api/@internal/component/ets/repeat.d.ts index 6af6579320ffaa14b5911dc1bce322f7733d0342..2f88d43abcf891341246a9f9f2ed30a6a97a1699 100644 --- a/api/@internal/component/ets/repeat.d.ts +++ b/api/@internal/component/ets/repeat.d.ts @@ -84,28 +84,6 @@ interface VirtualScrollOptions { * @since 18 */ reusable?: boolean; - - /** - * Data lazy loading - * - * @param { number } index - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onLazyLoading?(index: number): void; - - /** - * The function of total data count. - * - * @returns { number } Returns the total data count. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onTotalCount?(): number; } /** @@ -165,17 +143,7 @@ declare type RepeatItemBuilder = (repeatItem: RepeatItem) => void; * @atomicservice * @since 12 */ -/** - * Defines the Repeat component attribute functions. - * - * @extends DynamicNode> - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ -declare class RepeatAttribute extends DynamicNode> { +declare class RepeatAttribute { /** * Executes itemGenerator of each item. * diff --git a/api/@internal/component/ets/rich_editor.d.ts b/api/@internal/component/ets/rich_editor.d.ts index 3ef4e32d0d56dd91f90c239df7b806c0587f9f7e..19210279782f0b826450c82ff83cf62795a12c36 100644 --- a/api/@internal/component/ets/rich_editor.d.ts +++ b/api/@internal/component/ets/rich_editor.d.ts @@ -637,17 +637,6 @@ declare interface RichEditorParagraphStyle { * @since 12 */ lineBreakStrategy?: LineBreakStrategy; - - /** - * Set paragraph spacing. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - paragraphSpacing?: number; } /** @@ -1540,17 +1529,6 @@ declare interface RichEditorTextSpanResult { * @since 12 */ previewText?: string; - - /** - * RichEditor url style. - * - * @type { ?RichEditorUrlStyle } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - urlStyle?: RichEditorUrlStyle; } /** @@ -2032,19 +2010,7 @@ declare interface RichEditorTextSpanOptions { * @since 12 */ gesture?: RichEditorGesture; - - /** - * RichEditor url style. - * - * @type { ?RichEditorUrlStyle } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - urlStyle?: RichEditorUrlStyle; } - /** * Defines the custom keyboard options of RichEditor. * @@ -2338,17 +2304,6 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty * @since 11 */ textStyle: RichEditorTextStyle; - - /** - * RichEditor url style. - * - * @type { ?RichEditorUrlStyle } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - urlStyle?: RichEditorUrlStyle; } /** @@ -4083,27 +4038,6 @@ declare interface CopyEvent { preventDefault?: Callback; } -/** - * RichEditor url style. - * @interface RichEditorUrlStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface RichEditorUrlStyle { - /** - * uniform resoure locator. - * - * @type { ?ResourceStr } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - url?: ResourceStr; -} - /** * callback of the listened enter key event. * diff --git a/api/@internal/component/ets/row.d.ts b/api/@internal/component/ets/row.d.ts index f05a61a938df25b773d0e32217033ccecd45cc2a..36d502a1feb9129f65a79c70a37b64d30d47b1cb 100644 --- a/api/@internal/component/ets/row.d.ts +++ b/api/@internal/component/ets/row.d.ts @@ -26,7 +26,7 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ declare interface RowOptions { /** @@ -63,6 +63,17 @@ declare interface RowOptions { * @atomicservice * @since 11 */ + /** + * Row spacing. + * + * Anonymous Object Rectification + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ space?: string | number; } @@ -166,18 +177,20 @@ interface RowInterface { /** * Called when the layout is set in the horizontal direction. * + * Anonymous Object Rectification * @param { ?RowOptions } options - row options * @returns { RowAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ (options?: RowOptions): RowAttribute; /** * Called when the layout is set in the horizontal direction. * + * Anonymous Object Rectification * @param { ?(RowOptions | RowOptionsV2) } options - row options * @returns { RowAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index 5b37398a442589a29281ff1bed4d9a9f25b075ef..784876b201733aab22096ee12297083246c56a08 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -435,6 +435,7 @@ declare class Scroller { */ /** * Called when the setting slides to the specified position. + * Anonymous Object Rectification. * * @param { ScrollOptions } options - scroll options * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -480,6 +481,7 @@ declare class Scroller { */ scrollEdge(value: Edge, options?: ScrollEdgeOptions); + /** * Fling the scroll view. * @@ -707,6 +709,38 @@ declare class Scroller { getItemIndex(x: number, y: number): number; } +/** + * Define scroll page options + * @interface ScrollPageOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 14 + */ +declare interface ScrollPageOptions { + /** + * Control whether to scroll to the next page or the previous page. + * + * @type { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 14 + */ + next: boolean; + + /** + * Set whether the scrollPage have animate. + * + * @type { ?boolean } + * @default false + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 14 + */ + animation?: boolean; +} + /** * Define scroll options. * @@ -734,6 +768,16 @@ declare interface ScrollOptions { * @atomicservice * @since 11 */ + /** + * The X-axis offset. + * Anonymous Object Rectification. + * + * @type { number | string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ xOffset: number | string; /** @@ -753,6 +797,16 @@ declare interface ScrollOptions { * @atomicservice * @since 11 */ + /** + * The Y-axis offset. + * Anonymous Object Rectification. + * + * @type { number | string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ yOffset: number | string; /** @@ -784,39 +838,18 @@ declare interface ScrollOptions { * @atomicservice * @since 12 */ - animation?: ScrollAnimationOptions | boolean; -} - -/** - * Define scroll page options - * @interface ScrollPageOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 14 - */ -declare interface ScrollPageOptions { - /** - * Control whether to scroll to the next page or the previous page. - * - * @type { boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 14 - */ - next: boolean; - /** - * Set whether the scrollPage have animate. + * Descriptive animation. + * Anonymous Object Rectification. * - * @type { ?boolean } - * @default false + * @type { ?( ScrollAnimationOptions | boolean) } The ScrollAnimationOptions type provides custom animation parameters + * and the boolean type enables default spring animation. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ - animation?: boolean; + animation?: ScrollAnimationOptions | boolean; } /** @@ -1015,6 +1048,16 @@ interface OnScrollFrameBeginHandlerResult { * @atomicservice * @since 11 */ + /** + * Actual sliding amount, unit vp. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ offsetRemain: number; } @@ -1172,6 +1215,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod { */ /** * Called when scrolling to the edge of the container. + * Anonymous Object Rectification. * * @param { OnScrollEdgeCallback } event * @returns { ScrollAttribute } @@ -1211,6 +1255,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod { */ /** * Called when scrolling start. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { ScrollAttribute } @@ -1262,6 +1307,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod { */ /** * Called when scrolling has stopped. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { ScrollAttribute } @@ -1418,6 +1464,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod { */ /** * Called when scrolling begin each frame. + * Anonymous Object Rectification. * * @param { OnScrollFrameBeginCallback } event * @returns { ScrollAttribute } diff --git a/api/@internal/component/ets/search.d.ts b/api/@internal/component/ets/search.d.ts index 7a107792c52c6a02e72985e1d45ddb6dbfbe6141..615866b645b1e6e6237320288e0d527e25307fec 100644 --- a/api/@internal/component/ets/search.d.ts +++ b/api/@internal/component/ets/search.d.ts @@ -303,6 +303,7 @@ declare enum SearchType { /** * Options used to construct the search. * + * Anonymous Object Rectification. * @typedef SearchOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -325,6 +326,15 @@ declare interface SearchOptions { * @atomicservice * @since 11 */ + /** + * Text input in the search text box. + * + * Anonymous Object Rectification. + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 18 + */ value?: string; /** @@ -349,6 +359,15 @@ declare interface SearchOptions { * @atomicservice * @since 11 */ + /** + * Text displayed when there is no input. + * + * Anonymous Object Rectification. + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 18 + */ placeholder?: ResourceStr; /** @@ -366,6 +385,15 @@ declare interface SearchOptions { * @atomicservice * @since 11 */ + /** + * Path to the search icon. + * + * Anonymous Object Rectification. + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 18 + */ icon?: string; /** @@ -383,6 +411,15 @@ declare interface SearchOptions { * @atomicservice * @since 11 */ + /** + * Controller of the component. + * + * Anonymous Object Rectification. + * @type { ?SearchController } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 18 + */ controller?: SearchController; } @@ -441,6 +478,7 @@ interface SearchInterface { /** * The options of SearchInterface. * + * Anonymous Object Rectification. * @param { SearchOptions } [options] - Search options. * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1010,6 +1048,7 @@ declare class SearchAttribute extends CommonMethod { /** * Call the function when clicked the search button. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1091,6 +1130,7 @@ declare class SearchAttribute extends CommonMethod { /** * Called when the text selection changes. * + * Anonymous Object Rectification. * @param { OnTextSelectionChangeCallback } callback - Callback of the listened event. * @returns { SearchAttribute } Returns the instance of the SearchAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1122,6 +1162,7 @@ declare class SearchAttribute extends CommonMethod { /** * Called when the content scrolls. * + * Anonymous Object Rectification. * @param { OnContentScrollCallback } callback - Callback of the listened event. * @returns { SearchAttribute } Returns the instance of the SearchAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1161,6 +1202,7 @@ declare class SearchAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1200,6 +1242,7 @@ declare class SearchAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1242,6 +1285,7 @@ declare class SearchAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { OnPasteCallback } callback - Executed when a paste operation is performed. * @returns { SearchAttribute } Returns the instance of the SearchAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1606,18 +1650,6 @@ declare class SearchAttribute extends CommonMethod { */ enableHapticFeedback(isEnabled: boolean): SearchAttribute; - /** - * Set text mode of automatic case mode switching. - * - * @param { AutoCapitalizationMode } mode - Automatic case mode switching. - * @returns { SearchAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - */ - autoCapitalizationMode(mode: AutoCapitalizationMode): SearchAttribute; - /** * Set the text with half leading. * diff --git a/api/@internal/component/ets/select.d.ts b/api/@internal/component/ets/select.d.ts index ab1ea4bebe5cecbf303341060563cecc832d72d8..a132bca5d72ce57a9a24ef08412b470693266022 100644 --- a/api/@internal/component/ets/select.d.ts +++ b/api/@internal/component/ets/select.d.ts @@ -278,35 +278,6 @@ declare enum MenuAlignType { END } -/** - * Enumeration of avoidance modes for the Select dropdown menu - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare enum AvoidanceMode { - /** - * The value covers the target component. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - COVER_TARGET, - /** - * This value is displayed in the maximum space.(Compress the scrollbar) - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - AVOID_AROUND_TARGET -} - /** * Callback of selecting an item from the select event. * @@ -1087,78 +1058,6 @@ declare class SelectAttribute extends CommonMethod { * @since 12 */ divider(options: Optional | null): SelectAttribute; - - /** - * Sets the attribute modifier for the text of select. - * - * @param { Optional } modifier Set modifier for the text of select. - * @returns { SelectAttribute } the attribute of the select. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - textModifier(modifier: Optional): SelectAttribute; - - /** - * Sets the attribute modifier for the arrow symbol of select. - * - * @param { Optional } modifier Set modifier for the arrow symbol of select. - * @returns { SelectAttribute } the attribute of the select. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - arrowModifier(modifier: Optional): SelectAttribute; - - /** - * Sets the attribute modifier for the text of each option. - * - * @param { Optional } modifier Set modifier for the text of each option. - * @returns { SelectAttribute } the attribute of the select. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - optionTextModifier(modifier: Optional): SelectAttribute; - - /** - * Sets the attribute modifier for the text of selected option. - * - * @param { Optional } modifier Set modifier for the text of selected option. - * @returns { SelectAttribute } the attribute of the select. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - selectedOptionTextModifier(modifier: Optional): SelectAttribute; - - /** - * Set the divider style of option - * - * @param { Optional } style - * @returns { SelectAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - dividerStyle(style: Optional): SelectAttribute; - - /** - * Set the select menu avoidance mode - * - * @param { AvoidanceMode } mode - Enumeration value of the avoidance mode - * @returns { SelectAttribute } Returns the chained object of Select component attributes - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - avoidance(mode: AvoidanceMode): SelectAttribute; } /** diff --git a/api/@internal/component/ets/shape.d.ts b/api/@internal/component/ets/shape.d.ts index 1f8ad943ed135b8836a0d643785f503e33d0f050..e6ee5e009d237847ba6bf0641f588bf7179e4b4c 100644 --- a/api/@internal/component/ets/shape.d.ts +++ b/api/@internal/component/ets/shape.d.ts @@ -63,6 +63,17 @@ declare interface ViewportRect { * @atomicservice * @since 11 */ + /** + * Viewport X coordinate. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ x?: number | string; /** @@ -99,6 +110,17 @@ declare interface ViewportRect { * @atomicservice * @since 11 */ + /** + * Viewport Y coordinate. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ y?: number | string; /** @@ -135,6 +157,17 @@ declare interface ViewportRect { * @atomicservice * @since 11 */ + /** + * Viewport width. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ width?: number | string; /** @@ -171,6 +204,17 @@ declare interface ViewportRect { * @atomicservice * @since 11 */ + /** + * Viewport height. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ height?: number | string } @@ -365,6 +409,7 @@ declare class ShapeAttribute extends CommonMethod { */ /** * Viewport of shape + * Anonymous Object Rectification. * * @param { ViewportRect } value * @returns { ShapeAttribute } diff --git a/api/@internal/component/ets/sidebar.d.ts b/api/@internal/component/ets/sidebar.d.ts index 2890bf36f0f17dd5764c307f4496f488aa80eca4..4622bd4555f349a4cc90c0b81a16c5a9dfff62e3 100644 --- a/api/@internal/component/ets/sidebar.d.ts +++ b/api/@internal/component/ets/sidebar.d.ts @@ -184,7 +184,7 @@ declare enum SideBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare interface ButtonIconOptions { /** @@ -211,6 +211,16 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is shown. + * + * Anonymous Object Rectification. + * @type { string | PixelMap | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ shown: string | PixelMap | Resource; /** @@ -237,6 +247,16 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is hidden. + * + * Anonymous Object Rectification. + * @type { string | PixelMap | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ hidden: string | PixelMap | Resource; /** @@ -263,6 +283,16 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is switching. + * + * Anonymous Object Rectification. + * @type { ?(string | PixelMap | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ switching?: string | PixelMap | Resource; } @@ -434,11 +464,12 @@ declare interface ButtonStyle { /** * Set the button icon when sidebar status has changed * + * Anonymous Object Rectification. * @type { ?ButtonIconOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ icons?: ButtonIconOptions; } diff --git a/api/@internal/component/ets/stack.d.ts b/api/@internal/component/ets/stack.d.ts index a69c515b8e81f3a6b5580204f6350806ebfe95a6..4fa1fab7527a2b6aafe9cde8c778351b45cb04e8 100644 --- a/api/@internal/component/ets/stack.d.ts +++ b/api/@internal/component/ets/stack.d.ts @@ -26,7 +26,7 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ declare interface StackOptions { /** @@ -63,6 +63,17 @@ declare interface StackOptions { * @atomicservice * @since 11 */ + /** + * Set the alignment of sub components within the container. + * + * Anonymous Object Rectification + * @type { ?Alignment } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ alignContent?: Alignment; } @@ -142,13 +153,14 @@ interface StackInterface { /** * Set the options. * + * Anonymous Object Rectification * @param { ?StackOptions } options - stack options * @returns { StackAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 14 + * @since 18 */ (options?: StackOptions): StackAttribute; } diff --git a/api/@internal/component/ets/styled_string.d.ts b/api/@internal/component/ets/styled_string.d.ts index f5c622d31e9ee314d545885f7f9c5a7bfca3e201..b9b58b93c3d4af34aac5bf013f109c987c872777 100644 --- a/api/@internal/component/ets/styled_string.d.ts +++ b/api/@internal/component/ets/styled_string.d.ts @@ -18,47 +18,6 @@ * @kit ArkUI */ -/** - * Defines the StyledStringMarshallingValue Type. - * - * @typedef { UserDataSpan } StyledStringMarshallingValue - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type StyledStringMarshallingValue = UserDataSpan; - - -/** - * Defines the callback type used in marshalling. - * - * @typedef { function } StyledStringMarshallCallback - * @param { StyledStringMarshallingValue } marshallableVal - value that will be serialized to array buffer - * @returns { ArrayBuffer } Array buffer from the serialized marshalling value - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type StyledStringMarshallCallback = (marshallableVal: StyledStringMarshallingValue) => ArrayBuffer; - -/** - * Defines the callback type used in unmarshalling. - * - * @typedef { function } StyledStringUnmarshallCallback - * @param { ArrayBuffer } buf - The buffer that will be deserialized to a StyledStringMarshallingValue. - * @returns { StyledStringMarshallingValue } Marshalling value from the deserialized ArrayBuffer. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type StyledStringUnmarshallCallback = (buf: ArrayBuffer) => StyledStringMarshallingValue; - /** * StyledString * @@ -181,34 +140,6 @@ declare class StyledString { */ static toHtml(styledString: StyledString): string; - /** - * Returns ArrayBuffer from the serialized styled string. - * - * @param { StyledString } styledString - StyledString parameter. - * @param { function } callback - When marshalling StyledStringMarshingValue, will trigger this callback to get ArrayBuffer - * @returns { ArrayBuffer } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since 18 - */ - static marshalling(styledString: StyledString, callback: StyledStringMarshallCallback): ArrayBuffer; - - /** - * Returns StyledString from the deserialized ArrayBuffer. - * - * @param { ArrayBuffer } buffer - The buffer will be deserialized to a StyledString. - * @param { function } callback - When unmarshalling ArrayBuffer, will trigger this callback to get StyledStringMarshingValue - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since 18 - */ - static unmarshalling(buffer: ArrayBuffer, callback: StyledStringUnmarshallCallback): Promise; - /** * Returns ArrayBuffer from the serialized styled string. * @@ -883,18 +814,6 @@ declare class ParagraphStyle { * @since 12 */ readonly leadingMargin?: number | LeadingMarginPlaceholder; - - /** - * Get the paragraph spacing of the StyledString. - * - * @type { ?number } - * @readonly - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - readonly paragraphSpacing?: number; } /** @@ -972,17 +891,6 @@ declare interface ParagraphStyleInterface { * @since 12 */ leadingMargin?: LengthMetrics | LeadingMarginPlaceholder; - - /** - * Set the paragraph spacing of the StyledString. - * - * @type { ?LengthMetrics } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - paragraphSpacing?: LengthMetrics; } /** diff --git a/api/@internal/component/ets/swiper.d.ts b/api/@internal/component/ets/swiper.d.ts index 6c7fbe0bfb86fac417189e68d99c9c56eb0dfaff..302249893c469731c6ae28b08360217e6f473bef 100644 --- a/api/@internal/component/ets/swiper.d.ts +++ b/api/@internal/component/ets/swiper.d.ts @@ -173,6 +173,7 @@ declare class SwiperController { */ /** * Called when need to stop the swiper animation. + * Anonymous Object Rectification * * @param { ?VoidCallback } callback * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -312,19 +313,6 @@ declare class Indicator { */ bottom(value: Length): T; - /** - * Set the offset of indicator to the bottom. - * - * @param { LengthMetrics | Length } bottom - the offset of indicator to the bottom. - * @param { boolean } ignoreSize - ignore the size of the indicator. - * @returns { T } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - bottom(bottom: LengthMetrics | Length, ignoreSize: boolean): T; /** * Set the indicator to the left in LTR @@ -612,19 +600,6 @@ declare class DotIndicator extends Indicator { * @since 12 */ maxDisplayCount(maxDisplayCount: number): DotIndicator; - - /** - * Set the space between dots. - * - * @param { LengthMetrics } space - the space between dots - * @returns { DotIndicator } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since 18 - */ - space(space: LengthMetrics): DotIndicator; } /** @@ -1976,6 +1951,7 @@ declare class SwiperAttribute extends CommonMethod { */ /** * Called when the index value changes. + * Anonymous Object Rectification * * @param { Callback } event * @returns { SwiperAttribute } @@ -2125,6 +2101,7 @@ declare class SwiperAttribute extends CommonMethod { */ /** * Called when the swiper animation start. + * Anonymous Object Rectification * * @param { OnSwiperAnimationStartCallback } event * @returns { SwiperAttribute } @@ -2171,6 +2148,7 @@ declare class SwiperAttribute extends CommonMethod { */ /** * Called when the swiper animation end. + * Anonymous Object Rectification * * @param { OnSwiperAnimationEndCallback } event * @returns { SwiperAttribute } @@ -2207,6 +2185,7 @@ declare class SwiperAttribute extends CommonMethod { */ /** * Called when the swiper swipe with the gesture. + * Anonymous Object Rectification * * @param { OnSwiperGestureSwipeCallback } event * @returns { SwiperAttribute } diff --git a/api/@internal/component/ets/tab_content.d.ts b/api/@internal/component/ets/tab_content.d.ts index 6a1bc94f6c9c2c13a54ad4e67238e8cc43dbe97f..64bb69890db41e6821510e897c4f746fae88ceac 100644 --- a/api/@internal/component/ets/tab_content.d.ts +++ b/api/@internal/component/ets/tab_content.d.ts @@ -555,6 +555,16 @@ declare interface TabBarOptions { * @atomicservice * @since 11 */ + /** + * TabBar icon. + * Anonymous Object Rectification + * + * @type { ?(string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ icon?: string | Resource; /** @@ -581,6 +591,16 @@ declare interface TabBarOptions { * @atomicservice * @since 11 */ + /** + * TabBar text. + * Anonymous Object Rectification + * + * @type { ?(string | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ text?: string | Resource } @@ -1177,6 +1197,7 @@ declare class TabContentAttribute extends CommonMethod { */ /** * Called when tabbar is entered. + * Anonymous Object Rectification * * @param { string | Resource | CustomBuilder | TabBarOptions } options - TabBar options. * @returns { TabContentAttribute } @@ -1218,6 +1239,7 @@ declare class TabContentAttribute extends CommonMethod { /** * Set the content of the tab bar. + * Anonymous Object Rectification * * @param { ComponentContent | SubTabBarStyle | BottomTabBarStyle | string | Resource | CustomBuilder | TabBarOptions } content * Set the content of the tab bar. diff --git a/api/@internal/component/ets/tabs.d.ts b/api/@internal/component/ets/tabs.d.ts index 8558e19f132b809cafc3d0dccf8ea0aa8a33338a..9a980d44ee68d8d5b40404fd9706554c179fbf28 100644 --- a/api/@internal/component/ets/tabs.d.ts +++ b/api/@internal/component/ets/tabs.d.ts @@ -304,37 +304,6 @@ declare enum LayoutStyle { SPACE_BETWEEN_OR_CENTER = 2 } -/** - * Declare the cache mode of the child components. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare enum TabsCacheMode { - /** - * Caches the child components on both sides of the current child components. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - CACHE_BOTH_SIDE = 0, - - /** - * Caches the latest switched child components. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - CACHE_LATEST_SWITCHED = 1 -} - /** * Provides methods for switching tabs. * @@ -1387,6 +1356,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when the tab is switched. + * Anonymous Object Rectification * * @param { Callback } event * @returns { TabsAttribute } @@ -1430,6 +1400,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when the tab is clicked. + * Anonymous Object Rectification * * @param { Callback } event * @returns { TabsAttribute } @@ -1479,6 +1450,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when the tab content flip animation start. + * Anonymous Object Rectification * * @param { OnTabsAnimationStartCallback } handler * @returns { TabsAttribute } @@ -1514,6 +1486,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when the tab content flip animation end. + * Anonymous Object Rectification * * @param { OnTabsAnimationEndCallback } handler * @returns { TabsAttribute } @@ -1549,6 +1522,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when swiping the tab content with the gesture. + * Anonymous Object Rectification * * @param { OnTabsGestureSwipeCallback } handler * @returns { TabsAttribute } @@ -1688,6 +1662,7 @@ declare class TabsAttribute extends CommonMethod { /** * Custom tab content transition animation. * When undefined is set, this interface does not take effect. + * Anonymous Object Rectification * * @param { TabsCustomContentTransitionCallback } delegate - Custom content transition animation. * @returns { TabsAttribute } The attribute of the tabs. @@ -1763,6 +1738,7 @@ declare class TabsAttribute extends CommonMethod { */ /** * Called when content will change. + * Anonymous Object Rectification * * @param { OnTabsContentWillChangeCallback } handler * @returns { TabsAttribute } @@ -1772,19 +1748,6 @@ declare class TabsAttribute extends CommonMethod { * @since 18 */ onContentWillChange(handler: OnTabsContentWillChangeCallback): TabsAttribute; - - /** - * Sets the maximum number of child components to be cached. - * - * @param { number } count - the maximum number of child components to be cached. - * @param { TabsCacheMode } mode - the mode of caching child components. - * @returns { TabsAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - cachedMaxCount(count: number, mode: TabsCacheMode): TabsAttribute; } /** @@ -1853,6 +1816,7 @@ declare interface TabContentAnimatedTransition { */ /** * Called when custom content transition animation start. + * Anonymous Object Rectification * * @type { Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@internal/component/ets/text.d.ts b/api/@internal/component/ets/text.d.ts index 4e083f0378f2585d7014b47a1bc388ee80ad887c..d3576c5508dda1140e4bb1ab705ec4dc5fe24ce5 100644 --- a/api/@internal/component/ets/text.d.ts +++ b/api/@internal/component/ets/text.d.ts @@ -21,6 +21,7 @@ /** * Text overflow options. * + * Anonymous Object Rectification. * @interface TextOverflowOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -63,6 +64,17 @@ declare interface TextOverflowOptions { * @atomicservice * @since 11 */ + /** + * Text overflow option. + * + * Anonymous Object Rectification. + * @type { TextOverflow } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ overflow: TextOverflow; } @@ -613,6 +625,7 @@ declare class TextAttribute extends CommonMethod { /** * Called when the overflow mode of the font is set. * + * Anonymous Object Rectification. * @param { TextOverflowOptions } options - Text overflow options. * @returns { TextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@internal/component/ets/text_area.d.ts b/api/@internal/component/ets/text_area.d.ts index b0ccd467e1f5fa5525d9baed2ac6ba5c7e8a7bea..e16e41e6508594a83a49e3a321e92d55d10a2d66 100644 --- a/api/@internal/component/ets/text_area.d.ts +++ b/api/@internal/component/ets/text_area.d.ts @@ -1508,18 +1508,6 @@ declare class TextAreaAttribute extends CommonMethod { */ enableHapticFeedback(isEnabled: boolean): TextAreaAttribute; - /** - * Set text mode of automatic case mode switching. - * - * @param { AutoCapitalizationMode } mode - Automatic case mode values. - * @returns { TextAreaAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - */ - autoCapitalizationMode(mode: AutoCapitalizationMode): TextAreaAttribute; - /** * Set the text with half leading. * diff --git a/api/@internal/component/ets/text_clock.d.ts b/api/@internal/component/ets/text_clock.d.ts index f5facc3693689c31be0273f531eca8cf3dfe6f8d..011184e44215cd95a6819d4fc585e305b5852b4e 100644 --- a/api/@internal/component/ets/text_clock.d.ts +++ b/api/@internal/component/ets/text_clock.d.ts @@ -167,7 +167,7 @@ declare interface TextClockConfiguration extends CommonConfiguration /** * Defines a TextInput callback when onTextSelectionChange. * + * Anonymous Object Rectification. * @typedef { function } OnTextSelectionChangeCallback * @param { number } selectionStart - The starting position of the selected text, the starting position of the text is 0. * @param { number } selectionEnd - The end location of the selected text. @@ -1238,6 +1240,7 @@ declare type OnTextSelectionChangeCallback = (selectionStart: number, selectionE /** * Defines a TextInput callback when onContentScroll. * + * Anonymous Object Rectification. * @typedef { function } OnContentScrollCallback * @param { number } totalOffsetX - The text is offset in px on the horizontal axis of the content area. * @param { number } totalOffsetY - The text is offset in px on the vertical axis of the content area. @@ -1252,6 +1255,7 @@ declare type OnContentScrollCallback = (totalOffsetX: number, totalOffsetY: numb /** * Defines a TextInput callback when onPaste. * + * Anonymous Object Rectification. * @typedef { function } OnPasteCallback * @param { string } content - The text content of the paste. * @param { PasteEvent } event - User-defined paste event. @@ -1509,6 +1513,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when judging whether the text editing change finished. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1548,6 +1553,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when submitted. * + * Anonymous Object Rectification. * @param { OnSubmitCallback } callback - Callback of the listened event. * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1618,6 +1624,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when the text selection changes. * + * Anonymous Object Rectification. * @param { OnTextSelectionChangeCallback } callback - Callback of the listened event. * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1649,6 +1656,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when the content scrolls. * + * Anonymous Object Rectification. * @param { OnContentScrollCallback } callback - Callback of the listened event. * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1865,6 +1873,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when the inputFilter of text is set. * + * Anonymous Object Rectification. * @param { ResourceStr } value * @param { Callback } [error] * @returns { TextInputAttribute } @@ -1905,6 +1914,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1944,6 +1954,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { Callback } callback * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1986,6 +1997,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Called when using the Clipboard menu. * + * Anonymous Object Rectification. * @param { OnPasteCallback } callback - Executed when a paste operation is performed. * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -2448,6 +2460,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Set the cancel button style. * + * Anonymous Object Rectification. * @param { CancelButtonOptions } options - Indicates the style of the cancel button. * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -2745,18 +2758,6 @@ declare class TextInputAttribute extends CommonMethod { */ enableHapticFeedback(isEnabled: boolean): TextInputAttribute; - /** - * Set text mode of automatic case mode switching. - * - * @param { AutoCapitalizationMode } mode - Automatic case mode switching. - * @returns { TextInputAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - */ - autoCapitalizationMode(mode: AutoCapitalizationMode): TextInputAttribute; - /** * Set the text with half leading. * @@ -2772,7 +2773,7 @@ declare class TextInputAttribute extends CommonMethod { /** * Set the ellipsis mode. * - * @param { EllipsisMode } mode - The ellipsis mode. + * @param { Optional } mode - The ellipsis mode. * @returns { TextInputAttribute } The attribute of TextInput. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform diff --git a/api/@internal/component/ets/text_picker.d.ts b/api/@internal/component/ets/text_picker.d.ts index 2d3b976c8b54296a0067ad8d057c7674227d021f..18f9222cf7f09a4322f6eb7295576aed2c134782 100644 --- a/api/@internal/component/ets/text_picker.d.ts +++ b/api/@internal/component/ets/text_picker.d.ts @@ -1330,28 +1330,6 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the textPickerDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the textPickerDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Callback function when the dialog appears. * diff --git a/api/@internal/component/ets/time_picker.d.ts b/api/@internal/component/ets/time_picker.d.ts index 535ad84ead136849f576c276ee017acb9e64457f..fccc41bdd281900543744d3bac057c68141b111a 100644 --- a/api/@internal/component/ets/time_picker.d.ts +++ b/api/@internal/component/ets/time_picker.d.ts @@ -965,28 +965,6 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the timePickerDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the timePickerDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Defines whether the AM/PM option is cascaded with the time in 12-hour mode. * diff --git a/api/@internal/component/ets/toggle.d.ts b/api/@internal/component/ets/toggle.d.ts index b1344ab7c46dcb7bdc939fb532d31c7cd147c235..85c27baa49cae0c6d55796cf581bbe6418b043fa 100644 --- a/api/@internal/component/ets/toggle.d.ts +++ b/api/@internal/component/ets/toggle.d.ts @@ -296,6 +296,17 @@ declare interface ToggleOptions { * @atomicservice * @since 11 */ + /** + * Type of the toggle. + * Anonymous Object Rectification. + * + * @type { ToggleType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ type: ToggleType; /** @@ -332,6 +343,17 @@ declare interface ToggleOptions { * @atomicservice * @since 11 */ + /** + * Whether the toggle is on. + * Anonymous Object Rectification. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ isOn?: boolean } @@ -410,6 +432,7 @@ interface ToggleInterface { */ /** * Set parameters to obtain the toggle. + * Anonymous Object Rectification. * * @param { ToggleOptions } options - toggle options * @returns { ToggleAttribute } diff --git a/api/@internal/component/ets/ui_extension_component.d.ts b/api/@internal/component/ets/ui_extension_component.d.ts index 98f807a2e72805dd36ae2b259636860251c5ac2f..0f6445ff78bd453db554fcf1d8377a03a71c8c56 100644 --- a/api/@internal/component/ets/ui_extension_component.d.ts +++ b/api/@internal/component/ets/ui_extension_component.d.ts @@ -169,6 +169,7 @@ declare interface TerminationInfo { /** * Get Callback from @ohos.base. + * AnonyMous Object Rectification * * @typedef { import('../api/@ohos.base').Callback> } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -198,6 +199,7 @@ declare interface UIExtensionProxy { */ /** * This function is for sending data to the UIExtensionAbility. + * AnonyMous Object Rectification * * @param { Record } data * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -219,6 +221,7 @@ declare interface UIExtensionProxy { */ /** * This function is for sending data to the UIExtensionAbility and waiting the result in blocking mode. + * AnonyMous Object Rectification * * @param { Record } data - Data send to the UIExtensionAbility. * @returns { Record } data - Data transferred from the UIExtensionAbility. @@ -241,6 +244,7 @@ declare interface UIExtensionProxy { */ /** * Register the listener that watches for async data receiver callback being registered by UIExtensionAbility. + * AnonyMous Object Rectification * * @param { 'asyncReceiverRegister' } type - Indicates the type of event. * @param { Callback } callback - Callback of the listened event. @@ -261,6 +265,7 @@ declare interface UIExtensionProxy { */ /** * Register the listener that watches for sync data receiver callback being registered by UIExtensionAbility. + * AnonyMous Object Rectification * * @param { 'syncReceiverRegister' } type - Indicates the type of event. * @param { Callback } callback - Callback of the listened event. @@ -281,6 +286,7 @@ declare interface UIExtensionProxy { */ /** * Deregisters the listener that watches for async data receiver callback being registered by UIExtensionAbility. + * AnonyMous Object Rectification * * @param { 'asyncReceiverRegister' } type - Type of the listened event. * @param { Callback } [callback] - Callback of the listened event. @@ -301,6 +307,7 @@ declare interface UIExtensionProxy { */ /** * Deregisters the listener that watches for sync data receiver callback being registered by UIExtensionAbility. + * AnonyMous Object Rectification * * @param { 'syncReceiverRegister' } type - Type of the listened event. * @param { Callback } [callback] - Callback of the listened event. @@ -379,6 +386,8 @@ declare class UIExtensionComponentAttribute extends CommonMethod { */ /** * Called when the video is played. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { VideoAttribute } @@ -1065,6 +1096,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the video is paused. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { VideoAttribute } @@ -1104,6 +1136,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the video playback ends. + * Anonymous Object Rectification. * * @param { VoidCallback } event * @returns { VideoAttribute } @@ -1143,6 +1176,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the video enters and exits the full screen. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { VideoAttribute } @@ -1182,6 +1216,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the video preparation is complete. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { VideoAttribute } @@ -1221,6 +1256,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the time information is reported when the progress bar process is operated. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { VideoAttribute } @@ -1260,6 +1296,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the playback time information is reported after the operation progress bar is completed. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { VideoAttribute } @@ -1299,6 +1336,7 @@ declare class VideoAttribute extends CommonMethod { */ /** * Called when the playback progress changes. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { VideoAttribute } diff --git a/api/@internal/component/ets/web.d.ts b/api/@internal/component/ets/web.d.ts index 0d1790b0f402f13d60d065ed8be0ea57c0b1df11..8c738eb07ae48843a95c352266dc8391c4a07a3c 100644 --- a/api/@internal/component/ets/web.d.ts +++ b/api/@internal/component/ets/web.d.ts @@ -397,7 +397,7 @@ declare enum MessageLevel { * @atomicservice * @since 11 */ - Debug = 0, + Debug, /** * Error level. @@ -413,7 +413,7 @@ declare enum MessageLevel { * @atomicservice * @since 11 */ - Error = 1, + Error, /** * Info level. @@ -429,7 +429,7 @@ declare enum MessageLevel { * @atomicservice * @since 11 */ - Info = 2, + Info, /** * Log level. @@ -445,7 +445,7 @@ declare enum MessageLevel { * @atomicservice * @since 11 */ - Log = 3, + Log, /** * Warn level. @@ -461,7 +461,7 @@ declare enum MessageLevel { * @atomicservice * @since 11 */ - Warn = 4 + Warn } /** @@ -755,15 +755,6 @@ declare enum CacheMode { */ Default = 0, - /** - * load cache when they are available and not expired, otherwise load online. - * - * @syscap SystemCapability.Web.Webview.Core - * @atomicservice - * @since 18 - */ - DEFAULT = 0, - /** * load cache when they are available, otherwise load online. * @@ -787,15 +778,6 @@ declare enum CacheMode { */ None = 1, - /** - * load cache when they are available even if the cache is expired. - * - * @syscap SystemCapability.Web.Webview.Core - * @atomicservice - * @since 18 - */ - CACHE_ELSE_NETWORK = 1, - /** * Load online and not cache. * @@ -819,15 +801,6 @@ declare enum CacheMode { */ Online = 2, - /** - * load only from network, not use cache. - * - * @syscap SystemCapability.Web.Webview.Core - * @atomicservice - * @since 18 - */ - NO_CACHE = 2, - /** * load cache and not online. * @@ -849,16 +822,7 @@ declare enum CacheMode { * @atomicservice * @since 18 */ - Only = 3, - - /** - * load cache and not online. - * - * @syscap SystemCapability.Web.Webview.Core - * @atomicservice - * @since 18 - */ - CACHE_ONLY = 3 + Only = 3 } /** @@ -6703,24 +6667,6 @@ declare enum WebResponseType { LONG_PRESS = 1 } -/** - * Defines the options of preview menu - * - * @interface PreviewMenuOptions - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ -declare interface PreviewMenuOptions { - /** - * Defines the haptic feedback mode of preview menu. - * - * @type { ?HapticFeedbackMode } - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ - hapticFeedbackMode?: HapticFeedbackMode; -} - /** * Defines the selection menu options. * @@ -6764,15 +6710,6 @@ declare interface SelectionMenuOptionsExt { * @since 13 */ menuType?: MenuType; - - /** - * Defines the options of preview menu. - * - * @type { ?PreviewMenuOptions } - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ - previewMenuOptions?: PreviewMenuOptions; } /** @@ -9647,8 +9584,10 @@ declare interface NestedScrollOptionsExt { */ declare interface EmbedOptions { /** - * Whether the embed element support the default intrinsic size of 300 * 150. - *
Default value is false. If false, then the intrinsic size is 0 * 0. + * Whether the embed element support the default intrinsic size of 300 * 150, expressed in CSS pixels. + *
When CSS size is set, the embed element size is CSS size, otherwise it is intrinsic size. + *
If true, then the intrinsic size is 300 * 150. + *
If false, the embed element will not be rendered when the CSS size is not set. * * @type { ?boolean } * @default false @@ -9656,4 +9595,4 @@ declare interface EmbedOptions { * @since 16 */ supportDefaultIntrinsicSize?: boolean; -} \ No newline at end of file +} diff --git a/api/@internal/component/ets/xcomponent.d.ts b/api/@internal/component/ets/xcomponent.d.ts index 571d2ce314c0ecf2696c63e2517159933e63d3f2..2e38b80135b441ee2ecf6e1c3c8662d2141e0341 100644 --- a/api/@internal/component/ets/xcomponent.d.ts +++ b/api/@internal/component/ets/xcomponent.d.ts @@ -302,36 +302,16 @@ declare interface XComponentOptions { * @since 12 */ imageAIOptions?: ImageAIOptions; -} -/** - * Defines the native xcomponent parameters. - * - * @interface NativeXComponentParameters - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ -declare interface NativeXComponentParameters { /** - * The type of xcomponent + * Identifier of a screen. * - * @type { XComponentType } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - type: XComponentType; - - /** - * Image ai options. - * - * @type { ?ImageAIOptions } + * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 + * @systemapi + * @since 17 */ - imageAIOptions?: ImageAIOptions; + screenId?: number; } /** @@ -392,17 +372,6 @@ interface XComponentInterface { * @since 12 */ (options: XComponentOptions): XComponentAttribute; - - /** - * Constructor parameters - * - * @param { NativeXComponentParameters } params - Indicates the constructor parameters of the xcomponent for native developing. - * @returns { XComponentAttribute } The attribute of the xcomponent. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - (params: NativeXComponentParameters): XComponentAttribute; } /** @@ -455,6 +424,7 @@ declare class XComponentAttribute extends CommonMethod { */ /** * Called when judging whether the xcomponent surface is created. + * Anonymous Object Rectification. * * @param { OnNativeLoadCallback } callback - Called when judging whether the xcomponent surface is created. * @returns { XComponentAttribute } @@ -485,6 +455,7 @@ declare class XComponentAttribute extends CommonMethod { */ /** * Called when judging whether the xcomponent is destroyed. + * Anonymous Object Rectification. * * @param { VoidCallback } event - Called when judging whether the xcomponent is destroyed. * @returns { XComponentAttribute } diff --git a/api/@ohos.PiPWindow.d.ts b/api/@ohos.PiPWindow.d.ts index 81ebbcadcb6e558ee34462d59dfd6a787a8dbac4..4a57aceb152b32c639a00aa339f2fb3ca13c29ff 100644 --- a/api/@ohos.PiPWindow.d.ts +++ b/api/@ohos.PiPWindow.d.ts @@ -243,6 +243,16 @@ declare namespace PiPWindow { * @since 12 */ customUIController?: NodeController; + + /** + * Describes the data object shared within the content instance loaded by the window. + * + * @type { ?LocalStorage } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 17 + */ + localStorage?: LocalStorage; } /** diff --git a/api/@ohos.UiTest.d.ts b/api/@ohos.UiTest.d.ts index 632fc87c7deb0649e3eced3ef84b94407c673d51..2e2634f7ebb0f22cbd20a35903d452b050cb3ffa 100644 --- a/api/@ohos.UiTest.d.ts +++ b/api/@ohos.UiTest.d.ts @@ -149,7 +149,6 @@ declare enum MatchPattern { * Matches the given value using a regular expression, which is case sensitive. * * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 */ @@ -158,7 +157,6 @@ declare enum MatchPattern { * Matches the given value using a regular expression, which is case insensitive. * * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 */ @@ -2197,7 +2195,6 @@ declare class On { * @returns { On } this {@link On} object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 * @test @@ -2211,7 +2208,6 @@ declare class On { * @returns { On } this {@link On} object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 * @test @@ -2225,7 +2221,6 @@ declare class On { * @returns { On } this {@link On} object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 * @test @@ -3119,7 +3114,6 @@ declare class Component { * @throws { BusinessError } 17000002 - The async function is not called with await. * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice * @since 18 * @test @@ -4271,7 +4265,7 @@ declare class Driver { * @returns { Promise } * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 17000002 The async function is not called with await. - * @throws { BusinessError } 17000005 This device can not support this action. + * @throws { BusinessError } 17000005 This operation is not supported. * @syscap SystemCapability.Test.UiTest * @atomicservice * @since 18 diff --git a/api/@ohos.abilityAccessCtrl.d.ts b/api/@ohos.abilityAccessCtrl.d.ts index 11233217060e2adbfcec71f62c9e6405b3c0bfa3..0a88c03bea8459816295197babba0c04b823073d 100644 --- a/api/@ohos.abilityAccessCtrl.d.ts +++ b/api/@ohos.abilityAccessCtrl.d.ts @@ -618,7 +618,6 @@ declare namespace abilityAccessCtrl { * * @param { number } tokenID - Token ID of the application. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100007 - The service is abnormal. diff --git a/api/@ohos.account.osAccount.d.ts b/api/@ohos.account.osAccount.d.ts index 0b9cbc77692ea87218d737a7b13dbfbd824c64a3..8aad41291a1e81e13c83069b68274be87c19d582 100644 --- a/api/@ohos.account.osAccount.d.ts +++ b/api/@ohos.account.osAccount.d.ts @@ -2288,26 +2288,6 @@ declare namespace osAccount { * @since 12 */ shortName: string; - - /** - * Indicates the bundles are disallowed to be preinstalled on the OS account. - * - * @type { ?Array } - * @syscap SystemCapability.Account.OsAccount - * @systemapi Hide this for inner system use. - * @since 18 - */ - disallowedPreinstalledBundles?: Array; - - /** - * Indicates the bundles are allowed to be preinstalled on the OS account. - * - * @type { ?Array } - * @syscap SystemCapability.Account.OsAccount - * @systemapi Hide this for inner system use. - * @since 18 - */ - allowedPreinstalledBundles?: Array; } /** @@ -3472,8 +3452,6 @@ declare namespace osAccount { * @param { DomainAccountInfo } newAccountInfo - Indicates the new domain account information. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - The new account info is invalid. @@ -3654,8 +3632,6 @@ declare namespace osAccount { * @param { Record } parameters - Indicates the server config parameters. * @returns { Promise } Returns the added domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid server config parameters. @@ -3675,8 +3651,6 @@ declare namespace osAccount { * @param { string } configId - Indicates the server config identifier. * @returns { Promise } Returns void. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300212 - Server config not found. @@ -3690,13 +3664,11 @@ declare namespace osAccount { /** * Updates the target server config with the specified parameters. * - * @permission ohos.permission.MANAGE_DOMAIN_ACCOUNT_SERVER_CONFIGS + * @permission ohos.permission.MANAGE_DOMAIN_ACCOUNT_SERVER_CONFIGS * @param { string } configId - Indicates the server config identifier. * @param { Record } parameters - Indicates the server config parameters. * @returns { Promise } Returns the updated domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid server config parameters. @@ -3717,8 +3689,6 @@ declare namespace osAccount { * @param { string } configId - Indicates the server config identifier. * @returns { Promise } Returns the server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300212 - Server config not found. @@ -3749,8 +3719,6 @@ declare namespace osAccount { * @param { DomainAccountInfo } domainAccountInfo - Indicates the domain account information. * @returns { Promise } Returns the domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300003 - Domain account not found. diff --git a/api/@ohos.app.ability.StartOptions.d.ts b/api/@ohos.app.ability.StartOptions.d.ts index 08ce48efb8ecf69e1d41ff14983a82cc80dfe99c..4dafb4fe684f3f3cf96459c59717532af536dcf2 100644 --- a/api/@ohos.app.ability.StartOptions.d.ts +++ b/api/@ohos.app.ability.StartOptions.d.ts @@ -189,9 +189,9 @@ export default class StartOptions { * The min width of window rectangle. * * @type { ?number } - * @syscap SystemCapAbility.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since 17 */ minWindowWidth?: number; @@ -199,9 +199,9 @@ export default class StartOptions { * The min height of window rectangle. * * @type { ?number } - * @syscap SystemCapAbility.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since 17 */ minWindowHeight?: number; @@ -209,9 +209,9 @@ export default class StartOptions { * The max width of window rectangle. * * @type { ?number } - * @syscap SystemCapAbility.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since 17 */ maxWindowWidth?: number; @@ -219,9 +219,9 @@ export default class StartOptions { * The max height of window rectangle. * * @type { ?number } - * @syscap SystemCapAbility.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since 17 */ maxWindowHeight?: number; } \ No newline at end of file diff --git a/api/@ohos.app.ability.UIAbility.d.ts b/api/@ohos.app.ability.UIAbility.d.ts index 131d722f43e2a0c2b8b2836776ac720811ab8f0b..7ac55c07963336ddffbc09b92aac775e852bf5ed 100644 --- a/api/@ohos.app.ability.UIAbility.d.ts +++ b/api/@ohos.app.ability.UIAbility.d.ts @@ -522,26 +522,6 @@ export default class UIAbility extends Ability { */ onForeground(): void; - /** - * Called back when the state of an ability will changes to foreground. - * - * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly - * @atomicservice - * @since 18 - */ - onWillForeground(): void; - - /** - * Called back when the state of an ability changed to foreground. - * - * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly - * @atomicservice - * @since 18 - */ - onDidForeground(): void; - /** * Called back when the state of an ability changes to background. * @@ -568,26 +548,6 @@ export default class UIAbility extends Ability { */ onBackground(): void; - /** - * Called back when the state of an ability will changes to background. - * - * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly - * @atomicservice - * @since 18 - */ - onWillBackground(): void; - - /** - * Called back when the state of an ability changed to background. - * - * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly - * @atomicservice - * @since 18 - */ - onDidBackground(): void; - /** * Called back when an ability prepares to continue. * diff --git a/api/@ohos.app.ability.UIExtensionContentSession.d.ts b/api/@ohos.app.ability.UIExtensionContentSession.d.ts index 254253c3496053747a4c3462ea031ef591053399..b7599368f0b88215bf5545ef7d3d46244c4dca2c 100644 --- a/api/@ohos.app.ability.UIExtensionContentSession.d.ts +++ b/api/@ohos.app.ability.UIExtensionContentSession.d.ts @@ -111,8 +111,6 @@ export default class UIExtensionContentSession { * * @param { string } name - name of the page to which the content will be loaded. * @param { LocalStorage } [storage] - The data object shared within the content instance loaded by the page. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly diff --git a/api/@ohos.app.ability.continueManager.d.ts b/api/@ohos.app.ability.continueManager.d.ts index 515d4d889d283289bb18470112f6241778ddd72c..00748177aa9a7566466f933bff124e247fe1abe4 100644 --- a/api/@ohos.app.ability.continueManager.d.ts +++ b/api/@ohos.app.ability.continueManager.d.ts @@ -36,6 +36,7 @@ declare namespace continueManager { * @param { Context } context - the ability context. * @param { AsyncCallback } callback - Used to handle ('prepareContinue') command. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. + * @throws { BusinessError } 16300501 - the system ability work abnormally. * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @since 18 */ @@ -48,6 +49,7 @@ declare namespace continueManager { * @param { Context } context - the ability context. * @param { AsyncCallback } callback - Used to handle ('prepareContinue') command. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. + * @throws { BusinessError } 16300501 - the system ability work abnormally. * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @since 18 */ diff --git a/api/@ohos.app.ability.errorManager.d.ts b/api/@ohos.app.ability.errorManager.d.ts index 114c614ef812f10e6bea595d37d911fa2665a76f..0cfab9798a447fde33daaec2ed61230422ae6db6 100644 --- a/api/@ohos.app.ability.errorManager.d.ts +++ b/api/@ohos.app.ability.errorManager.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2025 Huawei Device Co., Ltd. + * Copyright (c) 2022-2023 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -37,15 +37,6 @@ import { LoopObserver as _LoopObserver } from './application/LoopObserver'; * @atomicservice * @since 11 */ -/** - * This module provides the function of error manager. - * - * @namespace errorManager - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ declare namespace errorManager { /** * Register error observer. @@ -72,20 +63,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Register error observer. - * - * @param { 'error' } type - error. - * @param { ErrorObserver } observer - The error observer. - * @returns { number } Returns the number code of the observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function on(type: 'error', observer: ErrorObserver): number; /** @@ -113,20 +90,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Unregister error observer. - * - * @param { 'error' } type - error. - * @param { number } observerId - Indicates the number code of the observer. - * @param { AsyncCallback } callback - The callback of off. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'error', observerId: number, callback: AsyncCallback): void; /** @@ -154,20 +117,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Unregister error observer. - * - * @param { 'error' } type - error. - * @param { number } observerId - Indicates the number code of the observer. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'error', observerId: number): Promise; /** @@ -350,19 +299,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Register unhandled rejection observer. - * - * @param { 'unhandledRejection' } type - 'unhandledRejection'. - * @param { UnhandledRejectionObserver } observer - The unhandled rejection observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16200001 - If the caller is invalid. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function on(type: 'unhandledRejection', observer: UnhandledRejectionObserver): void; /** @@ -378,20 +314,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Unregister unhandled rejection observer. - * - * @param { 'unhandledRejection' } type - error. - * @param { UnhandledRejectionObserver } [observer] - the registered observer - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16200001 - If the caller is invalid. - * @throws { BusinessError } 16300004 - If the observer does not exist - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'unhandledRejection', observer?: UnhandledRejectionObserver): void; /** @@ -439,15 +361,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * The observer will be called by system when an error occurs. - * - * @typedef { _ErrorObserver.default } - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export type ErrorObserver = _ErrorObserver.default; /** * The observer will be called when application main thread execute timeout. @@ -468,17 +381,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * 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 } promise - the promise that is rejected - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export type UnhandledRejectionObserver = (reason: Error | any, promise: Promise) => void; /** * The observer will be called by system when freeze happens. diff --git a/api/@ohos.application.DistributedExtensionAbility.d.ts b/api/@ohos.application.DistributedExtensionAbility.d.ts deleted file mode 100644 index 0ec7469f3a14a1aa210a112ee4ac6746302f4cd1..0000000000000000000000000000000000000000 --- a/api/@ohos.application.DistributedExtensionAbility.d.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Copyright (c) 2025 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 DistributedServiceKit - */ - -import Want from './@ohos.app.ability.Want'; -import AbilityConstant from './@ohos.app.ability.AbilityConstant'; -import type DistributedExtensionContext from './@ohos.application.DistributedExtensionContext'; - -/** - * Class to be override for distributed extension ability. - * - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ - -export default class DistributedExtensionAbility { - - /** - * distributed collaborative context. - * - * @type { DistributedExtensionContext } - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ - context: DistributedExtensionContext; - - /** - * Callback when Extension is started - * - * @param { Want } want Indicates the want info of ability. - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ - onCreate(want: Want): void; - - /** - * Callback when the distributed collaborative extension is destroyed - * - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ - onDestroy(): void; - - /** - * Callback when there is a request in distributed collaboration - * - * @param { Record } wantParam - Indicates the want parameter. - * @returns { AbilityConstant.CollaborateResult } Return the result of onCollaborate. - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ - onCollaborate(wantParam: Record): AbilityConstant.CollaborateResult; -} diff --git a/api/@ohos.application.DistributedExtensionContext.d.ts b/api/@ohos.application.DistributedExtensionContext.d.ts deleted file mode 100644 index 17a0dde2503e1452f37ac10b67608ea6f9abb8e6..0000000000000000000000000000000000000000 --- a/api/@ohos.application.DistributedExtensionContext.d.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (c) 2025 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 DistributedServiceKit - */ - -import type ExtensionContext from './application/ExtensionContext'; -/** - * Class inherited for the distributed extension function. - * - * @extends ExtensionContext - * @syscap SystemCapability.DistributedSched.AppCollaboration - * @stagemodelonly - * @since 18 - */ -export default class DistributedExtensionContext extends ExtensionContext {} \ No newline at end of file diff --git a/api/@ohos.arkui.ArcSwiper.d.ts b/api/@ohos.arkui.ArcSwiper.d.ts index 0a3f8871f87cb1413988697a03964df7d729e0f8..ff7b734adc41477d7f521dcc72b7573b2a9628bf 100644 --- a/api/@ohos.arkui.ArcSwiper.d.ts +++ b/api/@ohos.arkui.ArcSwiper.d.ts @@ -508,10 +508,9 @@ declare class ArcSwiperAttribute extends CommonMethod { onGestureSwipe(handler: Optional): ArcSwiperAttribute; /** - * Invoked when setting the sliding effect + * Set effect when scrolling over edge. * - * @param { Optional } edgeEffect - scrolling effect over edge, default value is { EdgeEffect.Spring }. - + * @param { Optional } edgeEffect - scrolling effect over edge, default value is { EdgeEffect.Spring }. * @returns { ArcSwiperAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Circle * @crossplatform diff --git a/api/@ohos.arkui.StateManagement.d.ts b/api/@ohos.arkui.StateManagement.d.ts index d1f78377ffdd4314f35b614b5be3cc838cb84060..cda4f51d08136d20b46d78b3418350fc746e6921 100644 --- a/api/@ohos.arkui.StateManagement.d.ts +++ b/api/@ohos.arkui.StateManagement.d.ts @@ -18,7 +18,7 @@ * @kit ArkUI */ -import contextConstant from '@ohos.app.ability.contextConstant' +import contextConstant from '@ohos.app.ability.contextConstant'; /** * Function that returns default creator. @@ -55,7 +55,6 @@ export interface TypeConstructorWithArgs { /** * Define ConnectOptions class. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -63,7 +62,6 @@ export class ConnectOptions { /** * @type { TypeConstructorWithArgs } type class type of the stored value. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -73,7 +71,6 @@ export class ConnectOptions { * Defines alias name of the key, or the function generating the default value. * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -83,7 +80,6 @@ export class ConnectOptions { * Define the function generating the default value. * @type { ?StorageDefaultCreator} * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -95,7 +91,6 @@ export class ConnectOptions { * * @type { ?contextConstant.AreaMode} * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -188,7 +183,6 @@ export declare class PersistenceV2 extends AppStorageV2 { * @param { ConnectOptions } type Application level storage parameters. * @returns { T | undefined } the value of the existed key or the default value * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform * @atomicservice * @since 18 */ @@ -285,42 +279,15 @@ export declare class UIUtils { static getTarget(source: T): T; /** - * Make non-observed data into V2 observed data. + * 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 } V2 proxy object from the source object data. + * @returns { T } proxy object from the source object data. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ static makeObserved(source: T): T; - - /** - * Make non-observed data into V1 observed data. - * Support JS object, interface, class (non-@Observed, non-ObservedV2). - * - * @param { T } source input source object data. - * @returns { T } V1 proxy object from the source object data. - * @static - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - static makeV1Observed(source: T): T; - - /** - * Enables V2 compatibility on given viewmodel object or nested viewmodels, which are V1 observed object already. - * - * @param {T} source - The object to be made V2-compatible. - * @returns {T} The processed object with V2 compatibility enabled. - * @static - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - static enableV2Compatibility(source: T): T; } \ No newline at end of file diff --git a/api/@ohos.arkui.UIContext.d.ts b/api/@ohos.arkui.UIContext.d.ts index 999ea594144211dc55e102ebb65f1d62017f1393..13107b3f861890a9a6f8a7de3296c00ca27af12a 100644 --- a/api/@ohos.arkui.UIContext.d.ts +++ b/api/@ohos.arkui.UIContext.d.ts @@ -1005,20 +1005,20 @@ export class PromptAction { showToast(options: promptAction.ShowToastOptions): void; /** - * Displays the notification text. - * - * @param { promptAction.ShowToastOptions } options - Options. - * @returns { Promise } return the toast id that will be used by closeToast. - * @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. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ + * Displays the notification text. + * + * @param { promptAction.ShowToastOptions } options - Options. + * @returns { Promise } return the toast id that will be used by closeToast. + * @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. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ openToast(options: promptAction.ShowToastOptions): Promise; /** @@ -1190,7 +1190,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. * @throws { BusinessError } 103302 - Dialog content already exists. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1210,7 +1210,7 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. * @throws { BusinessError } 103302 - Dialog content already exists. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1230,8 +1230,8 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1248,13 +1248,13 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 - */ + */ closeCustomDialog(dialogContent: ComponentContent): Promise; /** @@ -1319,7 +1319,7 @@ export class PromptAction { * @atomicservice * @since 18 */ - getTopOrder(): LevelOrder + getTopOrder(): LevelOrder; /** * Get order value of bottom dialog. @@ -1330,7 +1330,7 @@ export class PromptAction { * @atomicservice * @since 18 */ - getBottomOrder(): LevelOrder + getBottomOrder(): LevelOrder; /** * Open popup with frameNode. @@ -1343,10 +1343,10 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - The content is incorrect. - * @throws { BusinessError } 103302 - The content already exists. - * @throws { BusinessError } 103304 - The target does not exist. - * @throws { BusinessError } 103305 - The target node is not in the component tree. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103302 - The ComponentContent already exists. + * @throws { BusinessError } 103304 - The targetId does not exist. + * @throws { BusinessError } 103305 - The node of targetId is not in the component tree. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1367,8 +1367,8 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1385,8 +1385,8 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1405,10 +1405,10 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - The content is incorrect. - * @throws { BusinessError } 103302 - The content already exists. - * @throws { BusinessError } 103304 - The target does not exist. - * @throws { BusinessError } 103305 - The target node is not in the component tree. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103302 - The ComponentContent already exists. + * @throws { BusinessError } 103304 - The targetId does not exist. + * @throws { BusinessError } 103305 - The node of targetId is not in the component tree. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1429,8 +1429,8 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1447,8 +1447,8 @@ export class PromptAction { *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. - * @throws { BusinessError } 103301 - the ComponentContent is incorrect. - * @throws { BusinessError } 103303 - the ComponentContent cannot be found. + * @throws { BusinessError } 103301 - The ComponentContent is incorrect. + * @throws { BusinessError } 103303 - The ComponentContent cannot be found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1472,22 +1472,6 @@ export class PromptAction { */ declare type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) => void; -/** - * Defines the callback type used in UIObserver watch pan event. - * The value of event indicates the information of pan event. - * The value of node indicates the frameNode which will receive the event. - * - * @typedef { function } PanListenerCallback - * @param { GestureEvent } event - the information of pan event - * @param { GestureRecognizer } current - the information of panRecognizer - * @param { FrameNode } [node] - the information of frameNode - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare type PanListenerCallback = (event: GestureEvent, current: GestureRecognizer, node?: FrameNode) => void; - /** * Defines the callback type used in UIObserver watch gesture. * The value of event indicates the information of gesture. @@ -1559,17 +1543,6 @@ export interface OverlayManagerOptions { * @since 15 */ renderRootOverlay?: boolean; - - /** - * Set whether support backPressed event or not. - * - * @type { ?boolean } - * @default true - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - enableBackPressedEvent?: boolean; } /** @@ -2023,110 +1996,6 @@ export class UIObserver { */ off(type: 'didClick', callback?: GestureEventListenerCallback): void; - /** - * Registers a callback function to be called before panGesture onActionStart is called. - * - * @param { 'beforePanStart' } type - The type of event to listen for. - * @param { PanListenerCallback } callback - The callback function to be called - * when the panGesture will be trigger or after. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - on(type: 'beforePanStart', callback: PanListenerCallback): void; - - /** - * Removes a callback function to be called before panGesture onActionStart is called. - * - * @param { 'beforePanStart' } type - The type of event to remove the listener for. - * @param { PanListenerCallback } [callback] - The callback function to remove. If not provided, - * all callbacks for the given event type will be removed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - off(type: 'beforePanStart', callback?: PanListenerCallback): void; - - /** - * Registers a callback function to be called before panGesture onActionEnd is called. - * - * @param { 'beforePanEnd' } type - The type of event to listen for. - * @param { PanListenerCallback } callback - The callback function to be called - * when the panGesture will be trigger or after. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - on(type: 'beforePanEnd', callback: PanListenerCallback): void; - - /** - * Removes a callback function to be called before panGesture onActionEnd is called. - * - * @param { 'beforePanEnd' } type - The type of event to remove the listener for. - * @param { PanListenerCallback } [callback] - The callback function to remove. If not provided, - * all callbacks for the given event type will be removed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - off(type: 'beforePanEnd', callback?: PanListenerCallback): void; - - /** - * Registers a callback function to be called after panGesture onActionStart is called. - * - * @param { 'afterPanStart' } type - The type of event to listen for. - * @param { PanListenerCallback } callback - The callback function to be called - * when the panGesture will be trigger or after. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - on(type: 'afterPanStart', callback: PanListenerCallback): void; - - /** - * Removes a callback function to be called after panGesture onActionStart is called. - * - * @param { 'afterPanStart' } type - The type of event to remove the listener for. - * @param { PanListenerCallback } [callback] - The callback function to remove. If not provided, - * all callbacks for the given event type will be removed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - off(type: 'afterPanStart', callback?: PanListenerCallback): void; - - /** - * Registers a callback function to be called after panGesture onActionEnd is called. - * - * @param { 'afterPanEnd' } type - The type of event to listen for. - * @param { PanListenerCallback } callback - The callback function to be called - * when the panGesture will be trigger or after. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - on(type: 'afterPanEnd', callback: PanListenerCallback): void; - - /** - * Removes a callback function to be called after panGesture onActionEnd is called. - * - * @param { 'afterPanEnd' } type - The type of event to remove the listener for. - * @param { PanListenerCallback } [callback] - The callback function to remove. If not provided, - * all callbacks for the given event type will be removed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - off(type: 'afterPanEnd', callback?: PanListenerCallback): void; - /** * Registers a callback function to be called when the tabContent is showed or hidden. * @@ -3478,6 +3347,28 @@ export class UIContext { */ getKeyboardAvoidMode(): KeyboardAvoidMode; + /** + * Set the pixel round mode of the system. The default mode is PixelRoundMode.PIXEL_ROUND_ON_LAYOUT_FINISH. + * + * @param { PixelRoundMode } mode - The mode of pixel round. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ + setPixelRoundMode(mode: PixelRoundMode): void; + + /** + * Get the pixel round mode of the system. + * + * @returns { PixelRoundMode } the mode of pixel round. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ + getPixelRoundMode(): PixelRoundMode; + /** * Dispach keyboard event to the frameNode with inspector key. * @@ -4028,6 +3919,32 @@ export class UIContext { * @since 16 */ getTextMenuController(): TextMenuController; + + /** + * Create a UI instance singleton without window and get its UIContext object. + * + * @param { common.UIAbilityContext | common.ExtensionContext } context - UIAbilityContext or ExtensionContext. + * @returns { UIContext | undefined } object UIContext, or undefined when failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + *
1. The number of parameters is incorrect. + *
2. Invalid parameter type of context. + * @throws { BusinessError } 100001 - Internal error. + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 17 + */ + static createUIContextWithoutWindow(context: common.UIAbilityContext | common.ExtensionContext) : UIContext | undefined; + + /** + * Destroy the UI instance singleton without window. + * + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 17 + */ + static destroyUIContextWithoutWindow(): void; } /** diff --git a/api/@ohos.arkui.advanced.ArcSlider.d.ets b/api/@ohos.arkui.advanced.ArcSlider.d.ets index 486d49eb6610c043d3e8705d7e10e0d2a3224007..99741247f87543f4b0a97462996d2781bf18ecc7 100644 --- a/api/@ohos.arkui.advanced.ArcSlider.d.ets +++ b/api/@ohos.arkui.advanced.ArcSlider.d.ets @@ -420,6 +420,18 @@ declare type ArcSliderTouchHandler = (event: TouchEvent) => void; */ declare type ArcSliderChangeHandler = (progress: number) => void; +/** + * Handler of ArcSlider, used in OnEnlarge. + * + * @typedef { function } ArcSliderEnlargeHandler + * @param { boolean } isEnlarged - the enlarged type of the ArcSlider. + * @syscap SystemCapability.ArkUI.ArkUI.Circle + * @crossplatform + * @atomicservice + * @since 18 + */ +declare type ArcSliderEnlargeHandler = (isEnlarged: boolean) => void; + /** * Construct parameter types for ArcSliderOptions. * @@ -495,6 +507,17 @@ interface ArcSliderOptionsConstructorOptions { * @since 18 */ onChange?: ArcSliderChangeHandler; + + /** + * Enlarged type changging triggers the callback. + * + * @type { ?ArcSliderEnlargeHandler } + * @syscap SystemCapability.ArkUI.ArkUI.Circle + * @crossplatform + * @atomicservice + * @since 18 + */ + onEnlarge?: ArcSliderEnlargeHandler; } /** @@ -579,6 +602,18 @@ declare class ArcSliderOptions { @Trace onChange?: ArcSliderChangeHandler; + /** + * Enlarged type changging triggers the callback. + * + * @type { ?ArcSliderEnlargeHandler } + * @syscap SystemCapability.ArkUI.ArkUI.Circle + * @crossplatform + * @atomicservice + * @since 18 + */ + @Trace + onEnlarge?: ArcSliderEnlargeHandler; + /** * The constructor used to create a ArcSliderOptions object. * diff --git a/api/@ohos.arkui.advanced.ChipGroup.d.ets b/api/@ohos.arkui.advanced.ChipGroup.d.ets index 1242e40f7ab976df799aa0b5a870eef8a043d748..bc833d450a26fa434c2aed87a31e6a63678bf675 100644 --- a/api/@ohos.arkui.advanced.ChipGroup.d.ets +++ b/api/@ohos.arkui.advanced.ChipGroup.d.ets @@ -668,7 +668,7 @@ export declare struct ChipGroup { chipGroupPadding?: ChipGroupPaddingOptions; /** - * Chip group callback. + * Chip group callback. when chip status is changed, this onChange is called. * * @type { ?Callback> } * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/@ohos.arkui.drawableDescriptor.d.ts b/api/@ohos.arkui.drawableDescriptor.d.ts index 6c7ff4b6a3120ecd4095d063ccd187c9dcfe086a..ca890716966b74baf64f928df0ce74ffe4ab5cc7 100644 --- a/api/@ohos.arkui.drawableDescriptor.d.ts +++ b/api/@ohos.arkui.drawableDescriptor.d.ts @@ -20,63 +20,6 @@ import image from './@ohos.multimedia.image'; -/** - * Indicates the return result of the data to be fetched. - * - * @typedef DrawableDescriptorResult - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface DrawableDescriptorResult { - /** - * DrawableDescriptor width.The default value is -1. - * - * @type { ?number } - * @readonly - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - readonly width?: number; - - /** - * DrawableDescriptor height.The default value is -1. - * - * @type { ?number } - * @readonly - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - readonly height?: number; -} - -/** - * DrawableDescriptor's option which is used in constructor. - * - * @typedef DrawableDescriptorOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface DrawableDescriptorOptions { - /** - * If true, it will fetch the data using the uri when object is constructing.The default value is false. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchWhenConstructingWithUri?: boolean; -} - /** * Use the DrawableDescriptor class to get drawable image. * @@ -133,54 +76,6 @@ export class DrawableDescriptor { * @since 12 */ getPixelMap(): image.PixelMap; - - /** - * Get original width of drawable object. - * - * @returns { number } Return the width of the DrawableDescriptor object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - getOriginalWidth(): number; - - /** - * Get original height of drawable object. - * - * @returns { number } Return the height of the DrawableDescriptor object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - getOriginalHeight(): number; - - /** - * Fetch the drawable's data whose corresponding uri is passed in constructor.This fetched data can be draw in Image view. - * - * @returns { Promise } Return the promise returned by the funciton. - * @throws { BusinessError } 100001 - Data loading failed. Maybe the uri is invalid. - * @throws { BusinessError } 100002 - Data decoding failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetch(): Promise; - - /** - * Fetch the drawable's data whose corresponding uri is passed in constructor.This fetched data can be draw in Image view. - * - * @returns { DrawableDescriptorResult } Return the result of the DrawableDescriptor object. - * @throws { BusinessError } 100001 - Data loading failed. Maybe the uri is invalid. - * @throws { BusinessError } 100002 - Data decoding failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchSync(): DrawableDescriptorResult; } /** @@ -347,17 +242,6 @@ export class PixelMapDrawableDescriptor extends DrawableDescriptor { * @since 12 */ constructor(src?: image.PixelMap); - - /** - * Creates a new PixelMapDrawableDescriptor. - * @param { image.PixelMap | ResourceStr } src - Indicates the resource to create PixelMapDrawableDescriptor. - * @param { DrawableDescriptorOptions } options - Indicates the option to create PixelMapDrawableDescriptor. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - constructor(src?: image.PixelMap | ResourceStr, options?: DrawableDescriptorOptions); } /** @@ -390,17 +274,6 @@ declare interface AnimationOptions { * @since 12 */ iterations?: number; - - /** - * If true, it will fetch the data using the uri when object is constructing.The default value is false. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchWhenConstructingWithUri?: boolean; } /** @@ -424,49 +297,4 @@ export class AnimatedDrawableDescriptor extends DrawableDescriptor { * @since 12 */ constructor(pixelMaps: Array, options?: AnimationOptions); - - /** - * Creates a new AnimatedDrawableDescriptor. - * @param { Array | ResourceStr } pixelMaps - Indicates the resource to create AnimatedDrawableDescriptor. - * @param { ?AnimationOptions } [options] - Animation control options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - constructor(pixelMaps: Array | ResourceStr, options?: AnimationOptions); - - /** - * Get the running status of animation. - * - * @returns { boolean } Return the running status of animation. - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - isRunning(): boolean; - - /** - * Start the animation. - * - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - start(): void; - - /** - * Stop the animation. - * - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - stop(): void; } diff --git a/api/@ohos.arkui.observer.d.ts b/api/@ohos.arkui.observer.d.ts index ea3a7070d3e855e1fd57d70bec5faae845c49396..d343fb941730845b50b6c1970aa52792d9171b11 100644 --- a/api/@ohos.arkui.observer.d.ts +++ b/api/@ohos.arkui.observer.d.ts @@ -158,7 +158,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since 17 */ ON_ACTIVE = 8, @@ -168,7 +168,7 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since 17 */ ON_INACTIVE = 9, diff --git a/api/@ohos.bluetooth.access.d.ts b/api/@ohos.bluetooth.access.d.ts index 0ce9d06f189e612b002af91b3597f82af28bd067..15547e3fbb9e46c60ca69b7f7bde47f3dbc968b4 100644 --- a/api/@ohos.bluetooth.access.d.ts +++ b/api/@ohos.bluetooth.access.d.ts @@ -332,6 +332,20 @@ declare namespace access { * @atomicservice * @since 13 */ + /** + * Unsubscribe the event reported when the Bluetooth state changes. + * + * @param { 'stateChange' } type - Type of the Bluetooth state changes event to listen for. + * @param { Callback } callback - Callback used to listen for the Bluetooth state event. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @crossplatform + * @atomicservice + * @since 18 + */ function off(type: 'stateChange', callback?: Callback): void; /** @@ -342,7 +356,8 @@ declare namespace access { * @param { string } deviceId - the randomized address of remote device. * @returns { Promise } Returns the promise object. * @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 } 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 } 2900003 - Bluetooth disabled. * @throws { BusinessError } 2900010 - The number of supported device addresses has reached the upper limit. @@ -360,7 +375,8 @@ declare namespace access { * @param { string } deviceId - the randomized address of remote device. * @returns { Promise } Returns the promise object. * @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 } 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 } 2900003 - Bluetooth disabled. * @throws { BusinessError } 2900099 - delete persistent device address failed. @@ -392,7 +408,8 @@ declare namespace access { * @param { string } deviceId - the randomized address of remote device. * @returns { boolean } Returns whether the randomized device address is valid. * @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 } 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 } 2900003 - Bluetooth disabled. * @throws { BusinessError } 2900099 - Check persistent device address failed. diff --git a/api/@ohos.bluetooth.connection.d.ts b/api/@ohos.bluetooth.connection.d.ts index 31e245edcf43b465e48a42bd802d8e0dc0d4c3c5..4436723f197650369f39c19b581c70675683c91f 100644 --- a/api/@ohos.bluetooth.connection.d.ts +++ b/api/@ohos.bluetooth.connection.d.ts @@ -473,7 +473,8 @@ declare namespace connection { * @param { boolean } [alias] - Indicates whether to obtain the device alias. If the parameter is not provided, the device alias is obtained by default. * @returns { string } Returns the device name in character string format. * @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 } 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 } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth disabled. @@ -1056,7 +1057,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @param { AsyncCallback } callback - the callback result. * @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 } 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 } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth disabled. @@ -1091,7 +1093,8 @@ declare namespace connection { * @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF". * @returns { Promise } Returns the promise object. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900001 - Service stopped. * @throws { BusinessError } 2900003 - Bluetooth disabled. @@ -1262,7 +1265,7 @@ declare namespace connection { /** * Controls the actions of Bluetooth peripherals. - * + * * @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH * @param { ControlDeviceActionParams } controlDeviceActionParams - Indicates the action for Bluetooth peripherals. * @returns { Promise } Returns the promise object. @@ -2363,7 +2366,7 @@ declare namespace connection { interface ControlDeviceActionParams { /** * Indicates the address of the peripheral. - * + * * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2372,7 +2375,7 @@ declare namespace connection { deviceId: string; /** * Indicates the control type. - * + * * @type { ControlType } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2381,7 +2384,7 @@ declare namespace connection { type: ControlType; /** * Indicates the control value. - * + * * @type { ControlTypeValue } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2390,7 +2393,7 @@ declare namespace connection { typeValue: ControlTypeValue; /** * Indicates the control object. - * + * * @type { ControlObject } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2401,7 +2404,7 @@ declare namespace connection { /** * Describes the control type. - * + * * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2410,7 +2413,7 @@ declare namespace connection { enum ControlType { /** * Indicates the control command of play. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2418,7 +2421,7 @@ declare namespace connection { PLAY = 0, /** * Indicates the control command of vibration. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2426,7 +2429,7 @@ declare namespace connection { VIBRATE = 1, /** * Indicates the control command of flash. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2434,7 +2437,7 @@ declare namespace connection { FLASH = 2, /** * Indicates the control command of lock. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2442,7 +2445,7 @@ declare namespace connection { LOCK = 3, /** * Indicates the control command of erase. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2452,7 +2455,7 @@ declare namespace connection { /** * Describes the control type value. - * + * * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2461,7 +2464,7 @@ declare namespace connection { enum ControlTypeValue { /** * Indicates the action of disable. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2469,7 +2472,7 @@ declare namespace connection { DISABLE = 0, /** * Indicates the action of enable. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2477,7 +2480,7 @@ declare namespace connection { ENABLE = 1, /** * Indicates the action of query. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2487,7 +2490,7 @@ declare namespace connection { /** * Describes the control object. - * + * * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi @@ -2496,7 +2499,7 @@ declare namespace connection { enum ControlObject { /** * Control object of left ear. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2504,7 +2507,7 @@ declare namespace connection { LEFT_EAR = 0, /** * Control object of right ear. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2512,7 +2515,7 @@ declare namespace connection { RIGHT_EAR = 1, /** * Control object of left and right ear. - * + * * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi * @since 15 @@ -2539,7 +2542,7 @@ declare namespace connection { */ trustedPairedDevices: Array; } - + /** * Describes device of cloud pair. * diff --git a/api/@ohos.bluetooth.socket.d.ts b/api/@ohos.bluetooth.socket.d.ts index 763a4eb8e325fe467efc0d6af3e010cd0844cca3..bca53505b1da79f9dc6ae0a73c62a25da68b0cf1 100644 --- a/api/@ohos.bluetooth.socket.d.ts +++ b/api/@ohos.bluetooth.socket.d.ts @@ -85,6 +85,20 @@ declare namespace socket { */ function sppConnect(deviceId: string, options: SppOptions, callback: AsyncCallback): void; + /** + * Obtain the device id in the client socket. + * + * @param { number } clientSocket - Indicates client socket. + * @returns { string } Returns the connected device id + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @since 17 + */ + function getDeviceId(clientSocket: number): string; + /** * Disables an spp server socket and releases related resources. * @@ -158,6 +172,37 @@ declare namespace socket { */ function off(type: 'sppRead', clientSocket: number, callback?: Callback): void; + /** + * Asynchronous interface for writing data to the socket. + * + * @param { number } clientSocket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. + * @param { ArrayBuffer } data - Indicates the data to write. + * @returns { Promise } Returns the promise object. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2901054 - IO error. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @since 18 + */ + function sppWriteAsync(clientSocket: number, data: ArrayBuffer): Promise; + + /** + * Asynchronous interface for reading data from the socket. + * + * @param { number } clientSocket - Indicates the client socket ID, returned by {@link sppAccept} or {@link sppConnect}. + * @returns { Promise } Returns the promise object, used to get the spp read data. + * @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 2901054 - IO error. + * @throws { BusinessError } 2900099 - Operation failed. + * @syscap SystemCapability.Communication.Bluetooth.Core + * @since 18 + */ + function sppReadAsync(clientSocket: number): Promise; + /** * Describes the spp parameters. * diff --git a/api/@ohos.bundle.bundleManager.d.ts b/api/@ohos.bundle.bundleManager.d.ts index b7a573cf434b507ab3a2b4fa6f5066e9b0888aa4..e6abee283c63df087907257252d6dfb73c309350 100644 --- a/api/@ohos.bundle.bundleManager.d.ts +++ b/api/@ohos.bundle.bundleManager.d.ts @@ -662,6 +662,14 @@ declare namespace bundleManager { */ INSIGHT_INTENT_UI = 22, + /** + * Indicates extension info with type of FENCE + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @since 18 + */ + FENCE = 24, + /** * Indicates extension info with type of asset acceleration * @@ -671,12 +679,12 @@ declare namespace bundleManager { ASSET_ACCELERATION = 26, /** - * Indicates extension info with type of distributed + * Indicates extension info with type of form edit * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 18 */ - DISTRIBUTED = 28, + FORM_EDIT = 27, /** * Indicates extension info with type of unspecified @@ -1516,7 +1524,8 @@ declare namespace bundleManager { function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo; /** - * Obtains bundleInfo based on bundleName, bundleFlags. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundleInfo based on bundleName, bundleFlags. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. @@ -1532,7 +1541,8 @@ declare namespace bundleManager { function getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback): void; /** - * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundleInfo based on bundleName, bundleFlags and userId. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. @@ -1551,7 +1561,8 @@ declare namespace bundleManager { bundleFlags: number, userId: number, callback: AsyncCallback): void; /** - * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundleInfo based on bundleName, bundleFlags and userId. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. @@ -1986,7 +1997,8 @@ declare namespace bundleManager { userId?: number): Array; /** - * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundle name by the given uid. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { number } uid - Indicates the UID of an application. @@ -2000,7 +2012,8 @@ declare namespace bundleManager { function getBundleNameByUid(uid: number, callback: AsyncCallback): void; /** - * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundle name by the given uid. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { number } uid - Indicates the UID of an application. @@ -2014,7 +2027,8 @@ declare namespace bundleManager { function getBundleNameByUid(uid: number): Promise; /** - * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundle name by the given uid. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { number } uid - Indicates the UID of an application. @@ -2877,7 +2891,8 @@ declare namespace bundleManager { function getApplicationInfoSync(bundleName: string, applicationFlags: number): ApplicationInfo; /** - * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundleInfo based on bundleName, bundleFlags and userId. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. @@ -2895,7 +2910,8 @@ declare namespace bundleManager { function getBundleInfoSync(bundleName: string, bundleFlags: number, userId: number): BundleInfo; /** - * Obtains bundleInfo based on bundleName, bundleFlags. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains bundleInfo based on bundleName, bundleFlags. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. @@ -3406,7 +3422,6 @@ declare namespace bundleManager { * @param { number } uid - Indicates the UID of an application. * @returns { SignatureInfo } The result of getting the signature info. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 18 @@ -3456,7 +3471,8 @@ declare namespace bundleManager { function getAllAppCloneBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise>; /** - * Obtains AppCloneIdentity contains bundleName and appIndex by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. + * Obtains AppCloneIdentity contains bundleName and appIndex by the given uid. + * The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO. * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { number } uid - Indicates the UID of an application. @@ -3478,7 +3494,6 @@ declare namespace bundleManager { * @returns { Promise } The result of migrating data. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 17700080 - The source paths are invalid. * @throws { BusinessError } 17700081 - The destination path is invalid. * @throws { BusinessError } 17700082 - User authentication failed. diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index 406f1d3dee1a22189300732993045cb091776f2f..7bd257a40977700af6fb32cd6688e691e3408743 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -271,6 +271,52 @@ declare namespace installer { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 13 + */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } installParam - Indicates other parameters required for the installation. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 */ /** * Install HAPs for an application. @@ -312,8 +358,9 @@ declare namespace installer { * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same - * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 18 @@ -505,6 +552,50 @@ declare namespace installer { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 13 + */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 */ /** * Install HAPs for an application. @@ -544,8 +635,9 @@ declare namespace installer { * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same - * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 18 @@ -751,6 +843,52 @@ declare namespace installer { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 13 + */ + /** + * Install haps for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. + * @returns { Promise } + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 */ /** * Install haps for an application. @@ -792,8 +930,9 @@ declare namespace installer { * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same - * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700076 - Failed to install the HAP or HSP because the app distribution type is not allowed. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 18 diff --git a/api/@ohos.bundle.launcherBundleManager.d.ts b/api/@ohos.bundle.launcherBundleManager.d.ts index 604d60397513b6ae3598546f16c68524f13e1864..d0dfbed0761158d9b9ab7f0259bcbbb65b40f6ce 100644 --- a/api/@ohos.bundle.launcherBundleManager.d.ts +++ b/api/@ohos.bundle.launcherBundleManager.d.ts @@ -78,7 +78,6 @@ declare namespace launcherBundleManager { * @param { number } userId - Indicates the id for the user. * @returns { Array } the LauncherAbilityInfo object. * @throws { BusinessError } 201 - Verify permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not support. * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found. diff --git a/api/@ohos.commonEventManager.d.ts b/api/@ohos.commonEventManager.d.ts index 4cf9fe240196ce66490278206ff7bd1ac53204ab..0598a9b7681ecfdb6d5be7bcbe4ff2cb86edfb51 100644 --- a/api/@ohos.commonEventManager.d.ts +++ b/api/@ohos.commonEventManager.d.ts @@ -48,7 +48,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -62,7 +61,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -77,7 +75,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -97,7 +94,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -113,7 +109,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -130,7 +125,6 @@ declare namespace commonEventManager { * @param { AsyncCallback } callback - The callback of publish. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -150,7 +144,6 @@ declare namespace commonEventManager { * @throws { BusinessError } 202 - not system app * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -171,7 +164,6 @@ declare namespace commonEventManager { * @throws { BusinessError } 202 - not system app * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @throws { BusinessError } 1500009 - Failed to obtain system parameters. @@ -2208,7 +2200,7 @@ declare namespace commonEventManager { * @systemapi * @since 15 */ - COMMON_EVENT_BUNDLE_RESOURCES_CHANGED = "usual.event.BUNDLE_RESOURCES_CHANGED", + COMMON_EVENT_BUNDLE_RESOURCES_CHANGED = 'usual.event.BUNDLE_RESOURCES_CHANGED', /** * This common event means that datashare is ready. diff --git a/api/@ohos.data.collaborationEditObject.d.ts b/api/@ohos.data.collaborationEditObject.d.ts deleted file mode 100644 index 6a722831980745a23f87180ec2698c21072bb5a3..0000000000000000000000000000000000000000 --- a/api/@ohos.data.collaborationEditObject.d.ts +++ /dev/null @@ -1,1147 +0,0 @@ -/* - * Copyright (c) 2025 Huawei Device Co., Ltd. - * Licensed under the Apache License, Version 2.0 (the "License"), - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** - * @file - * @kit ArkData - */ - -import { Callback } from './@ohos.base'; -import Context from './application/BaseContext'; - -/** - * Provides interfaces to collaboration edit object. - * - * @namespace collaborationEditObject - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ -declare namespace collaborationEditObject { - /** - * Manages collaboration configurations. - * - * @interface CollaborationConfig - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface CollaborationConfig { - /** - * The name of collaboration edit object. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - name: string; - } - - /** - * Obtains a collaboration edit object. - * - * @param { Context } context - Indicates the application context. - * @param { CollaborationConfig } config - Indicates the {@link CollaborationConfig} config related to this object. - * @returns { CollaborationEditObject } - Return the collaboration edit object. {@link CollaborationEditObject}. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - function getCollaborationEditObject(context: Context, config: CollaborationConfig): CollaborationEditObject; - - /** - * Deletes a collaboration edit object. - * - * @param { Context } context - Indicates the application context. - * @param { CollaborationConfig } config - Indicates the {@link CollaborationConfig} config related to this object. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - function deleteCollaborationEditObject(context: Context, config: CollaborationConfig): void; - - /** - * Manages undo redo manager configurations. - * - * @interface UndoRedoConfig - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface UndoRedoConfig { - /** - * Interval for capturing an operation in milliseconds. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - captureTimeout: number; - } - - /** - * Represents the relative position in the edit unit. - * - * @interface RelativePos - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface RelativePos { - /** - * The id of the parent in the relative position, null if parent is edit unit. - * - * @type { UniqueId | null } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - parentId: UniqueId | null; - - /** - * The name of the parent in the relative position, null if parent is not edit unit. - * - * @type { string | null } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - parentName: string | null; - - /** - * The id of the left or right in the relative position, null if left or right is null. - * - * @type { UniqueId | null } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - id: UniqueId | null; - - /** - * The position of the character binding to the relative position, default 0 means the character right after - * the relative position, less than 0 means the character left to the relative position, greater than 0 means - * the character right to the relative position. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - pos: number; - } - - /** - * The collaboration edit object record used to sync. - * - * @interface EditObjectRecord - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface EditObjectRecord { - /** - * Indicates the auto incrementing number of each record. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - cursor: number; - - /** - * The identifier used to distinguish the different clients. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - id: string; - - /** - * The collaboration edit object record data. - * - * @type { Uint8Array } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - data: Uint8Array; - } - - /** - * Describes the predicates of query condition. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - enum Predicate { - /** - * EQUAL_TO: means to query records where record field is equal to the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - EQUAL_TO = 0, - - /** - * NOT_EQUAL_TO: means to query records where record field is not equal to the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - NOT_EQUAL_TO, - - /** - * GREATER_THAN: means to query records where record field is greater than the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - GREATER_THAN, - - /** - * LESS_THAN: means to query records where record field is less than the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - LESS_THAN, - - /** - * GREATER_THAN_OR_EQUAL_TO: means to query records where record field is greater than or equal to the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - GREATER_THAN_OR_EQUAL_TO, - - /** - * LESS_THAN_OR_EQUAL_TO: means to query records where record field is less than or equal to the given field. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - LESS_THAN_OR_EQUAL_TO - } - - /** - * Describes the condition of a query request. - * - * @interface QueryCondition - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface QueryCondition { - /** - * The predicate of query condition. - * - * @type { Predicate } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - condition: Predicate; - - /** - * The edit object record field name of query condition. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - fieldName: string; - - /** - * The edit object record field value of query condition. - * - * @type { string | number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - fieldValue: string | number; - } - - /** - * Manages asset operation configurations. - * - * @interface AssetOperationConfig - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface AssetOperationConfig { - /** - * The path of asset. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - path: string; - } - - /** - * Provides definition of data upload function. - * - * @typedef { function } BatchInsertHandler - * @param { Array } records - the inserted collaboration edit object records - * @returns { Promise } the number of inserted data - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type BatchInsertHandler = (records: Array) => Promise; - - /** - * Provides definition of data query function. - * - * @typedef { function } QueryHandler - * @param { Array } queryConditions - the conditions when query data from cloud - * @returns { Promise> } the collaboration edit object records queried from cloud - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type QueryHandler = (queryConditions: Array) => Promise>; - - /** - * Provides definition of asset operation function. - * - * @typedef { function } AssetHandler - * @param { AssetOperationConfig } config - the config of asset operation - * @returns { Promise } the promise returned by the function. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type AssetHandler = (config: AssetOperationConfig) => Promise; - - /** - * Describes the handlers of CloudDB object. - * - * @interface CloudDB - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface CloudDB { - /** - * Provides ability of uploading data from local device to cloud. - * - * @type { BatchInsertHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - batchInsert: BatchInsertHandler; - - /** - * Provides ability of querying data from cloud to local device. - * - * @type { QueryHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - query: QueryHandler; - - /** - * Provides ability of downloading asset from cloud to local device. - * - * @type { AssetHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - downloadAsset: AssetHandler; - - /** - * Provides ability of uploading asset from local device to cloud. - * - * @type { AssetHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - uploadAsset: AssetHandler; - - /** - * Provides ability of deleting asset from cloud. - * - * @type { AssetHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - deleteAsset: AssetHandler; - - /** - * Provides ability of deleting asset from local device. - * - * @type { AssetHandler } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - deleteLocalAsset: AssetHandler; - } - - /** - * Describes the status of a cloud sync progress. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - enum ProgressCode { - /** - * CLOUD_SYNC_SUCCESS: means the status of progress is success. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - CLOUD_SYNC_SUCCESS = 0, - - /** - * CLOUD_NOT_SET: means the CloudDB handlers are not set. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - CLOUD_NOT_SET, - - /** - * INTERNAL_ERROR: means the cloud sync progress meets internal error. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - INTERNAL_ERROR, - - /** - * EXTERNAL_ERROR: means the cloud sync progress meets error in CloudDB handlers. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - EXTERNAL_ERROR, - } - - /** - * Describes the progress status of a cloud sync operation. - * - * @interface ProgressDetail - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface ProgressDetail { - /** - * The status code of cloud sync operation. - * - * @type { ProgressCode } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - code: ProgressCode; - } - - /** - * Indicates the mode of cloud sync operation. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - enum SyncMode { - /** - * SYNC_MODE_PUSH: Indicates the data is pushed to remote from local device. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - SYNC_MODE_PUSH = 0, - - /** - * SYNC_MODE_PULL: Indicates the data is pulled from remote to local device. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - SYNC_MODE_PULL, - - /** - * SYNC_MODE_PULL_PUSH: Indicates the data is first pulled from remote, then followed by a push operation. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - SYNC_MODE_PULL_PUSH, - } - - /** - * Provides methods for managing the collaboration edit object. - * - * @interface CollaborationEditObject - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface CollaborationEditObject { - /** - * Get an edit unit of this collaboration edit object. - * - * @param { string } editUnitName - Indicates the name of the edit unit in collaboration edit object. - * @returns { EditUnit } Indicates the edit unit {@link EditUnit} related to this collaboration edit object. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getEditUnit(editUnitName: string): EditUnit; - - /** - * Get an undo redo manager of an edit unit in collaboration edit object. - * - * @param { string } editUnitName - Indicates the name of the edit unit in collaboration edit object. - * @param { UndoRedoConfig } config - Indicates the {@link UndoRedoConfig} config of the undo redo manager. - * @returns { UndoRedoManager } Indicates the {@link UndoRedoManager} undo redo manager of the edit unit. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getUndoRedoManager(editUnitName: string, config: UndoRedoConfig): UndoRedoManager; - - /** - * Delete an undo redo manager of an edit unit in collaboration edit object. - * - * @param { string } editUnitName - Indicates the name of the edit unit in collaboration edit object. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - deleteUndoRedoManager(editUnitName: string): void; - - /** - * Get local id in collaboration edit object. - * - * @returns { string } - local id. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getLocalId(): string; - - /** - * Apply update in collaboration edit object. - * - * @returns { Array } - the array that contains the modified node, used to refresh the editor. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - applyUpdate(): Array; - - /** - * Write update in collaboration edit object, used to process record pushed from remote. - * - * @param { EditObjectRecord } update - the collaboration edit object record. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - writeUpdate(update:EditObjectRecord): void; - - /** - * Register cloudDB handlers which need to be implemented. - * - * @param { CloudDB } cloudDB - Indicates the CloudDB handlers. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - setCloudDB(cloudDB: CloudDB): void; - - /** - * Synchronize data between local devices and cloud. - * - * @param { SyncMode } syncMode - Indicates the synchronization mode {@link SyncMode}. - * @param { Callback } progress - Indicates the specified sync callback function. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - cloudSync(syncMode: SyncMode, progress: Callback): void; - } - - /** - * Provides methods for managing edit unit in the collaboration edit object. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - class EditUnit { - /** - * Return the name of this edit unit. - * - * @returns { string } Indicates the name of this edit unit. - * @throws { BusinessError } 202 - Not system application. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getName(): string; - - /** - * Inserts nodes into the target edit unit in index location. - * - * @param { number } index - Indicates the index at which to start inserting. - * @param { Node[] } nodes - Indicates inserting new nodes. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - insertNodes(index: number, nodes: Node[]): void; - - /** - * Deletes continuous length of nodes and texts from the target edit unit in index location. - * - * @param { number } index - Indicates the index at which to start deleting. - * @param { number } length - Indicates deleting length. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - delete(index: number, length: number): void; - - /** - * Get the children nodes and texts in range [start, end) of this edit unit. - * - * @param { number } start - Indicates the start location. - * @param { number } end - Indicates the end location. - * @returns { Array } Indicates the children nodes and texts. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getChildren(start: number, end: number): Array; - - /** - * Get the json string result of this edit unit. - * - * @returns { string } Indicates the json string of this edit unit. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getJsonResult(): string; - - /** - * Get the relative position in the edit unit by the absolute position of the cursor on the editor. - * - * @param { number } absolutePos - Indicates the absolute position of the cursor on the editor. - * @returns { RelativePos } Relative position in the edit unit. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getRelativePos(absolutePos: number): RelativePos; - - /** - * Get the absolute position of the cursor on the editor by the relative position in the edit unit. - * - * @param { RelativePos } relativePos - Indicates the relative position in the edit unit. - * @returns { number } Absolute position of the cursor on the editor. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getAbsolutePos(relativePos: RelativePos): number; - } - - /** - * The unique identifier of current object. - * - * @interface UniqueId - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface UniqueId { - /** - * The identifier used to distinguish the different clients. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - id: string; - - /** - * The clock of current object. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - clock: number; - } - - /** - * Attributes in node are stored in key-value pairs. - * - * @typedef { Record } AttributesRecord - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type AttributesRecord = Record; - - /** - * Provides methods for managing node in the edit unit. - * - * @extends EditUnit - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - class Node extends EditUnit { - /** - * A parameterized constructor used to create a Node instance. - * - * @param { string } name - Indicates the name of this node. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - constructor(name: string); - - /** - * Returns the UniqueId of this node. - * - * @returns { UniqueId } Indicates the unique id of this node. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getId(): UniqueId; - - /** - * Inserts texts into the target edit unit in index location. - * - * @param { number } index - Indicates the index at which to start inserting. - * @param { Text[] } texts - Indicates inserting new texts. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - insertTexts(index: number, texts: Text[]): void; - - /** - * Sets or updates attributes into the target node. - * - * @param { AttributesRecord } attributes - Indicates the attribute names and values that is to be set. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - setAttributes(attributes: AttributesRecord): void; - - /** - * Removes attributes from the target node, including asset attribute. - * - * @param { string[] } attributeNames - Indicates the attribute names that is to be removed. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - removeAttributes(attributeNames: string[]): void; - - /** - * Returns all attribute name and value pairs of this node. - * - * @returns { AttributesRecord } Indicates all attribute name and value pairs. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getAttributes(): AttributesRecord; - - /** - * Sets or updates an asset into the target node. - * - * @param { string } assetKey - Indicates the asset key to be set. - * @param { string } assetValue - Indicates the asset value to be set. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - setAsset(assetKey: string, assetValue: string): void; - } - - /** - * Indicates possible format value types. - * - * @typedef { null | number | string | boolean } FormatValueType - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type FormatValueType = null | number | string | boolean; - - /** - * Values in text format are stored in key-value pairs. - * - * @typedef { Record } TextFormat - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - type TextFormat = Record; - - /** - * Provides methods for managing text in the edit unit. - * - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - class Text { - /** - * A constructor used to create a Text instance. - * - * @throws { BusinessError } 202 - Not system application. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - constructor(); - - /** - * Returns the UniqueId of this text. - * - * @returns { UniqueId } Indicates the unique id of this text. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getId(): UniqueId; - - /** - * Inserts text with optional format into the target text in index location. - * - * @param { number } index - Indicates the index at which to start inserting. - * @param { string } text - Indicates the text to insert at the specified position. - * @param { TextFormat } format - Indicates the formatting information to apply on the inserted text. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - insert(index: number, text: string, format?: TextFormat): void; - - /** - * Deletes continuous length into the target text in index location. - * - * @param { number } index - Indicates the index at which to start inserting. - * @param { number } length - Indicates deleting length. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - delete(index: number, length: number): void; - - /** - * Formats continuous length into the target text from index location. - * - * @param { number } index - Indicates the index at which to start formatting. - * @param { number } length - Indicates formatting length. - * @param { TextFormat } format - Indicates the formatting information to apply. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - format(index: number, length: number, format: TextFormat): void; - - /** - * Get the plain string result without format of this text. - * - * @returns { string } Indicates the plain string result of this text. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getPlainText(): string; - - /** - * Get the json string result with format of this text. - * - * @returns { string } Indicates the json string result of this text. - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410001 - Unsupported operation. - * @throws { BusinessError } 15410002 - Index out of range. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - getJsonResult(): string; - } - - /** - * Provides methods for managing undo redo operations in the collaboration edit object. - * - * @interface UndoRedoManager - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface UndoRedoManager { - /** - * Undo last changes. - * - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - undo(): void; - - /** - * Redo last undo operation. - * - * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 15410000 - Internal error. - * @throws { BusinessError } 15410003 - Database error. - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - redo(): void; - } - - /** - * The updated node {@link Node} or text {@link Text}. - * - * @interface UpdatedNode - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - interface UpdatedNode { - /** - * The identifier used to distinguish the different edit unit. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - editUnitName: string; - - /** - * The updated node {@link Node} or text {@link Text}. - * - * @type { Node | Text } - * @syscap SystemCapability.DistributedDataManager.DataObject.DistributedObject - * @systemapi - * @since 18 - */ - node: Node | Text; - } -} - -export default collaborationEditObject; diff --git a/api/@ohos.data.intelligence.d.ts b/api/@ohos.data.intelligence.d.ts index 014814d9d726709551bb677a7701b2af4c7b65d0..983dcbcc43437af96c64568048ea7154b3626bdb 100644 --- a/api/@ohos.data.intelligence.d.ts +++ b/api/@ohos.data.intelligence.d.ts @@ -18,9 +18,6 @@ * @kit ArkData */ -import Context from './application/BaseContext'; -import relationalStore from './@ohos.data.relationalStore'; - /** * Provides methods for intelligent data processing. * @@ -269,969 +266,6 @@ declare namespace intelligence { */ overlapRatio: number; } - - /** - * Obtains a retriever. - * - * @param { RetrievalConfig } config - Indicates the {@link RetrievalConfig} configuration of the retriever. - * @returns { Promise } The retriever object {@link Retriever}. - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - function getRetriever(config: RetrievalConfig): Promise; - - /** - * Manages retrieval configurations. - * - * @interface RetrievalConfig - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface RetrievalConfig { - /** - * An array of configurations for different retrieval channels. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - channelConfigs: Array; - } - - /** - * Manages the configuration for each retrieval channel. - * - * @interface ChannelConfig - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface ChannelConfig { - /** - * The type of database for this retrieval channel. - * - * @type { ChannelType } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - channelType: ChannelType; - - /** - * Indicates the context of an application or ability. - * - * @type { Context } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - context: Context; - - /** - * The configuration of database for this retrieval channel. - * - * @type { DbConfig } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - dbConfig: DbConfig; - } - - /** - * Type of database. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - enum ChannelType { - /** - * Represents a vector database. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - VECTOR_DATABASE = 0, - - /** - * Represents an inverted index database. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - INVERTED_INDEX_DATABASE - } - - /** - * Describes the configuration of the database. - * - * @typedef { relationalStore.StoreConfig } DbConfig - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type DbConfig = relationalStore.StoreConfig; - - /** - * Describes the retriever. - * - * @interface Retriever - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface Retriever { - /** - * Given the retrieval condition that includes query terms, recall conditions, and re-ranking strategies, - * retrieve a collection of records that meet the specified conditions from a relational store (RDB). - * - * @param { RetrievalCondition } condition - The condition {@link RetrievalCondition} of the retrieve method. - * @returns { Promise } The promise used to return the retrieved records {@link RdbRecords}. - * @throws { BusinessError } 31300001 - Database corrupted. - * @throws { BusinessError } 31300002 - Already closed. - * @throws { BusinessError } 31300003 - The database is busy. - * @throws { BusinessError } 31300004 - The database is out of memory. - * @throws { BusinessError } 31300100 - SQLite: Generic error. - * @throws { BusinessError } 31300101 - SQLite: Access permission denied. - * @throws { BusinessError } 31300102 - SQLite: The database file is locked. - * @throws { BusinessError } 31300103 - SQLite: Some kind of disk I/O error occurred. - * @throws { BusinessError } 31300104 - SQLite: The WAL file size exceeds the default limit. - * @throws { BusinessError } 31300105 - SQLite: Unable to open the database file. - * @throws { BusinessError } 31301000 - Retrieval: An error occurred during the recall phase. - * @throws { BusinessError } 31301001 - Retrieval: An error occurred during the re-ranking phase. - * @throws { BusinessError } 31301002 - Retrieval: The value of the numerical parameter is outside the constrained range. - * @throws { BusinessError } 31301003 - Retrieval: There are invalid primary keys. - * @throws { BusinessError } 31301004 - Retrieval: A re-ranking algorithm that does not support composite primary keys was used. - * @throws { BusinessError } 31301005 - Retrieval: There are fields with empty strings. - * @throws { BusinessError } 31301006 - Retrieval: The filter input is invalid. - * @throws { BusinessError } 31301007 - Retrieval: There are invalid recall names in RecallCondition. - * @throws { BusinessError } 31301008 - Retrieval: The vector similarity threshold in VectorQuery is higher than the tiered threshold in VectorRerankParameter. - * @throws { BusinessError } 31301009 - Retrieval: RerankMethod parameters do not match the channel type. - * @throws { BusinessError } 31301010 - Retrieval: There exists a parameter value that should not be empty but is actually empty. - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - retrieveRdb(condition: RetrievalCondition): Promise; - } - - /** - * Describes the retrieval conditions. - * - * @interface RetrievalCondition - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface RetrievalCondition { - /** - * The query to the retrieval. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - query: string; - - /** - * The conditions {@link RecallCondition} for recall, where each item in the array corresponds to a recall operation. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - recallConditions: Array; - - /** - * The parameters of the re-ranking method {@link RerankMethod}. - * - * @type { ?RerankMethod } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - rerankMethod?: RerankMethod; - - /** - * The maximum number of results allowed to be returned after re-ranking. - * - * @type { ?number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - resultCount?: number; - } - - /** - * Describes the conditions for a recall operation. - * - * @typedef { InvertedIndexRecallCondition | VectorRecallCondition } RecallCondition - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type RecallCondition = InvertedIndexRecallCondition | VectorRecallCondition; - - /** - * Describes the recall conditions for the inverted index retrieval. - * - * @interface InvertedIndexRecallCondition - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface InvertedIndexRecallCondition { - /** - * The table name of the fts5 data table used for the inverted index recall. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - ftsTableName: string; - - /** - * Represents the table name in the database, supporting JOIN operations. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - fromClause: string; - - /** - * Represents the column name(s) of the primary key, and this parameter supports composite primary keys. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - primaryKey: Array; - - /** - * The names of the columns included in the recall results. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - responseColumns: Array; - - /** - * The recall strategy {@link InvertedIndexStrategy} used for the inverted index database. - * - * @type { ?Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - invertedIndexStrategies?: Array; - - /** - * The name of the recall operation corresponding to this recall condition, used to identify this recall process. - * - * @type { ?RecallName } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - recallName?: RecallName; - - /** - * Additional filtering conditions. - * - * @type { ?Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - filters?: Array; - - /** - * The maximum number of recalls for this recall process. - * - * @type { ?number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - deepSize?: number; - } - - /** - * The type of the column name. - * - * @typedef { string } ColumnName - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type ColumnName = string; - - /** - * The type of the identifier name for a recall operation. - * - * @typedef { string } RecallName - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type RecallName = string; - - /** - * Describes the filter information. - * - * @interface FilterInfo - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface FilterInfo { - /** - * The column names of the filtered columns. - * Any record in the database that satisfies the filter condition for any of its columns will be filtered out. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columns: Array; - - /** - * The operator in the filter conditions. - * - * @type { ?Operator } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - operator?: Operator; - - /** - * The filtering value in the filter conditions. - * - * @type { ?FilterValue} - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - filterValue?: FilterValue; - - /** - * The filtering range in the filter conditions. - * - * @type { ?FilterRange } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - filterRange?: FilterRange; - } - - /** - * Describes the filtering value in the filter conditions. - * - * @typedef { string | number | bigint } FilterValue - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type FilterValue = string | number | bigint; - - /** - * Describes the filtering range in the filter conditions. - * - * @interface FilterRange - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface FilterRange { - /** - * The range of the filter: maximum. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - max: number; - - /** - * The range of the filter: minimum. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - min: number; - } - - /** - * Types of the operator in the filter conditions. - * - * @enum { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - enum Operator { - /** - * Means = . - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_EQ = '=', - - /** - * Means != . - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_NE = '!=', - - /** - * Means < , while should be number. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_LT = '<', - - /** - * Means <= , while should be number. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_LE = '<=', - - /** - * Means > , while should be number. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_GT = '>', - - /** - * Means >= , while should be number. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_GE = '>=', - - /** - * Means IN , while should be string and be concatenated by ','. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_IN = 'IN', - - /** - * Means NOT IN , while should be string and be concatenated by ','. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_NOT_IN = 'NOT_IN', - - /** - * Means BETWEEN AND , while should be array of numbers. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_BETWEEN = 'BETWEEN', - - /** - * Means LIKE , while should be string. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_LIKE = 'LIKE', - - /** - * Means NOT LIKE , while should be string. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - OP_NOT_LIKE = 'NOT_LIKE' - } - - /** - * Describes the inverted index recall strategy. - * - * @typedef { Bm25Strategy | ExactMatchingStrategy | ProximityStrategy } InvertedIndexStrategy - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type InvertedIndexStrategy = Bm25Strategy | ExactMatchingStrategy | ProximityStrategy; - - /** - * Describes the BM25 strategy used for inverted index recall. - * - * @interface Bm25Strategy - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface Bm25Strategy { - /** - * Represents the weights of multiple strategies. The weight must be non-negative number. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - bm25Weight: number; - - /** - * Represents the weights of multiple columns. The weight must be non-negative number. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columnWeight?: Record; - } - - /** - * Describes the exact phrase matching stratey used for inverted index recall. - * - * @interface ExactMatchingStrategy - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface ExactMatchingStrategy { - /** - * Represents the weights of multiple strategies. The weight must be non-negative number. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - exactMatchingWeight: number; - - /** - * Represents the weights of multiple columns. The weight must be non-negative number. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columnWeight?: Record; - } - - /** - * Describes the proximity and out-of-order matching stratey for inverted index recall. - * - * @interface ProximityStrategy - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface ProximityStrategy { - /** - * Represents the weights of multiple strategies. The weight must be non-negative number. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - proximityWeight: number; - - /** - * Represents the weights of multiple columns. The weight must be non-negative number. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columnWeight?: Record; - - /** - * The offset configuration used for each out-of-order matching column. Must be positive integer. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columnSlops?: Record; - } - - /** - * Describes the recall conditions for vector retrieval. - * - * @interface VectorRecallCondition - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface VectorRecallCondition { - /** - * The query vector used for vector data retrieval {@link VectorQuery}. - * Typically, the query vector is generated from the query terms in RetrievalCondition {@link RetrievalCondition} - * using an embedding model{@link TextEmbedding}. - * - * @type { VectorQuery } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - query: VectorQuery; - - /** - * Represents the table name in the database, supporting JOIN operations. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - fromClause: string; - - /** - * Represents the column name(s) of the primary key, and this parameter supports composite primary keys. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - primaryKey: Array; - - /** - * The names of the columns included in the recall results. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - responseColumns: Array; - - /** - * The name of the recall operation corresponding to this recall condition, used to identify this recall process. - * - * @type { ?RecallName } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - recallName?: RecallName; - - /** - * Additional filtering conditions. - * - * @type { ?Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - filters?: Array; - - /** - * The maximum number of recalls for this recall process. - * - * @type { ?number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - deepSize?: number; - } - - /** - * Describes the query vector. - * - * @interface VectorQuery - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface VectorQuery { - /** - * The column name of the vector column. - * - * @type { ColumnName } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - column: ColumnName; - - /** - * The vector value of the vector column. - * - * @type { Float32Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - value: Float32Array; - - /** - * The threshold used to filter out dissimilar vectors based on similarity. - * - * @type { ?number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - similarityThreshold?: number; - } - - /** - * Describes the parameters of the re-ranking strategy. - * - * @interface RerankMethod - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface RerankMethod { - /** - * Represents the type of re-ranking algorithms. - * - * @type { RerankType } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - rerankType: RerankType; - - /** - * Represents the mapping relationship between each retrieval channel and the re-ranking algorithm parameters. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - parameters?: Record; - - /** - * Indicates whether to use the softmax function to normalize the results from multiple recalls. - * - * @type { ?boolean } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - isSoftmaxNormalized?: boolean; - } - - /** - * Represents type of re-ranking algorithms. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - enum RerankType { - /** - * Represents Reciprocal Rank Fusion (RRF) method. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - RRF = 0, - - /** - * Represents score-based recall fusion method. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - FUSION_SCORE - } - - /** - * Describes the re-ranking algorithm parameter configuration. - * - * @typedef { InvertedIndexRerankParameter | VectorRerankParameter } RerankParameter - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - type RerankParameter = InvertedIndexRerankParameter | VectorRerankParameter; - - /** - * Describes the parameters of the re-ranking algorithm used for inverted index. - * - * @interface InvertedIndexRerankParameter - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface InvertedIndexRerankParameter { - /** - * Represents the weight corresponding to each recall process. The weight must be non-negative number. - * - * @type { Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - invertedIndexWeights: Record; - } - - /** - * Describes the parameters of the re-ranking algorithm used for vector data. - * - * @interface VectorRerankParameter - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface VectorRerankParameter { - /** - * Represents the weight corresponding to each recall process. The weight must be non-negative number. - * - * @type { Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - vectorWeights: Record; - - /** - * The tiered thresholds for vector recall, - * which will affect the division of similarityLevel {@link SimilarityLevel} in the retrieval results. - * Currently, the results can be divided into three tiers (high, medium, low) using two thresholds. - * - * @type { ?Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - thresholds?: Array; - - /** - * An optimization measure for query terms containing numbers. - * Since embedding models cannot accurately represent numerical magnitudes, - * and numerical values are often critical retrieval criteria, - * this measure ensures that if a column in the vector recall results contains numbers that differ from those in the query terms, - * the final similarity level {@link SimilarityLevel} will not exceed a medium level. - * - * @type { ?Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - numberInspector?: Record; - } - - /** - * Describes the retrieval results. - * - * @interface RdbRecords - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface RdbRecords { - /** - * Describes the collection of retrieved records {@link ItemInfo}. - * - * @type { Array } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - records: Array; - } - - /** - * Describes the specific content of each record in the retrieval results. - * - * @interface ItemInfo - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface ItemInfo { - /** - * Represents the primary key of the retrieval results. - * - * @type { string } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - primaryKey: string; - - /** - * Represents the recall columns and their contents. - * - * @type { Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - columns: Record; - - /** - * Represents the final score after retrieval re-ranking, - * which qualitatively reflects the similarity between the re-ranked records and the query terms. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - score: number; - - /** - * Represents the scores from each recall process, - * which qualitatively reflects the similarity between the records after each recall and the query terms. - * - * @type { Record> } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - recallScores: Record>; - - /** - * Represents the scores from different inverted index strategies. - * - * @type { Record } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - features: Record; - - /** - * Represents the similarity of the retrieval results to the query vectors. - * Influenced by vectorRerankThresholds in the re-ranking algorithm configuration {@link VectorRerankParameter}. - * Currently, supporting three tiers (high, medium, low). - * - * @type { SimilarityLevel } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - similarityLevel: SimilarityLevel; - } - - /** - * Describes the score of the recall process. - * - * @interface RecallScore - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - interface RecallScore { - /** - * Represents the recall score. - * - * @type { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - score: number; - - /** - * Indicates whether the score is obtained from the original recall process or from a reverse query process. - * - * @type { boolean } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - isReverseQuery: boolean; - } - - /** - * Represents the similarity of the retrieval result to the query vector. - * - * @enum { number } - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - enum SimilarityLevel { - /** - * There is no query vector in the recall conditions {@link VectorRecallCondition}. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - NONE = 0, - - /** - * Indicates a low similarity between the query vector and the retrieval result. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - LOW, - - /** - * Indicates a medium similarity between the query vector and the retrieval result. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - MEDIUM, - - /** - * Indicates a high similarity between the query vector and the retrieval result. - * - * @syscap SystemCapability.DistributedDataManager.DataIntelligence.Core - * @since 18 - */ - HIGH - } } export default intelligence; \ No newline at end of file diff --git a/api/@ohos.data.relationalStore.d.ts b/api/@ohos.data.relationalStore.d.ts index 994a1a4ddca7d6a6e00867015a1ec848a7254ad4..a47fbcfabc74e8709479beb41450bef3820107b7 100644 --- a/api/@ohos.data.relationalStore.d.ts +++ b/api/@ohos.data.relationalStore.d.ts @@ -431,7 +431,7 @@ declare namespace relationalStore { * * @type { ?Tokenizer } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 18 + * @since 17 */ tokenizer?: Tokenizer; @@ -641,21 +641,21 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 18 + * @since 17 */ enum Tokenizer { /** * NONE_TOKENIZER: not use tokenizer * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 18 + * @since 17 */ NONE_TOKENIZER = 0, /** * ICU_TOKENIZER: native icu tokenizer. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 18 + * @since 17 */ ICU_TOKENIZER, /** @@ -1557,6 +1557,99 @@ declare namespace relationalStore { transactionType?: TransactionType; } + /** + * Enumerates the data types of a column. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + enum ColumnType { + /** + * The value in the column is null. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + NULL, + + /** + * The value in the column is a 64-bit integer. It can be used to hold an 8-bit (including Boolean values), 16-bit, + * 32-bit, or 64-bit integer.if the 64-bit integer is greater than 2^53 or less than -2^53, you can use getString + * to convert the 64-bit integer into a string. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + INTEGER, + + /** + * The value in the column is a floating point number. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + REAL, + + /** + * The value in the column is a string. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + TEXT, + + /** + * The value in the column is a Uint8Array. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + BLOB, + + /** + * The value in the column is an asset. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + ASSET, + + /** + * The value in the column is an array of assets. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + ASSETS, + + /** + * The value in the column is a Float32Array. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + FLOAT_VECTOR, + + /** + * The value in the column is a bigint. + * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + UNLIMITED_INT, + } + /** * Manages relational database configurations. * @@ -2634,6 +2727,74 @@ declare namespace relationalStore { */ getColumnName(columnIndex: number): string; + /** + * Obtains the column data type based on the specified column index. + * The column index is passed as an input parameter. + * + * @param { number | string } columnIdentifier - Index or name of the column. + * @returns { Promise } Promise used to return the data type obtained, + * in an {@link ColumnType} instance. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 14800000 - Inner error. + * @throws { BusinessError } 14800011 - Database corrupted. + * @throws { BusinessError } 14800012 - Row out of bounds. + * @throws { BusinessError } 14800013 - Column out of bounds. + * @throws { BusinessError } 14800014 - Already closed. + * @throws { BusinessError } 14800019 - The SQL must be a query statement. + * @throws { BusinessError } 14800021 - SQLite: Generic error. + * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. + * @throws { BusinessError } 14800023 - SQLite: Access permission denied. + * @throws { BusinessError } 14800024 - SQLite: The database file is locked. + * @throws { BusinessError } 14800025 - SQLite: A table in the database is locked. + * @throws { BusinessError } 14800026 - SQLite: The database is out of memory. + * @throws { BusinessError } 14800027 - SQLite: Attempt to write a readonly database. + * @throws { BusinessError } 14800028 - SQLite: Some kind of disk I/O error occurred. + * @throws { BusinessError } 14800029 - SQLite: The database is full. + * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. + * @throws { BusinessError } 14800031 - SQLite: TEXT or BLOB exceeds size limit. + * @throws { BusinessError } 14800032 - SQLite: Abort due to constraint violation. + * @throws { BusinessError } 14800033 - SQLite: Data type mismatch. + * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + getColumnType(columnIdentifier: number | string): Promise; + + /** + * Obtains the column data type based on the specified column index. This API returns the result synchronously. + * + * @param { number | string } columnIdentifier - Index or name of the column. + * @returns { ColumnType } Column data type obtained. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 14800000 - Inner error. + * @throws { BusinessError } 14800011 - Database corrupted. + * @throws { BusinessError } 14800012 - Row out of bounds. + * @throws { BusinessError } 14800013 - Column out of bounds. + * @throws { BusinessError } 14800014 - Already closed. + * @throws { BusinessError } 14800019 - The SQL must be a query statement. + * @throws { BusinessError } 14800021 - SQLite: Generic error. + * @throws { BusinessError } 14800022 - SQLite: Callback routine requested an abort. + * @throws { BusinessError } 14800023 - SQLite: Access permission denied. + * @throws { BusinessError } 14800024 - SQLite: The database file is locked. + * @throws { BusinessError } 14800025 - SQLite: A table in the database is locked. + * @throws { BusinessError } 14800026 - SQLite: The database is out of memory. + * @throws { BusinessError } 14800027 - SQLite: Attempt to write a readonly database. + * @throws { BusinessError } 14800028 - SQLite: Some kind of disk I/O error occurred. + * @throws { BusinessError } 14800029 - SQLite: The database is full. + * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. + * @throws { BusinessError } 14800031 - SQLite: TEXT or BLOB exceeds size limit. + * @throws { BusinessError } 14800032 - SQLite: Abort due to constraint violation. + * @throws { BusinessError } 14800033 - SQLite: Data type mismatch. + * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core + * @crossplatform + * @since 18 + */ + getColumnTypeSync(columnIdentifier: number | string): ColumnType; + /** * Go to the specified row of the result set forwards or backwards by an offset relative to its current position. * A positive offset indicates moving backwards, and a negative offset indicates moving forwards. diff --git a/api/@ohos.data.unifiedDataChannel.d.ts b/api/@ohos.data.unifiedDataChannel.d.ts index 387102726442a8856e3a8bb423df8e1a37f562c6..6e01683bf7f47cba076d056fde824db4b09bd783 100644 --- a/api/@ohos.data.unifiedDataChannel.d.ts +++ b/api/@ohos.data.unifiedDataChannel.d.ts @@ -1990,6 +1990,21 @@ declare namespace unifiedDataChannel { * @since 14 */ function removeAppShareOptions(intention: Intention): void; + + /** + * It is used to convert the multi-entry structure. + *
When the input parameters use different records to represent various formats of a single data entry, + * and the tag in the properties is marked as "records_to_entries_data_format", this API will convert the data into a single record with multiple entries. + *
If the input data does not meet the conversion criteria, it will remain unchanged by default. + * + * @param { UnifiedData } data - {@link UnifiedData} Data represents the data that needs to be converted. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @stagemodelonly + * @atomicservice + * @since 17 + */ + function convertRecordsToEntries(data: UnifiedData): void; } export default unifiedDataChannel; diff --git a/api/@ohos.deviceStatus.dragInteraction.d.ts b/api/@ohos.deviceStatus.dragInteraction.d.ts index 7beaaf44f0ea0d66c347473c13de9aa1e4d2d5ca..16fc70e7cf185a53e314a17aff14af30ab4d09e6 100644 --- a/api/@ohos.deviceStatus.dragInteraction.d.ts +++ b/api/@ohos.deviceStatus.dragInteraction.d.ts @@ -164,8 +164,6 @@ declare namespace dragInteraction { * * @param { boolean } enabled Switch state. * @throws {BusinessError} 202 - Permission verification failed. A non-system application calls a system API. - * @throws {BusinessError} 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. * @since 18 diff --git a/api/@ohos.display.d.ts b/api/@ohos.display.d.ts index b4bc6372b6af603ad03d18c2434a095452369280..84014b31709d1f1852f1f80944c4395c09f6ef11 100644 --- a/api/@ohos.display.d.ts +++ b/api/@ohos.display.d.ts @@ -474,21 +474,6 @@ declare namespace display { */ function setFoldDisplayMode(mode: FoldDisplayMode): void; - /** - * Change the display mode of the foldable device. - * - * @param { FoldDisplayMode } mode target display mode to change. - * @param { string } reason set display mode reason. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - * @throws { BusinessError } 1400003 - This display manager service works abnormally. - * @syscap SystemCapability.Window.SessionManager - * @systemapi Hide this for inner system use. - * @since 15 - */ - function setFoldDisplayMode(mode: FoldDisplayMode, reason: string): void; - /** * Register the callback for fold display mode changes. * @@ -572,6 +557,158 @@ declare namespace display { */ function setFoldStatusLocked(locked: boolean): void; + /** + * Create virtual screen. + * + * @permission ohos.permission.ACCESS_VIRTUAL_SCREEN + * @param { VirtualScreenConfig } config Indicates the options of the virtual screen. + * @returns { Promise } Promise used to return the created virtual screen id + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported.function createVirtualScreen can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400001 - Invalid display or screen. + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + function createVirtualScreen(config: VirtualScreenConfig): Promise; + + /** + * Destroy virtual screen. + * + * @permission ohos.permission.ACCESS_VIRTUAL_SCREEN + * @param { number } screenId Indicates the screen id of the virtual screen. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported.function destroyVirtualScreen can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400001 - Invalid display or screen. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + function destroyVirtualScreen(screenId: number): Promise; + + /** + * Set surface for the virtual screen. + * + * @permission ohos.permission.ACCESS_VIRTUAL_SCREEN + * @param { number } screenId Indicates the screen id of the virtual screen. + * @param { string } surfaceId Indicates the surface id. + * @returns { Promise } Promise that returns no value + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported.function setVirtualScreenSurface can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400001 - Invalid display or screen. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + function setVirtualScreenSurface(screenId: number, surfaceId: string): Promise; + + /** + * Make screen as unique-screen + * + * @permission ohos.permission.ACCESS_VIRTUAL_SCREEN + * @param { number } screenId Indicates the unique screen id. It's type should be int. + * @returns { Promise } Promise that returns no value + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported.function makeUnique can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400001 - Invalid display or screen. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + function makeUnique(screenId: number): Promise; + + /** + * The parameter for creating virtual screen. + * + * @interface VirtualScreenConfig + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + interface VirtualScreenConfig { + /** + * Indicates the name of the virtual screen. + * + * @type { string } + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + name: string; + + /** + * Indicates the width of the virtual screen. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + width: number; + + /** + * Indicates the height of the virtual screen. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + height: number; + + /** + * Indicates the density of the virtual screen. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + density: number; + + /** + * Indicates the surface id of the virtual screen. + * + * @type { string } + * @syscap SystemCapability.Window.SessionManager + * @since 16 + */ + surfaceId: string; + } + + /** + * Add the list of window ids to the block list which won't display on the virtual screen + * + * @param { Array } windowIds - The list of window ids that do not want to display on the virtual screen + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported.Function addVirtualScreenBlocklist can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @systemapi Hide this for inner system use. + * @since 18 + */ + function addVirtualScreenBlocklist(windowIds: Array): Promise; + + /** + * Remove the list of window ids from the block list which won't display on the virtual screen + * + * @param { Array } windowIds - The list of window ids that want to display on the virtual screen + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported.Function removeVirtualScreenBlocklist can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @systemapi Hide this for inner system use. + * @since 18 + */ + function removeVirtualScreenBlocklist(windowIds: Array): Promise; + /** * Enumerates the fold status. * @@ -985,61 +1122,6 @@ declare namespace display { LANDSCAPE_INVERTED = 3 } - /** - * Indicate the source mode of the display - * - * @enum { number } - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - enum DisplaySourceMode { - /** - * Indicate that the display is not in use. - * - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - NONE = 0, - - /** - * Indicate that the display is the main display. - * - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - MAIN = 1, - - /** - * Indicate that the display is in mirror mode. - * - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - MIRROR = 2, - - /** - * Indicate that the display is in extend mode. - * - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - EXTEND = 3, - - /** - * Indicate that the display stands alone. - * - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - ALONE = 4 - } - /** * Enumerates the screen shape. * @@ -1779,36 +1861,6 @@ declare namespace display { */ hdrFormats: Array; - /** - * The source mode of display - * - * @type { ?DisplaySourceMode } - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - sourceMode?: DisplaySourceMode; - - /** - * Coordinates of the top-left corner of the display relative to the main display. - * - * @type { ?number } - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - x?: number; - - /** - * Coordinates of the top-left corner of the display relative to the main display. - * - * @type { ?number } - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - y?: number; - /** * Obtain the cutout info of the display. * @@ -1916,6 +1968,20 @@ declare namespace display { * @since 12 */ off(type: 'availableAreaChange', callback?: Callback): void; + + /** + * Get current display capability, including foldstatus, displaymode, rotation, and orientation information. + * + * @returns { string } Indicates the current foldstatus, displaymode, rotation, and orientation information. + * @throws { BusinessError } 801 - Capability not supported.Function getDisplayCapability can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1400001 - Invalid display or screen. + * @throws { BusinessError } 1400003 - This display manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 18 + * @test + */ + getDisplayCapability(): string; } } diff --git a/api/@ohos.distributedDeviceManager.d.ts b/api/@ohos.distributedDeviceManager.d.ts index eb3446bc9fe44d3be1e6adb4667ee8fe5b291a0c..ef9f77d9c55b2d73735db8c5277f32036fe5a2b9 100644 --- a/api/@ohos.distributedDeviceManager.d.ts +++ b/api/@ohos.distributedDeviceManager.d.ts @@ -71,14 +71,6 @@ declare namespace distributedDeviceManager { * @since 10 */ networkId?: string; - - /** - * Device extra data. - * @type { ?string } - * @syscap SystemCapability.DistributedHardware.DeviceManager - * @since 18 - */ - extraData?: string; } /** @@ -584,6 +576,33 @@ declare namespace distributedDeviceManager { START_HEARTBEAT = 101, } + /** + * Device network id query filter options. + * @interface NetworkIdQueryFilter + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi + * @since 18 + */ + interface NetworkIdQueryFilter { + /** + * Get device network id list by wiseDevice ID. + * @type { string } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi + * @since 18 + */ + wiseDeviceId : string; + + /** + * Get device network id list by online status. + * @type { number } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi + * @since 18 + */ + onlineStatus : number, + } + /** * Creates an {@code DeviceManager} instance. * @@ -1105,7 +1124,7 @@ declare namespace distributedDeviceManager { * @throws { BusinessError } 11600102 - Failed to obtain service. * @syscap SystemCapability.DistributedHardware.DeviceManager * @systemapi - * @since 15 + * @since 18 */ putDeviceProfileInfoList(deviceProfileInfoList: Array): Promise; @@ -1224,6 +1243,31 @@ declare namespace distributedDeviceManager { * @since 18 */ restoreLocalDeivceName(): void; + + /** + * Get the device network id list by conditions. + * + * @permission ohos.permission.ACCESS_SERVICE_DM + * @param { NetworkIdQueryFilter } filterOptions - parameter for querying the device network id list, + * The parameter type is map, such as: + * "wiseDeviceId" : xx-xxxxx - Get device network id list by wiseDevice id. + * "onlineStatus" : 1, - Get device network id list by online status. + * 0 - indicates that the device is offline. + * 1 - indicates that the device is online. + * @returns { Promise> } - Returns a list of device network id. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Parameter verification failed; + * @throws { BusinessError } 11600102 - Failed to obtain service. + * @throws { BusinessError } 11600107 - A login account is required. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi + * @since 18 + */ + getDeviceNetworkIdList(filterOptions: NetworkIdQueryFilter): Promise>; } } diff --git a/api/@ohos.distributedsched.abilityConnectionManager.d.ts b/api/@ohos.distributedsched.abilityConnectionManager.d.ts index f25a27c552e60b897c55c406f67bb0e498fe6fd6..f74111341b0ac8da493dd4fb6893b9d512a73920 100644 --- a/api/@ohos.distributedsched.abilityConnectionManager.d.ts +++ b/api/@ohos.distributedsched.abilityConnectionManager.d.ts @@ -205,6 +205,13 @@ declare namespace abilityConnectionManager { * @since 18 */ PEER_ABILITY_NO_ONCOLLABORATE = 4, + + /** + * The connection failed due to an internal system error. + * @syscap SystemCapability.DistributedSched.AppCollaboration + * @since 18 + */ + SYSTEM_INTERNAL_ERROR = 5, } /** @@ -246,6 +253,14 @@ declare namespace abilityConnectionManager { */ sessionId: number; + /** + * The type of event returned is consistent with the type registered in function 'on'. + * @type { string } + * @syscap SystemCapability.DistributedSched.AppCollaboration + * @since 18 + */ + eventType: string; + /** * Indicates the reason of ability disconnection. * @type { ?DisconnectReason } @@ -266,7 +281,6 @@ declare namespace abilityConnectionManager { * Received data. * @type { ?ArrayBuffer } * @syscap SystemCapability.DistributedSched.AppCollaboration - * @systemapi * @since 18 */ data?: ArrayBuffer; @@ -288,6 +302,14 @@ declare namespace abilityConnectionManager { * @since 18 */ interface CollaborateEventInfo { + /** + * Ability connection Session id. + * @type { number } + * @syscap SystemCapability.DistributedSched.AppCollaboration + * @since 18 + */ + sessionId: number; + /** * Indicates the type of collaborate event. * @type { CollaborateEventType } diff --git a/api/@ohos.driver.deviceManager.d.ts b/api/@ohos.driver.deviceManager.d.ts index a112554dff370c7615c25584ce490667de8dd2ec..9c9cc21e162981a2092b6f052237bf68c5fcea79 100644 --- a/api/@ohos.driver.deviceManager.d.ts +++ b/api/@ohos.driver.deviceManager.d.ts @@ -57,8 +57,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 10 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#bindDriverWithDeviceId */ function bindDevice(deviceId: number, onDisconnect: AsyncCallback, callback: AsyncCallback<{deviceId: number; remote: rpc.IRemoteObject;}>): void; @@ -78,8 +76,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 11 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#bindDriverWithDeviceId */ function bindDeviceDriver(deviceId: number, onDisconnect: AsyncCallback, callback: AsyncCallback): void; @@ -99,8 +95,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 10 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#bindDriverWithDeviceId */ function bindDevice(deviceId: number, onDisconnect: AsyncCallback): Promise<{deviceId: number; remote: rpc.IRemoteObject;}>; @@ -119,8 +113,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 11 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#bindDriverWithDeviceId */ function bindDeviceDriver(deviceId: number, onDisconnect: AsyncCallback): Promise; @@ -135,8 +127,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 10 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#unbindDriverWithDeviceId */ function unbindDevice(deviceId: number, callback: AsyncCallback): void; @@ -152,8 +142,6 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @since 10 - * @deprecated since 18 - * @useinstead ohos.driver.deviceManager/deviceManager#unbindDriverWithDeviceId */ function unbindDevice(deviceId: number): Promise; @@ -189,40 +177,6 @@ declare namespace deviceManager { */ function queryDriverInfo(driverUid?: string): Array>; - /** - * Bind the device based on the device information returned by queryDevices(). - * - * @permission ohos.permission.ACCESS_DDK_DRIVERS - * @param { number } deviceId - Device id on the device list returned by queryDevices(). - * @param { AsyncCallback } onDisconnect - Callback is invoked when device is disconnected after bind - * success. - * @returns { Promise } Indicates the bind result including device ID and remote object. - * @throws { BusinessError } 201 - The permission check failed. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * 3.Parameter verification failed. - * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. - * @throws { BusinessError } 26300002 - Service not allowed. - * @syscap SystemCapability.Driver.ExternalDevice - * @since 18 - */ - function bindDriverWithDeviceId(deviceId: number, onDisconnect: AsyncCallback): Promise; - - /** - * Unbind the device based on the device information returned by queryDevices(). - * - * @permission ohos.permission.ACCESS_DDK_DRIVERS - * @param { number } deviceId - Device id on the device list returned by queryDevices(). - * @returns { Promise } - Indicates the unbind result invoked when unbind is finished. - * @throws { BusinessError } 201 - The permission check failed. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * 3.Parameter verification failed. - * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. - * @throws { BusinessError } 26300003 - There is no binding relationship. - * @syscap SystemCapability.Driver.ExternalDevice - * @since 18 - */ - function unbindDriverWithDeviceId(deviceId: number): Promise; - /** * Enumerates the bus types. * diff --git a/api/@ohos.enterprise.accountManager.d.ts b/api/@ohos.enterprise.accountManager.d.ts index bea9d35c1a16edbe9390a29203bedf0bcc5aff59..b9398fa989f4a05fcf9c33d27c2da357d620e35e 100644 --- a/api/@ohos.enterprise.accountManager.d.ts +++ b/api/@ohos.enterprise.accountManager.d.ts @@ -30,42 +30,6 @@ import type osAccount from './@ohos.account.osAccount'; * @since 10 */ declare namespace accountManager { - /** - * The policy of domain account - * - * @interface DomainAccountPolicy - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @since 18 - */ - interface DomainAccountPolicy { - /** - * The validity period of authentication. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @since 18 - */ - authenticationValidityPeriod?: number; - - /** - * The validity period of password. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @since 18 - */ - passwordValidityPeriod?: number; - - /** - * The password expiration notification. - * - * @type { ?number } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @since 18 - */ - passwordExpirationNotification?: number; - } - /** * Disallow the user of device add local account. * This function can be called by a super administrator. @@ -239,46 +203,6 @@ declare namespace accountManager { * @since 12 */ function addOsAccountAsync(admin: Want, name: string, type: osAccount.OsAccountType): Promise; - - /** - * Sets domain account policy. - * This function can be called by a super administrator. - * - * @permission ohos.permission.ENTERPRISE_SET_ACCOUNT_POLICY - * @param { Want } admin - admin indicates the enterprise admin extension ability information. - * The admin must have the corresponding permission. - * @param { osAccount.DomainAccountInfo } domainAccountInfo - the infomation of domain account. - * @param { DomainAccountPolicy } policy - policy indicates the domain account policy. - * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. - * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 18 - */ - function setDomainAccountPolicy(admin: Want, domainAccountInfo: osAccount.DomainAccountInfo, policy: DomainAccountPolicy): void; - - /** - * Gets domain account policy. - * This function can be called by a super administrator. - * - * @permission ohos.permission.ENTERPRISE_SET_ACCOUNT_POLICY - * @param { Want } admin - admin indicates the enterprise admin extension ability information. - * The admin must have the corresponding permission. - * @param { osAccount.DomainAccountInfo } domainAccountInfo - the infomation of domain account. - * @returns { DomainAccountPolicy } policy - policy indicates the domain account policy. - * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. - * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 18 - */ - function getDomainAccountPolicy(admin: Want, domainAccountInfo: osAccount.DomainAccountInfo): DomainAccountPolicy; } export default accountManager; diff --git a/api/@ohos.enterprise.adminManager.d.ts b/api/@ohos.enterprise.adminManager.d.ts index a980bdd8c7b676ab81942e75336b7213622317f0..64d4c6bfc73bbdaef2101522773b446b20748cbe 100644 --- a/api/@ohos.enterprise.adminManager.d.ts +++ b/api/@ohos.enterprise.adminManager.d.ts @@ -748,13 +748,11 @@ declare namespace adminManager { * @param { Want } oldAdmin - oldAdmin indicates the old administrator ability information. * @param { Want } newAdmin - newAdmin indicates the new administrator ability information. * @param { boolean } isKeepPolicy - true indicates whether keep admin policy. - * @throws { BusinessError } 9200001 - The application is not an administrator application of the device.= + * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. * @throws { BusinessError } 9200003 - The administrator ability component is invalid. * @throws { BusinessError } 9200011 - Failed to replace the administrator application of the device. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi * @stagemodelonly diff --git a/api/@ohos.enterprise.securityManager.d.ts b/api/@ohos.enterprise.securityManager.d.ts index db5ccc68775bc94dc6b137352a9b4c28563dfb7b..a82ec35a5e28b6c2c5cd6c9666e83a69dd4c7c03 100644 --- a/api/@ohos.enterprise.securityManager.d.ts +++ b/api/@ohos.enterprise.securityManager.d.ts @@ -180,8 +180,6 @@ declare namespace securityManager { * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. * @throws { BusinessError } 9201001 - Failed to manage the certificate. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 18 @@ -221,8 +219,6 @@ declare namespace securityManager { * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 18 @@ -324,8 +320,6 @@ declare namespace securityManager { * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 18 @@ -343,8 +337,6 @@ declare namespace securityManager { * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @stagemodelonly * @since 18 diff --git a/api/@ohos.enterprise.systemManager.d.ts b/api/@ohos.enterprise.systemManager.d.ts index 6711e6afeca35b06130f7d471df3379b2356d431..21c5c5360ea7178fcb7efb0f82598b0081e55943 100644 --- a/api/@ohos.enterprise.systemManager.d.ts +++ b/api/@ohos.enterprise.systemManager.d.ts @@ -232,16 +232,6 @@ declare namespace systemManager { * @since 12 */ description?: PackageDescription; - - /** - * The authentication information of system update package. - * - * @type { ?string } - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 18 - */ - authInfo?: string; } /** @@ -592,24 +582,6 @@ declare namespace systemManager { * @since 12 */ function getUpdateResult(admin: Want, version: string): Promise; - - /** - * Gets the authorize data of system update. - * This function can be called by a super administrator. - * - * @permission ohos.permission.ENTERPRISE_MANAGE_SYSTEM - * @param { Want } admin - admin indicates the administrator ability information. - * @returns { Promise } the promise returned by the getUpdateAuthData. - * @throws { BusinessError } 9200001 - The application is not an administrator application of the device. - * @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Customization.EnterpriseDeviceManager - * @stagemodelonly - * @since 18 - */ - function getUpdateAuthData(admin: Want): Promise; } export default systemManager; \ No newline at end of file diff --git a/api/@ohos.file.photoAccessHelper.d.ts b/api/@ohos.file.photoAccessHelper.d.ts index 5a886b87d9c2b7a8de6d68462b2582768e20a226..edc1de07849c7901e2ce46dd962ddc51242228ed 100644 --- a/api/@ohos.file.photoAccessHelper.d.ts +++ b/api/@ohos.file.photoAccessHelper.d.ts @@ -275,6 +275,13 @@ declare namespace photoAccessHelper { * @systemapi * @since 10 */ + /** + * Photo asset position + * + * @enum { number } Photo asset position, such as local device or cloud + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 16 + */ enum PositionType { /** * Asset exists only in local device @@ -283,7 +290,13 @@ declare namespace photoAccessHelper { * @systemapi * @since 10 */ - LOCAL = 1 << 0, + /** + * Asset exists only in local device + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 16 + */ + LOCAL = 1, /** * Asset exists only in cloud * @@ -291,7 +304,20 @@ declare namespace photoAccessHelper { * @systemapi * @since 10 */ - CLOUD = 1 << 1 + /** + * Asset exists only in cloud + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 16 + */ + CLOUD = 2, + /** + * Asset exists in local device and cloud + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 16 + */ + LOCAL_AND_CLOUD = 3 } /** @@ -538,7 +564,16 @@ declare namespace photoAccessHelper { * @atomicservice * @since 12 */ - FEATURED_SINGLE_PORTRAIT = 10 + FEATURED_SINGLE_PORTRAIT = 10, + + /** + * COLOR_STYLE_PHOTO indicates that color style photo can be recommended + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + COLOR_STYLE_PHOTO = 12 } /** @@ -1025,6 +1060,24 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 12 */ + /** + * Request moving photo + * + * @permission ohos.permission.READ_IMAGEVIDEO + * @param { Context } context - Hap context information + * @param { PhotoAsset } asset - the photo asset requested + * @param { RequestOptions } requestOptions - the request options + * @param { MediaAssetDataHandler } dataHandler - data handler used to obtain moving photo when data is prepared + * @returns { Promise } Returns request id + * @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. + * @throws { BusinessError } 14000011 - System inner fail + * @static + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 18 + */ static requestMovingPhoto( context: Context, asset: PhotoAsset, @@ -2131,6 +2184,12 @@ declare namespace photoAccessHelper { * @systemapi * @since 10 */ + /** + * Asset position, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 16 + */ POSITION = 'position', /** * Trashed date of the asset, read only @@ -2234,19 +2293,19 @@ declare namespace photoAccessHelper { */ MOVING_PHOTO_EFFECT_MODE = 'moving_photo_effect_mode', /** - * Dynamic range type of the asset, read only + * Cover position of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 12 */ - DYNAMIC_RANGE_TYPE = 'dynamic_range_type', + COVER_POSITION = 'cover_position', /** - * Cover position of the asset, read only + * Dynamic range type of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 12 */ - COVER_POSITION = 'cover_position', + DYNAMIC_RANGE_TYPE = 'dynamic_range_type', /** * Unique uuid of the burst photos, read only * @@ -2321,7 +2380,30 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - IS_CE_AUTO = 'is_auto' + IS_CE_AUTO = 'is_auto', + /** + * Owner album id of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + OWNER_ALBUM_ID = 'owner_album_id', + /** + * Recentshow state of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + IS_RECENT_SHOW = 'is_recent_show', + /** + * Suffix of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 18 + */ + MEDIA_SUFFIX = 'media_suffix' } @@ -2376,7 +2458,23 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - ALBUM_LPATH = 'lpath' + ALBUM_LPATH = 'lpath', + /** + * Album bundle name + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + BUNDLE_NAME = 'bundle_name', + /** + * Modified date of the album + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + DATE_MODIFIED = 'date_modified', } /** @@ -2607,6 +2705,53 @@ declare namespace photoAccessHelper { requestPhotoType?: RequestPhotoType; } + /** + * CreationSource of the asset + * + * @interface PhotoCreationSource + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + interface PhotoCreationSource { + /** + * BundleName of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + bundleName?: string; + /** + * AppName of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + appName?: string; + /** + * AppId of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + appId?: string; + /** + * TokenId of the asset + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + tokenId?: number; + } + /** * The fetch result of assets or albums * @@ -2993,6 +3138,14 @@ declare namespace photoAccessHelper { * @since 12 */ SYSTEM = 1024, + /** + * Album created by app. + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + SOURCE = 2048, /** * Album created by smart abilities. * @@ -3493,6 +3646,26 @@ declare namespace photoAccessHelper { * @since 12 */ readonly videoCount?: number; + /** + * Album dateAdded + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + readonly dateAdded?: number; + /** + * Album dateModified + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + readonly dateModified?: number; /** * Modify metadata for the album * @@ -4664,7 +4837,12 @@ declare namespace photoAccessHelper { * @systemapi * @since 15 */ - grantPhotoUrisPermission(tokenId: number, uriList: Array, photoPermissionType: PhotoPermissionType, hideSensitiveType: HideSensitiveType): Promise; + grantPhotoUrisPermission( + tokenId: number, + uriList: Array, + photoPermissionType: PhotoPermissionType, + hideSensitiveType: HideSensitiveType + ): Promise; /** * Grant permission of asset to an APP. * @@ -4777,7 +4955,43 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - startAssetAnalysis(type: AnalysisType, assetUris?: Array): Promise; + startAssetAnalysis(type: AnalysisType, assetUris?: Array): Promise; + /** + * Fetch albums by albumIds + * + * @permission ohos.permission.READ_IMAGEVIDEO + * @param { Array } albumIds - List of albumId + * @returns { Promise> } - Return the map of albums + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - System inner fail + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + getAlbumsByIds(albumIds: Array): Promise>; + /** + * Create assets in the album and grant save permission to the app + * + * @permission ohos.permission.WRITE_IMAGEVIDEO + * @param { PhotoCreationSource } source - photo asset creation source + * @param { string } albumUri - URI of the album. + * @param { boolean } isAuthorized - Is grant save permission to the app + * @param { Array } photoCreationConfigs - List of the photo asset creation configs + * @returns { Promise> } - Returns the media library file uri list to application which has been authorized + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - Internal system error + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + createAssetsForAppWithAlbum(source: PhotoCreationSource, albumUri: string, isAuthorized: boolean, + photoCreationConfigs: Array): Promise>; } /** @@ -5078,6 +5292,41 @@ declare namespace photoAccessHelper { MOVING_PHOTO_IMAGE_TYPE = 'image/movingPhoto' } + /** + * Enumeration type of single selection mode + * + * @enum { number } SingleSelectionMode + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 18 + */ + export enum SingleSelectionMode { + /** + * browser mode + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 18 + */ + BROWSER_MODE = 0, + /** + * select directly mode + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 18 + */ + SELECT_MODE = 1, + /** + * browser and select mode + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 18 + */ + BROWSER_AND_SELECT_MODE = 2 + } + /** * Class BaseSelectOptions, which is extracted from class PhotoSelectOptions * @@ -5225,6 +5474,16 @@ declare namespace photoAccessHelper { * @since 12 */ isPreviewForSingleSelectionSupported?: boolean; + + /** + * The mode of single selection + * + * @type { ?SingleSelectionMode } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @atomicservice + * @since 18 + */ + singleSelectionMode?: SingleSelectionMode; } /** @@ -5299,6 +5558,16 @@ declare namespace photoAccessHelper { * @since 14 */ completeButtonText?: CompleteButtonText; + + /** + * user id + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + userId?: number; } /** @@ -5656,7 +5925,16 @@ declare namespace photoAccessHelper { * @systemapi * @since 13 */ - PRIVATE_MOVING_PHOTO_RESOURCE = 4 + PRIVATE_MOVING_PHOTO_RESOURCE = 4, + + /** + * Private moving photo metadata + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + PRIVATE_MOVING_PHOTO_METADATA = 5 } /** @@ -6058,6 +6336,20 @@ declare namespace photoAccessHelper { */ setTitle(title: string): void; + /** + * Set display name of the asset. + * + * @param { string } displayName - the new display name of the asset + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - System inner fail + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + setDisplayName(displayName: string): void; + /** * Save edit data. * @@ -6321,6 +6613,20 @@ declare namespace photoAccessHelper { * @since 11 */ setUserComment(userComment: string): void; + + /** + * Set recentShow state of the asset. + * + * @param { boolean } isRencentShow - the new recentShow state of the asset + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - System inner fail + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + setIsRecentShow(isRencentShow: boolean): void; } /** @@ -6837,7 +7143,7 @@ declare namespace photoAccessHelper { subtype: PhotoSubtype; /** * Effect mode of moving photo - * + * * @type { MovingPhotoEffectMode } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi diff --git a/api/@ohos.file.picker.d.ts b/api/@ohos.file.picker.d.ts index 81febd62b56c738a921452184376239d452cc113..bf3d72559a8e7eda47ecbdbaf747da5f77aa8832 100644 --- a/api/@ohos.file.picker.d.ts +++ b/api/@ohos.file.picker.d.ts @@ -20,7 +20,8 @@ import { AsyncCallback, Callback } from './@ohos.base'; import Context from './application/Context'; -import { window } from '@kit.ArkUI'; +import window from './@ohos.window'; +import type { CustomColors } from './@ohos.arkui.theme'; /** * Provide the capabilities to use different pickers. * @@ -76,7 +77,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoViewMIMETypes.IMAGE_TYPE */ IMAGE_TYPE = 'image/*', @@ -93,7 +94,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoViewMIMETypes.VIDEO_TYPE */ VIDEO_TYPE = 'video/*', @@ -110,7 +111,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoViewMIMETypes.IMAGE_VIDEO_TYPE */ IMAGE_VIDEO_TYPE = '*/*' @@ -146,7 +147,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoSelectOptions.MIMEType */ MIMEType?: PhotoViewMIMETypes; @@ -165,7 +166,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoSelectOptions.maxSelectNumber */ maxSelectNumber?: number; @@ -201,7 +202,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoSelectResult.photoUris */ photoUris: Array; @@ -220,7 +221,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.file.photoAccessHelper/photoAccessHelper#PhotoSelectResult.isOriginalPhoto */ isOriginalPhoto: boolean; @@ -240,7 +241,7 @@ declare namespace picker { * @type { ?Array } * @syscap SystemCapability.FileManagement.UserFileService * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ newFileNames?: Array; } @@ -267,7 +268,7 @@ declare namespace picker { * @syscap SystemCapability.FileManagement.UserFileService * @atomicservice * @since 12 - * @deprecated since 16 + * @deprecated since 18 */ constructor(); @@ -277,7 +278,7 @@ declare namespace picker { * @param { Context } context - represents the context. * @syscap SystemCapability.FileManagement.UserFileService * @since 12 - * @deprecated since 16 + * @deprecated since 18 */ constructor(context: Context); @@ -654,18 +655,16 @@ declare namespace picker { * @since 15 */ mergeMode?: MergeTypeMode; - + /** - * Specifies whether the picker supports encryption. - * When its value is set to true, the picker will display a button that allows the user - * to encrypt files selected. + * Theme color * - * @type { ?boolean } + * @type { ?CustomColors } * @syscap SystemCapability.FileManagement.UserFileService - * @atomicservice + * @systemapi * @since 18 */ - isEncryptionSupported?: boolean; + themeColor?: CustomColors; } /** @@ -744,6 +743,16 @@ declare namespace picker { * @since 12 */ pickerMode?: DocumentPickerMode; + + /** + * Theme color + * + * @type { ?CustomColors } + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 18 + */ + themeColor?: CustomColors; } /** diff --git a/api/@ohos.fileshare.d.ts b/api/@ohos.fileshare.d.ts index 728df25c8e5a587c4ba11f87aabad8ae05d39657..d40e87b1ca27f20b539ba4bde3c70703c7230ca2 100644 --- a/api/@ohos.fileshare.d.ts +++ b/api/@ohos.fileshare.d.ts @@ -335,6 +335,18 @@ declare namespace fileShare { * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization * @since 12 */ + /** + * Check persistent permissions for the URI. + * + * @param { Array } policies - Policy information to grant permission on URIs. + * @returns { Promise> } Returns the persistent state of uri permissions. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization + * @since 17 + */ function checkPersistentPermission(policies: Array): Promise>; /** diff --git a/api/@ohos.geoLocationManager.d.ts b/api/@ohos.geoLocationManager.d.ts index 1c3f886108c068cb3ca15d8f5077ff4618393c71..f9e4887961c3addf26641fb2268b430d8676d055 100644 --- a/api/@ohos.geoLocationManager.d.ts +++ b/api/@ohos.geoLocationManager.d.ts @@ -470,6 +470,37 @@ declare namespace geoLocationManager { */ function off(type: 'locationIconStatusChange', callback?: Callback): void; + /** + * Registers and listens to bluetooth scanning results for location services. + * + * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION + * @param { 'bluetoothScanResultChange' } type - Indicates the location service event to be subscribed to. + * @param { Callback } callback - Indicates the callback for reporting Bluetooth scan info. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('bluetoothScanResultChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. + * @throws { BusinessError } 3301100 - The location switch is off. + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + function on(type: 'bluetoothScanResultChange', callback: Callback): void; + + /** + * Stop bluetooth scanning and unregister to listen to bluetooth scanning result changes. + * + * @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION + * @param { 'bluetoothScanResultChange' } type - Indicates the location service event to be subscribed to. + * @param { Callback } [callback] - Indicates the callback for reporting Bluetooth scan info. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('bluetoothScanResultChange')} due to limited device capabilities. + * @throws { BusinessError } 3301000 - The location service is unavailable. + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + function off(type: 'bluetoothScanResultChange', callback?: Callback): void; + /** * Obtain current location. * @@ -2497,6 +2528,60 @@ declare namespace geoLocationManager { timestamp: number; } + /** + * Describes the contents of the bluetooth scan results. + * + * @typedef BluetoothScanResult + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + export interface BluetoothScanResult { + /** + * Address of the scanned device + * + * @type { string } + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + deviceId: string; + + /** + * RSSI of the scanned device + * + * @type { number } + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + rssi: number; + + /** + * The raw data of broadcast packet + * + * @type { ?ArrayBuffer } + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + data?: ArrayBuffer; + + /** + * The local name of the scanned device + * + * @type { string } + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + deviceName: string; + + /** + * Connectable of the scanned device + * + * @type { boolean } + * @syscap SystemCapability.Location.Location.Core + * @since 16 + */ + connectable: boolean; + } + /** * Enum for the source of the location. * diff --git a/api/@ohos.graphics.colorSpaceManager.d.ts b/api/@ohos.graphics.colorSpaceManager.d.ts index d1830c876a23f52b5924a8659fe28c317e4ed2d1..e6db31c4fef0598aefb9244a191a8975a0c1807d 100644 --- a/api/@ohos.graphics.colorSpaceManager.d.ts +++ b/api/@ohos.graphics.colorSpaceManager.d.ts @@ -550,6 +550,13 @@ declare namespace colorSpaceManager { */ DISPLAY_P3_PQ = P3_PQ, + /** + * PRIMARIES_BT2020 | TRANSFUNC_LOG + * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core + * @since 18 + */ + H_LOG = 26, + /** * Indicates a customized color space. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core diff --git a/api/@ohos.graphics.drawing.d.ts b/api/@ohos.graphics.drawing.d.ts index 78e6e1272003bd57efbf54153f30ceeb22bc2e36..9e3e26770f1b39a03e02c4454ebaef822f53122b 100644 --- a/api/@ohos.graphics.drawing.d.ts +++ b/api/@ohos.graphics.drawing.d.ts @@ -871,8 +871,6 @@ declare namespace drawing { * @param { boolean } startWithMoveTo - Whether the path obtained moveTo to the starting segment. * @param { Path } dst - The path obtained. * @returns { boolean } - Returns false if the segment is zero-length or start >= stop, else return true. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1299,8 +1297,6 @@ declare namespace drawing { * @param { number } startAngle - Indicates the startAngle of the arc. * @param { number } sweepAngle - Indicates the sweepAngle of the arc. * @param { boolean } useCenter - If true, include the center of the oval in the arc, and close it if it is being stroked. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1470,8 +1466,6 @@ declare namespace drawing { /** * Clears a canvas by using a specified color represented by ARGB color of hexadecimal format. * @param { common2D.Color | number } color - Number must be ARGB color of hexadecimal format. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1669,8 +1663,6 @@ declare namespace drawing { * Determines whether path is intersect with current clip area. * @param { Path } path - Path to draw. * @returns { boolean } Returns true if path is not intersect; returns false otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1680,8 +1672,6 @@ declare namespace drawing { * Determines whether rect is intersect with current clip area. * @param { common2D.Rect } rect - Rectangle to determines. * @returns { boolean } Returns true if rect and region is not intersect; returns false otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1872,8 +1862,6 @@ declare namespace drawing { * Generate typeface from Rawfile. * @param { Resource } rawfile - RawFile for typeface. * @returns { Typeface } Typeface. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2233,8 +2221,6 @@ declare namespace drawing { * @param { number } index - the index of Glyphs. * @returns { Path } The path object for specified glyph, undefined if not found. * Note: Path use y-axis-goes-down system, y axis is inverted to the y-axis-goes-up system. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2246,8 +2232,6 @@ declare namespace drawing { * Note: 1. Rect use y-axis-goes-down system, y axis is inverted to the y-axis-goes-up system. *
2. Rect use two points(left-bottom & right-top) to describe the bound. *
3. The bound rect will be snap to integral boundaries. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2627,8 +2611,6 @@ declare namespace drawing { * @param { number } dev - Indicates the deviation during drawing. * @param { number } seedAssist - Indicates generate effect pseudo-random sequence, the default value is zero. * @returns { PathEffect } PathEffect object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types; * @static * @syscap SystemCapability.Graphics.Drawing * @since 18 @@ -2640,8 +2622,6 @@ declare namespace drawing { * @param { PathEffect } outer - Indicates the path effect that takes effect later in the combination path effect. * @param { PathEffect } inner - Indicates the path effect of the first effect in the combination path effect. * @returns { PathEffect } PathEffect object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types; * @static * @syscap SystemCapability.Graphics.Drawing * @since 18 @@ -2668,8 +2648,6 @@ declare namespace drawing { * @param { PathEffect } firstPathEffect - Indicates the first path effect. * @param { PathEffect } secondPathEffect - Indicates the second path effect. * @returns { PathEffect } PathEffect object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @static * @syscap SystemCapability.Graphics.Drawing * @since 18 @@ -3146,8 +3124,6 @@ declare namespace drawing { /** * Set the specified ARGB color of hexadecimal format to the pen. * @param { number } color - Number must be ARGB color of hexadecimal format. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ diff --git a/api/@ohos.graphics.text.d.ts b/api/@ohos.graphics.text.d.ts index edaf344f7d730927357d90f5ef2d9aa4098d1b98..9e05aa351e7bc8c68fb94073d32cbb165441f8d1 100755 --- a/api/@ohos.graphics.text.d.ts +++ b/api/@ohos.graphics.text.d.ts @@ -868,7 +868,7 @@ declare namespace text { * @param { string | Resource } path - The path of the font file. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1338,7 +1338,7 @@ declare namespace text { * @param { number } width - Control how wide the text is allowed to be. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1550,7 +1550,7 @@ declare namespace text { * @param { number } width - The requested line-break width. * @returns { number } A count of the characters from startIndex that would cause the line break. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1562,7 +1562,7 @@ declare namespace text { * @param { number } count - The characters count of the text range. * @returns { TextLine } Text line object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1886,8 +1886,6 @@ declare namespace text { * @param { EllipsisMode } ellipsisMode - Text ellipsis mode, EllipsisMode:MIDDLE is not supported. * @param { string } ellipsis - Text ellipsis. * @returns { TextLine } Truncated text line object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1921,8 +1919,6 @@ declare namespace text { * Gets the string index of the given position. * @param { common2D.Point } point - The given position. * @returns { number } The string index for a given position. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1932,8 +1928,6 @@ declare namespace text { * Gets the offset of the given string index. * @param { number } index - The given string index. * @returns { number } The offset for a given string index. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1942,8 +1936,6 @@ declare namespace text { /** * Enumerate caret offset and index in text lines. * @param { CaretOffsetsCallback } callback - User-defined callback functions. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1957,8 +1949,6 @@ declare namespace text { * @param { number } alignmentWidth - The width of the text to be aligned. * Returns 0 if it is less than the actual width of the text. * @returns { number } The offset of the aligned text. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -1992,8 +1982,6 @@ declare namespace text { * @param { Range } range of run, range.start is the starting index of the run block, starting from 0. * range.end is run length, if range.start and range.end are set to 0, then get all of the current run. * @returns { Array } Glyph identifier or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2012,8 +2000,6 @@ declare namespace text { * @param { Range } range of run, range.start is the starting index of the run block, starting from 0. * range.end is run length, if range.start and range.end are set to 0, then get all of the current run. * @returns { Array } The position of the font in the layout or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2050,8 +2036,6 @@ declare namespace text { * @param { Range } range of run, range.start is the starting index of the run block, starting from 0. * range.end is run length, if range.start range.and end are set to 0, then get all of the current run. * @returns { Array } The glyph indices or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ @@ -2235,7 +2219,7 @@ declare namespace text { * @returns { Promise> } List of font descriptors, and an empty array will be returned * if the matching fails. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Graphics.Drawing * @since 18 */ diff --git a/api/@ohos.graphics.uiEffect.d.ts b/api/@ohos.graphics.uiEffect.d.ts index f47373f86a57685e80146f0ac00be9b93cbf5c64..e8e5fd8aac6c9d5817d07e5bd979b0ade1b75eb0 100644 --- a/api/@ohos.graphics.uiEffect.d.ts +++ b/api/@ohos.graphics.uiEffect.d.ts @@ -65,7 +65,7 @@ declare namespace uiEffect { * @param { number } x - Represents the X-axis position of center point where the water ripple first appears on the screen. * @param { number } y - Represents the Y-axis position of center point where the water ripple first appears on the screen. * @param { WaterRippleMode } rippleMode - Set the mode of water ripple, - * 0 for mobile to desktop(Receive), 1 for mobile to desktop(Send), 2 for mobile to mobile. + * 0 for mobile to desktop(Receive), 1 for mobile to desktop(Send), 2 for mobile to mobile, 3 for cross platform. * @returns { Filter } - Returns water ripple Filter. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Graphics.Drawing @@ -185,6 +185,15 @@ declare namespace uiEffect { * @since 12 */ SMALL2SMALL = 2, + + /** + * MINI_RECV mode. + * + * @syscap SystemCapability.Graphics.Drawing + * @systemapi + * @since 17 + */ + MINI_RECV = 3, } /** diff --git a/api/@ohos.hiTraceMeter.d.ts b/api/@ohos.hiTraceMeter.d.ts index a203466d09630807877aa4a788e4c5eaead91041..a19bce9e0cb086b23293bee2afadf386fb7207e1 100644 --- a/api/@ohos.hiTraceMeter.d.ts +++ b/api/@ohos.hiTraceMeter.d.ts @@ -45,91 +45,7 @@ * @syscap SystemCapability.HiviewDFX.HiTrace * @since 8 */ -/** - * Provides interfaces to trace a task for performance measure, the logs can be capture by the - * bytrace cmdline available on the device. - * - *

This interfaces trace the start, end, and value changes of key processes that last for at least 3 ms. - * - *

Example: - * Track the beginning of a context: - *

{@code
- * hiTraceMeter.startTrace("checkName", 111);
- * }
- * Track the end of a context: - *
{@code
- * hiTraceMeter.finishTrace("checkName", 111);
- * }
- * To trace the number of layers, which is 3: - *
{@code
- * hiTraceMeter.traceByValue("curLayer", 3);
- * }
- * - *

Each {@code startTrace} matches one {@code finishTrace}, and they must have the same name - * and taskId. - * - * @namespace hiTraceMeter - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ declare namespace hiTraceMeter { - - /** - * Enumerates the HiTrace output levels. The output level threshold system parameter determines the minimum output trace. - * - * @enum { number } - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - enum HiTraceOutputLevel { - /** - * Ouput level only for debug usage. - * - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - DEBUG = 0, - - /** - * Output level for beta version usage. - * - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - INFO = 1, - - /** - * Output level for beta version usage, with higher priority than INFO. - * - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - CRITICAL = 2, - - /** - * Output level for commercial version usage. - * - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - COMMERCIAL = 3, - - /** - * Output level range limit. - * - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - MAX = COMMERCIAL - } - /** * Records a trace marking it as the start of a task, can with the expected completion time between * startTrace and finishTrace. @@ -143,20 +59,6 @@ declare namespace hiTraceMeter { * @syscap SystemCapability.HiviewDFX.HiTrace * @since 8 */ - /** - * Records a trace marking it as the start of a task, can with the expected completion time between - * startTrace and finishTrace. - * - * This method is invoked at the start of a transaction to indicate that a task has started, whose name - * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by - * {@link #finishTrace}, the name and taskId need to be the same. - * - * @param { string } name Indicates the task name. - * @param { number } taskId The unique id used to distinguish the tasks and match with the id in follow finishTrace. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ function startTrace(name: string, taskId: number): void; /** @@ -171,20 +73,7 @@ declare namespace hiTraceMeter { * @syscap SystemCapability.HiviewDFX.HiTrace * @since 8 */ - /** - * Records a trace and marks it as the end of a task. - * - * This method is invoked at the end of a transaction to indicate that a task has ended, whose name - * is specified by {@code name}. This method must be invoked after the the startTrace. - * - * @param { string } name Indicates the task name. It must be the same with the {@code name} of startTrace. - * @param { number } taskId The unique id used to distinguish the tasks and must be the same with the . - * {@code taskId} of startTrace. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function finishTrace(name: string, taskId: number): void; + function finishTrace(name: string, taskId: number): void; /** * Records a trace for generating a count, such as clock pulse and the number of layers. @@ -194,104 +83,8 @@ declare namespace hiTraceMeter { * @syscap SystemCapability.HiviewDFX.HiTrace * @since 8 */ - /** - * Records a trace for generating a count, such as clock pulse and the number of layers. - * - * @param { string } name Indicates the name used to identify the count. - * @param { number } count Indicates the number of the count. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ function traceByValue(name: string, count: number): void; - - /** - * Records a trace marking it as the start of a task. - * - * This method is invoked at the start of a transaction to indicate that a task has started, whose name - * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by - * {@link #finishSyncTrace}, called by the same thread with the same level. - * - * @param { HiTraceOutputLevel } level Indicates trace output priority level. - * @param { string } name Indicates the task name. - * @param { string } customArgs Indicates key=value pair to be outputed in trace; multiple pairs should use comma - * as seperator. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function startSyncTrace(level: HiTraceOutputLevel, name: string, customArgs?: string): void; - - /** - * Records a trace and marks it as the end of a task. - * - * This method is invoked at the end of a transaction to indicate that the nearest running task tracked by - * startSyncTrace that has yet to be marked by finishSyncTrace, has ended. - * This method must be invoked after the the {@link #startSyncTrace}, by the same thread. - * - * @param { HiTraceOutputLevel } level Indicates trace output priority level. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function finishSyncTrace(level: HiTraceOutputLevel): void; - - /** - * Records a trace marking it as the start of a task. - * - * This method is invoked at the start of a transaction to indicate that a task has started, whose name - * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by a - * corresponding {@link #finishAsyncTrace}, with the same level, name, and taskId. - * - * @param { HiTraceOutputLevel } level Indicates trace output priority level. - * @param { string } name Indicates the task name. - * @param { number } taskId The unique id used to distinguish the task and match with the id of the corresponding finishAsyncTrace. - * @param { string } customCategory Indicates the label to aggregate asynchronous task display. - * @param { string } customArgs Indicates key=value pair to be outputed in trace; multiple pairs should use comma as seperator. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function startAsyncTrace(level: HiTraceOutputLevel, name: string, taskId: number, customCategory: string, customArgs?: string): void; - - /** - * Records a trace and marks it as the end of a task. - * - * This method is invoked at the end of a transaction to indicate that a task has ended, whose name is specified - * by {@code name}. This method must be invoked after the the {@link #startAsyncTrace}, with the same level, name, and taskId. - * It is not required to be invoked by the same thread calling startAsyncTrace. - * - * @param { HiTraceOutputLevel } level Indicates trace output priority level. - * @param { string } name Indicates the task name. - * @param { number } taskId The unique id used to distinguish the task and match with the id of the corresponding startAsyncTrace. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function finishAsyncTrace(level: HiTraceOutputLevel, name: string, taskId: number): void; - - /** - * Records a trace for generating a count, such as clock pulse and the number of layers. - * - * @param { HiTraceOutputLevel } level Indicates trace output priority level. - * @param { string } name Indicates the name used to identify the count. - * @param { number } count Indicates the number of the count. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function traceByValue(level: HiTraceOutputLevel, name: string, count: number): void; - - /** - * Return whether the current process is allowed to output trace. - * - * @returns { boolean } The status of whether the current process is allowed to output trace. - * @syscap SystemCapability.HiviewDFX.HiTrace - * @atomicservice - * @since 18 - */ - function isTraceEnabled(): boolean; - } export default hiTraceMeter; + \ No newline at end of file diff --git a/api/@ohos.hidebug.d.ts b/api/@ohos.hidebug.d.ts index 329efe1e955fa22d58250f8194ecab9e09b4c523..4453c8fbf27bf27f0eb4207d48d3cb149e1fdeea 100644 --- a/api/@ohos.hidebug.d.ts +++ b/api/@ohos.hidebug.d.ts @@ -840,7 +840,6 @@ declare namespace hidebug { * * @param { boolean } needGC - Whether do GC before dump, default is true. * @returns { Promise } Returns the full path of raw heap snapshot file. - * @throws { BusinessError } 401 - Invalid parameter. * @throws { BusinessError } 11400106 - Quota exceeded. * @throws { BusinessError } 11400107 - Fork operation failed. * @throws { BusinessError } 11400108 - Failed to wait for the child process to finish. diff --git a/api/@ohos.hiviewdfx.hiAppEvent.d.ts b/api/@ohos.hiviewdfx.hiAppEvent.d.ts index 006f4261490b0a7285c8dff6d46a14837a6bb723..1825109022948f603e5db7912607ed5dd0010e35 100644 --- a/api/@ohos.hiviewdfx.hiAppEvent.d.ts +++ b/api/@ohos.hiviewdfx.hiAppEvent.d.ts @@ -39,17 +39,6 @@ import type { AsyncCallback } from './@ohos.base'; * @atomicservice * @since 11 */ -/** - * Provides the event logging function for applications to log the fault, statistical, security, - * and user behavior events reported during running. Based on event information, - * you will be able to analyze the running status of applications. - * - * @namespace hiAppEvent - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ declare namespace hiAppEvent { /** * Enumerate application event types. @@ -66,15 +55,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Enumerate application event types. - * - * @enum { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ enum EventType { /** * Fault event. @@ -89,14 +69,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Fault event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ FAULT = 1, /** @@ -112,14 +84,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Statistic event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ STATISTIC = 2, /** @@ -135,14 +99,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Security event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ SECURITY = 3, /** @@ -158,14 +114,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * User behavior event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ BEHAVIOR = 4 } @@ -177,15 +125,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset domain. - * - * @namespace domain - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace domain { /** * the domain of operating system. @@ -194,14 +133,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * the domain of operating system. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const OS: string; } @@ -220,15 +151,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset event. - * - * @namespace event - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace event { /** * User login event. @@ -282,14 +204,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * crash event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const APP_CRASH: string; /** @@ -380,15 +294,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset param. - * - * @namespace param - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace param { /** * User id. @@ -403,14 +308,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * User id. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const USER_ID: string; /** @@ -426,14 +323,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Distributed service name. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const DISTRIBUTED_SERVICE_NAME: string; /** @@ -449,14 +338,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Distributed service instance id. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const DISTRIBUTED_SERVICE_INSTANCE_ID: string; } @@ -482,19 +363,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Application event logging configuration interface. - * - * @param { ConfigOption } config Application event logging configuration item object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11103001 - Invalid max storage quota value. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function configure(config: ConfigOption): void; /** @@ -512,15 +380,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Describe the options for the configuration. - * - * @interface ConfigOption - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface ConfigOption { /** * Configuration item: application event logging switch. @@ -537,15 +396,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Configuration item: application event logging switch. - * - * @type { ?boolean } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ disable?: boolean; /** @@ -581,15 +431,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of written application event information. - * - * @interface AppEventInfo - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventInfo { /** * The domain of the event. @@ -606,15 +447,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The domain of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ domain: string; /** @@ -632,15 +464,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -658,15 +481,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The type of the event. - * - * @type { EventType } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ eventType: EventType; /** @@ -684,15 +498,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The params of the event. - * - * @type { object } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ params: object; } @@ -732,26 +537,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Write application event. - * - * @param { AppEventInfo } info Application event information to be written. - * @returns { Promise } Return Promise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11100001 - Function disabled. - * @throws { BusinessError } 11101001 - Invalid event domain. - * @throws { BusinessError } 11101002 - Invalid event name. - * @throws { BusinessError } 11101003 - Invalid number of event parameters. - * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. - * @throws { BusinessError } 11101005 - Invalid event parameter name. - * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function write(info: AppEventInfo): Promise; /** @@ -790,26 +575,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Write application event. - * - * @param { AppEventInfo } info Application event information to be written. - * @param { AsyncCallback } callback Callback function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11100001 - Function disabled. - * @throws { BusinessError } 11101001 - Invalid event domain. - * @throws { BusinessError } 11101002 - Invalid event name. - * @throws { BusinessError } 11101003 - Invalid number of event parameters. - * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. - * @throws { BusinessError } 11101005 - Invalid event parameter name. - * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function write(info: AppEventInfo, callback: AsyncCallback): void; /** @@ -820,15 +585,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * Indicates possible parameter types. - * - * @typedef {number | string | boolean | Array} - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ type ParamType = number | string | boolean | Array; /** @@ -847,23 +603,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * It is used to set custom parameters for events, including both system-subscribed events and custom events. - * Existing parameter will be overwritten, and non-existing parameter will be created. - * - * @param { Record } params The parameters of the event. - * @param { string } domain The domain of the event. - * @param { string } name The name of the event. - * @returns { Promise } Return Promise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11101007 - The number of parameter keys exceeds the limit. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setEventParam(params: Record, domain: string, name?: string): Promise; /** @@ -896,15 +635,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of the read event package. - * - * @interface AppEventPackage - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventPackage { /** * The id of the package. @@ -921,15 +651,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The id of the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ packageId: number; /** @@ -947,15 +668,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The number of events contained in the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ row: number; /** @@ -973,15 +685,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The total size of events contained in the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ size: number; /** @@ -999,15 +702,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The events data contained in the package. - * - * @type { string[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ data: string[]; /** @@ -1018,15 +712,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * The event json format data contained in the package. - * - * @type { Array } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventInfos: Array; } @@ -1043,14 +728,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event holder object, which is used to read the event data monitored by the watcher. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ class AppEventPackageHolder { /** * Constructor for AppEventPackageHolder. @@ -1067,15 +744,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Constructor for AppEventPackageHolder. - * - * @param { string } watcherName Name of the watcher to read. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ constructor(watcherName: string); /** @@ -1098,18 +766,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set the threshold size per read. - * - * @param { number } size Threshold size. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11104001 - Invalid size value. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ setSize(size: number): void; /** @@ -1123,18 +779,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * Set the number of rows per read. - * - * @param { number } size Row size. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11104001 - Invalid size value. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ setRow(size: number): void; /** @@ -1152,15 +796,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Read the event data monitored by the watcher. - * - * @returns { AppEventPackage } The read event package. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ takeNext(): AppEventPackage; } @@ -1179,15 +814,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of the condition for triggering callback when the watcher monitors event data. - * - * @interface TriggerCondition - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface TriggerCondition { /** * The number of write events that trigger callback. @@ -1204,15 +830,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The number of write events that trigger callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ row?: number; /** @@ -1230,15 +847,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The size of write events that trigger callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ size?: number; /** @@ -1256,15 +864,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The interval for triggering callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ timeOut?: number; } @@ -1283,15 +882,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event filter object, which is used to filter events monitored by the watcher. - * - * @interface AppEventFilter - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventFilter { /** * The name of the event domain to be monitored by the watcher. @@ -1308,15 +898,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event domain to be monitored by the watcher. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ domain: string; /** @@ -1334,15 +915,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The types of the events to be monitored by the watcher. - * - * @type { ?EventType[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ eventTypes?: EventType[]; /** @@ -1353,15 +925,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The names of the events to be monitored by the watcher. - * - * @type { ?string[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ names?: string[]; } @@ -1373,15 +936,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event group. - * - * @interface AppEventGroup - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventGroup { /** * The name of the event. @@ -1391,15 +945,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -1410,15 +955,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The event array which is group by the name. - * - * @type { Array } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventInfos: Array; } @@ -1437,15 +973,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event watcher object, which is used to monitor written event data. - * - * @interface Watcher - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface Watcher { /** * The name of watcher. @@ -1462,15 +989,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of watcher. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -1488,15 +1006,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The condition for triggering callback. - * - * @type { ?TriggerCondition } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ triggerCondition?: TriggerCondition; /** @@ -1514,15 +1023,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The event filters for monitoring events. - * - * @type { ?AppEventFilter[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventFilters?: AppEventFilter[]; /** @@ -1540,15 +1040,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The callback function of watcher. - * - * @type { ?function } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ onTrigger?: (curRow: number, curSize: number, holder: AppEventPackageHolder) => void; /** @@ -1559,15 +1050,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The callback function, when watcher receive the event. - * - * @type { ?function } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ onReceive?: (domain: string, appEventGroups: Array) => void; } @@ -1603,24 +1085,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Add event watcher. - * - * @param { Watcher } watcher Watcher object for monitoring events. - * @returns { AppEventPackageHolder } Holder object, which is used to read the monitoring data of the watcher. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11102001 - Invalid watcher name. - * @throws { BusinessError } 11102002 - Invalid filtering event domain. - * @throws { BusinessError } 11102003 - Invalid row value. - * @throws { BusinessError } 11102004 - Invalid size value. - * @throws { BusinessError } 11102005 - Invalid timeout value. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function addWatcher(watcher: Watcher): AppEventPackageHolder; /** @@ -1645,19 +1109,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Remove event watcher. - * - * @param { Watcher } watcher Watcher object for monitoring events. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11102001 - Invalid watcher name. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function removeWatcher(watcher: Watcher): void; /** @@ -1675,15 +1126,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Clear all local logging data of the application. - * - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function clearData(): void; /** @@ -1698,19 +1140,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set user ID. - * - * @param { string } name The key of the user ID. - * @param { string } value The value of the user ID. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setUserId(name: string, value: string): void; /** @@ -1725,19 +1154,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Get user ID. - * - * @param { string } name The key of the user ID. - * @returns { string } the user ID value. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function getUserId(name: string): string; /** @@ -1752,19 +1168,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set user property. - * - * @param { string } name The key of the user property. - * @param { string } value The value of the user property. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setUserProperty(name: string, value: string): void; /** @@ -1779,19 +1182,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Get user property. - * - * @param { string } name The key of the user property. - * @returns { string } the user property value. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function getUserProperty(name: string): string; /** diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index ed3ec67d2ecef4bb9d42a1374fea7312c2bb9180..5397bbbf13940c4dbb67e05879083d6b8c5689e3 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -599,7 +599,6 @@ declare namespace i18n { * @param { TemperatureType } type - Indicates a temperature type. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. @@ -622,7 +621,6 @@ declare namespace i18n { * * @param { TemperatureType } type - Indicates a temperature type. * @returns { string } temperature name. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice @@ -637,7 +635,6 @@ declare namespace i18n { * @param { WeekDay } type - one of week days. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. @@ -953,7 +950,6 @@ declare namespace i18n { * @param [ string ] delimiter - the file path's delimiter. * @param [ intl.Locale ] locale - the locale object used to localized file path. * @returns { string } the localized file path. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @static * @syscap SystemCapability.Global.I18n @@ -3585,7 +3581,6 @@ declare namespace i18n { * @param { string } pattern - the pattern used to create SimpleDateTimeFormat object. * @param [ intl.Locale ] locale - the intl.Locale object used to create intl.DateTimeFormat object. * @returns { SimpleDateTimeFormat } a SimpleDateTimeFormat object created from pattern. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice @@ -3601,7 +3596,6 @@ declare namespace i18n { * @param { string } skeleton - the skeleton used to create intl.DateTimeFormat object. * @param [ intl.Locale ] locale - the intl.Locale object used to create intl.DateTimeFormat object. * @returns { SimpleDateTimeFormat } a SimpleDateTimeFormat object created from skeleton. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice @@ -3622,7 +3616,6 @@ declare namespace i18n { * * @param { Date } date - Indicates the Date object to be formatted. * @returns { string } a date string formatted based on the specified locale. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice * @since 18 @@ -3637,7 +3630,6 @@ declare namespace i18n { * @param { string } skeleton - the skeleton used to create SimpleNumberFormat object. * @param [ intl.Locale ] locale - the intl.Locale object used to create SimpleNumberFormat object. * @returns { SimpleNumberFormat } a SimpleNumberFormat object created from pattern. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @crossplatform @@ -3659,7 +3651,6 @@ declare namespace i18n { * * @param { number } value - Indicates the number to be formatted. * @returns { string } a number string formatted based on the specified locale. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice * @since 18 @@ -3680,7 +3671,6 @@ declare namespace i18n { * * @param { intl.NumberFormat | SimpleNumberFormat } numberFormat - Indicates the number format object that used to format number. * @param { StyledNumberFormatOptions } [ options ] - Indicates the options used to format the number. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice * @since 18 @@ -3692,7 +3682,6 @@ declare namespace i18n { * * @param { number } value - Indicates the number to be formatted. * @returns { StyledString } a styled number string formatted based on the specified locale. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice * @since 18 diff --git a/api/@ohos.inputMethod.d.ts b/api/@ohos.inputMethod.d.ts index 1a6650f58d56ff52b624331e2f8c1ccb2a16365c..9d6f7ee49e04fc46dd24072b1e4247501df002d2 100644 --- a/api/@ohos.inputMethod.d.ts +++ b/api/@ohos.inputMethod.d.ts @@ -602,7 +602,7 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ showOptionalInputMethods(callback: AsyncCallback): void; @@ -613,7 +613,7 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ showOptionalInputMethods(): Promise; @@ -1336,6 +1336,52 @@ declare namespace inputMethod { * @since 10 */ off(type: 'getTextIndexAtCursor', callback?: () => number): void; + + /** + *

Subscribe 'setPreviewText' event.

+ *

To support the preview text feature, developers should subscribe to this event before calling attach.

+ * + * @param { 'setPreviewText' } type - the type of subscribe event. + * @param { SetPreviewTextCallback } callback - the callback of on('setPreviewText'). + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 17 + */ + on(type: 'setPreviewText', callback: SetPreviewTextCallback): void; + + /** + * Unsubscribe 'setPreviewText' event. + * + * @param { 'setPreviewText' } type - the type of unsubscribe event. + * @param { SetPreviewTextCallback } [callback] - optional, the callback of off('setPreviewText'). + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 17 + */ + off(type: 'setPreviewText', callback?: SetPreviewTextCallback): void; + + /** + *

Subscribe 'finishTextPreview' event.

+ *

To support the preview text feature, developers should subscribe to this event before calling attach.

+ * + * @param { 'finishTextPreview' } type - the type of subscribe event. + * @param { Callback } callback - the callback of on('finishTextPreview'). + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 17 + */ + on(type: 'finishTextPreview', callback: Callback): void; + + /** + * Unsubscribe 'finishTextPreview' event. + * + * @param { 'finishTextPreview' } type - the type of unsubscribe event. + * @param { Callback } [callback] - optional, the callback of off('finishTextPreview'). + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 17 + */ + off(type: 'finishTextPreview', callback?: Callback): void; } /** @@ -2058,6 +2104,17 @@ declare namespace inputMethod { */ OTHER = 20 } + + /** + * The callback of 'setPreviewText' event. + * + * @typedef { function } SetPreviewTextCallback. + * @param { text } string - text to be previewed. + * @param { range } Range - the range of the text to be replaced by the preview text. + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 17 + */ + export type SetPreviewTextCallback = (text: string, range: Range) => void; } export default inputMethod; \ No newline at end of file diff --git a/api/@ohos.inputMethodEngine.d.ts b/api/@ohos.inputMethodEngine.d.ts index 6e25274da8b3042f577fc59353ce90b39fcb895b..49feb7925d93a8cef90f95211c4d85ed31f3a490 100644 --- a/api/@ohos.inputMethodEngine.d.ts +++ b/api/@ohos.inputMethodEngine.d.ts @@ -644,6 +644,27 @@ declare namespace inputMethodEngine { */ off(type: 'privateCommand', callback?: Callback>): void; + /** + * Subscribe 'callingDisplayDidChange' event. + * + * @param { 'callingDisplayDidChange' } type - indicates the type of subscribe event. + * @param { Callback } callback - indicates the callback of on('callingDisplayDidChange'). + * @throws { BusinessError } 801 - capability not supported. + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 18 + */ + on(type: 'callingDisplayDidChange', callback: Callback): void; + + /** + * Unsubscribe 'callingDisplayDidChange' event. + * + * @param { 'callingDisplayDidChange' } type - indicates the type of subscribe event. + * @param { Callback } [callback] - optional, indicates the callback of off('callingDisplayDidChange'). + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 18 + */ + off(type: 'callingDisplayDidChange', callback?: Callback): void; + /** * Get input method's security mode. * @@ -1934,7 +1955,6 @@ declare namespace inputMethodEngine { * * @param { 'sizeUpdate' } type - the type of subscribe event. * @param { SizeUpdateCallback } callback - the callback of on('sizeUpdate'). - * @throws { BusinessError } 202 - not system application. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi * @since 14 @@ -2030,6 +2050,26 @@ declare namespace inputMethodEngine { * @since 15 */ readonly immersiveMode?: ImmersiveMode; + + /** + * Indicates the ID of the window where the edit box is located. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 18 + */ + readonly windowId?: number; + + /** + * Indicates the ID of the display where the edit box is located. + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.MiscServices.InputMethodFramework + * @since 18 + */ + readonly displayId?: number; } /** diff --git a/api/@ohos.multimedia.audio.d.ts b/api/@ohos.multimedia.audio.d.ts index eb5deb46b4ca63d29028a2b8cbc65a04bfdeb43d..7f20143075e1a7f04f0b5e13fb5e957aca90eab3 100644 --- a/api/@ohos.multimedia.audio.d.ts +++ b/api/@ohos.multimedia.audio.d.ts @@ -775,14 +775,6 @@ declare namespace audio { * @since 18 */ USB_DEVICE = 25, - - /** - * HDMI device, such as HDMI, ARC, eARC - * @syscap SystemCapability.Multimedia.Audio.Device - * @since 18 - */ - HDMI = 27, - /** * Distributed virtualization audio device. * @syscap SystemCapability.Multimedia.Audio.Device @@ -1890,14 +1882,6 @@ declare namespace audio { * @since 12 */ rendererFlags: number; - /** - * Audio volume mode config. If volumeMode is set to {@link AudioVolumeMode.APP_INDIVIDUAL}, this audio renderer - * will be affeted by app volume percentage setted by {@link setAppVolumePercentage} - * @type { ?AudioVolumeMode } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - volumeMode?: AudioVolumeMode; } /** @@ -3549,9 +3533,6 @@ declare namespace audio { * @param { AudioDeviceDescriptors } inputAudioDevices - Audio device descriptions * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified. - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3642,9 +3623,6 @@ declare namespace audio { * @param { AudioRendererFilter } filter - Audio renderer filter. * @returns { AudioDeviceDescriptors } The preferred devices. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified. - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3767,9 +3745,6 @@ declare namespace audio { * @param { AudioCapturerFilter } filter - Audio capturer filter. * @returns { AudioDeviceDescriptors } The preferred devices. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3902,9 +3877,6 @@ declare namespace audio { * @returns { Promise } Promise used to return result. * @throws { BusinessError } 201 - Permisson denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3920,9 +3892,6 @@ declare namespace audio { * @returns { Promise } Promise used to return result. * @throws { BusinessError } 201 - Permisson denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3937,9 +3906,6 @@ declare namespace audio { * @returns { Promise } Promise used to return result. * @throws { BusinessError } 201 - Permisson denied. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -3952,9 +3918,6 @@ declare namespace audio { * @param { DeviceUsage } usage - Device usage, only output device usages can be accepted. * @returns { AudioDeviceDescriptors } Exclueded devices. * @throws { BusinessError } 202 - Not system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi @@ -4166,9 +4129,6 @@ declare namespace audio { * Unsubscribes to audio renderer change events. * @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported. * @param { Callback } callback - Callback invoked for the audio renderer change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform @@ -4228,9 +4188,6 @@ declare namespace audio { * Unsubscribes to audio capturer change events. * @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported. * @param { Callback } callback - Callback invoked for the audio capturer change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform @@ -4573,109 +4530,6 @@ declare namespace audio { */ getVolumeGroupManagerSync(groupId: number): AudioVolumeGroupManager; - /** - * Get the volume for specified app with range from 0 to 100. Applications with same uid share the same volume. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - getAppVolumePercentageForUid(uid: number): Promise; - - /** - * Sets the volume for specified app with range from 0 to 100. Applications with same uid share the same volume. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { number } volume - Volume to set. The value range is from 0 to 100. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - setAppVolumePercentageForUid(uid: number, volume: number): Promise; - - /** - * Checks whether the app volume is muted. If there are multiple callers setting muted states, - * only when all callers cancel muted state the volume of this app will be truly unmuted. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { boolean } owned - If true is passed, the result will be indicated your owned muted state - * settings to this app. Otherwise if false is passed, the result will be indicated the real muted state. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - isAppVolumeMutedForUid(uid: number, owned: boolean): Promise; - - /** - * Change mute state of specified application volume. If there are multiple callers setting muted states, - * only when all callers cancel muted state the volume of this app will be truly unmuted. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { boolean } muted - Muted state to set. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - setAppVolumeMutedForUid(uid: number, muted: boolean): Promise; - - /** - * Get the volume for your app with range from 0 to 100. Applications with the same uid share the same volume. - * @returns { Promise } The application's volume percentage. The value range is from 0 to 100. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - getAppVolumePercentage(): Promise; - - /** - * Sets the volume for your app with range from 0 to 100. Applications with the same uid share the same volume. - * Only AudioRenderers with {@link AudioRendererInfo.volumeMode} set to {@link AudioVolumeMode.APP_INDIVIDUAL} - * will be affected by this volume. - * When you change your app's volume, your will receive 'appVolumeChange' callback event. - * Your app volume can be also changed by other system settings, and you can monitor the changes through - * 'appVolumeChange' callback. - * @param { number } volume - Volume to set. The value range is from 0 to 100. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - setAppVolumePercentage(volume: number): Promise; - /** * Listens for system volume change events. This method uses a callback to get volume change events. * @param { 'volumeChange' } type - Type of the event to listen for. Only the volumeChange event is supported. @@ -4713,72 +4567,6 @@ declare namespace audio { * @since 12 */ off(type: 'volumeChange', callback?: Callback): void; - - /** - * Listens for specified app volume change events. - * The app volume may changed by {@link setAppVolumePercentageForUid}. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { 'appVolumeChangeForUid' } type - Type of the event to listen for. Only the - * appVolumeChangeForUid event is supported. - * @param { number } uid - The app's uid. - * @param { Callback } callback - Callback used to get the app volume change event. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - on(type: 'appVolumeChangeForUid', uid: number, callback: Callback): void; - - /** - * Unsubscribes to the app volume change events.. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { 'appVolumeChangeForUid' } type - Type of the event to be unregistered. Only the appVolumeChangeForUid - * event is supported. - * @param { Callback } callback - Callback used to obtain the invoking volume change event. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - off(type: 'appVolumeChangeForUid', callback?: Callback): void; - - /** - * Listens for app volume change events. The app volume may changed by your called {@link setAppVolumePercentage} - * or other system settings. - * @param { 'appVolumeChange' } type - Type of the event to listen for. Only the appVolumeChange event is supported. - * @param { Callback } callback - Callback used to get the app volume change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - on(type: 'appVolumeChange', callback: Callback): void; - - /** - * Unsubscribes to the app volume change events.. - * @param { 'appVolumeChange' } type - Type of the event to be unregistered. Only the appVolumeChange event - * is supported. - * @param { Callback } callback - Callback used to obtain the invoking volume change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - off(type: 'appVolumeChange', callback?: Callback): void; } /** @@ -5187,9 +4975,6 @@ declare namespace audio { * Unsubscribes to the ringer mode state change events. * @param { 'ringerModeChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the updated ringer mode. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Volume * @since 18 @@ -5979,9 +5764,6 @@ declare namespace audio { * When the spatialization enable state changes, registered clients will receive the callback. * @param { 'spatializationEnabledChangeForCurrentDevice' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the spatialization enable state. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @since 18 @@ -5992,9 +5774,6 @@ declare namespace audio { * Unsubscribes to the spatialization enable state change events by the current device. * @param { 'spatializationEnabledChangeForCurrentDevice' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to get the spatialization enable state. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @since 18 @@ -6030,9 +5809,6 @@ declare namespace audio { * Notice that only one effect property name in each effect property category should be set. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Caller is not a system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. Possible causes: * 1. More than one effect property name of the same effect property category are in the input array. * 2. The input audioEffectProperties are not supported by the current device. @@ -6611,27 +6387,6 @@ declare namespace audio { */ type AudioDeviceDescriptors = Array>; - /** - * Volume mode. - * @enum { number } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - enum AudioVolumeMode { - /** - * Audio volume affected by system volume level. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - SYSTEM_GLOBAL = 0, - /** - * Audio volume affected by app's individual percentage. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - APP_INDIVIDUAL = 1 - } - /** * Describes the volume event received by the app when the volume is changed. * @typedef VolumeEvent @@ -6690,13 +6445,6 @@ declare namespace audio { * @since 9 */ networkId: string; - /** - * Audio volume mode of this volume event - * @type { ?AudioVolumeMode } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - volumeMode?: AudioVolumeMode; } /** @@ -8036,9 +7784,6 @@ declare namespace audio { * Unsubscribes audio interrupt events. * @param { 'audioInterrupt' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen for interrupt callback. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Interrupt * @since 18 @@ -8152,9 +7897,6 @@ declare namespace audio { * Unsubscribes audio state change event callback. * @param { 'stateChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback invoked when state change. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Renderer * @since 18 @@ -9100,9 +8842,6 @@ declare namespace audio { * Unsubscribes audio state change event callback. * @param { 'stateChange' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen for the audio state change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 6800101 - Parameter verification failed. * @syscap SystemCapability.Multimedia.Audio.Capturer * @since 18 @@ -9806,6 +9545,13 @@ declare namespace audio { * @since 9 */ TONE_TYPE_COMMON_SUPERVISORY_RINGTONE = 107, + /** + * Supervisory tone for call holding. + * @syscap SystemCapability.Multimedia.Audio.Tone + * @systemapi + * @since 18 + */ + TONE_TYPE_COMMON_SUPERVISORY_CALL_HOLDING = 108, /** * Proprietary tone for beep. * @syscap SystemCapability.Multimedia.Audio.Tone diff --git a/api/@ohos.multimedia.avInputCastPicker.d.ets b/api/@ohos.multimedia.avInputCastPicker.d.ets deleted file mode 100644 index caadd4dbddeecc1e74d6c7760db3973aef8b3033..0000000000000000000000000000000000000000 --- a/api/@ohos.multimedia.avInputCastPicker.d.ets +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Copyright (c) 2025 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 AVSessionKit - */ - -import { AVCastPickerState } from './@ohos.multimedia.avCastPickerParam'; - -/** - * A picker view to show availale input device list. - * @struct { AVInputCastPicker } - * @syscap SystemCapability.Multimedia.AVSession.AVInputCast - * @atomicservice - * @since 18 - */ -@Component -export declare struct AVInputCastPicker { - - /** - * Set the custom builder for the picker appearance. - * If not set, system will show the default appearance for different device type. - * @type { ? CustomBuilder } - * @syscap SystemCapability.Multimedia.AVSession.AVInputCast - * @atomicservice - * @since 18 - */ - @Prop - customPicker?: CustomBuilder; - - /** - * Picker state change callback. - * @type { ?OnPickerStateCallback } - * @syscap SystemCapability.Multimedia.AVSession.AVInputCast - * @atomicservice - * @since 18 - */ - onStateChange?: OnPickerStateCallback; -} - -/** - * Callback for picker state - * - * @typedef { function } OnPickerStateCallback - * @param { AVCastPickerState } state - the picker state. - * @returns { void } - * @syscap SystemCapability.Multimedia.AVSession.AVInputCast - * @atomicservice - * @since 18 - */ -export type OnPickerStateCallback = (state: AVCastPickerState) => void; \ No newline at end of file diff --git a/api/@ohos.multimedia.avsession.d.ts b/api/@ohos.multimedia.avsession.d.ts index dc87a72b457ece2ace2b665b6adf4296571fe9ef..3f7523cc386388844cc87d8ec94a4be2e2b46e9d 100644 --- a/api/@ohos.multimedia.avsession.d.ts +++ b/api/@ohos.multimedia.avsession.d.ts @@ -27,7 +27,6 @@ import audio from './@ohos.multimedia.audio'; import { AVCastPickerState, AVCastPickerColorMode } from './@ohos.multimedia.avCastPickerParam'; import type media from './@ohos.multimedia.media'; import type Context from './application/BaseContext'; -import type hdrCapability from './@ohos.graphics.hdrCapability'; /** * @namespace avSession @@ -276,8 +275,6 @@ declare namespace avSession { * @returns { Promise> } Promise for AVSessionController. * @throws { BusinessError } 201 - permission denied * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. - * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600109 - The remote connection is not established. * @syscap SystemCapability.Multimedia.AVSession.Manager @@ -443,8 +440,6 @@ declare namespace avSession { * @param { DistributedSessionType } distributedSessionType - Indicates the distributed session type * @param { Callback> } callback - The callback will return remote changed AVSessionController. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -458,8 +453,6 @@ declare namespace avSession { * @param { DistributedSessionType } distributedSessionType - Indicates the distributed session type * @param { Callback> } callback - The callback will return remote changed AVSessionController. * @throws { BusinessError } 202 - Not System App. - * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Manager * @systemapi @@ -2117,6 +2110,31 @@ declare namespace avSession { */ off(type: 'setLoopMode', callback?: (mode: LoopMode) => void): void; + /** + * Register setTargetLoopMode command callback + * Application should change playmode to the loopmode which is requested. + * @param { 'setTargetLoopMode' } type - Registration Type 'setTargetLoopMode' + * @param { Callback } callback - Used to handle setTargetLoopMode command.The callback provides the {@link LoopMode} + * @throws { BusinessError } 6600101 - Session service exception. + * @throws { BusinessError } 6600102 - The session does not exist. + * @syscap SystemCapability.Multimedia.AVSession.Core + * @atomicservice + * @since 18 + */ + on(type: 'setTargetLoopMode', callback: Callback): void; + + /** + * Unregister setTargetLoopMode command callback + * @param { 'setTargetLoopMode' } type - Registration Type 'setTargetLoopMode' + * @param { Callback } callback - Used to handle setTargetLoopMode command.The callback provides the {@link LoopMode} + * @throws { BusinessError } 6600101 - Session service exception. + * @throws { BusinessError } 6600102 - The session does not exist. + * @syscap SystemCapability.Multimedia.AVSession.Core + * @atomicservice + * @since 18 + */ + off(type: 'setTargetLoopMode', callback?: Callback): void; + /** * Register toggle favorite command callback * @param { 'toggleFavorite' } type - Registration Type 'toggleFavorite' @@ -2828,49 +2846,6 @@ declare namespace avSession { */ getAVPlaybackState(): Promise; - /** - * Get supported decoders of remote player. - * @returns { Promise> } (DecoderType) returned through promise - * @throws { BusinessError } 6600101 - Session service exception - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - getSupportedDecoders(): Promise>; - - /** - * Get recommended resolution of remote player based on each decoder. - * @param { DecoderType } decoderType - The decoder type. - * @returns { Promise } ResolutionLevel returned through promise - * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. - * 2.Parameter verification failed. - * @throws { BusinessError } 6600101 - Session service exception - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - getRecommendedResolutionLevel(decoderType: DecoderType): Promise; - - /** - * Get supported hdr capabilities of remote player. - * @returns { Promise> } HDRFormat returned through promise - * @throws { BusinessError } 6600101 - Session service exception - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - getSupportedHdrCapabilities(): Promise>; - - /** - * Get supported speed of remote player. - * @returns { Promise> } supported speed returned through promise - * @throws { BusinessError } 6600101 - Session service exception - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - getSupportedPlaySpeeds(): Promise>; - /** * Send control commands to remote player * @param { AVCastControlCommand } command The command to be send. @@ -3951,88 +3926,6 @@ declare namespace avSession { TAG_AUDIO_VIVID = 1, } - /** - * The defination of decoder type. - * @enum { string } - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - enum DecoderType { - /** - * Defination of avc codec type. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - OH_AVCODEC_MIMETYPE_VIDEO_AVC = "video/avc", - - /** - * Defination of hevc codec type. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - OH_AVCODEC_MIMETYPE_VIDEO_HEVC = "video/hevc", - - /** - * Defination of audio vivid codec type. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - OH_AVCODEC_MIMETYPE_AUDIO_VIVID = "audio/av3a", - } - - /** - * The defination of suggested resolution. - * @enum { number } - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - enum ResolutionLevel { - /** - * Defination of 480P which typically resolution is 640*480. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - RESOLUTION_480P = 0, - - /** - * Defination of 720P which typically resolution is 1280*720. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - RESOLUTION_720P = 1, - - /** - * Defination of 1080P which typically resolution is 1920*1080. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - RESOLUTION_1080P = 2, - - /** - * Defination of 2K which typically resolution is 2560*1440. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - RESOLUTION_2K = 3, - - /** - * Defination of 4K which typically resolution is 4096*3840. - * @syscap SystemCapability.Multimedia.AVSession.AVCast - * @atomicservice - * @since 18 - */ - RESOLUTION_4K = 4, - } - /** * The play list information definition. * @interface AVQueueInfo @@ -4316,7 +4209,7 @@ declare namespace avSession { * @type { ?string } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 18 + * @since 17 */ singleLyricText?: string; @@ -6684,8 +6577,6 @@ declare namespace avSession { * Get extra information for remote device, such as volume level, connected devices. * @param { string } extraEvent - the event name to get * @returns { Promise } the value returned for such event - * @throws { BusinessError } 401 - parameter check failed. 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @throws { BusinessError } 6600103 - The session controller does not exist. @@ -7380,8 +7271,17 @@ declare namespace avSession { * @atomicservice * @since 12 */ + /** + * The type of control command, add new support 'playFromAssetId' | 'answer' | 'hangUp' | 'toggleCallMute' + * @typedef { 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind' | 'seek' | + * 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'playFromAssetId' | 'answer' | 'hangUp' | + * 'toggleCallMute' | 'setTargetLoopMode' } AVControlCommandType + * @syscap SystemCapability.Multimedia.AVSession.Core + * @atomicservice + * @since 18 + */ type AVControlCommandType = 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind' | - 'seek' | 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'playFromAssetId' | 'answer' | 'hangUp' | 'toggleCallMute'; + 'seek' | 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'playFromAssetId' | 'answer' | 'hangUp' | 'toggleCallMute' | 'setTargetLoopMode'; /** * The definition of command to be sent to the session diff --git a/api/@ohos.multimedia.camera.d.ts b/api/@ohos.multimedia.camera.d.ts index c5ba5cafab8e2067346bdccfe0068a1d17ca2ab9..9d3c3ab5db8d34ac693695daa4c7c3afb2738546 100644 --- a/api/@ohos.multimedia.camera.d.ts +++ b/api/@ohos.multimedia.camera.d.ts @@ -348,6 +348,24 @@ declare namespace camera { */ UNRESOLVED_CONFLICTS_WITH_CURRENT_CONFIGURATIONS = 7400110, + /** + * Camera frequently switched. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + DEVICE_FREQUENTLY_SWITCHED = 7400111, + + /** + * Camera lens retracted. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + CAMERA_LENS_RETRACTED = 7400112, + /** * Camera service fatal error. * @@ -814,6 +832,30 @@ declare namespace camera { */ createSession(mode: SceneMode): T; + /** + * Queries a specified device based on position and type. + * + * @param { CameraPosition } position - Camera position. + * @param { CameraType } type - Camera type. + * @returns { CameraDevice } A device queried base on position and type. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + getCameraDevice(position: CameraPosition, type: CameraType): CameraDevice; + + /** + * Obtains the concurrent information of specified cameras, + * the empty return means concurrency is not supported. + * + * @param { Array } cameras - Set of camera devices to be queried. + * @returns { Array } Set of queried concurrent information. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + getCameraConcurrentInfos(cameras: Array): Array; + /** * Subscribes camera status change event callback. * @@ -1063,6 +1105,15 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Set torch mode to the device. + * + * @param { TorchMode } mode - torch mode. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ setTorchMode(mode: TorchMode): void; /** @@ -1644,6 +1695,20 @@ declare namespace camera { */ open(isSecureEnabled: boolean): Promise; + /** + * Open camera with specified concurrent type. + * + * @param { CameraConcurrentType } type - Camera concurrent type. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400107 - Can not use camera cause of conflict. + * @throws { BusinessError } 7400108 - Camera disabled cause of security reason. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + open(type: CameraConcurrentType): Promise; + /** * Close camera. * @@ -1711,7 +1776,7 @@ declare namespace camera { * @since 12 */ on(type: 'cameraOcclusionDetection', callback: AsyncCallback): void; - + /** * Unsubscribes from camera occlusion detection results. * @@ -1723,6 +1788,21 @@ declare namespace camera { * @since 12 */ off(type: 'cameraOcclusionDetection', callback?: AsyncCallback): void; + + /** + * Control auxiliary. + * + * @param { AuxiliaryType } auxiliaryType - Auxiliary type. + * @param { AuxiliaryStatus } auxiliaryStatus - Auxiliary status. + * @returns { Promise } Promise used to return the result. + * @throws { BusinessError } 202 - Not System Application. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + controlAuxiliary(auxiliaryType: AuxiliaryType, auxiliaryStatus: AuxiliaryStatus): Promise; } /** @@ -1909,6 +1989,15 @@ declare namespace camera { */ CAMERA_FORMAT_DNG = 4, + /** + * Extreme Digital Format. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + CAMERA_FORMAT_DNG_XDRAW = 5, + /** * YUV 420 Format. * @@ -3181,7 +3270,7 @@ declare namespace camera { /** * Zoom object. * - * extends ZoomQuery + * @extends ZoomQuery * @interface Zoom * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 @@ -3225,6 +3314,14 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 */ + /** + * Sets target zoom ratio by smooth method. + * + * @param { number } targetRatio - Target zoom ratio. + * @param { SmoothZoomMode } mode - Smooth zoom mode. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ setSmoothZoom(targetRatio: number, mode?: SmoothZoomMode): void; /** @@ -3799,6 +3896,13 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Gets the supported color space types. + * + * @returns { Array } The array of the supported color space for the session. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ getSupportedColorSpaces(): Array; } @@ -3851,6 +3955,13 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 13 */ + /** + * Check whether auto device switch is supported. + * + * @returns { boolean } Is auto device switch supported. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ isAutoDeviceSwitchSupported(): boolean; } @@ -4073,6 +4184,17 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Adds a camera input. + * This method is valid between Session.beginConfig() and Session.commitConfig(). + * + * @param { CameraInput } cameraInput - Target camera input to add. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ addInput(cameraInput: CameraInput): void; /** @@ -4098,6 +4220,17 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Removes a camera input. + * This method is valid between Session.beginConfig() and Session.commitConfig(). + * + * @param { CameraInput } cameraInput - Target camera input to remove. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ removeInput(cameraInput: CameraInput): void; /** @@ -4134,6 +4267,17 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Adds a camera output. + * This method is valid after Session.addInput(cameraInput) and before Session.commitConfig(). + * + * @param { CameraOutput } cameraOutput - Target camera output to add. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ addOutput(cameraOutput: CameraOutput): void; /** @@ -4159,6 +4303,17 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Removes a camera output. + * This method is valid between Session.beginConfig() and Session.commitConfig(). + * + * @param { CameraOutput } cameraOutput - Target camera output to remove. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ removeOutput(cameraOutput: CameraOutput): void; /** @@ -4859,7 +5014,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_720P = 0, - + /** * 1080P output for preconfig. * @@ -4867,7 +5022,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_1080P = 1, - + /** * 4K output for preconfig. * @@ -4875,7 +5030,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_4K = 2, - + /** * high quality output for preconfig. * @@ -4900,7 +5055,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_RATIO_1_1 = 0, - + /** * Aspect ratio 4:3 for preconfig. * @@ -4908,7 +5063,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_RATIO_4_3 = 1, - + /** * Aspect ratio 16:9 for preconfig. * @@ -5144,7 +5299,7 @@ declare namespace camera { * Must choose preconfig type from {@link PreconfigType}. * * @param { PreconfigType } preconfigType - preconfig type. - * @param { PreconfigRatio } preconfigRatio - the aspect ratio of surface for preconfig, + * @param { PreconfigRatio } preconfigRatio - the aspect ratio of surface for preconfig, * default value {@link PreconfigRatio#PRECONFIG_RATIO_4_3}. * @returns { boolean } Whether the choosed preconfig type can be used. * @throws { BusinessError } 7400201 - Camera service fatal error. @@ -5385,7 +5540,16 @@ declare namespace camera { * @systemapi * @since 15 */ - interface VideoSessionForSys extends VideoSession, Beauty, ColorEffect, ColorManagement, Macro, Aperture, ColorReservation { + /** + * Video session object for system hap. + * + * @extends VideoSession, Beauty, ColorEffect, ColorManagement, Macro, Aperture, ColorReservation, EffectSuggestion + * @interface VideoSessionForSys + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + interface VideoSessionForSys extends VideoSession, Beauty, ColorEffect, ColorManagement, Macro, Aperture, ColorReservation, EffectSuggestion { } /** @@ -5609,6 +5773,30 @@ declare namespace camera { */ off(type: 'focusTrackingInfoAvailable', callback?: Callback): void; + /** + * Subscribes to effect suggestion event callback. + * + * @param { 'effectSuggestionChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the effect suggestion change info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + on(type: 'effectSuggestionChange', callback: AsyncCallback): void; + + /** + * Unsubscribes from effect suggestion event callback. + * + * @param { 'effectSuggestionChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to get the effect suggestion change info. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + off(type: 'effectSuggestionChange', callback?: AsyncCallback): void; + /** * Gets session functions. * @@ -5647,6 +5835,58 @@ declare namespace camera { * @since 14 */ setQualityPrioritization(quality : QualityPrioritization) : void; + + /** + * Subscribes camera light status event callback. + * + * @param { 'lightStatusChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to return the result. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + on(type: 'lightStatusChange', callback: AsyncCallback): void; + + /** + * Unsubscribes camera light status event callback. + * + * @param { 'lightStatusChange' } type - Event type. + * @param { AsyncCallback } callback - Callback used to return the result. + * @throws { BusinessError } 202 - Not System Application. + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + off(type: 'lightStatusChange', callback?: AsyncCallback): void; + } + + /** + * Enum for the camera light status. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + enum LightStatus { + /** + * Sufficient lighting. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + NORMAL = 0, + + /** + * Insufficient lighting. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + INSUFFICIENT = 1 } /** @@ -7269,6 +7509,15 @@ declare namespace camera { * @syscap SystemCapability.Multimedia.Camera.Core * @since 12 */ + /** + * Add Secure output for camera. + * + * @param { PreviewOutput } previewOutput - Specify the output as a secure flow. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400102 - Operation not allowed. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ addSecureOutput(previewOutput: PreviewOutput): void; /** @@ -7411,7 +7660,7 @@ declare namespace camera { * * @param { LightPaintingType } type - Light painting type to set. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400103 - Session not config. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi @@ -7934,6 +8183,16 @@ declare namespace camera { */ getActiveFrameRate(): FrameRateRange; + /** + * Gets the current preconfig type if you had already call preconfig interface. + * + * @returns { Profile } The current preconfig type. + * @throws { BusinessError } 7400201 - Camera service fatal error. + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 12 + */ + getActiveProfile(): Profile; + /** * Gets the preview rotation angle. * @@ -7958,16 +8217,6 @@ declare namespace camera { */ setPreviewRotation(previewRotation: ImageRotation, isDisplayLocked?: boolean): void; - /** - * Gets the current preconfig type if you had already call preconfig interface. - * - * @returns { Profile } The current preconfig type. - * @throws { BusinessError } 7400201 - Camera service fatal error. - * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 - */ - getActiveProfile(): Profile; - /** * Adds a deferred surface. * @@ -8135,7 +8384,16 @@ declare namespace camera { * @systemapi * @since 12 */ - EFFECT_SUGGESTION_SUNRISE_SUNSET = 4 + EFFECT_SUGGESTION_SUNRISE_SUNSET = 4, + + /** + * Stage. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + EFFECT_SUGGESTION_STAGE = 5 } /** @@ -8963,7 +9221,7 @@ declare namespace camera { * The method must be called after Session.addInput() and Session.addOutput(photoOutput) are called. * To avoid stream reconfiguration and performance loss, * you are advised to call the method before Session.commitConfig(). - * + * * @param { boolean } enabled - The value TRUE means to enable quick thumbnail, and FALSE means the opposite. * @throws { BusinessError } 7400104 - session is not running. * @syscap SystemCapability.Multimedia.Camera.Core @@ -8975,7 +9233,7 @@ declare namespace camera { * The method must be called after Session.addInput() and Session.addOutput(photoOutput) are called. * To avoid stream reconfiguration and performance loss, * you are advised to call the method before Session.commitConfig(). - * + * * @param { boolean } enabled - The value TRUE means to enable quick thumbnail, and FALSE means the opposite. * @throws { BusinessError } 202 - Not System Application. * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. @@ -9279,7 +9537,7 @@ declare namespace camera { /** * Video output object. * - * extends CameraOutput + * @extends CameraOutput * @interface VideoOutput * @syscap SystemCapability.Multimedia.Camera.Core * @since 10 @@ -9494,7 +9752,6 @@ declare namespace camera { * * @param { boolean } enabled - enable auto frame rate if TRUE. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 401 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400103 - Session not config. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi @@ -10159,7 +10416,7 @@ declare namespace camera { /** * Metadata Output object * - * extends CameraOutput + * @extends CameraOutput * @interface MetadataOutput * @syscap SystemCapability.Multimedia.Camera.Core * @since 10 @@ -10274,6 +10531,80 @@ declare namespace camera { off(type: 'error', callback?: ErrorCallback): void; } + /** + * Enum for camera concurrent type. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + enum CameraConcurrentType { + /** + * Cameras concurrency with limited capabilities. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + CAMERA_LIMITED_CAPABILITY = 0, + + /** + * Cameras concurrency with full capabilities. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + CAMERA_FULL_CAPABILITY = 1, + } + + /** + * Camera concurrent information. + * + * @interface CameraConcurrentInfo + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + interface CameraConcurrentInfo { + /** + * Camera instance. + * + * @type { CameraDevice } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + readonly device: CameraDevice; + + /** + * Camera concurrent type. + * + * @type { CameraConcurrentType } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + readonly type: CameraConcurrentType; + + /** + * Supported scene modes. + * + * @type { Array } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + readonly modes: Array; + + /** + * Supported outputCapability. + * + * @type { Array } + * @readonly + * @syscap SystemCapability.Multimedia.Camera.Core + * @since 18 + */ + readonly outputCapabilities: Array; + } + /** * Enumerates the timelapse recording state. * @@ -10991,6 +11322,62 @@ declare namespace camera { enableDepthFusion(enabled: boolean): void; } + /** + * Enum for auxiliary type. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + enum AuxiliaryType { + /** + * Contract lens. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + CONTRACT_LENS = 0 + } + + /** + * Enum for auxiliary status. + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + enum AuxiliaryStatus { + /** + * Auxiliary locked. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + LOCKED = 0, + + /** + * Turn on auxiliary. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + ON = 1, + + /** + * Turn off auxiliary. + * + * @syscap SystemCapability.Multimedia.Camera.Core + * @systemapi + * @since 18 + */ + OFF = 2 + } + /** * Enum for color reservation type. * diff --git a/api/@ohos.multimedia.media.d.ts b/api/@ohos.multimedia.media.d.ts index bdea21c75aecb8ed26b4fa849b98926f91258c35..429fc7d2ac59d8491867c106b308d8951324597e 100755 --- a/api/@ohos.multimedia.media.d.ts +++ b/api/@ohos.multimedia.media.d.ts @@ -20,7 +20,7 @@ import { ErrorCallback, AsyncCallback, Callback } from './@ohos.base'; import audio from "./@ohos.multimedia.audio"; -import photoAccessHelper from "./@ohos.file.photoAccessHelper"; +import photoAccessHelper from './@ohos.file.photoAccessHelper'; import type image from './@ohos.multimedia.image'; import type { SoundPool as _SoundPool } from './multimedia/soundPool'; import type { PlayParameters as _PlayParameters } from './multimedia/soundPool'; @@ -175,17 +175,6 @@ declare namespace media { */ function createMediaSourceWithUrl(url: string, headers?: Record): MediaSource; - /** - * Create media source from media stream array. - * @param { Array } streams - The player uses it to get stream source info. - * @returns { MediaSource } MediaSource instance if the operation is successful; returns null otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - function createMediaSourceWithStreamData(streams: Array): MediaSource; - /** * Creates an VideoPlayer instance. * @param { AsyncCallback } callback - used to return AudioPlayer instance if the operation is successful; returns null otherwise. @@ -314,7 +303,8 @@ declare namespace media { /** * Get the ScreenCaptureMonitor instance * - * @returns { Promise } A Promise instance used to return ScreenCaptureMonitor instance if the operation is successful; returns null otherwise. + * @returns { Promise } A Promise instance used to return ScreenCaptureMonitor instance if the operation is successful; + * returns null otherwise. * @throws { BusinessError } 202 - Not System App. * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture @@ -1694,16 +1684,18 @@ declare namespace media { */ interface AVPlayer { /** - * Prepare audio/video playback, it will request resource for playing. - * @param { AsyncCallback } callback - instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @param { AsyncCallback } callback used to return the result when prepare completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @throws { BusinessError } 5400106 - Unsupported format. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Prepare audio/video playback, it will request resource for playing. - * @param { AsyncCallback } callback - instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @param { AsyncCallback } callback used to return the result when prepare completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @throws { BusinessError } 5400106 - Unsupported format. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -1711,8 +1703,9 @@ declare namespace media { * @since 11 */ /** - * Prepare audio/video playback, it will request resource for playing. - * @param { AsyncCallback } callback - instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @param { AsyncCallback } callback used to return the result when prepare completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @throws { BusinessError } 5400106 - Unsupported format. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -1723,16 +1716,18 @@ declare namespace media { prepare(callback: AsyncCallback): void; /** - * Prepare audio/video playback, it will request resource for playing. - * @returns { Promise } A Promise instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @throws { BusinessError } 5400106 - Unsupported format. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Prepare audio/video playback, it will request resource for playing. - * @returns { Promise } A Promise instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @throws { BusinessError } 5400106 - Unsupported format. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -1740,8 +1735,9 @@ declare namespace media { * @since 11 */ /** - * Prepare audio/video playback, it will request resource for playing. - * @returns { Promise } A Promise instance used to return when prepare completed. + * Prepare audio/video playback, it will request resource for playing. This API can be called + * only when the AVPlayer is in the initialized state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @throws { BusinessError } 5400106 - Unsupported format. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -1752,23 +1748,23 @@ declare namespace media { prepare(): Promise; /** - * Play audio/video playback. - * @param { AsyncCallback } callback - instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVPlayer is in the prepared, paused or completed state. + * @param { AsyncCallback } callback used to return the result when play completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Play audio/video playback. - * @param { AsyncCallback } callback - instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVPlayer is in the prepared, paused or completed state. + * @param { AsyncCallback } callback used to return the result when play completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Play audio/video playback. - * @param { AsyncCallback } callback - instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVPlayer is in the prepared, paused or completed state. + * @param { AsyncCallback } callback used to return the result when play completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1778,23 +1774,23 @@ declare namespace media { play(callback: AsyncCallback): void; /** - * Play audio/video playback. - * @returns { Promise } A Promise instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVPlayer is in the prepared, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Play audio/video playback. - * @returns { Promise } A Promise instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVplayer is in the prepared, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Play audio/video playback. - * @returns { Promise } A Promise instance used to return when play completed. + * Play audio/video playback. This API can be called only when the AVPlayer is in the prepared, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1804,23 +1800,23 @@ declare namespace media { play(): Promise; /** - * Pause audio/video playback. - * @param { AsyncCallback } callback - instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @param { AsyncCallback } callback used to return the result when pause completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Pause audio/video playback. - * @param { AsyncCallback } callback - instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @param { AsyncCallback } callback used to return the result when pause completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Pause audio/video playback. - * @param { AsyncCallback } callback - instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @param { AsyncCallback } callback used to return the result when pause completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1830,23 +1826,23 @@ declare namespace media { pause(callback: AsyncCallback): void; /** - * Pause audio/video playback. - * @returns { Promise } A Promise instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Pause audio/video playback. - * @returns { Promise } A Promise instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Pause audio/video playback. - * @returns { Promise } A Promise instance used to return when pause completed. + * Pause audio/video playback. This API can be called only when the AVPlayer is in the playing state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1856,23 +1852,26 @@ declare namespace media { pause(): Promise; /** - * Stop audio/video playback. - * @param { AsyncCallback } callback - instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @param { AsyncCallback } callback used to return the result when stop completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Stop audio/video playback. - * @param { AsyncCallback } callback - instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @param { AsyncCallback } callback used to return the result when stop completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Stop audio/video playback. - * @param { AsyncCallback } callback - instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @param { AsyncCallback } callback used to return the result when stop completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1882,23 +1881,26 @@ declare namespace media { stop(callback: AsyncCallback): void; /** - * Stop audio/video playback. - * @returns { Promise } A Promise instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Stop audio/video playback. - * @returns { Promise } A Promise instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Stop audio/video playback. - * @returns { Promise } A Promise instance used to return when stop completed. + * Stop audio/video playback. This API can be called only when the AVPlayer is in the prepared, + * playing, paused or completed state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1908,23 +1910,26 @@ declare namespace media { stop(): Promise; /** - * Reset AVPlayer, it will to idle state and can set src again. - * @param { AsyncCallback } callback - instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @param { AsyncCallback } callback used to return the result when reset completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Reset AVPlayer, it will to idle state and can set src again. - * @param { AsyncCallback } callback - instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @param { AsyncCallback } callback used to return the result when reset completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Reset AVPlayer, it will to idle state and can set src again. - * @param { AsyncCallback } callback - instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @param { AsyncCallback } callback used to return the result when reset completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1934,23 +1939,26 @@ declare namespace media { reset(callback: AsyncCallback): void; /** - * Reset AVPlayer, it will to idle state and can set src again. - * @returns { Promise } A Promise instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Reset AVPlayer, it will to idle state and can set src again. - * @returns { Promise } A Promise instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Reset AVPlayer, it will to idle state and can set src again. - * @returns { Promise } A Promise instance used to return when reset completed. + * Reset AVPlayer, it will be set to idle state and can set src again. This API can be called only when + * the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped or error state. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1960,23 +1968,23 @@ declare namespace media { reset(): Promise; /** - * Releases resources used for AVPlayer. - * @param { AsyncCallback } callback - instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @param { AsyncCallback } callback used to return the result when release completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Releases resources used for AVPlayer. - * @param { AsyncCallback } callback - instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @param { AsyncCallback } callback used to return the result when release completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Releases resources used for AVPlayer. - * @param { AsyncCallback } callback - instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @param { AsyncCallback } callback used to return the result when release completed. * @throws { BusinessError } 5400102 - Operation not allowed. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -1986,23 +1994,23 @@ declare namespace media { release(callback: AsyncCallback): void; /** - * Releases resources used for AVPlayer. - * @returns { Promise } A Promise instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Releases resources used for AVPlayer. - * @returns { Promise } A Promise instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 */ /** - * Releases resources used for AVPlayer. - * @returns { Promise } A Promise instance used to return when release completed. + * Releases resources used for AVPlayer. This API can be called when the AVPlayer is in any state except released. + * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform @@ -2012,14 +2020,16 @@ declare namespace media { release(): Promise; /** - * Jumps to the specified playback position. + * Jumps to the specified playback position. This API can be called only when the AVPlayer is in the prepared, + * playing, paused, or completed state. * @param { number } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** - * Jumps to the specified playback position. + * Jumps to the specified playback position. This API can be called only when the AVPlayer is in the prepared, + * playing, paused, or completed state. * @param { number } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -2027,7 +2037,8 @@ declare namespace media { * @since 11 */ /** - * Jumps to the specified playback position. + * Jumps to the specified playback position. This API can be called only when the AVPlayer is in the prepared, + * playing, paused, or completed state. * @param { number } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer @@ -2238,25 +2249,25 @@ declare namespace media { setPlaybackRange(startTimeMs: number, endTimeMs: number, mode?: SeekMode) : Promise; /** - * Get current playback position. - * @returns { number } return the time of current playback position - millisecond(ms) - * @throws { BusinessError } 5400102 - Operation not allowed. + * Check whether the media stream currently being played by the player supports seek continuous. + * Should be called after {@link #prepare}. + * @returns { boolean } true: seek continuous is supported; + * false: seek continuous is not supported or the support status is uncertain. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 18 */ - getPlaybackPosition() : number; + isSeekContinuousSupported() : boolean; /** - * Check whether the media stream currently being played by the player supports seek continuous. - * Should be called after {@link #prepare}. - * @returns { boolean } true: seek continuous is supported; - * false: seek continuous is not supported or the support status is uncertain. + * Get current playback position. + * @returns { number } return the time of current playback position - millisecond(ms) + * @throws { BusinessError } 5400102 - Operation not allowed. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 18 */ - isSeekContinuousSupported() : boolean; + getPlaybackPosition() : number; /** * Enable or disable super-resolution dynamically. @@ -3848,51 +3859,6 @@ declare namespace media { finishLoading(uuid: number, state: LoadingRequestError): void; } - /** - * Media Stream. AVPlayer use this for mediaData access, current version only support live stream. - * @typedef MediaStream - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - interface MediaStream { - /** - * url for this mediaStream - * @type { string } - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - url: string; - - /** - * video width. - * @type { number } - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - width: number; - - /** - * video height. - * @type { number } - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - height: number; - - /** - * biterate of this mediaStream. - * @type { number } - * @syscap SystemCapability.Multimedia.Media.Core - * @atomicservice - * @since 18 - */ - bitrate: number; - } - /** * Media source descriptor. User can set media data information @@ -4011,7 +3977,7 @@ declare namespace media { * @type { ?boolean } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since 17 */ showFirstFrameOnPrepare?: boolean; @@ -7236,6 +7202,7 @@ declare namespace media { */ AUTO_CREATE_CAMERA_SCENE = 1, } + /** * Provides the video recorder configuration definitions. * @@ -7581,6 +7548,15 @@ declare namespace media { * @since 12 */ enableTemporalScale?: boolean; + + /** + * Whether to enble video encoding policy to quality stable encoding. + * @type { ?boolean } + * @syscap SystemCapability.Multimedia.Media.AVRecorder + * @systemapi + * @since 18 + */ + enableStableQualityMode?: boolean } /** @@ -7664,16 +7640,7 @@ declare namespace media { * @atomicservice * @since 12 */ - /** - * File output uri, support a kind of uri now. - * format like: "fd://" + "context". - * @type { ?string } - * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @crossplatform - * @atomicservice - * @since 18 - */ - url?: string; + url: string; /** * Mode of creating recorder file, details see @FileGenerationMode. @@ -8408,7 +8375,7 @@ declare namespace media { * @since 12 */ videoFrameWidth?: number; - + /** * Indicates the video height. * @type { ?number } @@ -8417,7 +8384,7 @@ declare namespace media { */ videoFrameHeight?: number; } - + /** * Transcode a source video file to a destination video file. * Before calling an AVTranscoder method, you must use @createAVTranscoder diff --git a/api/@ohos.multimodalAwareness.deviceStatus.d.ts b/api/@ohos.multimodalAwareness.deviceStatus.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..06ec05a786a7076175af0b941178bdaa6244815c --- /dev/null +++ b/api/@ohos.multimodalAwareness.deviceStatus.d.ts @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2025 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 MultimodalAwarenessKit + */ +import type { Callback } from "./@ohos.base"; + +/** + * This module provides the capability to subscribe to report the device status. + * + * @namespace deviceStatus + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ +declare namespace deviceStatus { + /** + * Enum for steady standing status. + * + * @enum { number } SteadyStandingStatus + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ + export enum SteadyStandingStatus { + /** + * indicates exit status + * + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ + STATUS_EXIT = 0, + /** + * indicates enter status + * + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ + STATUS_ENTER = 1 + } + + /** + * Subscribe to detect the steady standing status + * @param { 'steadyStandingDetect' } type - Indicates the event type. + * @param { Callback } callback - Indicates the callback for getting the event data. + * @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. Function can not work correctly due to limited + *
device capabilities. + * @throws { BusinessError } 32500001 - Service exception. + * @throws { BusinessError } 32500002 - Subscribe Failed. + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ + function on(type: 'steadyStandingDetect', callback: Callback): void; + + /** + * Unsubscribe to detect the steady standing status + * @param { 'steadyStandingDetect' } type - Indicates the event type. + * @param { Callback } callback - Indicates the callback for getting the event data. + * @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. Function can not work correctly due to limited + *
device capabilities. + * @throws { BusinessError } 32500001 - Service exception. + * @throws { BusinessError } 32500003 - Unsubscribe Failed. + * @syscap SystemCapability.MultimodalAwareness.DeviceStatus + * @since 18 + */ + function off(type: 'steadyStandingDetect', callback?: Callback): void; +} +export default deviceStatus; diff --git a/api/@ohos.multimodalAwareness.metadataBinding.d.ts b/api/@ohos.multimodalAwareness.metadataBinding.d.ts index 83b1f206a45d63369a4284dacd3320e1f89acb0b..7f8d5f4963c7634c2b8dbedc311f64ea359b831f 100644 --- a/api/@ohos.multimodalAwareness.metadataBinding.d.ts +++ b/api/@ohos.multimodalAwareness.metadataBinding.d.ts @@ -26,7 +26,7 @@ import type { Callback } from './@ohos.base'; * @namespace metadataBinding * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ declare namespace metadataBinding { /** @@ -35,12 +35,11 @@ declare namespace metadataBinding { * @param { string } metadata - Coded metadata * @returns { Promise } encoded image * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. File creation failed * @throws { BusinessError } 32100002 - Encode process fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function encodeImage(srcImage: image.PixelMap, metadata: string): Promise; @@ -48,13 +47,12 @@ declare namespace metadataBinding { * MetadataBinding provides decode capabilities * @param { image.PixelMap } encodedImage - Encoded image * @returns { Promise } decode result - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @throws { BusinessError } 32100001 - Internal handling failed. File read failed. * @throws { BusinessError } 32100003 - Decode process fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function decodeImage(encodedImage: image.PixelMap): Promise; @@ -63,22 +61,20 @@ declare namespace metadataBinding { * @param { string } bundleName - Bundle name of a third-party application * @returns { Promise } third-party app callback the meta data * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Obtain metadata failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function notifyMetadataBindingEvent(bundleName: string): Promise; /** * set the Metadata to the screenshot app * @param { string } metadata - the Metadata of a Third-Party App - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Set Meta data to screenshot app fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function submitMetadata(metadata: string): void; @@ -87,12 +83,11 @@ declare namespace metadataBinding { * @param { 'operationSubmitMetadata' } type - Event Type * @param { string } bundleName - Bundle name of a third-party application * @param { Callback } callback - Call back the screenshot event - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Service exception. * @throws { BusinessError } 32100004 - Subscribe Failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function on(type: 'operationSubmitMetadata', bundleName: string, callback: Callback): void; @@ -101,14 +96,13 @@ declare namespace metadataBinding { * @param { 'operationSubmitMetadata' } type - Event Type * @param { string } bundleName - Bundle name of a third-party application * @param { Callback } callback - Call back the screenshot event - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Service exception. * @throws { BusinessError } 32100005 - Unsubscribe Failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function off(type: 'operationSubmitMetadata', bundleName: string, callback?: Callback): void; } -export default metadataBinding +export default metadataBinding; diff --git a/api/@ohos.multimodalInput.inputConsumer.d.ts b/api/@ohos.multimodalInput.inputConsumer.d.ts index bad68f4bd2f005e6636200b102d605bae59fe619..ec5c99af69274398d77ab7a4ae3a316de6cb9490 100644 --- a/api/@ohos.multimodalInput.inputConsumer.d.ts +++ b/api/@ohos.multimodalInput.inputConsumer.d.ts @@ -134,7 +134,7 @@ declare namespace inputConsumer { */ interface KeyPressedConfig { /** - * Key value. + * Key value. Currently listening is supported only for KEYCODE_VOLUME_UP and KEYCODE_VOLUME_DOWN keys. * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer @@ -143,7 +143,8 @@ declare namespace inputConsumer { key: number; /** - * Key event type. + * Key event type. The value 1 indicates key press and the value 2 indicates key release. Currently + * listening is supported only for key press events. * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer @@ -152,7 +153,7 @@ declare namespace inputConsumer { action: number; /** - * Whether to report repeated key events. By default, the value is true if it is left unspecified. + * Whether to report repeated key events. * * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer @@ -291,7 +292,7 @@ declare namespace inputConsumer { * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @since 14 */ - function on(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback: Callback): void + function on(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback: Callback): void; /** * Unsubscribe from hotkey event changes. @@ -305,7 +306,7 @@ declare namespace inputConsumer { * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @since 14 */ - function off(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback?: Callback): void + function off(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback?: Callback): void; /** * Consumed key events. Only the VolumeUp and VolumeDown keys are supported. When the current application process @@ -320,7 +321,7 @@ declare namespace inputConsumer { * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @since 16 */ - function on(type: 'keyPressed', options: KeyPressedConfig, callback: Callback): void + function on(type: 'keyPressed', options: KeyPressedConfig, callback: Callback): void; /** * Cancels consumption of key events. @@ -333,7 +334,7 @@ declare namespace inputConsumer { * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @since 16 */ - function off(type: 'keyPressed', callback?: Callback): void + function off(type: 'keyPressed', callback?: Callback): void; } export default inputConsumer; \ No newline at end of file diff --git a/api/@ohos.multimodalInput.inputDevice.d.ts b/api/@ohos.multimodalInput.inputDevice.d.ts index 73b4ddc38b7fae85dd7c5c41de008c63e3b935b0..557e15b22744bc1da7269aa22b1c53fd283ebecf 100644 --- a/api/@ohos.multimodalInput.inputDevice.d.ts +++ b/api/@ohos.multimodalInput.inputDevice.d.ts @@ -683,11 +683,11 @@ declare namespace inputDevice { * @param { number } functionKey - Function key. * @param { boolean } enabled - Whether to enable or disable the function key. * @returns { Promise } Returns the result through a promise. - * @throws { BusinessError } 201 - Permission verification failed. + * @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 } 3900002 - There is currently no keyboard device connected. - * @throws { BusinessError } 3900003 - it is prohibited for non-input applications + * @throws { BusinessError } 3900003 - It is prohibited for non-input applications. * @syscap SystemCapability.MultimodalInput.Input.InputDevice * @since 15 */ diff --git a/api/@ohos.multimodalInput.inputMonitor.d.ts b/api/@ohos.multimodalInput.inputMonitor.d.ts index e0ddd4572d8774893605f0e63df7442a117ff119..65f44cfaee4dc4ab91549493c674d7ec1526094a 100644 --- a/api/@ohos.multimodalInput.inputMonitor.d.ts +++ b/api/@ohos.multimodalInput.inputMonitor.d.ts @@ -477,6 +477,7 @@ declare namespace inputMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. + * 3.Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputMonitor * @systemapi hide for inner use * @since 18 @@ -495,6 +496,7 @@ declare namespace inputMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. + * 3.Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputMonitor * @systemapi hide for inner use * @since 18 @@ -513,6 +515,7 @@ declare namespace inputMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. + * 3.Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputMonitor * @systemapi hide for inner use * @since 18 @@ -531,6 +534,7 @@ declare namespace inputMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. + * 3.Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputMonitor * @systemapi hide for inner use * @since 18 diff --git a/api/@ohos.multimodalInput.pointer.d.ts b/api/@ohos.multimodalInput.pointer.d.ts index 5d289d172a90e0c0f6f858095c3777ed9fbbe51c..fae453f3436976384095aa0cc6882378b0ee2b7e 100644 --- a/api/@ohos.multimodalInput.pointer.d.ts +++ b/api/@ohos.multimodalInput.pointer.d.ts @@ -743,7 +743,7 @@ declare namespace pointer { * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported; * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 14 + * @since 18 */ function setPointerVisible(visible: boolean, callback: AsyncCallback): void; @@ -768,7 +768,7 @@ declare namespace pointer { * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported; * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 14 + * @since 18 */ function setPointerVisible(visible: boolean): Promise; diff --git a/api/@ohos.multimodalInput.touchEvent.d.ts b/api/@ohos.multimodalInput.touchEvent.d.ts index 711139c69db7900793f57922cd0edebcbfc8d6c1..7fcaa2e5490054914c8bcc3dc5fadcef6b7131a7 100644 --- a/api/@ohos.multimodalInput.touchEvent.d.ts +++ b/api/@ohos.multimodalInput.touchEvent.d.ts @@ -167,31 +167,6 @@ export declare enum SourceType { TOUCH_PAD = 2 } -/** - * Fixed mode of screenX and screenY. - * - * @enum { number } - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ -export declare enum FixedMode { - /** - * Not fix. - * - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ - NONE = 0, - - /** - * One hand mode. - * - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ - ONE_HAND = 1 -} - /** * Touch * @@ -343,22 +318,6 @@ export declare interface Touch { * @since 9 */ toolType: ToolType; - - /** - * fixedDisplayX - Corrected value of the screen x coordinate. - * @type { number } - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ - fixedDisplayX?: number; - - /** - * fixedDisplayY - Corrected value of the screen y coordinate. - * @type { number } - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ - fixedDisplayY?: number; } /** @@ -401,13 +360,4 @@ export declare interface TouchEvent extends InputEvent { * @since 9 */ sourceType: SourceType; - - /** - * fixedMode - Fixed mode of Touch. - * - * @type { FixedMode } - * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 - */ - fixedMode?: FixedMode; } \ No newline at end of file diff --git a/api/@ohos.net.connection.d.ts b/api/@ohos.net.connection.d.ts index fe160e86d3ebeb31bc4afe85eba292acb6dbd7b1..8948fa62c746b869f3ef1c29f1bad0cd1c032792 100644 --- a/api/@ohos.net.connection.d.ts +++ b/api/@ohos.net.connection.d.ts @@ -384,71 +384,6 @@ declare namespace connection { * @since 11 */ function getNetCapabilitiesSync(netHandle: NetHandle): NetCapabilities; - - /** - * Set the network extended attribute for a {@link NetHandle} object. - * To invoke this method, you must have the {@code ohos.permission.SET_NET_EXT_ATTRIBUTE} permission. - * @permission ohos.permission.SET_NET_EXT_ATTRIBUTE - * @param { NetHandle } netHandle - Indicates the network to be queried. See {@link NetHandle}. - * @param { string } netExtAttribute - Indicates the extended attribute of the network. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Failed to connect to the service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @since 18 - */ - function setNetExtAttribute(netHandle: NetHandle, netExtAttribute: string): Promise; - - /** - * Set the network extended attribute for a {@link NetHandle} object. - * To invoke this method, you must have the {@code ohos.permission.SET_NET_EXT_ATTRIBUTE} permission. - * @permission ohos.permission.SET_NET_EXT_ATTRIBUTE - * @param { NetHandle } netHandle - Indicates the network to be queried. See {@link NetHandle}. - * @param { string } netExtAttribute - Indicates the extended attribute of the network. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Failed to connect to the service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @since 18 - */ - function setNetExtAttributeSync(netHandle: NetHandle, netExtAttribute: string): void; - - /** - * Get the network extended attribute for a {@link NetHandle} object. - * To invoke this method, you must have the {@code ohos.permission.GET_NETWORK_INFO} permission. - * @permission ohos.permission.GET_NETWORK_INFO - * @param { NetHandle } netHandle - Indicates the network to be queried. See {@link NetHandle}. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Failed to connect to the service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @since 18 - */ - function getNetExtAttribute(netHandle: NetHandle): Promise; - - /** - * Get the network extended attribute for a {@link NetHandle} object. - * To invoke this method, you must have the {@code ohos.permission.GET_NETWORK_INFO} permission. - * @permission ohos.permission.GET_NETWORK_INFO - * @param { NetHandle } netHandle - Indicates the network to be queried. See {@link NetHandle}. - * @returns { string } The netExtAttribute string returned by the function. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. - * @throws { BusinessError } 2100001 - Invalid parameter value. - * @throws { BusinessError } 2100002 - Failed to connect to the service. - * @throws { BusinessError } 2100003 - System internal error. - * @syscap SystemCapability.Communication.NetManager.Core - * @since 18 - */ - function getNetExtAttributeSync(netHandle: NetHandle): string; /** * Checks whether data traffic usage on the current network is metered. diff --git a/api/@ohos.net.socket.d.ts b/api/@ohos.net.socket.d.ts index c042d76b5e70b8519e39670fa9a8ffd64b1afcc9..df3a30f8105e8e653ebd84b7caabe6055f659623 100644 --- a/api/@ohos.net.socket.d.ts +++ b/api/@ohos.net.socket.d.ts @@ -3350,6 +3350,14 @@ declare namespace socket { */ getSignatureAlgorithms(): Promise>; + /** + * Obtains the file descriptor of the TLSSocket connection. + * @returns { Promise } The promise returns the file descriptor of the TLSSocket connection. + * @syscap SystemCapability.Communication.NetStack + * @since 16 + */ + getSocketFd(): Promise; + /** * Sets up a connection to the specified IP address and port number. * Only TCP is supported. diff --git a/api/@ohos.nfc.cardEmulation.d.ts b/api/@ohos.nfc.cardEmulation.d.ts index 0a088d9bb9237fe4ebea0dd2455be0a0419f1cab..7731d7ec91d10398d866bba77a605941a2557b2b 100644 --- a/api/@ohos.nfc.cardEmulation.d.ts +++ b/api/@ohos.nfc.cardEmulation.d.ts @@ -350,7 +350,6 @@ declare namespace cardEmulation { * @param { 'hceCmd' } type - The type to unregister event. * @param { AsyncCallback } callback - The callback used to listen for the event. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Invalid parameter. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice diff --git a/api/@ohos.notificationManager.d.ts b/api/@ohos.notificationManager.d.ts index a844fb08b4465900622a6578000ea378e2e2a288..99a7a698fac87acb559b17c6e54d3daf62e5e0ac 100644 --- a/api/@ohos.notificationManager.d.ts +++ b/api/@ohos.notificationManager.d.ts @@ -3855,40 +3855,40 @@ declare namespace notificationManager { function getDoNotDisturbProfile(id: number): Promise; /** - * Set target device status. + * Disabling notifications based on the application list. * * @permission ohos.permission.NOTIFICATION_CONTROLLER - * @param { string } deviceType - The device. - * @param { number } status - The device status. + * @param { boolean } disabled - The switch of disableNotification. + * @param { Array } bundleList - The bundles of disableNotification. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1600001 - Internal error. + * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 18 */ - function setTargetDeviceStatus(deviceType: string, status: number): Promise; + function disableNotificationFeature(disabled:boolean, bundleList: Array): Promise; /** - * Disabling notifications based on the application list. + * Set target device status. * * @permission ohos.permission.NOTIFICATION_CONTROLLER - * @param { boolean } disabled - The switch of disableNotification. - * @param { Array } bundleList - The bundles of disableNotification. + * @param { string } deviceType - The device. + * @param { number } status - The device status. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application to call the interface. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3. Parameter verification failed. - * @throws { BusinessError } 1600001 - Internal error. - * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @syscap SystemCapability.Notification.Notification * @systemapi * @since 18 */ - function disableNotificationFeature(disabled:boolean, bundleList: Array): Promise; + function setTargetDeviceStatus(deviceType: string, status: number): Promise; /** * Set notification slot synchronization switch. diff --git a/api/@ohos.pasteboard.d.ts b/api/@ohos.pasteboard.d.ts index 6e8ab17c15a0864fc79e92eb72d339b36cf71964..2c52fa1faba9e45cf0c1fa0e77377a6c8fa981e4 100755 --- a/api/@ohos.pasteboard.d.ts +++ b/api/@ohos.pasteboard.d.ts @@ -1419,7 +1419,7 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of getData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1428,7 +1428,7 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of getData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1441,7 +1441,7 @@ declare namespace pasteboard { * permission required to call the API. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1451,14 +1451,14 @@ declare namespace pasteboard { /** * Gets pastedata from the system pasteboard. * @returns { Promise } the promise returned by the getData. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ /** * Gets pastedata from the system pasteboard. * @returns { Promise } the promise returned by the getData. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1469,7 +1469,7 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the getData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1593,8 +1593,8 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of setData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified. * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1604,8 +1604,8 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of setData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1618,8 +1618,8 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1629,8 +1629,8 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1655,7 +1655,7 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the getData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1681,8 +1681,8 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 diff --git a/api/@ohos.power.d.ts b/api/@ohos.power.d.ts index 4b41504996fb80e88258f770f724eb83aaa56649..ff07348b95623e1a1e8cef52a19f27fe696649c8 100644 --- a/api/@ohos.power.d.ts +++ b/api/@ohos.power.d.ts @@ -123,20 +123,6 @@ declare namespace power { * @systemapi * @since 9 */ - /** - * Wakes up the device to turn on the screen with permission. - * - * @permission ohos.permission.POWER_MANAGER - * @param { string } detail Indicates the detail information who request wakeup. - * detail parameter must be of type string. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 18 - */ function wakeup(detail: string): void; /** @@ -160,19 +146,6 @@ declare namespace power { * @systemapi * @since 10 */ - /** - * Suspends the device to turn off the screen with permission. - * - * @permission ohos.permission.POWER_MANAGER - * @param { boolean } isImmediate Indicates whether suspend the device immediately. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 18 - */ function suspend(isImmediate?: boolean): void; /** @@ -230,55 +203,29 @@ declare namespace power { function isStandby(): boolean; /** - * hibernate the device. - * - * @param { boolean } clearMemory - Indicates whether to clear the memory before the device hibernates. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 12 - */ - /** - * hibernate the device with permission. - * - * @permission ohos.permission.POWER_MANAGER - * @param { boolean } clearMemory - Indicates whether to clear the memory before the device hibernates. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 18 - */ + * hibernate the device. + * + * @param { boolean } clearMemory - Indicates whether to clear the memory before the device hibernates. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. + * @throws { BusinessError } 4900101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.PowerManager.Core + * @systemapi + * @since 12 + */ function hibernate(clearMemory: boolean): void; /** - * Sets the timeout duration(ms) for turning off the screen. - * - * @param { number } timeout - Indicates duration(ms) for turning off the screen. The value -1 means restore the default value. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 12 - */ - /** - * Sets the timeout duration(ms) for turning off the screen with permission. - * - * @permission ohos.permission.POWER_MANAGER - * @param { number } timeout - Indicates duration(ms) for turning off the screen. The value -1 means restore the default value. - * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. - * @throws { BusinessError } 4900101 - Failed to connect to the service. - * @syscap SystemCapability.PowerManager.PowerManager.Core - * @systemapi - * @since 18 - */ + * Sets the timeout duration(ms) for turning off the screen. + * + * @param { number } timeout - Indicates duration(ms) for turning off the screen. The value -1 means restore the default value. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. + * @throws { BusinessError } 4900101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.PowerManager.Core + * @systemapi + * @since 12 + */ function setScreenOffTime(timeout: number): void; /** diff --git a/api/@ohos.promptAction.d.ts b/api/@ohos.promptAction.d.ts index a07be30d8f91644099104719bba320177dc30eca..e9585a04973734a9cdc67bd3952c5ad0fe204e23 100644 --- a/api/@ohos.promptAction.d.ts +++ b/api/@ohos.promptAction.d.ts @@ -104,7 +104,7 @@ export class LevelOrder { * @atomicservice * @since 18 */ - static clamp(order: number): LevelOrder + static clamp(order: number): LevelOrder; /** * Get the order from LevelOrder object. @@ -115,7 +115,7 @@ export class LevelOrder { * @atomicservice * @since 18 */ - getOrder(): number + getOrder(): number; } /** @@ -761,28 +761,6 @@ declare namespace promptAction { */ backgroundBlurStyle?: BlurStyle; - /** - * Defines the dialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the dialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Defines the dialog's shadow. * @@ -818,50 +796,6 @@ declare namespace promptAction { */ hoverModeArea?: HoverModeAreaType; - /** - * Callback function when the dialog appears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidAppear?: Callback; - - /** - * Callback function when the dialog disappears. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onDidDisappear?: Callback; - - /** - * Callback function before the dialog openAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillAppear?: Callback; - - /** - * Callback function before the dialog closeAnimation starts. - * - * @type { ?Callback } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - onWillDisappear?: Callback; - /** * Determine the display level of the dialog. * @@ -1088,28 +1022,6 @@ declare namespace promptAction { * @since 12 */ transition?: TransitionEffect; - - /** - * Dialog transition parameters of opening/closing custom dialog. - * - * @type { ?TransitionEffect } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - dialogTransition?: TransitionEffect; - - /** - * Mask transition parameters of opening/closing custom dialog. - * - * @type { ?TransitionEffect } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - maskTransition?: TransitionEffect; /** * Defines custom dialog maskColor @@ -1202,7 +1114,7 @@ declare namespace promptAction { enableHoverMode?: boolean; /** - * Defines the customDialog's display area in hover mode. + * Defines the dialog's display area in hover mode. * * @type { ?HoverModeAreaType } * @default HoverModeAreaType.BOTTOM_SCREEN @@ -1213,28 +1125,6 @@ declare namespace promptAction { */ hoverModeArea?: HoverModeAreaType; - /** - * Defines the customDialog's background blur style with options - * - * @type { ?BackgroundBlurStyleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; - - /** - * Defines the customDialog's background effect with options - * - * @type { ?BackgroundEffectOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - backgroundEffect?: BackgroundEffectOptions; - /** * Defines the distance between the customDialog and system keyboard. * @@ -1292,18 +1182,6 @@ declare namespace promptAction { * @since 18 */ levelOrder?: LevelOrder; - - /** - * Specifies whether to get focus when the custom dialog is displayed. - * - * @type { ?boolean } - * @default true - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - focusable?: boolean; } /** diff --git a/api/@ohos.resourceManager.d.ts b/api/@ohos.resourceManager.d.ts index a5b9f8b882be892a4c9824c327c724b31e25cbf6..f6657872849b9ac673a517826c86c8f52f1e3a44 100644 --- a/api/@ohos.resourceManager.d.ts +++ b/api/@ohos.resourceManager.d.ts @@ -3082,7 +3082,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001001 - Invalid resource ID. * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. @@ -3103,7 +3102,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001001 - Invalid resource ID. * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. @@ -3125,7 +3123,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the name string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001003 - Invalid resource name. * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. @@ -3146,7 +3143,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001001 - Invalid resource ID. * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. @@ -3167,7 +3163,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the ID string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001001 - Invalid resource ID. * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. @@ -3189,7 +3184,6 @@ declare namespace resourceManager { * @param { Array } args - Indicates the formatting string resource parameters. * @returns { string } The singular-plural character string represented by the name string * corresponding to the specified number. - * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. * @throws { BusinessError } 9001003 - Invalid resource name. * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. * @throws { BusinessError } 9001006 - The resource is referenced cyclically. diff --git a/api/@ohos.resourceschedule.backgroundProcessManager.d.ts b/api/@ohos.resourceschedule.backgroundProcessManager.d.ts index 8e8c321e1dfb202eb64ea887997c436459613b87..3ae8da7cf107e1c1732d8f4304b798daaf2ffa70 100644 --- a/api/@ohos.resourceschedule.backgroundProcessManager.d.ts +++ b/api/@ohos.resourceschedule.backgroundProcessManager.d.ts @@ -23,7 +23,7 @@ * * @namespace backgroundProcessManager * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ declare namespace backgroundProcessManager { /** @@ -31,14 +31,14 @@ declare namespace backgroundProcessManager { * * @enum { number } * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ export enum ProcessPriority { /** * Means the process has stopped working and in the background * * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ PROCESS_BACKGROUND = 1, @@ -46,7 +46,7 @@ declare namespace backgroundProcessManager { * Means the process is working in the background * * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ PROCESS_INACTIVE = 2, } @@ -58,9 +58,8 @@ declare namespace backgroundProcessManager { * @param { ProcessPriority } priority - Indicates the priority to set. Specific priority can be referenced ProcessPriority * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: priority is out of range. - * @throws { BusinessError } 31800001 - remote error. Possible causes: remote is not work. * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ function setProcessPriority(pid: number, priority: ProcessPriority): Promise; @@ -69,9 +68,8 @@ declare namespace backgroundProcessManager { * * @param { number } pid - Indicates the pid of the process to be reset. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 31800001 - remote error. Possible causes: remote is not work. * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ function resetProcessPriority(pid: number): Promise; } diff --git a/api/@ohos.router.d.ts b/api/@ohos.router.d.ts index 94200d96b24a4d347faf89724600185b6fa50cd1..e8dc83c4ba71afc9c0847a0b79d74cd069f0670b 100644 --- a/api/@ohos.router.d.ts +++ b/api/@ohos.router.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2025 Huawei Device Co., Ltd. + * Copyright (c) 2021 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -135,13 +135,6 @@ declare namespace router { * @atomicservice * @since 11 */ - /** - * @typedef RouterOptions - * @syscap SystemCapability.ArkUI.ArkUI.Lite - * @crossplatform - * @atomicservice - * @since 18 - */ interface RouterOptions { /** * URI of the destination page, which supports the following formats: @@ -168,20 +161,6 @@ declare namespace router { * @atomicservice * @since 11 */ - /** - * URI of the destination page, which supports the following formats: - * 1. Absolute path of the page, which is provided by the pages list in the config.json file. - * Example: - * pages/index/index - * pages/detail/detail - * 2. Particular path. If the URI is a slash (/), the home page is displayed. - * - * @type { string } - * @syscap SystemCapability.ArkUI.ArkUI.Lite - * @crossplatform - * @atomicservice - * @since 18 - */ url: string; /** @@ -203,17 +182,6 @@ declare namespace router { * @atomicservice * @since 11 */ - /** - * Data that needs to be passed to the destination page during navigation. - * After the destination page is displayed, the parameter can be directly used for the page. - * For example, this.data1 (data1 is the key value of the params used for page navigation.) - * - * @type { ?Object } - * @syscap SystemCapability.ArkUI.ArkUI.Lite - * @crossplatform - * @atomicservice - * @since 18 - */ params?: Object; /** diff --git a/api/@ohos.rpc.d.ts b/api/@ohos.rpc.d.ts index de5eec3b252c182c31da82cbac76ee3531dcc32d..8fdf401724f2e9c799429f9c13cf74c29df94867 100644 --- a/api/@ohos.rpc.d.ts +++ b/api/@ohos.rpc.d.ts @@ -1266,6 +1266,7 @@ declare namespace rpc { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.The number of parameters is incorrect; * 2.The parameter type does not match. + * @throws { BusinessError } 1900009 - Failed to write data to the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ @@ -1280,6 +1281,7 @@ declare namespace rpc { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.The number of parameters is incorrect; * 2.The parameter type does not match. + * @throws { BusinessError } 1900009 - Failed to write data to the message sequence. * @throws { BusinessError } 1900011 - Memory allocation failed. * @syscap SystemCapability.Communication.IPC.Core * @since 9 @@ -1334,6 +1336,7 @@ declare namespace rpc { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.The number of parameters is incorrect; * 2.The parameter type does not match. + * @throws { BusinessError } 1900010 - Failed to read data from the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ @@ -1348,6 +1351,7 @@ declare namespace rpc { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.The number of parameters is incorrect; * 2.The parameter type does not match. + * @throws { BusinessError } 1900009 - Failed to write data to the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ @@ -1698,7 +1702,7 @@ declare namespace rpc { writeRemoteObjectArray(objectArray: IRemoteObject[]): void; /** - * Reads a byte value from the {@link MessageParcel} object. + * Reads a byte value from the {@link MessageSequence} object. * * @returns { number } Return a byte value. * @throws { BusinessError } 1900010 - Failed to read data from the message sequence. @@ -1819,7 +1823,6 @@ declare namespace rpc { * Reads a byte array from the {@link MessageSequence} object. * * @returns { number[] } Return a byte array. - * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - Failed to read data from the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 @@ -2127,7 +2130,7 @@ declare namespace rpc { * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.The number of parameters is incorrect; * 2.The parameter is not an instance of the Ashmem object. - * @throws { BusinessError } 1900003 - Failed to write data to the shared memory. + * @throws { BusinessError } 1900009 - Failed to write data to the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ @@ -2137,8 +2140,7 @@ declare namespace rpc { * Reads the anonymous shared memory object from this {@link MessageSequence} object. * * @returns { Ashmem } Return the anonymous share object obtained. - * @throws { BusinessError } 401 - check param failed - * @throws { BusinessError } 1900004 - Failed to read data from the shared memory. + * @throws { BusinessError } 1900010 - Failed to read data from the message sequence. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ @@ -2624,6 +2626,7 @@ declare namespace rpc { * 1.The number of parameters is incorrect; * 2.The parameter type does not match; * 3.The callback used to receive remote object death notifications is empty. + * @throws { BusinessError } 1900005 - Operation allowed only for the proxy object. * @throws { BusinessError } 1900008 - The proxy or remote object is invalid. * @syscap SystemCapability.Communication.IPC.Core * @since 9 @@ -2653,6 +2656,7 @@ declare namespace rpc { * 1.The number of parameters is incorrect; * 2.The parameter type does not match; * 3.The callback used to receive remote object death notifications is empty. + * @throws { BusinessError } 1900005 - Operation allowed only for the proxy object. * @throws { BusinessError } 1900008 - The proxy or remote object is invalid. * @syscap SystemCapability.Communication.IPC.Core * @since 9 @@ -2761,35 +2765,39 @@ declare namespace rpc { * * @type { number } * @default 0 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - TF_SYNC: number; + static TF_SYNC: number; /** * Indicates asynchronous call. * * @type { number } * @default 1 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - TF_ASYNC: number; + static TF_ASYNC: number; /** * Indicates the sendRequest API for returning the file descriptor. * * @type { number } * @default 16 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - TF_ACCEPT_FDS: number; + static TF_ACCEPT_FDS: number; /** * Indicates the wait time for RPC, in seconds. It is NOT used in IPC case. * * @default 4 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ @@ -2798,10 +2806,11 @@ declare namespace rpc { * * @type { number } * @default 8 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 11 */ - TF_WAIT_TIME: number; + static TF_WAIT_TIME: number; /** * A constructor used to create a MessageOption instance. @@ -2956,9 +2965,9 @@ declare namespace rpc { * your own service logic when you are using IPC. * * @param { number } code - Indicates the service request code sent from the peer end. - * @param { MessageSequence } data - Indicates the {@link MessageParcel} object sent from the peer end. + * @param { MessageSequence } data - Indicates the {@link MessageSequence} object sent from the peer end. * @param { MessageSequence } reply - Indicates the response message object sent from the remote service. - * The local service writes the response data to the {@link MessageParcel} object. + * The local service writes the response data to the {@link MessageSequence} object. * @param { MessageOption } options - Indicates whether the operation is synchronous or asynchronous. * @returns { boolean | Promise } * Return a simple boolean which is {@code true} if the operation succeeds; @@ -3179,30 +3188,33 @@ declare namespace rpc { * * @type { number } * @default 1599098439 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - PING_TRANSACTION: number; + static PING_TRANSACTION: number; /** * Indicates the message code for a dump operation. * * @type { number } * @default 1598311760 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - DUMP_TRANSACTION: number; + static DUMP_TRANSACTION: number; /** * Indicates the message code for a transmission. * * @type { number } * @default 1598968902 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - INTERFACE_TRANSACTION: number; + static INTERFACE_TRANSACTION: number; /** * Indicates the minimum value of a valid message code. @@ -3210,10 +3222,11 @@ declare namespace rpc { * * @type { number } * @default 0x1 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - MIN_TRANSACTION_ID: number; + static MIN_TRANSACTION_ID: number; /** * Indicates the maximum value of a valid message code. @@ -3221,10 +3234,11 @@ declare namespace rpc { * * @type { number } * @default 0x00FFFFFF + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ - MAX_TRANSACTION_ID: number; + static MAX_TRANSACTION_ID: number; /** * Queries a local interface with a specified descriptor. @@ -3641,40 +3655,44 @@ declare namespace rpc { * * @type { number } * @default 4 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 8 */ - PROT_EXEC: number; + static PROT_EXEC: number; /** * The mapped memory is inaccessible. * * @type { number } * @default 0 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 8 */ - PROT_NONE: number; + static PROT_NONE: number; /** * The mapped memory is readable. * * @type { number } * @default 1 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 8 */ - PROT_READ: number; + static PROT_READ: number; /** * The mapped memory is writable. * * @type { number } * @default 2 + * @static * @syscap SystemCapability.Communication.IPC.Core * @since 8 */ - PROT_WRITE: number; + static PROT_WRITE: number; /** * Creates an Ashmem object with the specified name and size. diff --git a/api/@ohos.screen.d.ts b/api/@ohos.screen.d.ts index 7f1c9526ee9ddec5ca96836dcf0f1a731ab41956..4367666145423f11026e06ccfe0613253291f51c 100644 --- a/api/@ohos.screen.d.ts +++ b/api/@ohos.screen.d.ts @@ -19,7 +19,6 @@ */ import { AsyncCallback, Callback } from './@ohos.base'; -import image from './@ohos.multimedia.image'; /** * Interface of screen manager @@ -182,24 +181,6 @@ declare namespace screen { */ function makeMirror(mainScreen: number, mirrorScreen: Array): Promise; - /** - * Make screens as mirror-screen - * - * @param { number } mainScreen ID of the primary screen. It's type should be int. - * @param { Array } mirrorScreen IDs of secondary screens - * @param { Rect } mainScreenRegion mirror screen region - * @returns { Promise } Promise used to return the group ID of the secondary screens - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - * @throws { BusinessError } 1400001 - Invalid display or screen. - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - function makeMirrorWithRegion(mainScreen: number, mirrorScreen: Array, mainScreenRegion: Rect): Promise; - /** * Stop mirror screens * @@ -349,25 +330,6 @@ declare namespace screen { */ function setVirtualScreenSurface(screenId: number, surfaceId: string): Promise; - /** - * Set privacy mask image for the screen. - * - * @param { number } screenId Indicates the screen id of the screen. - * @param { image.PixelMap } image Indicates the privacy mask image. This parameter is optional. If not provided, - * the mask image will be cleared; - * @returns { Promise } Promise that returns no value - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1400001 - Invalid display or screen. - * @throws { BusinessError } 1400003 - This display manager service works abnormally. - * @syscap SystemCapability.Window.SessionManager - * @systemapi Hide this for inner system use. - * @since 18 - */ - function setScreenPrivacyMaskImage(screenId: number, image?: image.PixelMap): Promise; - /** * Get screen rotation lock status. * @@ -949,61 +911,6 @@ declare namespace screen { */ refreshRate: number; } - - /** - * Rectangle - * - * @interface Rect - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - interface Rect { - /** - * The X-axis coordinate of the upper left vertex of the rectangle, in pixels. - * - * @type { number } - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - left: number; - - /** - * The Y-axis coordinate of the upper left vertex of the rectangle, in pixels. - * - * @type { number } - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - top: number; - - /** - * Width of the rectangle, in pixels. - * - * @type { number } - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - width: number; - - /** - * Height of the rectangle, in pixels. - * - * @type { number } - * @syscap SystemCapability.WindowManager.WindowManager.Core - * @systemapi Hide this for inner system use. - * @atomicservice - * @since 15 - */ - height: number; - } } export default screen; diff --git a/api/@ohos.screenLock.d.ts b/api/@ohos.screenLock.d.ts index 51664bddb5e83c511ad1fe12a8e60ede43b033dd..87ebbab13a13ddfcec90b7a5c12e769c73d83d2c 100644 --- a/api/@ohos.screenLock.d.ts +++ b/api/@ohos.screenLock.d.ts @@ -226,26 +226,46 @@ declare namespace screenLock { enum StrongAuthReasonFlags { /** * Indicates that there are no strong authentication reason flags. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ NONE = 0x00000000, /** * Indicates the strong authentication reason requested after boot. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ AFTER_BOOT = 0x00000001, /** * Indicates the strong authentication reason requested after timeout. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ AFTER_TIMEOUT = 0x00000002, /** * Indicates the strong authentication reason requested by active request. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ ACTIVE_REQUEST = 0x00000004, /** * Indicates the strong authentication reason requested by policy restriction. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ POLICY_RESTRICTION = 0x00000008 } @@ -261,36 +281,64 @@ declare namespace screenLock { enum AuthState { /** * Indicates the screen lock is not authenticated. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ NOT_AUTHED = 0, /** * Indicates the screen lock is pre authenticated by credential. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ PRE_AUTHED_BY_CREDENTIAL = 1, /** * Indicates the screen lock is pre authenticated by fingerprint. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ PRE_AUTHED_BY_FINGERPRINT = 2, /** * Indicates the screen lock is pre authenticated by face. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ PRE_AUTHED_BY_FACE = 3, /** * Indicates the screen lock is authenticated by credential. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ AUTHED_BY_CREDENTIAL = 4, /** * Indicates the screen lock is authenticated by fingerprint. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ AUTHED_BY_FINGERPRINT = 5, /** * Indicates the screen lock is authenticated by face. + * + * @syscap SystemCapability.MiscServices.ScreenLock + * @systemapi Hide this for inner system use. + * @since 12 */ AUTHED_BY_FACE = 6, } @@ -482,22 +530,6 @@ declare namespace screenLock { * @since 12 */ function getScreenLockAuthState(userId: number): AuthState; - - /** - * Check whether the device is currently locked and the screenlock requires an identity to authenticate and unlock. - * - * @param { number } userId - Os account local userId. - * @returns { boolean } Whether the device is currently locked. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. - * @throws { BusinessError } 13200002 - The screenlock management service is abnormal. - * @throws { BusinessError } 13200004 - The userId is not same as the caller, and is not allowed for the caller. - * @syscap SystemCapability.MiscServices.ScreenLock - * @systemapi Hide this for inner system use. - * @since 15 - */ - function isDeviceLocked(userId: number): boolean; } export default screenLock; \ No newline at end of file diff --git a/api/@ohos.secureElement.d.ts b/api/@ohos.secureElement.d.ts index 44242f31a3b6b180ab55543e2567a314e0d0f9b7..bfc650866ef9ba406a9ebdf078b3606a21aae823 100644 --- a/api/@ohos.secureElement.d.ts +++ b/api/@ohos.secureElement.d.ts @@ -66,7 +66,6 @@ declare namespace omapi { * * @param { 'stateChanged' } type - The type to register. * @param { Callback } callback - The callback used to listen for the state change event. - * @throws { BusinessError } 401 - Invalid parameter. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.SecureElement * @since 18 @@ -78,7 +77,6 @@ declare namespace omapi { * * @param { 'stateChanged' } type - The type to register. * @param { Callback } callback - The callback used to listen for the state change event. - * @throws { BusinessError } 401 - Invalid parameter. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.SecureElement * @since 18 diff --git a/api/@ohos.security.cert.d.ts b/api/@ohos.security.cert.d.ts index 46327cf1317a8a65bd2ab361b3e9c4d9438ee565..0e13a7af5c0ca766ccfb1b31552da612efa5ed0c 100644 --- a/api/@ohos.security.cert.d.ts +++ b/api/@ohos.security.cert.d.ts @@ -2004,6 +2004,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 */ @@ -2017,6 +2018,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @since 11 @@ -2031,6 +2033,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @atomicservice @@ -2048,6 +2051,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 9 */ @@ -2061,6 +2065,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @since 11 @@ -2075,6 +2080,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @atomicservice @@ -2310,6 +2316,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 10 */ @@ -2323,6 +2330,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @since 11 @@ -2337,6 +2345,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @atomicservice @@ -2354,6 +2363,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @since 10 */ @@ -2367,6 +2377,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @since 11 @@ -2381,6 +2392,7 @@ declare namespace cert { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 19020001 - memory error. + * @throws { BusinessError } 19030001 - crypto operation error. * @syscap SystemCapability.Security.Cert * @crossplatform * @atomicservice diff --git a/api/@ohos.security.cryptoFramework.d.ts b/api/@ohos.security.cryptoFramework.d.ts index deb0aa9a015e5caffda5a878b5fcddec53cf9196..e5e861f913bcafc2f7e701928a47bdd13bac67c7 100644 --- a/api/@ohos.security.cryptoFramework.d.ts +++ b/api/@ohos.security.cryptoFramework.d.ts @@ -842,6 +842,7 @@ declare namespace cryptoFramework { * @returns { bigint | string | number } the specified parameters value. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -854,6 +855,7 @@ declare namespace cryptoFramework { * @returns { bigint | string | number } the specified parameters value. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework @@ -867,6 +869,7 @@ declare namespace cryptoFramework { * @returns { bigint | string | number } the specified parameters value. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Key.AsymKey @@ -916,6 +919,7 @@ declare namespace cryptoFramework { * @returns { string } the string of the key object in PEM format. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Key.AsymKey @@ -986,6 +990,7 @@ declare namespace cryptoFramework { * @returns { bigint | string | number } the specified parameters value. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - this operation is not supported. * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Key.AsymKey @@ -2157,6 +2162,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the init function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2168,6 +2174,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the init function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2180,6 +2187,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the init function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2195,6 +2203,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2206,6 +2215,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2218,6 +2228,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2232,6 +2243,7 @@ declare namespace cryptoFramework { * @param { SymKey } key - indicates the SymKey. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2247,6 +2259,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2258,6 +2271,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2270,6 +2284,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2285,6 +2300,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2296,6 +2312,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2308,6 +2325,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2322,6 +2340,7 @@ declare namespace cryptoFramework { * @param { DataBlob } input - indicates the DataBlob. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.Mac * @crossplatform @@ -2556,6 +2575,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2567,6 +2587,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2579,6 +2600,7 @@ declare namespace cryptoFramework { * @param { AsyncCallback } callback - the callback of the update function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.MessageDigest * @crossplatform @@ -2594,6 +2616,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @since 9 @@ -2605,6 +2628,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework * @crossplatform @@ -2617,6 +2641,7 @@ declare namespace cryptoFramework { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.MessageDigest * @crossplatform @@ -2631,6 +2656,7 @@ declare namespace cryptoFramework { * @param { DataBlob } input - indicates the DataBlob. * @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17620001 - memory error. * @throws { BusinessError } 17630001 - crypto operation error. * @syscap SystemCapability.Security.CryptoFramework.MessageDigest * @crossplatform diff --git a/api/@ohos.settings.d.ts b/api/@ohos.settings.d.ts index 84a80429cbf74f008ddec3d86508c6d55ce50841..e18939378d9dfef072de74d8c22b676e13c4a0c9 100644 --- a/api/@ohos.settings.d.ts +++ b/api/@ohos.settings.d.ts @@ -1077,11 +1077,13 @@ declare namespace settings { /** * Get value from settingsdata * + * @permission [USER_SECURE] ohos.permission.MANAGE_SECURE_SETTINGS. * @param { Context } context - Indicates the Context used to access the database. * @param { string } name - Indicates the name of the character string. * @param { string } domainName - Indicates the name of the domain name to set. * @returns { Promise } Returns the value of the character string in the domain if any is found; returns {@code * null} otherwise. + * @throws { BusinessError } 201 - Permission denied. * @syscap SystemCapability.Applications.Settings.Core * @StageModelOnly * @since 11 @@ -1125,7 +1127,7 @@ declare namespace settings { /** * Set settingsdata value. * - * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * @permission ohos.permission.MANAGE_SETTINGS * @param { Context } context - Indicates Context or dataAbilityHelper instance. * @param { string } name - Indicates the name of the character string. * @param { string } value - Indicates the value of the character string. @@ -1139,7 +1141,7 @@ declare namespace settings { /** * Set settingsdata value. * - * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * @permission ohos.permission.MANAGE_SETTINGS * @param { Context } context - Indicates Context or dataAbilityHelper instance. * @param { string } name - Indicates the name of the character string. * @param { string } value - Indicates the value of the character string. @@ -1153,7 +1155,8 @@ declare namespace settings { /** * Set settingsdata value. * - * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * @permission [DEVICE_SHARED, USER_PROPRERTY] ohos.permission.MANAGE_SETTINGS. + * or [USER_SECURE] ohos.permission.MANAGE_SECURE_SETTINGS. * @param { Context } context - Indicates Context instance. * @param { string } name - Indicates the name of the character string. * @param { string } value - Indicates the value of the character string. @@ -1248,11 +1251,13 @@ declare namespace settings { /** * Get value from settingsdata(synchronous method) * + * @permission [USER_SECURE] ohos.permission.MANAGE_SECURE_SETTINGS. * @param { Context } context - Indicates Context instance * @param { string } name - Indicates the name of the character string. * @param { string } defValue - Indicates the default value of the character string. * @param { string } domainName - Indicates the name of the domain name to set. * @returns { string } Returns settingsdata value. + * @throws { BusinessError } 201 - Permission denied. * @syscap SystemCapability.Applications.Settings.Core * @StageModelOnly * @since 11 @@ -1278,7 +1283,7 @@ declare namespace settings { /** * Set settingsdata value(synchronous method) * - * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * @permission ohos.permission.MANAGE_SETTINGS * @param { Context } context - Indicates Context or dataAbilityHelper instance. * @param { string } name - Indicates the name of the character string. * @param { string } value - Indicates the value of the character string. @@ -1292,7 +1297,8 @@ declare namespace settings { /** * Set settingsdata value(synchronous method) * - * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * @permission [DEVICE_SHARED, USER_PROPRERTY] ohos.permission.MANAGE_SETTINGS. + * or [USER_SECURE] ohos.permission.MANAGE_SECURE_SETTINGS. * @param { Context } context - Indicates Context instance. * @param { string } name - Indicates the name of the character string. * @param { string } value - Indicates the value of the character string. diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index 2d27ed71365659e0d39c3be32ea45a117a3fa6b5..1ed2dd5ce6e1ebe3523cea1e0a03a0799bbbf25a 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -5649,6 +5649,30 @@ declare namespace call { */ MARK_TYPE_ENTERPRISE = 11 } + + /** + * send ussd response to network + * + * @permission ohos.permission.SET_TELEPHONY_STATE + * @param { number } accountId - account id. + * @param { string } content - content send to network. + * @returns { Promise } Returns the result of send ussd. + * Returns {@code true} if the call request is successful; returns {@code false} otherwise. + * Note that the value {@code true} indicates only the successful processing of the request; it does not mean + * that the ussd is sendRequest to modem. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 202 - Non-system applications use system APIs. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; + * 2. Incorrect parameters types; + * @throws { BusinessError } 8300001 - Invalid parameter value. + * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 8300003 - System internal error. + * @throws { BusinessError } 8300999 - Unknown error code. + * @syscap SystemCapability.Telephony.CallManager + * @systemapi Hide this for inner system use. + * @since 16 + */ + function sendUssdResponse(accountId: number, content: string): Promise; } export default call; diff --git a/api/@ohos.telephony.data.d.ts b/api/@ohos.telephony.data.d.ts index 555398e899023dbbfaadc3f548fc16c97d897f60..259f288bc1ed582ee7fb020e626cb7560c24efdc 100644 --- a/api/@ohos.telephony.data.d.ts +++ b/api/@ohos.telephony.data.d.ts @@ -426,6 +426,115 @@ declare namespace data { */ function getDefaultCellularDataSimId(): number; + /** + * Query all APN info. + * + * @permission ohos.permission.MANAGE_APN_SETTING + * @returns { Promise> } Returns all APN info of default cellular data card. + * @throws { BusinessError } 201 - Permission denied. + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + function queryAllApns(): Promise>; + + /** + * Query APN IDs. + * + * @permission ohos.permission.MANAGE_APN_SETTING + * @param { ApnInfo } apnInfo - The APN information that needs to be queried. + * @returns { Promise> } Returns IDs of all APNs that meet the query conditions. + * @throws { BusinessError } 201 - Permission denied. + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + function queryApnIds(apnInfo: ApnInfo): Promise>; + + /** + * Set preferred APN. + * + * @permission ohos.permission.MANAGE_APN_SETTING + * @param { number } apnId - The APN ID which is used to be set. + * @returns { Promise } Returns {@code true} if preferred APN set success; returns {@code false} otherwise. + * @throws { BusinessError } 201 - Permission denied. + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + function setPreferredApn(apnId: number): Promise; + + /** + * Defines the APN info. + * + * @interface ApnInfo + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + interface ApnInfo { + /** + * Indicates APN name. + * + * @type { string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + apnName: string; + /** + * Indicates APN. + * + * @type { string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + apn: string; + /** + * Indicates APN mcc. + * + * @type { string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + mcc: string; + /** + * Indicates APN mcc. + * + * @type { string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + mnc: string; + /** + * Indicates APN user. + * + * @type { ?string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + user?: string; + /** + * Indicates APN type. + * + * @type { ?string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + type?: string; + /** + * Indicates APN proxy. + * + * @type { ?string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + proxy?: string; + /** + * Indicates APN mmsproxy. + * + * @type { ?string } + * @syscap SystemCapability.Telephony.CellularData + * @since 16 + */ + mmsproxy?: string; + } + /** * Describes the cellular data flow type. * diff --git a/api/@ohos.telephony.esim.d.ts b/api/@ohos.telephony.esim.d.ts index 26ac5e8a5296779a31b53f84cf2855942d86722e..8e2f80afe0fb1accb7559c9f9ace1e7fe6189af6 100644 --- a/api/@ohos.telephony.esim.d.ts +++ b/api/@ohos.telephony.esim.d.ts @@ -26,7 +26,7 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace eSIM * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ declare namespace eSIM { /** @@ -34,12 +34,11 @@ declare namespace eSIM { * * @param { number } slotId - Indicates the card slot index number. * @returns { boolean } Returns {@code true} if the eSIM capability is supported; returns {@code false} otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ function isSupported(slotId: number): boolean; @@ -51,13 +50,12 @@ declare namespace eSIM { * @returns { Promise } Returns {@code true} if the profile is added successfully; * returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ function addProfile(profile: DownloadableProfile): Promise; @@ -69,14 +67,13 @@ declare namespace eSIM { * @returns { Promise } Returns the EID. When eUICC is not ready, the return value may be null. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getEid(slotId: number): Promise; @@ -88,14 +85,13 @@ declare namespace eSIM { * @returns { Promise } Return the status of eUICC OS upgrade. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getOsuStatus(slotId: number): Promise; @@ -107,14 +103,13 @@ declare namespace eSIM { * @returns { Promise } Return the status of OS upgrade when OS upgrade status changed. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function startOsu(slotId: number): Promise; @@ -131,14 +126,13 @@ declare namespace eSIM { * @returns { Promise } Return the metadata for profile. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getDownloadableProfileMetadata(slotId: number, portIndex: number, profile: DownloadableProfile, forceDisableProfile: boolean): Promise; @@ -156,14 +150,13 @@ declare namespace eSIM { * available for download on this device. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getDownloadableProfiles(slotId: number, portIndex: number, forceDisableProfile: boolean): Promise; @@ -179,14 +172,13 @@ declare namespace eSIM { * @returns { Promise } Return the given downloadableProfile. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function downloadProfile(slotId: number, portIndex: number, profile: DownloadableProfile, configuration: DownloadConfiguration): Promise; @@ -199,14 +191,13 @@ declare namespace eSIM { * @returns { Promise } Return a list of eUICC profile information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getEuiccProfileInfoList(slotId: number): Promise; @@ -219,14 +210,13 @@ declare namespace eSIM { * the return value may be null. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getEuiccInfo(slotId: number): Promise; @@ -239,14 +229,13 @@ declare namespace eSIM { * @returns { Promise } Returns the response to deletes the given profile. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function deleteProfile(slotId: number, iccid: string): Promise; @@ -263,14 +252,13 @@ declare namespace eSIM { * @returns { Promise } Returns the response to switch profile. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function switchToProfile(slotId: number, portIndex: number, iccid: string, forceDisableProfile: boolean): Promise; @@ -285,14 +273,13 @@ declare namespace eSIM { * @returns { Promise } Returns the result of the set nickname operation. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function setProfileNickname(slotId: number, iccid: string, nickname: string): Promise; @@ -305,14 +292,13 @@ declare namespace eSIM { * @returns { Promise } Returns the result of the reset operation. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function resetMemory(slotId: number, options?:ResetOption): Promise; @@ -324,14 +310,13 @@ declare namespace eSIM { * @returns { Promise } Returns the result code. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function reserveProfilesForFactoryRestore(slotId: number): Promise; @@ -344,14 +329,13 @@ declare namespace eSIM { * @returns { Promise } Returns the result code. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function setDefaultSmdpAddress(slotId: number, address: string): Promise; @@ -363,14 +347,13 @@ declare namespace eSIM { * @returns { Promise } Returns the default SM-DP+ address. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function getDefaultSmdpAddress(slotId: number): Promise; @@ -386,14 +369,13 @@ declare namespace eSIM { * @returns { Promise } Returns the result code. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - * 2. Incorrect parameter types. 3. Invalid parameter value. + * @throws { BusinessError } 401 - Invalid parameter value. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3120001 - Service connection failed. * @throws { BusinessError } 3120002 - System internal error. * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ function cancelSession(slotId: number, transactionId: string, cancelReason: CancelReason): Promise; @@ -403,7 +385,7 @@ declare namespace eSIM { * @interface AccessRule * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface AccessRule { /** @@ -412,7 +394,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ certificateHashHexStr: string; @@ -422,7 +404,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ packageName: string; @@ -432,7 +414,7 @@ declare namespace eSIM { * @type { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ accessType: number; } @@ -442,7 +424,7 @@ declare namespace eSIM { * * @interface DownloadableProfile * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ export interface DownloadableProfile { /** @@ -450,7 +432,7 @@ declare namespace eSIM { * * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ activationCode: string; @@ -459,7 +441,7 @@ declare namespace eSIM { * * @type { ?string } * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ confirmationCode?: string; @@ -468,7 +450,7 @@ declare namespace eSIM { * * @type { ?string } * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ carrierName?: string; @@ -477,7 +459,7 @@ declare namespace eSIM { * * @type { ?Array } * @syscap SystemCapability.Telephony.CoreService.Esim - * @since 16 + * @since 18 */ accessRules?: Array; } @@ -488,7 +470,7 @@ declare namespace eSIM { * @interface GetDownloadableProfileMetadataResult * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface GetDownloadableProfileMetadataResult { /** @@ -497,7 +479,7 @@ declare namespace eSIM { * @type { DownloadableProfile } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ downloadableProfile: DownloadableProfile; @@ -507,7 +489,7 @@ declare namespace eSIM { * @type { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ pprType: number; @@ -517,7 +499,7 @@ declare namespace eSIM { * @type { boolean } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ pprFlag: boolean; @@ -527,7 +509,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ iccid: string; @@ -537,7 +519,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ serviceProviderName: string; @@ -547,7 +529,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ profileName: string; @@ -557,7 +539,7 @@ declare namespace eSIM { * @type { ProfileClass } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ profileClass: ProfileClass; @@ -567,7 +549,7 @@ declare namespace eSIM { * @type { SolvableErrors } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ solvableErrors: SolvableErrors; @@ -577,7 +559,7 @@ declare namespace eSIM { * @type { ResultCode } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ responseResult: ResultCode; } @@ -588,7 +570,7 @@ declare namespace eSIM { * @interface GetDownloadableProfilesResult * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface GetDownloadableProfilesResult { /** @@ -597,7 +579,7 @@ declare namespace eSIM { * @type { ResultCode } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ responseResult: ResultCode; @@ -607,7 +589,7 @@ declare namespace eSIM { * @type { Array } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ downloadableProfiles: Array; } @@ -618,7 +600,7 @@ declare namespace eSIM { * @interface DownloadProfileResult * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface DownloadProfileResult { /** @@ -627,7 +609,7 @@ declare namespace eSIM { * @type { ResultCode } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ responseResult: ResultCode; @@ -637,7 +619,7 @@ declare namespace eSIM { * @type { SolvableErrors } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ solvableErrors: SolvableErrors; @@ -647,7 +629,7 @@ declare namespace eSIM { * @type { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ cardId: number; } @@ -658,7 +640,7 @@ declare namespace eSIM { * @interface GetEuiccProfileInfoListResult * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface GetEuiccProfileInfoListResult { /** @@ -667,7 +649,7 @@ declare namespace eSIM { * @type { ResultCode } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ responseResult: ResultCode; @@ -677,7 +659,7 @@ declare namespace eSIM { * @type { Array } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ profiles: Array; @@ -687,7 +669,7 @@ declare namespace eSIM { * @type { boolean } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ isRemovable: boolean; } @@ -698,7 +680,7 @@ declare namespace eSIM { * @interface OperatorId * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface OperatorId { /** @@ -707,7 +689,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ mcc: string; @@ -717,7 +699,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ mnc: string; @@ -727,7 +709,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ gid1: string; @@ -737,7 +719,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ gid2: string; } @@ -748,7 +730,7 @@ declare namespace eSIM { * @interface EuiccProfile * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface EuiccProfile { /** @@ -757,7 +739,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ iccid: string; @@ -767,7 +749,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ nickName: string; @@ -777,7 +759,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ serviceProviderName: string; @@ -787,7 +769,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ profileName: string; @@ -797,7 +779,7 @@ declare namespace eSIM { * @type { ProfileState } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ state: ProfileState; @@ -807,7 +789,7 @@ declare namespace eSIM { * @type { ProfileClass } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ profileClass: ProfileClass; @@ -817,7 +799,7 @@ declare namespace eSIM { * @type { OperatorId } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ operatorId: OperatorId; @@ -827,7 +809,7 @@ declare namespace eSIM { * @type { PolicyRules } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ policyRules: PolicyRules; @@ -837,7 +819,7 @@ declare namespace eSIM { * @type { Array } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ accessRules: Array; } @@ -848,7 +830,7 @@ declare namespace eSIM { * @interface EuiccInfo * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface EuiccInfo { /** @@ -857,7 +839,7 @@ declare namespace eSIM { * @type { string } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ osVersion: string; } @@ -868,7 +850,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum ResetOption { /** @@ -876,7 +858,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ DELETE_OPERATIONAL_PROFILES = 1, @@ -885,7 +867,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ DELETE_FIELD_LOADED_TEST_PROFILES = 1 << 1, @@ -894,7 +876,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESET_DEFAULT_SMDP_ADDRESS = 1 << 2, } @@ -905,7 +887,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum OsuStatus { /** @@ -913,7 +895,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ EUICC_UPGRADE_IN_PROGRESS = 1, @@ -922,7 +904,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ EUICC_UPGRADE_FAILED = 2, @@ -931,7 +913,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ EUICC_UPGRADE_SUCCESSFUL = 3, @@ -940,7 +922,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ EUICC_UPGRADE_ALREADY_LATEST = 4, @@ -949,7 +931,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ EUICC_UPGRADE_SERVICE_UNAVAILABLE = 5, } @@ -960,7 +942,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum ResultCode { /** @@ -968,7 +950,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SOLVABLE_ERRORS = -2, @@ -977,7 +959,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_MUST_DISABLE_PROFILE = -1, @@ -986,7 +968,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_OK = 0, @@ -995,7 +977,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_GET_EID_FAILED = 201, @@ -1004,7 +986,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_ACTIVATION_CODE_CHANGED = 203, @@ -1013,7 +995,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_ACTIVATION_CODE_INVALID = 204, @@ -1022,7 +1004,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SMDP_ADDRESS_INVALID = 205, @@ -1031,7 +1013,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_EUICC_INFO_INVALID = 206, @@ -1040,7 +1022,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_TLS_HANDSHAKE_FAILED = 207, @@ -1049,7 +1031,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CERTIFICATE_IO_ERROR = 208, @@ -1058,7 +1040,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CERTIFICATE_RESPONSE_TIMEOUT = 209, @@ -1067,7 +1049,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_AUTHENTICATION_FAILED = 210, @@ -1076,7 +1058,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_RESPONSE_HTTP_FAILED = 211, @@ -1085,7 +1067,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CONFIRMATION_CODE_INCORRECT = 212, @@ -1094,7 +1076,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_EXCEEDED_CONFIRMATION_CODE_TRY_LIMIT = 213, @@ -1103,7 +1085,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_NO_PROFILE_ON_SERVER = 214, @@ -1112,7 +1094,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_TRANSACTION_ID_INVALID = 215, @@ -1121,7 +1103,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SERVER_ADDRESS_INVALID = 216, @@ -1130,7 +1112,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_GET_BOUND_PROFILE_PACKAGE_FAILED = 217, @@ -1139,7 +1121,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_USER_CANCEL_DOWNLOAD = 218, @@ -1148,7 +1130,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SERVER_UNAVAILABLE = 220, @@ -1157,7 +1139,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_PROFILE_NON_DELETE = 223, @@ -1166,7 +1148,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SMDP_ADDRESS_INCORRECT = 226, @@ -1175,7 +1157,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_ANALYZE_AUTHENTICATION_SERVER_RESPONSE_FAILED = 228, @@ -1184,7 +1166,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_ANALYZE_AUTHENTICATION_CLIENT_RESPONSE_FAILED = 229, @@ -1193,7 +1175,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_ANALYZE_AUTHENTICATION_CLIENT_MATCHING_ID_REFUSED = 231, @@ -1202,7 +1184,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_PROFILE_TYPE_ERROR_AUTHENTICATION_STOPPED = 233, @@ -1211,7 +1193,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CARRIER_SERVER_REFUSED_ERRORS = 249, @@ -1220,7 +1202,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CERTIFICATE_INVALID = 251, @@ -1229,7 +1211,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_OUT_OF_MEMORY = 263, @@ -1238,7 +1220,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_PPR_FORBIDDEN = 268, @@ -1247,7 +1229,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_NOTHING_TO_DELETE = 270, @@ -1256,7 +1238,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_PPR_NOT_MATCH = 276, @@ -1265,7 +1247,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_CAT_BUSY = 283, @@ -1274,7 +1256,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_PROFILE_EID_INVALID = 284, @@ -1283,7 +1265,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_DOWNLOAD_TIMEOUT = 287, @@ -1292,7 +1274,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ RESULT_SGP_22_OTHER = 400, } @@ -1303,7 +1285,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum CancelReason { /** @@ -1311,7 +1293,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ CANCEL_REASON_END_USER_REJECTION = 0, @@ -1320,7 +1302,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ CANCEL_REASON_POSTPONED = 1, @@ -1329,7 +1311,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ CANCEL_REASON_TIMEOUT = 2, @@ -1338,7 +1320,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ CANCEL_REASON_PPR_NOT_ALLOWED = 3, } @@ -1349,7 +1331,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum ProfileState { /** @@ -1357,7 +1339,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_STATE_UNSPECIFIED = -1, @@ -1366,7 +1348,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_STATE_DISABLED = 0, @@ -1375,7 +1357,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_STATE_ENABLED = 1, } @@ -1386,7 +1368,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum ProfileClass { /** @@ -1394,7 +1376,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_CLASS_UNSPECIFIED = -1, @@ -1403,7 +1385,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_CLASS_TEST = 0, @@ -1412,7 +1394,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_CLASS_PROVISIONING = 1, @@ -1421,7 +1403,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ PROFILE_CLASS_OPERATIONAL = 2, } @@ -1432,7 +1414,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum PolicyRules { /** @@ -1440,7 +1422,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ POLICY_RULE_DISABLE_NOT_ALLOWED = 1, @@ -1449,7 +1431,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ POLICY_RULE_DELETE_NOT_ALLOWED = 1 << 1, @@ -1458,7 +1440,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ POLICY_RULE_DISABLE_AND_DELETE = 1 << 2, } @@ -1469,7 +1451,7 @@ declare namespace eSIM { * @enum { number } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export enum SolvableErrors { /** @@ -1477,7 +1459,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ SOLVABLE_ERROR_NEED_CONFIRMATION_CODE = 1 << 0, @@ -1486,7 +1468,7 @@ declare namespace eSIM { * * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ SOLVABLE_ERROR_NEED_POLICY_RULE = 1 << 1, } @@ -1497,7 +1479,7 @@ declare namespace eSIM { * @interface DownloadConfiguration * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ export interface DownloadConfiguration { /** @@ -1506,7 +1488,7 @@ declare namespace eSIM { * @type { boolean } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ switchAfterDownload: boolean; @@ -1518,7 +1500,7 @@ declare namespace eSIM { * @type { boolean } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ forceDisableProfile: boolean; @@ -1529,7 +1511,7 @@ declare namespace eSIM { * @type { boolean } * @syscap SystemCapability.Telephony.CoreService.Esim * @systemapi Hide this for inner system use. - * @since 16 + * @since 18 */ isPprAllowed: boolean; } diff --git a/api/@ohos.telephony.radio.d.ts b/api/@ohos.telephony.radio.d.ts index 8a39228dd9b51e6b3547d46bfc7b4587446106ef..e733bfd3e7c356b845c19a4bda3a05a4f353cf10 100644 --- a/api/@ohos.telephony.radio.d.ts +++ b/api/@ohos.telephony.radio.d.ts @@ -169,6 +169,25 @@ declare namespace radio { */ function getRadioTech(slotId: number): Promise; + /** + * Obtains radio access technology (RAT) of the registered network. + * + * @permission ohos.permission.GET_NETWORK_INFO + * @param { number } slotId - Indicates the card slot index number, + * ranging from 0 to the maximum card slot index number supported by the device. + * @returns { NetworkRadioTech } Returns the RAT of PS domain and CS domain of registered network. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameter types. + * @throws { BusinessError } 8300001 - Invalid parameter value. + * @throws { BusinessError } 8300002 - Operation failed. Cannot connect to service. + * @throws { BusinessError } 8300003 - System internal error. + * @throws { BusinessError } 8300999 - Unknown error code. + * @syscap SystemCapability.Telephony.CoreService + * @since 18 + */ + function getRadioTechSync(slotId: number): NetworkRadioTech; + /** * Obtains the network state of the registered network. * diff --git a/api/@ohos.telephony.sim.d.ts b/api/@ohos.telephony.sim.d.ts index 37f1d31d087a98d45d98c21f101410ee68f52df0..e6c41027ef64cf6114f4f7d0f93a4cd542689741 100644 --- a/api/@ohos.telephony.sim.d.ts +++ b/api/@ohos.telephony.sim.d.ts @@ -2215,7 +2215,7 @@ declare namespace sim { * @systemapi Hide this for inner system use. * @since 14 */ - function getSimAuthentication(slotId: number, authType: AuthType, authData: string): Promise + function getSimAuthentication(slotId: number, authType: AuthType, authData: string): Promise; /** * Defines the carrier configuration. diff --git a/api/@ohos.usbManager.d.ts b/api/@ohos.usbManager.d.ts index 7f1460830e23c27f9a09d27cfa54737a4548ea8e..95bdda346f9de7692e6ce1c203a1f7a2258fc28e 100644 --- a/api/@ohos.usbManager.d.ts +++ b/api/@ohos.usbManager.d.ts @@ -18,7 +18,7 @@ * @kit BasicServicesKit */ -import { AsyncCallback } from '@kit.BasicServicesKit'; +import { AsyncCallback } from './@ohos.base'; /** * This module provides the capability of manage USB device. @@ -1620,7 +1620,7 @@ declare namespace usbManager { * @typedef USBControlParams * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.usbManager/usbManager#USBDeviceRequestParams */ interface USBControlParams { @@ -1630,7 +1630,7 @@ declare namespace usbManager { * @type { number } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ request: number; @@ -1640,7 +1640,7 @@ declare namespace usbManager { * @type { USBRequestTargetType } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ target: USBRequestTargetType; @@ -1650,7 +1650,7 @@ declare namespace usbManager { * @type { USBControlRequestType } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ reqType: USBControlRequestType; @@ -1660,7 +1660,7 @@ declare namespace usbManager { * @type { number } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ value: number; @@ -1670,7 +1670,7 @@ declare namespace usbManager { * @type { number } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ index: number; @@ -1680,7 +1680,7 @@ declare namespace usbManager { * @type { Uint8Array } * @syscap SystemCapability.USB.USBManager * @since 9 - * @deprecated since 16 + * @deprecated since 18 */ data: Uint8Array; } @@ -2338,9 +2338,6 @@ declare namespace usbManager { * * @param { transfer } As a generic USB data transfer interface. The Client populates this interface and * submits it in order to request a transfer - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1.Mandatory parameters are left unspecified. - *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14400001 - Access right denied. Call requestRight to get the USBDevicePipe access right first. * @throws { BusinessError } 14400007 - Resource busy. @@ -2356,9 +2353,6 @@ declare namespace usbManager { * Cancel USB data transfer. * * @param { transfer } Cancel the target transfer - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1.Mandatory parameters are left unspecified. - *
2.Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 14400001 - Access right denied. Call requestRight to get the USBDevicePipe access right first. * @throws { BusinessError } 14400008 - No such device (it may have been disconnected). diff --git a/api/@ohos.usbManager.serial.d.ts b/api/@ohos.usbManager.serial.d.ts deleted file mode 100644 index 6cfe5b88cb71f21a6d5ab13933f478af9838c4ae..0000000000000000000000000000000000000000 --- a/api/@ohos.usbManager.serial.d.ts +++ /dev/null @@ -1,615 +0,0 @@ -/* - * Copyright (c) 2025 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 BasicServicesKit - */ - -/** - * Provides APIs for managing USB-to-virtual serial ports and implementing USB-to-virtual serial port communication. - * @namespace serialManager - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ -declare namespace serialManager { - - /** - * Obtains the serial port device list. - * @returns { Readonly[]} Returns the list of serial port devices obtained. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function getPortList(): Readonly[]; - - /** - * Checks whether a serial port device has the access right. The system applications have the access right by default. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @returns {boolean} Returns true if the device has the right; returns false otherwise. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 14400005 Database operation exception. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function hasSerialRight(portId: number): boolean; - - /** - * Requests the right for accessing a serial port device from the user. The system applications do not need to call this API. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @returns { Promise} Promise used to return the result. The value true means the user allows the access; the value false means the opposite. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 14400005 Database operation exception. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function requestSerialRight(portId: number): Promise; - - /** - * Adds the access right for a serial port device. - * @permission ohos.permission.MANAGE_USB_CONFIG - * @param { number } tokenId Token ID of the target application. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @throws { BusinessError } 201 Permission verification failed. The application does not have the permission required to call the API. - * @throws { BusinessError } 202 Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 14400005 Database operation exception. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @syscap SystemCapability.USB.USBManager.Serial - * @systemapi - * @since 18 - */ - function addSerialRight(tokenId: number, portId: number): void; - - /** - * Cancels the access right for a serial port device. This API will not cancel the default access right of system applications. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 14400005 Database operation exception. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400002 Access denied. Call requestSerialRight to request user authorization first. - * @throws { BusinessError } 31400003 Device does not exist. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function cancelSerialRight(portId: number): void; - - /** - * Opens a serial port device. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400002 Access denied. Call requestSerialRight to request user authorization first. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400004 The serial port device is occupied. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function open(portId: number): void; - - /** - * Closes a serial port device. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function close(portId: number): void; - - /** - * Obtains the communication parameters of a serial port device. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @returns { Readonly} Communication parameters obtained, which are read-only. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function getAttribute(portId: number): Readonly; - - /** - * Sets the communication parameters for a serial port device. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @param { SerialAttribute} attribute Communication parameters to set. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function setAttribute(portId: number, attribute: SerialAttribute): void; - - /** - * Reads data from a serial port device. This API uses a promise to return the result. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @param { Uint8Array } buffer Buffer for storing the data read, with a maximum length of 8192 bytes. - * @param { number } timeout Timeout duration for reading data. The value is a non-negative number. The default value 0 indicates that there is no time limit for data reading. - * @returns { Promise } Promise used to return the length of the data read. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @throws { BusinessError } 31400006 Data transfer timed out. - * @throws { BusinessError } 31400007 I/O exception. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function read(portId: number, buffer: Uint8Array, timeout?: number): Promise; - - /** - * Reads data from a serial port device. This API returns the result synchronously. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @param { Uint8Array } buffer Buffer for storing the data read, with a maximum length of 8192 bytes. - * @param { number } timeout Timeout duration for reading data. The value is a non-negative number. The default value 0 indicates that there is no time limit for data reading. - * @returns {number} Length of the data read. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @throws { BusinessError } 31400006 Data transfer timed out. - * @throws { BusinessError } 31400007 I/O exception. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function readSync(portId: number, buffer: Uint8Array, timeout?: number): number; - - /** - * Writes data to a serial port device. This API uses a promise to return the result. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @param { Uint8Array } buffer Buffer for storing the data written, with a maximum length of 128 KB. - * @param { number } timeout Timeout duration for writing data. The value is a non-negative number. The default value 0 indicates that there is no time limit for data writing. - * @returns { Promise } Promise used to return the length of the data written. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @throws { BusinessError } 31400006 Data transfer timed out. - * @throws { BusinessError } 31400007 I/O exception. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function write(portId: number, buffer: Uint8Array, timeout?: number): Promise; - - /** - * Writes data to a serial port device. This API returns the result synchronously. - * @param { number} portId ID of the target device. For details, see SerialPort.portId. - * @param { Uint8Array } buffer Buffer for storing the data written, with a maximum length of 128 KB. - * @param { number } timeout Timeout duration for writing data. The value is a non-negative number. The default value 0 indicates that there is no time limit for data writing. - * @returns { number } Length of the data written. - * @throws { BusinessError } 401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 31400001 Serial port management exception. - * @throws { BusinessError } 31400003 Device does not exist. - * @throws { BusinessError } 31400005 The serial port device is not opened. Call the open API first. - * @throws { BusinessError } 31400006 Data transfer timed out. - * @throws { BusinessError } 31400007 I/O exception. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - function writeSync(portId: number, buffer: Uint8Array, timeout?: number): number; - - /** - * Represents a serial port device. - * @typedef SerialPort - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - interface SerialPort { - - /** - * Serial port device ID. - * @type { number } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - portId: number; - - /** - * Serial port device name. - * @type { string } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - deviceName: string; - } - /** - * Represents the communication parameters of a serial port device. - * @typedef SerialAttribute - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - interface SerialAttribute { - - /** - * Baud rate. - * @type { BaudRates } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - baudRate: BaudRates; - - /** - * Data bits. - * @type { DataBits } - * @default DATABIT_8 - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - dataBits?: DataBits; - - /** - * Parity bit. - * @type { Parity } - * @default NONE - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - parity?: Parity; - - /** - * Stop bits. - * @type { StopBits } - * @default STOPBIT_1 - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - stopBits?: StopBits; - } - /** - * Enumerates the baud rates of a serial port device, in bit/s. - * @enum { number } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - enum BaudRates { - - /** - * The baud rate is 50 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_50 = 50, - - /** - * The baud rate is 75 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_75 = 75, - - /** - * The baud rate is 110 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_110 = 110, - - /** - * The baud rate is 134 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_134 = 134, - - /** - * The baud rate is 150 bit/s. - * - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_150 = 150, - - /** - * The baud rate is 200 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_200 = 200, - - /** - * The baud rate is 300 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_300 = 300, - - /** - * The baud rate is 600 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_600 = 600, - - /** - * The baud rate is 1200 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_1200 = 1200, - - /** - * The baud rate is 1800 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_1800 = 1800, - - /** - * The baud rate is 2400 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_2400 = 2400, - - /** - * The baud rate is 4800 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_4800 = 4800, - - /** - * The baud rate is 9600 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_9600 = 9600, - - /** - * The baud rate is 19200 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_19200 = 19200, - - /** - * The baud rate is 38400 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_38400 = 38400, - - /** - * The baud rate is 57600 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_57600 = 57600, - - /** - * The baud rate is 115200 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_115200 = 115200, - - /** - * The baud rate is 230400 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_230400 = 230400, - - /** - * The baud rate is 460800 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_460800 = 460800, - - /** - * The baud rate is 500000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_500000 = 500000, - - /** - * The baud rate is 576000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_576000 = 576000, - - /** - * The baud rate is 921600 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_921600 = 921600, - - /** - * The baud rate is 1000000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_1000000 = 1000000, - - /** - * The baud rate is 1152000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_1152000 = 1152000, - - /** - * The baud rate is 1500000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_1500000 = 1500000, - - /** - * The baud rate is 2000000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_2000000 = 2000000, - - /** - * The baud rate is 2500000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_2500000 = 2500000, - - /** - * The baud rate is 3000000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_3000000 = 3000000, - - /** - * The baud rate is 3500000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_3500000 = 3500000, - - /** - * The baud rate is 4000000 bit/s. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - BAUDRATE_4000000 = 4000000 - } - /** - * Enumerates the data bits of a serial port device. - * @enum { number } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - enum DataBits { - - /** - * The number of data bits is 8. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - DATABIT_8 = 8, - - /** - * The number of data bits is 7. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - DATABIT_7 = 7, - - /** - * The number of data bits is 6. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - DATABIT_6 = 6, - - /** - * The number of data bits is 5. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - DATABIT_5 = 5, - - /** - * The number of data bits is 4. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - DATABIT_4 = 4 - } - /** - * Enumerates the parity bits of a serial port device. - * @enum { number } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - enum Parity { - - /** - * No parity. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - PARITY_NONE = 0, - - /** - * Odd parity. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - PARITY_ODD = 1, - - /** - * Even parity. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - PARITY_EVEN = 2, - - /** - * Mark parity, whose parity bit is always 1. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - PARITY_MARK = 3, - - /** - * Space parity, whose parity bit is always 0. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - PARITY_SPACE = 4 - } - /** - * Enumerates the stop bits for serial port communication. - * @enum { number } - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - enum StopBits { - - /** - * The number of stop bits is 1. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - STOPBIT_1 = 0, - - /** - * The number of stop bits is 1.5. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - STOPBIT_1P5 = 1, - - /** - * The number of stop bits is 2. - * @syscap SystemCapability.USB.USBManager.Serial - * @since 18 - */ - STOPBIT_2 = 2 - } -} - -export default serialManager; \ No newline at end of file diff --git a/api/@ohos.vibrator.d.ts b/api/@ohos.vibrator.d.ts index 8d08f4fea85f37558125120ac60086b5bf1e5889..4c7fedbbeafac91ccc9cfe3e25e4d0e0bd7b658c 100644 --- a/api/@ohos.vibrator.d.ts +++ b/api/@ohos.vibrator.d.ts @@ -943,7 +943,8 @@ declare namespace vibrator { * @param { number } duration The duration of the long-term vibration event * @param { ContinuousParam } options Optional parameter object * @returns { VibratorPatternBuilder } Return the current VibratorPatternBuilder object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 18 */ @@ -955,7 +956,8 @@ declare namespace vibrator { * @param { number } time Relative starting time of short oscillation events. * @param { TransientParam } options Optional parameter object * @returns { VibratorPatternBuilder } Return the current VibratorPatternBuilder object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Sensors.MiscDevice * @since 18 */ diff --git a/api/@ohos.web.webview.d.ts b/api/@ohos.web.webview.d.ts index ccf452830c3e7a2e6a529214eb0d4bbed1acfed0..83e8def08827d9910462713bfe22188e7a642db1 100644 --- a/api/@ohos.web.webview.d.ts +++ b/api/@ohos.web.webview.d.ts @@ -711,7 +711,7 @@ declare namespace webview { scale?: number; /** - * Whether background should be printed when creating pdf. + * Whether background should be printed when creating pdf. * * @type { ?boolean } * @syscap SystemCapability.Web.Webview.Core @@ -3893,7 +3893,7 @@ declare namespace webview { * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.web.webview.WebviewController#getLastHitTest */ getHitTest(): WebHitTestType; @@ -4085,7 +4085,7 @@ declare namespace webview { * @syscap SystemCapability.Web.Webview.Core * @atomicservice * @since 11 - * @deprecated since 16 + * @deprecated since 18 * @useinstead ohos.web.webview.WebviewController#getLastHitTest */ getHitTestValue(): HitTestValue; @@ -4671,11 +4671,15 @@ declare namespace webview { runJavaScriptExt(script: string | ArrayBuffer, callback: AsyncCallback): void; /** - * Execute createPdf code in the context of the currently displayed page and return the result. + * Rendering current Web page into Pdf data, return the result in async mode. * - * @param { PdfConfiguration } configuration - createPdf configuration. + * @param { PdfConfiguration } configuration - configuration for createPdf, + * including page width and height, etc. + * {@Link PdfConfiguration} * @param { AsyncCallback } callback - Callbacks execute createPdf results. - * @throws { BusinessError } 401 - Invalid input parameter. + * PdfData is pdf data stream of current web page in Uint8Array + * {@Link PdfData}. + * @throws { BusinessError } 401 - Invalid input parameter. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. * @syscap SystemCapability.Web.Webview.Core @@ -4685,13 +4689,16 @@ declare namespace webview { createPdf(configuration: PdfConfiguration, callback: AsyncCallback): void; /** - * Execute createPdf code in the context of the currently displayed page and return the result. + * Rendering current Web page into Pdf data, return the result in promise mode. * - * @param { PdfConfiguration } configuration - createPdf configuration. - * @returns { Promise } A promise is solved after the createPdf is executed. - * This parameter will be the result of createPdf execution. - * If the createPdf fails to execute or has no return value, - * a none type value will be returned. + * @param { PdfConfiguration } configuration - configuration for createPdf, + * including page width and height, etc. + * {@Link PdfConfiguration} + * @returns { Promise } The promise returned by the function. + * PdfData is pdf data stream of current web page in Uint8Array + * {@Link PdfData}. + * If createPdf fails or no return value, + * a none type value will be returned. * @throws { BusinessError } 401 - Invalid input parameter. * @throws { BusinessError } 17100001 - Init error. * The WebviewController must be associated with a Web component. @@ -5674,6 +5681,19 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Enable the ability to use Intelligent Tracking Prevention; default is disabled. + * + * @param { boolean } enable {@code true} enable Intelligent Tracking Prevention; {@code false} otherwise. + * @throws { BusinessError } 17100001 - Init error. + * The WebviewController must be associated with a Web component. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ enableIntelligentTrackingPrevention(enable: boolean): void; /** @@ -5686,6 +5706,17 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Get whether Intelligent Tracking Prevention is enabled. + * + * @returns { boolean } True if enable the Intelligent Tracking Prevention; else false. + * @throws { BusinessError } 17100001 - Init error. + * The WebviewController must be associated with a Web component. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ isIntelligentTrackingPreventionEnabled(): boolean; /** @@ -5698,6 +5729,17 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Add bypassing hosts for Intelligent Tracking Prevention. + * + * @param { Array } hostList - Hosts that bypass the Intelligent Tracking Prevention. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static addIntelligentTrackingPreventionBypassingList(hostList: Array): void; /** @@ -5710,6 +5752,17 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Remove bypassing hosts for Intelligent Tracking Prevention. + * + * @param { Array } hostList - Hosts needs to remove from bypass list. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static removeIntelligentTrackingPreventionBypassingList(hostList: Array): void; /** @@ -5719,6 +5772,14 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Clear bypassing hosts for Intelligent Tracking Prevention. + * + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static clearIntelligentTrackingPreventionBypassingList(): void; /** @@ -5908,6 +5969,19 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Enable the ability to block Ads, disabled by default. + * + * @param { boolean } enable {@code true} Enable Ads block; {@code false} otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Parameter string is too long. 3.Parameter verification failed. + * @throws { BusinessError } 17100001 - Init error. + * The WebviewController must be associated with a Web component. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ enableAdsBlock(enable: boolean): void; /** @@ -5918,6 +5992,15 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Get whether Ads block is enabled. + * + * @returns { boolean } True if the ability of AdsBlock is enabled; else false. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ isAdsBlockEnabled(): boolean; /** @@ -5928,6 +6011,15 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Get whether Ads block is enabled for current Webpage. + * + * @returns { boolean } True if the ability of AdsBlock is enabled for current Webpage; else false. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ isAdsBlockEnabledForCurPage(): boolean; /** @@ -6011,7 +6103,7 @@ declare namespace webview { setBackForwardCacheOptions(options: BackForwardCacheOptions): void; /** - * Get the scroll offset of the webpage in view port, the coordinates of the top left corner of the view port are X: 0, Y: 0. + * Get the scroll offset of the webpage in view port, the coordinates of the top left corner of the view port are X: 0, Y: 0. * And the unit is virtual pixel. * * @returns { ScrollOffset } scroll offset @@ -8219,6 +8311,17 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * set Ads Block ruleset file, containing easylist rules. + * @param {string} rulesFile - absolute file path contains app customized ads block rules. + * @param {boolean} replace - (@code true)replace internal rules;(@code false) add to internal rules. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static setAdsBlockRules(rulesFile: string, replace: boolean): void; /** @@ -8231,6 +8334,17 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Add items to Ads Block Disallow list. + * @param { Array } domainSuffixes - list of domain suffix, if web page url matches someone in the list, + * Ads Block will be disallowed for the web page. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static addAdsBlockDisallowedList(domainSuffixes: Array): void; /** @@ -8246,6 +8360,20 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * Add items to Ads Block Allow list. + * By default, ads block is allowed for all pages unless they are added to the + * disallow list. The priority of allowlist is higher than the disallowlist. It is + * used to re-enable ads block on the page that matches disallow list. + * @param { Array } domainSuffixes - list of domain suffix, if web page url matches someone in the list, + * Ads Block will be allowed for the web page. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static addAdsBlockAllowedList(domainSuffixes: Array): void; /** @@ -8257,6 +8385,16 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * remove items from Ads Block Disallowed list. + * @param { Array } domainSuffixes - list of domain suffix needed be removed from disallow list + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static removeAdsBlockDisallowedList(domainSuffixes: Array): void; /** @@ -8268,6 +8406,16 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * remove items from Ads Block Allowed list. + * @param { Array } domainSuffixes - list of domain suffix needed be removed from allow list + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static removeAdsBlockAllowedList(domainSuffixes: Array): void; /** @@ -8276,6 +8424,13 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * clear Ads Block Disallowed list. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static clearAdsBlockDisallowedList(): void; /** @@ -8284,12 +8439,19 @@ declare namespace webview { * @atomicservice * @since 12 */ + /** + * clear Ads Block Allowed list. + * @throws { BusinessError } 801 - Capability not supported. + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 18 + */ static clearAdsBlockAllowedList(): void; } /** * This class is used to enable back forward cache supported features. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 12 */ @@ -8323,7 +8485,7 @@ declare namespace webview { /** * This class is used to set back forward cache options. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 12 */ @@ -8383,7 +8545,7 @@ declare namespace webview { } /** * The ProxyConfig used by applyProxyOverride. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 15 */ @@ -8392,7 +8554,7 @@ declare namespace webview { * Insert a bypass rule that indicates URLs that should skip the override proxy and connect the server directly instead. * These maybe URLs or IP addresses and wildcards are supported. e.g. "*.example.com" means that requests to * "https://www.example.com" and "http://test.example.com" will connect the server directly. - * + * * @param { string } bypassRule - The bypass rule. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -8402,7 +8564,7 @@ declare namespace webview { insertBypassRule(bypassRule: string): void; /** * Insert a proxy rule that indicates URLs that match the schemeFilter will connect the server directly. - * + * * @param { ProxySchemeFilter } schemeFilter - The scheme filter for this rule. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -8413,11 +8575,11 @@ declare namespace webview { /** * Insert a proxy rule which indicates that requests matching the schemeFilter should use an override proxy, all requests will * use the proxy rule if schemeFilter is null. - * + * * The format for proxy is [scheme://]host[:port]. Scheme is optional and must be HTTP, HTTPS, or SOCKS if present. Scheme defaults to HTTP. * Host is an IPv6 literal with brackets, an IPv4 literal or one or more labels seperated by a period. Port number is optional and defaults * to 80 for HTTP, 443 for HTTPS and 1080 for SOCKS. - * + * * e.g. example.com host: example.com * https://example.com scheme: https host: example.com * example.com:8888 host: example.com port: 8888 @@ -8425,7 +8587,7 @@ declare namespace webview { * 192.168.1.1 host: 192.168.1.1 * 192.168.1.1:8888 host:192.168.1.1 port: 8888 * [10:20:30:40:50:60:70:80] - * + * * @param { string } proxyRule - The proxy rule. * @param { ProxySchemeFilter } schemeFilter - The scheme filter for this rule. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -8437,7 +8599,7 @@ declare namespace webview { /** * Hostnames without a period in them (and that are not IP literals) will skip the proxy and connect the server directly. * Examples: "abc", "local", "some-domain". - * + * * @syscap SystemCapability.Web.Webview.Core * @since 15 */ @@ -8446,17 +8608,17 @@ declare namespace webview { * By default, certain hostnames implicitly bypass the proxy if they are link-local IPs, or localhost addresses. For instance * hostnames matching any of (non-exhaustive list): localhost *.localhost [::1] 127.0.0.1/8 169.254/16 [FE80::]/10 * Call this function to override the default behavior and force localhost and link-local URLs to be sent through the proxy. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 15 */ clearImplicitRules(): void; /** * Reverse the bypass rules. - * + * * If false all URLs will use proxy settings except URLs match the bypass rules. * If true only URLs in the bypass list will use proxy, and all other URLs will be connected to directly. - * + * * @param { boolean } reverse - If reverse the bypass rule. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -8466,7 +8628,7 @@ declare namespace webview { enableReverseBypass(reverse: boolean): void; /** * Returns the bypass rules. - * + * * @returns { Array } The bypass rules. * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8474,7 +8636,7 @@ declare namespace webview { getBypassRules(): Array; /** * Returns the proxy rules. - * + * * @returns { Array } The proxy rules. * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8482,7 +8644,7 @@ declare namespace webview { getProxyRules(): Array; /** * Returns if reverse bypass rules. - * + * * @returns { boolean } If reverse bypass enabled. * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8492,14 +8654,14 @@ declare namespace webview { /** * The ProxyRule used by insertProxyRule. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 15 */ class ProxyRule { /** * Returns the scheme filter used for this rule. - * + * * @returns { ProxySchemeFilter } The scheme filter used for this rule. * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8507,7 +8669,7 @@ declare namespace webview { getSchemeFilter(): ProxySchemeFilter; /** * Returns the proxy URL. - * + * * @returns { string } The proxy URL. * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8517,7 +8679,7 @@ declare namespace webview { /** * The callback for proxy changed. - * + * * @typedef { function } * @syscap SystemCapability.Web.Webview.Core * @since 15 @@ -8526,7 +8688,7 @@ declare namespace webview { /** * This class is used for set proxy for ArkWeb. - * + * * @syscap SystemCapability.Web.Webview.Core * @since 15 */ @@ -8536,7 +8698,7 @@ declare namespace webview { * Instead, the request will use the proxy specified by the config. Requests are not guaranteed to use the new proxy immediately; wait for * the listener before loading a page. This listener will be called on the UI thread. * Note: calling applyProxyOverride will cause any existing system wide setting to be ignored. - * + * * @param { ProxyConfig } proxyConfig - The proxy config. * @param { OnProxyConfigChangeCallback } callback - Called when the proxy has been changed. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -8548,7 +8710,7 @@ declare namespace webview { /** * Remove the proxy config. Requests are not guaranteed to not use the proxy; Wait for the listener before loading a page. This listener * will be called on the UI thread. - * + * * @param { OnProxyConfigChangeCallback } callback - Called when the proxy has been changed. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. diff --git a/api/@ohos.wifiManager.d.ts b/api/@ohos.wifiManager.d.ts index 2ad2ab1b8ea29030df9313e49ba0eee1b43b2b05..c46eccd980cd017b6ee0035df0f7b35e9b9559ea 100644 --- a/api/@ohos.wifiManager.d.ts +++ b/api/@ohos.wifiManager.d.ts @@ -839,7 +839,7 @@ declare namespace wifiManager { * @throws {BusinessError} 2501001 - Wi-Fi STA disabled. * @syscap SystemCapability.Communication.WiFi.STA * @systemapi Hide this for inner system use. - * @since 18 + * @since 17 */ function allowAutoConnect(netId: number, isAllowed: boolean): void; @@ -2927,7 +2927,7 @@ declare namespace wifiManager { * @type { ?boolean } * @syscap SystemCapability.Communication.WiFi.STA * @systemapi Hide this for inner system use. - * @since 18 + * @since 17 */ isAutoConnectAllowed?: boolean; } diff --git a/api/@ohos.window.d.ts b/api/@ohos.window.d.ts index 29c982ed24ef14548359e7be5736d4794ff92a22..85b9c7702974930da08b04b3fe20633637204f23 100644 --- a/api/@ohos.window.d.ts +++ b/api/@ohos.window.d.ts @@ -326,9 +326,16 @@ declare namespace window { * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly - * @since 16 + * @since 17 */ - TYPE_FLOAT_NAVIGATION + TYPE_FLOAT_NAVIGATION, + /** + * Main. + * + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 18 + */ + TYPE_MAIN = 32 } /** @@ -1262,6 +1269,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * The info of window + * + * @interface WindowInfo + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ interface WindowInfo { /** * The position and size of the window @@ -1271,6 +1285,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * The position and size of the window + * + * @type { Rect } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ rect: Rect; /** @@ -1281,6 +1302,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * bundleName of window + * + * @type { string } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ bundleName: string; /** @@ -1291,6 +1319,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * abilityName of window + * + * @type { string } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ abilityName: string; /** @@ -1301,6 +1336,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * Indicates target window id. + * + * @type { number } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ windowId: number; /** @@ -1311,6 +1353,13 @@ declare namespace window { * @systemapi * @since 12 */ + /** + * The window status of an application. + * + * @type { WindowStatusType } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ windowStatusType: WindowStatusType; /** @@ -1321,6 +1370,13 @@ declare namespace window { * @systemapi * @since 14 */ + /** + * Whether the window is focused. The default value is false. + * + * @type { ?boolean } + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ isFocused?: boolean; } @@ -2489,6 +2545,26 @@ declare namespace window { * @atomicservice * @since 12 */ + /** + * Create a window with a specific configuration + * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required + * + * @permission ohos.permission.SYSTEM_FLOAT_WINDOW + * @param { Configuration } config - Parameters for window creation. + * @param { AsyncCallback } callback - Callback used to return the window created. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported.createWindow can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1300001 - Repeated operation. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @throws { BusinessError } 1300006 - This window context is abnormal. + * @throws { BusinessError } 1300009 - The parent window is invalid. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 17 + */ function createWindow(config: Configuration, callback: AsyncCallback): void; /** @@ -2527,6 +2603,26 @@ declare namespace window { * @atomicservice * @since 12 */ + /** + * Create a window with a specific configuration + * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required + * + * @permission ohos.permission.SYSTEM_FLOAT_WINDOW + * @param { Configuration } config - Parameters for window creation. + * @returns { Promise } Promise used to return the window created. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported.createWindow can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1300001 - Repeated operation. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. + * @throws { BusinessError } 1300006 - This window context is abnormal. + * @throws { BusinessError } 1300009 - The parent window is invalid. + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @atomicservice + * @since 17 + */ function createWindow(config: Configuration): Promise; /** @@ -3065,6 +3161,17 @@ declare namespace window { * @systemapi Hide this for inner system use. * @since 12 */ + /** + * Get info of visible windows. + * + * @permission ohos.permission.VISIBLE_WINDOW_INFO + * @returns { Promise> } - Promise that returns windowInfo list. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 801 - Capability not supported. Function getVisibleWindowInfo can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @since 18 + */ function getVisibleWindowInfo(): Promise>; /** @@ -3721,7 +3828,7 @@ declare namespace window { type SpecificSystemBar = 'status' | 'navigation' | 'navigationIndicator'; /** - * The infomation of keyboard + * The information of keyboard * * @interface KeyboardInfo * @syscap SystemCapability.Window.SessionManager @@ -3730,14 +3837,24 @@ declare namespace window { */ interface KeyboardInfo { /** - * The position and size of the keyboard + * The position and size of keyboard before animation. * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ - rect: Rect; + beginRect: Rect; + + /** + * The position and size of keyboard after animation completed. + * + * @type { Rect } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 18 + */ + endRect: Rect; } /** @@ -4409,8 +4526,9 @@ declare namespace window { * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager + * @stagemodelonly * @atomicservice - * @since 18 + * @since 17 */ setFollowParentWindowLayoutEnabled(enabled: boolean): Promise; @@ -7404,6 +7522,18 @@ declare namespace window { */ snapshot(): Promise; + /** + * Obtains snapshot of window even set the privacy mode. + * + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 801 - Capability not supported. Function snapshotIgnorePrivacy can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 18 + */ + snapshotIgnorePrivacy(): Promise; + /** * Sets opacity of window * @@ -7677,7 +7807,7 @@ declare namespace window { * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 18 + * @since 17 */ setWindowShadowRadius(radius: number): void; @@ -7724,7 +7854,7 @@ declare namespace window { * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 18 + * @since 17 */ setWindowCornerRadius(cornerRadius: number): Promise; @@ -7737,7 +7867,7 @@ declare namespace window { * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 18 + * @since 17 */ getWindowCornerRadius(): number; @@ -8538,18 +8668,6 @@ declare namespace window { */ setWindowTitleButtonVisible(isMaximizeButtonVisible: boolean, isMinimizeButtonVisible: boolean, isCloseButtonVisible?: boolean): void; - /** - * Checks whether the window title buttons is visible. - * - * @returns { boolean } - The value true means the window title buttons is visible, and false means the opposite. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - isWindowTitleButtonVisible(): boolean; - /** * Enable landscape multiWindow * @@ -8696,37 +8814,6 @@ declare namespace window { */ off(type: 'windowTitleButtonRectChange', callback?: Callback): void; - /** - * Register the callback of title buttons visible change. - * - * @param { 'windowTitleButtonVisibleChange' } type - The value is fixed at 'windowTitleButtonVisibleChange', indicating the title buttons visible change event. - * @param { Callback } callback - Callback used to return the current title buttons visibility. - * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - on(type: 'windowTitleButtonVisibleChange', callback: Callback): void; - - /** - * Unregister the callback of title buttons visible change. - * - * @param { 'windowTitleButtonVisibleChange' } type - The value is fixed at 'windowTitleButtonVisibleChange', indicating the title buttons visible change event. - * @param { Callback } callback - Callback used to return the current title buttons visibility. - * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; - * 2. Parameter verification failed. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - off(type: 'windowTitleButtonVisibleChange', callback?: Callback): void; - /** * Set the window mask of window * @@ -8863,39 +8950,6 @@ declare namespace window { */ createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise; - /** - * Set the parent window of the child window. - * - * @param { number } windowId - Indicates parent window id. - * @returns { Promise } Promise that returns no value. - * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @throws { BusinessError } 1300003 - This window manager service works abnormally. - * @throws { BusinessError } 1300004 - Unauthorized operation. - * @throws { BusinessError } 1300009 - The parent window is invaild. - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - setParentWindow(windowId: number): Promise; - - /** - * Get the parent window. - * - * @returns { Window } Parent Window. - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. - * @throws { BusinessError } 1300002 - This window state is abnormal. - * @throws { BusinessError } 1300004 - Unauthorized operation. - * @throws { BusinessError } 1300009 - The parent window is invaild. - * @syscap SystemCapability.Window.SessionManager - * @atomicservice - * @since 18 - */ - getParentWindow(): Window; - /** * Set whether the sub window supports simultaneous display on multiple screens when the parent window is dragged to move or dragged to zoom. * @@ -8910,7 +8964,7 @@ declare namespace window { * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 16 + * @since 17 */ setFollowParentMultiScreenPolicy(enabled: boolean): Promise; @@ -8932,35 +8986,36 @@ declare namespace window { setTitleAndDockHoverShown(isTitleHoverShown?: boolean, isDockHoverShown?: boolean): Promise; /** - * Set window container active and inactive color. + * Set the zlevel of current sub window. * - * @param { string } activeColor - window container color in active. - * @param { string } inactiveColor - window container color in inactive. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. + * @param { number } zLevel - the zlevel of current sub window. + * @returns { Promise } - The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. Function setSubWindowZLevel can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. + * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager - * @systemapi Hide this for inner system use. * @atomicservice - * @since 15 + * @since 18 */ - setWindowContainerColor(activeColor: string, inactiveColor: string): void; + setSubWindowZLevel(zLevel: number): Promise; /** - * Set whether window delay raise is enabled. + * Get the zlevel of current sub window. * - * @param { boolean } isEnabled - The value true means to enable window delay raise, and false means disable window delay raise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. - * @throws { BusinessError } 801 - Capability not supported.function setWindowDelayRaiseOnDrag can not work correctly due to limited device capabilities. + * @returns { number } - the zlevel of current sub window. + * @throws { BusinessError } 801 - Capability not supported. Function setSubWindowZLevel can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ - setWindowDelayRaiseOnDrag(isEnabled: boolean): void; + getSubWindowZLevel(): number; } /** @@ -9233,6 +9288,15 @@ declare namespace window { * @since 18 */ maximizeSupported?: boolean; + /** + * Indicates zlevel of subwindow + * + * @type { ?number } + * @syscap SystemCapability.Window.SessionManager + * @atomicservice + * @since 18 + */ + zLevel?: number; } /** * WindowStage @@ -9978,6 +10042,25 @@ declare namespace window { */ setWindowRectAutoSave(enabled: boolean): Promise; + /** + * Set to automatically save the window rect and whether to enable specifiedFlag. + * Through the specifiedFlag flag, the window is marked and its rect is saved. + * + * @param { boolean } enabled - Enable the window rect auto-save if true, otherwise means the opposite. + * @param { boolean } isSaveBySpecifiedFlag - Enable the specifiedFlag if true, otherwise means the opposite. + * @returns { Promise } Promise that returns no value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types. + * @throws { BusinessError } 801 - Capability not supported. Function setWindowRectAutoSave can not work correctly due to limited device capabilities. + * @throws { BusinessError } 1300002 - This window state is abnormal. + * @throws { BusinessError } 1300003 - This window manager service works abnormally. + * @syscap SystemCapability.Window.SessionManager + * @stagemodelonly + * @atomicservice + * @since 17 + */ + setWindowRectAutoSave(enabled: boolean, isSaveBySpecifiedFlag: boolean): Promise; + /** * Whether the window supports the window rect auto-save. * diff --git a/api/application/AccessibilityExtensionContext.d.ts b/api/application/AccessibilityExtensionContext.d.ts index ebf677f378fba7af002c4498fe937895c49eeac1..f9da199ed8fb75a8267bf99d920fd7295d7b6bdd 100644 --- a/api/application/AccessibilityExtensionContext.d.ts +++ b/api/application/AccessibilityExtensionContext.d.ts @@ -271,7 +271,10 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @param { number } elementId Indicates the elementId. * @returns { Promise> } * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. * @throws { BusinessError } 9300003 - No accessibility permission to perform the operation. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi diff --git a/api/application/Context.d.ts b/api/application/Context.d.ts index 740b4c574bd594dae99e4e78704c7c4f2d57375d..1dc8105b0916ee916ebfb31478db3f2c597fb718 100644 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -581,7 +581,6 @@ export default class Context extends BaseContext { * * @param { contextConstant.AreaMode } areaMode - Indicates the area mode. * @returns { Context } Returns the context with the specified area mode. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice diff --git a/api/application/ErrorObserver.d.ts b/api/application/ErrorObserver.d.ts index 6b1353396c0a0f5852e64edf688e17624bfa1995..acc0b8c036110c9b1532ea343d405c07651640d9 100644 --- a/api/application/ErrorObserver.d.ts +++ b/api/application/ErrorObserver.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2025 Huawei Device Co., Ltd. + * Copyright (c) 2022-2023 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"), * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -31,14 +31,6 @@ * @atomicservice * @since 11 */ -/** - * The observer will be called by system when an error occurs. - * - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export default class ErrorObserver { /** * Will be called when the js runtime throws an exception which doesn't caught by user. @@ -55,15 +47,6 @@ export default class ErrorObserver { * @atomicservice * @since 11 */ - /** - * Will be called when the js runtime throws an exception which doesn't caught by user. - * - * @param { string } errMsg - the message and error stacktrace about the exception. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ onUnhandledException(errMsg: string): void; /** diff --git a/api/application/UIAbilityContext.d.ts b/api/application/UIAbilityContext.d.ts index c13231a61dc99c1f2e8e34e486daa34d1a47db14..29ab32ce6397112a99eddc994b289772ef3666f5 100644 --- a/api/application/UIAbilityContext.d.ts +++ b/api/application/UIAbilityContext.d.ts @@ -4781,11 +4781,27 @@ export default class UIAbilityContext extends Context { */ setAbilityInstanceInfo(label: string, icon: image.PixelMap): Promise; + /** + * Revoke delegator. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 801 - Capability not support. + * @throws { BusinessError } 16000011 - The context does not exist. + * @throws { BusinessError } 16000050 - Internal error. + + * @throws { BusinessError } 16000065 - The API can be called only when the ability is running in the foreground. + * @throws { BusinessError } 16000084 - Only allow DelegatorAbility to call the method once. + * @throws { BusinessError } 16000085 - The interaction process between Ability and Window encountered an error. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @since 17 + */ + revokeDelegator(): Promise; + /** * Set colorMode of uiability. * * @param { ConfigurationConstant.ColorMode } colorMode - Color mode. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly diff --git a/api/application/UIExtensionContext.d.ts b/api/application/UIExtensionContext.d.ts index fcf3144f1a9d1b854b43dbe67d33f3cb25e3dfde..fd45b6d806a973b35b6239ea2e6ff339ed5e0aa9 100755 --- a/api/application/UIExtensionContext.d.ts +++ b/api/application/UIExtensionContext.d.ts @@ -1095,7 +1095,6 @@ export default class UIExtensionContext extends ExtensionContext { * Set colorMode of uiextension. * * @param { ConfigurationConstant.ColorMode } colorMode - Color mode. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. * @throws { BusinessError } 16000011 - The context does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly diff --git a/api/arkui/FrameNode.d.ts b/api/arkui/FrameNode.d.ts index ca0f1db0d35bd10a0725af602ac526bfff20081a..e6b6483f467b19534aa5e17e3cab091bf75056f4 100644 --- a/api/arkui/FrameNode.d.ts +++ b/api/arkui/FrameNode.d.ts @@ -1445,19 +1445,6 @@ export namespace typeNode { */ function createNode(context: UIContext, nodeType: 'XComponent', options: XComponentOptions): XComponent; - /** - * Create a FrameNode of XComponent type with options for native developing. - * - * @param { UIContext } context - uiContext used to create the FrameNode. - * @param { 'XComponent' } nodeType - node type. - * @param { NativeXComponentParameters } parameters - initialization parameters. - * @returns { XComponent } - Return XComponent type FrameNode. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 18 - */ - function createNode(context: UIContext, nodeType: 'XComponent', parameters: NativeXComponentParameters): XComponent; - /** * Define the FrameNode type for Checkbox. * diff --git a/api/arkui/NodeController.d.ts b/api/arkui/NodeController.d.ts index b2e6f94752748720e6cbf9626ec2627b8ade6cbb..a1c3a8f0911e986cda281c9d34991e43e4a47717 100644 --- a/api/arkui/NodeController.d.ts +++ b/api/arkui/NodeController.d.ts @@ -195,9 +195,9 @@ export abstract class NodeController { * @since 18 */ onWillUnbind?(containerId: number): void; - + /** - * OnBind Method. Executed when the NodeController is bound to a NodeContainer. + * OnBind Method. Executed after the NodeController is bound to a NodeContainer. * * @param { number } containerId - the uniqueId of the NodeContainer. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -208,7 +208,7 @@ export abstract class NodeController { onBind?(containerId: number): void; /** - * OnUnbind Method. Executed when the NodeController is unbind with the NodeContainer. + * OnUnbind Method. Executed after the NodeController is unbind with the NodeContainer. * * @param { number } containerId - the uniqueId of the NodeContainer. * @syscap SystemCapability.ArkUI.ArkUI.Full diff --git a/api/commonEvent/commonEventPublishData.d.ts b/api/commonEvent/commonEventPublishData.d.ts index 3b6865ac24a92c9a3f7b57cfe862cfeba9bbbd3c..7bbebde2149556cdd78ea15744f01dec5a5daed3 100644 --- a/api/commonEvent/commonEventPublishData.d.ts +++ b/api/commonEvent/commonEventPublishData.d.ts @@ -135,6 +135,7 @@ export interface CommonEventPublishData { /** * Whether the type of a common event is sticky or not. * + * @permission ohos.permission.COMMONEVENT_STICKY * @type { ?boolean } * @default false * @syscap SystemCapability.Notification.CommonEvent diff --git a/api/device-define/wearable.json b/api/device-define/wearable.json index c031fd0aabc1ba2d170bbedfecc09f11b33d75e0..455d7dbf3cd435e5260286d2356d9bad7718f7ac 100644 --- a/api/device-define/wearable.json +++ b/api/device-define/wearable.json @@ -81,7 +81,6 @@ "SystemCapability.ResourceSchedule.UsageStatistics.App", "SystemCapability.ResourceSchedule.UsageStatistics.AppGroup", "SystemCapability.PowerManager.DisplayPowerManager", - "SystemCapability.PowerManager.DisplayPowerManager.Lite", "SystemCapability.BundleManager.DistributedBundleFramework", "SystemCapability.DistributedHardware.DistributedHardwareFWK", "SystemCapability.Notification.Notification", @@ -142,7 +141,6 @@ "SystemCapability.Communication.NetStack", "SystemCapability.Account.AppAccount", "SystemCapability.Account.OsAccount", - "SystemCapability.MiscServices.Pasteboard", "SystemCapability.UserIAM.UserAuth.PinAuth", "SystemCapability.Multimedia.AudioHaptic.Core", "SystemCapability.Multimedia.Media.AVImageGenerator", diff --git a/api/global/resource.d.ts b/api/global/resource.d.ts index f40f7b0ab1f4db567f7dfd1f64a1e145029623bf..40f10e7b74fab275530a97b71a9b51172dc1d4c1 100644 --- a/api/global/resource.d.ts +++ b/api/global/resource.d.ts @@ -94,7 +94,7 @@ export interface Resource { * * @type { ?any[] } * @syscap SystemCapability.Global.ResourceManager - * @since 7 + * @since 9 */ /** * Set params. @@ -112,7 +112,7 @@ export interface Resource { * * @type { ?number } * @syscap SystemCapability.Global.ResourceManager - * @since 7 + * @since 9 */ /** * Set type. diff --git a/api/graphics3d/SceneResources.d.ts b/api/graphics3d/SceneResources.d.ts index 17579614059b5880220887ffd7aeac964e5bc1ea..6eb869132171ce7213b4b793920b3179118891c9 100644 --- a/api/graphics3d/SceneResources.d.ts +++ b/api/graphics3d/SceneResources.d.ts @@ -92,6 +92,14 @@ export enum SceneResourceType { * @since 12 */ IMAGE = 7, + + /** + * The resource is a mesh resource + * + * @syscap SystemCapability.ArkUi.Graphics3D + * @since 18 + */ + MESH_RESOURCE = 8, } /** diff --git a/api/multimedia/systemTonePlayer.d.ts b/api/multimedia/systemTonePlayer.d.ts index 11e454202473aa925a0b6acd0ce12536002c7113..960f9378ffa1db76b969625aef98856d40a14c9e 100644 --- a/api/multimedia/systemTonePlayer.d.ts +++ b/api/multimedia/systemTonePlayer.d.ts @@ -163,9 +163,6 @@ export interface SystemTonePlayer { * @param { Callback } callback - Callback used to obtain the finished event. The callback info is the stream * id that is finished. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 20700002 -Parameter check error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -178,9 +175,6 @@ export interface SystemTonePlayer { * @param { 'playFinished' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to obtain the finished event. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 20700002 -Parameter check error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -193,9 +187,6 @@ export interface SystemTonePlayer { * @param { 'error'} type - Type of the event to listen for. * @param { ErrorCallback } callback - Error callback while receiving the error event. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 20700002 -Parameter check error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi @@ -208,9 +199,6 @@ export interface SystemTonePlayer { * @param { 'error'} type - Type of the event to listen for. * @param { ErrorCallback } callback - Error callback while receiving the error event. * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. * @throws { BusinessError } 20700002 -Parameter check error. * @syscap SystemCapability.Multimedia.SystemSound.Core * @systemapi diff --git a/api/notification/notificationSubscribeInfo.d.ts b/api/notification/notificationSubscribeInfo.d.ts index 4c1e9608362f4067d60d00ae0b5e1c4da69d082b..12e41dd97db66b937affb15b894c576d2bc47d87 100644 --- a/api/notification/notificationSubscribeInfo.d.ts +++ b/api/notification/notificationSubscribeInfo.d.ts @@ -18,6 +18,8 @@ * @kit NotificationKit */ +import type notificationManager from '../@ohos.notificationManager'; + /** * Sets filter criteria of publishers for subscribing to desired notifications. * @@ -57,6 +59,16 @@ export interface NotificationSubscribeInfo { */ deviceType?: string; + /** + * Specifies the scope of notification slots for subscription. + * + * @type { ?Array } + * @syscap SystemCapability.Notification.Notification + * @systemapi + * @since 18 + */ + slotTypes?: Array; + /** * Filtered notification type range. * diff --git a/api/tag/nfctech.d.ts b/api/tag/nfctech.d.ts index 3230085c5d579abc897e9d452a5ce5ef19c04ba2..c8d7eff1e6f51c75375009172faeff5679fe41d4 100644 --- a/api/tag/nfctech.d.ts +++ b/api/tag/nfctech.d.ts @@ -310,22 +310,6 @@ export interface IsoDepTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Checks if extended apdu length supported or not. - * - * @permission ohos.permission.NFC_TAG - * @returns { Promise } Returns true if extended apdu length supported, otherwise false. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Checks if extended apdu length supported or not. * @@ -338,10 +322,9 @@ export interface IsoDepTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ isExtendedApduSupported(): Promise; @@ -493,22 +476,6 @@ export interface NdefTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Reads NDEF message on this tag. - * - * @permission ohos.permission.NFC_TAG - * @returns { Promise } The NDEF message in tag. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Reads NDEF message on this tag. * @@ -521,10 +488,9 @@ export interface NdefTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ readNdef(): Promise; @@ -575,23 +541,6 @@ export interface NdefTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Writes NDEF message into this tag. - * - * @permission ohos.permission.NFC_TAG - * @param { NdefMessage } msg - The NDEF message to be written. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Writes NDEF message into this tag. * @@ -605,10 +554,9 @@ export interface NdefTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ writeNdef(msg: NdefMessage): Promise; @@ -683,22 +631,6 @@ export interface NdefTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Sets the NDEF tag read-only. - * - * @permission ohos.permission.NFC_TAG - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Sets the NDEF tag read-only. * @@ -711,10 +643,9 @@ export interface NdefTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ setReadOnly(): Promise; @@ -811,25 +742,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Authenticates a sector with the key. Only successful authentication sector can be operated. - * - * @permission ohos.permission.NFC_TAG - * @param { number } sectorIndex - Index of sector to authenticate. - * @param { number[] } key - The key(6-bytes) to authenticate. - * @param { boolean } isKeyA - KeyA flag. true means KeyA, otherwise KeyB. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Authenticates a sector with the key. Only successful authentication sector can be operated. * @@ -845,10 +757,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise; @@ -905,23 +816,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Reads a block, one block size is 16 bytes. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of block to read. - * @returns { Promise } Returns the block data. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Reads a block, one block size is 16 bytes. * @@ -935,10 +829,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ readSingleBlock(blockIndex: number): Promise; @@ -992,24 +885,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Writes a block, one block size is 16 bytes. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of block to write. - * @param { number[] } data - The block data to write. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Writes a block, one block size is 16 bytes. * @@ -1024,10 +899,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ writeSingleBlock(blockIndex: number, data: number[]): Promise; @@ -1083,24 +957,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Increments the contents of a block, and stores the result in the internal transfer buffer. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of block to increment. - * @param { number } value - The value to increment, none-negative. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Increments the contents of a block, and stores the result in the internal transfer buffer. * @@ -1115,10 +971,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ incrementBlock(blockIndex: number, value: number): Promise; @@ -1174,24 +1029,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Decreases the contents of a block, and stores the result in the internal transfer buffer. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of block to decrease. - * @param { number } value - The value to decrease, none-negative. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Decreases the contents of a block, and stores the result in the internal transfer buffer. * @@ -1206,10 +1043,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ decrementBlock(blockIndex: number, value: number): Promise; @@ -1264,23 +1100,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Writes the contents of the internal transfer buffer to a value block. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of value block to be written. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Writes the contents of the internal transfer buffer to a value block. * @@ -1294,10 +1113,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ transferToBlock(blockIndex: number): Promise; @@ -1350,23 +1168,6 @@ export interface MifareClassicTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Moves the contents of a block into the internal transfer buffer. - * - * @permission ohos.permission.NFC_TAG - * @param { number } blockIndex - The index of value block to be moved from. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Moves the contents of a block into the internal transfer buffer. * @@ -1380,10 +1181,9 @@ export interface MifareClassicTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ restoreFromBlock(blockIndex: number): Promise; @@ -1602,23 +1402,6 @@ export interface MifareUltralightTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Reads 4 pages, total is 16 bytes. Page size is 4 bytes. - * - * @permission ohos.permission.NFC_TAG - * @param { number } pageIndex - The index of page to read. - * @returns { Promise } Returns 4 pages data. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Reads 4 pages, total is 16 bytes. Page size is 4 bytes. * @@ -1632,10 +1415,9 @@ export interface MifareUltralightTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ readMultiplePages(pageIndex: number): Promise; @@ -1689,24 +1471,6 @@ export interface MifareUltralightTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Writes a page, total 4 bytes. - * - * @permission ohos.permission.NFC_TAG - * @param { number } pageIndex - The index of page to write. - * @param { number[] } data - The page data to write. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Writes a page, total 4 bytes. * @@ -1721,10 +1485,9 @@ export interface MifareUltralightTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ writeSinglePage(pageIndex: number, data: number[]): Promise; @@ -1813,23 +1576,6 @@ export interface NdefFormatableTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Formats a tag as NDEF tag, writes NDEF message into the NDEF Tag. - * - * @permission ohos.permission.NFC_TAG - * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Formats a tag as NDEF tag, writes NDEF message into the NDEF Tag. * @@ -1843,10 +1589,9 @@ export interface NdefFormatableTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ format(message: NdefMessage): Promise; @@ -1899,23 +1644,6 @@ export interface NdefFormatableTag extends TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Formats a tag as NDEF tag, writes NDEF message into the NDEF Tag, then sets the tag readonly. - * - * @permission ohos.permission.NFC_TAG - * @param { NdefMessage } message - NDEF message to write while format. It can be null, then only format the tag. - * @returns { Promise } The void - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Formats a tag as NDEF tag, writes NDEF message into the NDEF Tag, then sets the tag readonly. * @@ -1929,10 +1657,9 @@ export interface NdefFormatableTag extends TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ formatReadOnly(message: NdefMessage): Promise; @@ -1989,7 +1716,6 @@ export interface BarcodeTag extends TagSession { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @throws { BusinessError } 3100204 - The tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 18 diff --git a/api/tag/tagSession.d.ts b/api/tag/tagSession.d.ts index 272a6d68f1dec7ec2206e4fde20a66cbc4c50463..f7f4785f2d9dfb58526c2dbc17aa937424c0cffd 100644 --- a/api/tag/tagSession.d.ts +++ b/api/tag/tagSession.d.ts @@ -283,25 +283,6 @@ export interface TagSession { * @syscap SystemCapability.Communication.NFC.Tag * @since 9 */ - /** - * Writes data to a tag. - * - * @permission ohos.permission.NFC_TAG - * @param { number[] } data Indicates the data to be written to the tag. - * @returns { Promise } Returns bytes received in response. Or bytes with a length of 0 if the - * data fails to be written to the tag. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - The parameter check failed. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 801 - Capability not supported. - * @throws { BusinessError } 3100201 - Tag running state is abnormal in service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. - * @syscap SystemCapability.Communication.NFC.Tag - * @atomicservice - * @since 12 - */ /** * Writes data to a tag. * @@ -316,11 +297,10 @@ export interface TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. - * @throws { BusinessError } 3100204 - The Tag I/O operation failed. - * @throws { BusinessError } 3100205 - The tag leaves the field. + * @throws { BusinessError } 3100204 - The tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since 12 */ transmit(data: number[]): Promise; @@ -353,7 +333,7 @@ export interface TagSession { *
3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. - * @throws { BusinessError } 3100204 - Tag I/O operation failed. + * @throws { BusinessError } 3100204 - The tag I/O operation failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice * @since 12 diff --git a/kits/@kit.AVSessionKit.d.ts b/kits/@kit.AVSessionKit.d.ts index 93753191f5c688df722bb4b4e555269de623b372..87903bfb9af6d1d5202c622f56a3f31d66458fc1 100644 --- a/kits/@kit.AVSessionKit.d.ts +++ b/kits/@kit.AVSessionKit.d.ts @@ -19,9 +19,8 @@ */ import AVCastPicker from '@ohos.multimedia.avCastPicker'; -import AVInputCastPicker from '@ohos.multimedia.avInputCastPicker'; import { AVCastPickerState, AVCastPickerStyle, AVCastPickerColorMode } from '@ohos.multimedia.avCastPickerParam'; import avSession from '@ohos.multimedia.avsession'; import MediaControlExtensionAbility from '@ohos.app.ability.MediaControlExtensionAbility'; -export { AVCastPicker, AVInputCastPicker, AVCastPickerState, AVCastPickerStyle, AVCastPickerColorMode, avSession, MediaControlExtensionAbility }; +export { AVCastPicker, AVCastPickerState, AVCastPickerStyle, AVCastPickerColorMode, avSession, MediaControlExtensionAbility }; diff --git a/kits/@kit.ArkData.d.ts b/kits/@kit.ArkData.d.ts index fb5e391298c84aabcaf4eb3946d04d6a0d056ebc..515bddb0c00516d132d61df4ae77df54b1b9b100 100644 --- a/kits/@kit.ArkData.d.ts +++ b/kits/@kit.ArkData.d.ts @@ -37,12 +37,11 @@ import { ValueType, ValuesBucket } from '@ohos.data.ValuesBucket'; import sendablePreferences from '@ohos.data.sendablePreferences'; import sendableRelationalStore from '@ohos.data.sendableRelationalStore'; import graphStore from '@ohos.data.graphStore'; -import collaborationEditObject from '@ohos.data.collaborationEditObject'; import intelligence from '@ohos.data.intelligence'; export { DataShareExtensionAbility, DataShareResultSet, DataType, ValueType, ValuesBucket, cloudData, cloudExtension, commonType, dataShare, dataSharePredicates, distributedDataObject, distributedKVStore, preferences, relationalStore, unifiedDataChannel, uniformTypeDescriptor, uniformDataStruct, sendablePreferences, dataAbility, - sendableRelationalStore, graphStore, collaborationEditObject, intelligence + sendableRelationalStore, graphStore, intelligence }; diff --git a/kits/@kit.ArkUI.d.ts b/kits/@kit.ArkUI.d.ts index c24c9a524f6c06b3dd7398b57bf95f7503eef8e1..86742c4210c33dcbf2d45610c0a0d850c2b4f9f3 100644 --- a/kits/@kit.ArkUI.d.ts +++ b/kits/@kit.ArkUI.d.ts @@ -21,7 +21,9 @@ import windowAnimationManager from '@ohos.animation.windowAnimationManager'; import Animator, { AnimatorOptions, AnimatorResult, SimpleAnimatorOptions } from '@ohos.animator'; import WindowExtensionAbility, { WindowExtensionContext } from '@ohos.application.WindowExtensionAbility'; -import { AtomicServiceNavigation, NavDestinationBuilder } from '@ohos.atomicservice.AtomicServiceNavigation'; +import { + AtomicServiceNavigation, NavDestinationBuilder, MixMode, GradientAlpha, BackgroundTheme, TitleBarType, SideBarOptions, TitleOptions, GradientBackground +} from '@ohos.atomicservice.AtomicServiceNavigation'; import { AtomicServiceSearch, InputFilterParams, @@ -98,17 +100,19 @@ import dragController from '@ohos.arkui.dragController'; import { DrawableDescriptor, LayeredDrawableDescriptor, PixelMapDrawableDescriptor, AnimationOptions, AnimatedDrawableDescriptor } from '@ohos.arkui.drawableDescriptor'; import inspector from '@ohos.arkui.inspector'; import { - NodeRenderType, RenderOptions, BuilderNode, BuildOptions, NodeController, FrameNode, DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4, Rotation, - Frame, RenderNode, XComponentNode, LengthMetrics, LengthMetricsUnit, LengthUnit, ColorMetrics, LayoutConstraint, ComponentContent, NodeContent, Content, typeNode, ShapeMask, ShapeClip, - NodeAdapter, Rect, RoundRect, edgeColors, edgeWidths, borderStyles, borderRadiuses, ExpandMode + NodeRenderType, RenderOptions, BuilderNode, BuildOptions, NodeController, FrameNode, DrawContext, Size, Offset, Position, Pivot, + Scale, Translation, Matrix4, Rotation, Frame, RenderNode, XComponentNode, LengthMetrics, ColorMetrics, LengthUnit, LengthMetricsUnit, + LayoutConstraint, ComponentContent, NodeContent, Content, typeNode, NodeAdapter, ShapeMask, ShapeClip, Rect, RoundRect, + edgeColors, edgeWidths, borderStyles, borderRadiuses, ExpandMode } from '@ohos.arkui.node'; import uiObserver from '@ohos.arkui.observer'; import performanceMonitor from '@ohos.arkui.performanceMonitor'; +import { AppStorageV2, PersistenceV2, Type, UIUtils, ConnectOptions } from '@ohos.arkui.StateManagement'; import { RectShape, CircleShape, EllipseShape, PathShape } from '@ohos.arkui.shape'; import { - AtomicServiceBar, ComponentUtils, ContextMenuController, CursorController, DragController, Font, KeyboardAvoidMode, MediaQuery, OverlayManager, PromptAction, Router, - UIContext, UIInspector, UIObserver, PageInfo, SwiperDynamicSyncScene, SwiperDynamicSyncSceneType, MarqueeDynamicSyncScene, MarqueeDynamicSyncSceneType, FrameCallback, - MeasureUtils, OverlayManagerOptions, TargetInfo + AtomicServiceBar, ComponentUtils, ContextMenuController, CursorController, DragController, Font, KeyboardAvoidMode, MediaQuery, OverlayManager, + PromptAction, Router, UIContext, UIInspector, UIObserver, PageInfo, SwiperDynamicSyncScene, SwiperDynamicSyncSceneType, MeasureUtils, FrameCallback, + OverlayManagerOptions, TargetInfo } from '@ohos.arkui.UIContext'; import curves from '@ohos.curves'; import { @@ -142,6 +146,7 @@ import SystemRouter, { BackRouterOptions, DisableAlertBeforeBackPageOptions, EnableAlertBeforeBackPageOptions, RouterOptions, RouterState } from '@system.router'; +import { ArcList, ArcListItem, ArcListAttribute, ArcListItemAttribute } from '@ohos.arkui.ArcList'; import { ArcAlphabetIndexer, ArcAlphabetIndexerAttribute } from '@ohos.arkui.ArcAlphabetIndexer'; import { ArcScrollBar, ArcScrollBarAttribute } from '@ohos.arkui.ArcScrollBar'; import { Colors, CustomColors, Theme, ThemeControl, CustomTheme } from '@ohos.arkui.theme'; @@ -155,11 +160,8 @@ import { HoverModeStatus, OnHoverStatusChangeHandler, } from '@ohos.arkui.advanced.FoldSplitContainer'; -import { AppStorageV2, PersistenceV2, Type, UIUtils, ConnectOptions } from '@ohos.arkui.StateManagement'; -import { IDataSourcePrefetching, IPrefetcher, BasicPrefetcher } from '@ohos.arkui.Prefetcher'; import uiExtension from '@ohos.arkui.uiExtension'; import { FullScreenLaunchComponent } from '@ohos.arkui.advanced.FullScreenLaunchComponent'; -import { ArcList, ArcListItem, ArcListAttribute, ArcListItemAttribute } from '@ohos.arkui.ArcList'; import { AtomicServiceTabs, TabBarOptions, TabBarPosition, TabContentBuilder, OnContentWillChangeCallback } from '@ohos.atomicservice.AtomicServiceTabs'; import { CommonModifier, ColumnModifier, ColumnSplitModifier, RowModifier, RowSplitModifier, SideBarContainerModifier, @@ -175,7 +177,8 @@ import { PolygonModifier, PolylineModifier, RectModifier, ShapeModifier, AlphabetIndexerModifier, HyperlinkModifier, MenuModifier, MenuItemModifier, PanelModifier, SymbolGlyphModifier, AttributeUpdater, ContainerSpanModifier, SymbolSpanModifier, ParticleModifier -} from "@ohos.arkui.modifier"; +} from '@ohos.arkui.modifier'; +import { IDataSourcePrefetching, IPrefetcher, BasicPrefetcher } from '@ohos.arkui.Prefetcher'; import { DownloadFileButton, DownloadLayoutDirection, @@ -191,10 +194,6 @@ import { import { SplitPolicy, MultiNavigation, MultiNavPathStack } from '@ohos.arkui.advanced.MultiNavigation'; -import { - SubHeaderV2IconType, SubHeaderV2Title, SubHeaderV2Select, - SubHeaderV2, SubHeaderV2OperationType, SubHeaderV2OperationItem, SubHeaderV2OperationItemType -} from '@ohos.arkui.advanced.SubHeaderV2'; import { ArcSlider, ArcSliderPosition, @@ -214,6 +213,10 @@ import { ArcDirection, ArcSwiperController } from '@ohos.arkui.ArcSwiper'; +import { + SubHeaderV2IconType, SubHeaderV2Title, SubHeaderV2Select, + SubHeaderV2, SubHeaderV2OperationType, SubHeaderV2OperationItem, SubHeaderV2OperationItemType +} from '@ohos.arkui.advanced.SubHeaderV2'; import { SegmentButtonV2ItemOptions, OnSelectedIndexChange, @@ -228,7 +231,7 @@ import { HalfScreenLaunchComponent } from '@ohos.atomicservice.HalfScreenLaunchC export { AtomicServiceSearch, InputFilterParams, SearchButtonParams, MenuAlignParams, SearchParams, SelectParams, OperationParams, AddFormMenuItem, AddFormOptions, AlertDialog, Animator, AnimatorOptions, AnimatorResult, SimpleAnimatorOptions, App, AppResponse, AtomicServiceBar, - AtomicServiceNavigation, NavDestinationBuilder, + AtomicServiceNavigation, NavDestinationBuilder, MixMode, GradientAlpha, BackgroundTheme, TitleBarType, SideBarOptions, TitleOptions, GradientBackground, NavPushPathHelper, BackRouterOptions, BuilderNode, Button, ButtonOptions, CallbackParam, ArcButton, ArcButtonOptions, ArcButtonPosition, ArcButtonStyleMode, @@ -248,8 +251,8 @@ export { PopupTextOptions, Position, PrefixIconOptions, ProgressButton, ProgressButtonV2, ProgressButtonV2Color, ProgressButtonV2ColorOptions, Prompt, PromptAction, PromptOptions, RectShape, RenderNode, RenderOptions, BuildOptions, RequestFullWindowOptions, Rotation, Router, RouterOptions, RouterState, Scale, ScreenOnVisibleOptions, SegmentButton, SegmentButtonItemOptionsArray, SegmentButtonOptions, SelectDialog, SelectOptions, SelectTitleBar, SelectTitleBarMenuItem, SelectionMenu, - SelectionMenuOptions, ShapeMask, ShapeClip, ShowActionMenuOptions, ShowDialogOptions, ShowDialogSuccessResponse, - ShowToastOptions, Size, SplitLayout, SubHeader, SuffixIconOptions, SwipeRefresher, SymbolOptions, SystemMediaQuery, SystemRouter, + SelectionMenuOptions, ShapeMask, ShapeClip, ShowActionMenuOptions, ShowDialogOptions, ShowDialogSuccessResponse, AppStorageV2, PersistenceV2, Type, UIUtils, + ConnectOptions, ShowToastOptions, Size, SplitLayout, SubHeader, SuffixIconOptions, SwipeRefresher, SymbolOptions, SystemMediaQuery, SystemRouter, SubHeaderV2IconType, SubHeaderV2Title, SubHeaderV2Select, SubHeaderV2, SubHeaderV2OperationType, SubHeaderV2OperationItem, SubHeaderV2OperationItemType, TabSegmentButtonConstructionOptions, TabSegmentButtonOptions, TabTitleBar, TabTitleBarMenuItem, TabTitleBarTabItem, @@ -257,19 +260,18 @@ export { ToolBarV2ItemState, ToolBarV2SymbolGlyph, ToolBarV2SymbolGlyphOptions, ToolBarV2ItemText, ToolBarV2ItemTextOptions, ToolBarV2ItemIconType, ToolBarV2ItemImage, ToolBarV2ItemImageOptions, ToolBarV2, ToolBarV2Item, ToolBarV2ItemOptions, ToolBarV2Modifier, ToolBarV2ItemAction, TreeListenerManager, TreeView, UIContext, UIInspector, UIObserver, PageInfo, WindowExtensionAbility, WindowExtensionContext, XComponentNode, - LengthMetrics, LengthMetricsUnit, LengthUnit, ColorMetrics, LayoutConstraint, ComponentContent, NodeContent, Content, componentSnapshot, componentUtils, curves, display, dragController, dragInteraction, - font, inspector, matrix4, mediaquery, performanceMonitor, pluginComponentManager, PluginComponentTemplate, prompt, promptAction, LevelMode, ImmersiveMode, LevelOrder, router, - AtomicServiceWeb, OnMessageEvent, OnErrorReceiveEvent, OnHttpErrorReceiveEvent, OnPageBeginEvent, OnPageEndEvent, + LengthMetrics, LengthUnit, ColorMetrics, LengthMetricsUnit, LayoutConstraint, ComponentContent, NodeContent, Content, + componentSnapshot, componentUtils, curves, display, dragController, dragInteraction, + font, inspector, matrix4, mediaquery, performanceMonitor, pluginComponentManager, PluginComponentTemplate, prompt, promptAction, router, + LevelMode, ImmersiveMode, LevelOrder, AtomicServiceWeb, OnMessageEvent, OnErrorReceiveEvent, OnHttpErrorReceiveEvent, OnPageBeginEvent, OnPageEndEvent, AtomicServiceWebController, OnLoadInterceptEvent, OnProgressChangeEvent, OnLoadInterceptCallback, WebHeader, screen, screenshot, uiAppearance, uiExtensionHost, uiObserver, window, windowAnimationManager, CustomContentDialog, PopoverDialog, PopoverOptions, AtomicServiceTabs, TabBarOptions, TabBarPosition, TabContentBuilder, OnContentWillChangeCallback, IconOptions, ChipItemLabelOptions, ChipGroupItemOptions, ChipItemStyle, ChipGroupSpaceOptions, IconItemOptions, IconGroupSuffix, ChipGroup, Colors, CustomColors, Theme, ThemeControl, CustomTheme, ChipSymbolGlyphOptions, ExtraRegionPosition, ExpandedRegionLayoutOptions, HoverModeRegionLayoutOptions, FoldedRegionLayoutOptions, PresetSplitRatio, FoldSplitContainer, - HoverModeStatus, OnHoverStatusChangeHandler, - AppStorageV2, PersistenceV2, Type, UIUtils, ConnectOptions, typeNode, - IDataSourcePrefetching, IPrefetcher, BasicPrefetcher, SwiperDynamicSyncScene, SwiperDynamicSyncSceneType, MarqueeDynamicSyncScene, MarqueeDynamicSyncSceneType, - uiExtension, FullScreenLaunchComponent, MeasureUtils, + HoverModeStatus, OnHoverStatusChangeHandler, SwiperDynamicSyncScene, SwiperDynamicSyncSceneType, uiExtension, FullScreenLaunchComponent, MeasureUtils, + typeNode, CommonModifier, ColumnModifier, ColumnSplitModifier, RowModifier, RowSplitModifier, SideBarContainerModifier, BlankModifier, DividerModifier, GridColModifier, GridRowModifier, NavDestinationModifier, NavigatorModifier, StackModifier, NavigationModifier, NavRouterModifier, StepperItemModifier, TabsModifier, GridModifier, @@ -282,21 +284,24 @@ export { MarqueeModifier, ProgressModifier, QRCodeModifier, TextClockModifier, TextTimerModifier, LineModifier, PathModifier, PolygonModifier, PolylineModifier, RectModifier, ShapeModifier, AlphabetIndexerModifier, FormComponentModifier, HyperlinkModifier, MenuModifier, MenuItemModifier, PanelModifier, SymbolGlyphModifier, AttributeUpdater, SymbolSpanModifier, - ContainerSpanModifier, SegmentButtonTextItem, SegmentButtonIconItem, SegmentButtonIconTextItem, DimensionNoPercentage, - CommonSegmentButtonOptions, ItemRestriction, SegmentButtonItemTuple, SegmentButtonItemArray, SegmentButtonItemOptionsConstructorOptions, SegmentButtonItemOptions, - PixelMapDrawableDescriptor, AnimationOptions, AnimatedDrawableDescriptor, NodeAdapter, DownloadFileButton, - DownloadLayoutDirection, DownloadIconStyle, DownloadDescription, DownloadContentOptions, DownloadStyleOptions, + ContainerSpanModifier, PixelMapDrawableDescriptor, AnimationOptions, AnimatedDrawableDescriptor, + IDataSourcePrefetching, IPrefetcher, BasicPrefetcher, + SegmentButtonTextItem, SegmentButtonIconItem, SegmentButtonIconTextItem, DimensionNoPercentage, + CommonSegmentButtonOptions, ItemRestriction, SegmentButtonItemTuple, SegmentButtonItemArray, + SegmentButtonItemOptionsConstructorOptions, SegmentButtonItemOptions, DownloadFileButton, + DownloadLayoutDirection, DownloadIconStyle, DownloadDescription, DownloadContentOptions, DownloadStyleOptions, NodeAdapter, Rect, RoundRect, edgeColors, edgeWidths, borderStyles, borderRadiuses, ParticleModifier, InnerFullScreenLaunchComponent, LaunchController, AccessibilitySelectedType, AccessibilityOptions, CloseOptions, ChipSuffixSymbolGlyphOptions, + SuffixImageIconOptions, SymbolItemOptions, ArcList, ArcListItem, ArcListAttribute, ArcListItemAttribute, + SplitPolicy, MultiNavigation, MultiNavPathStack, ArcAlphabetIndexer, ArcAlphabetIndexerAttribute, - SuffixImageIconOptions, SymbolItemOptions, - SplitPolicy, MultiNavigation, MultiNavPathStack, OverlayManagerOptions, - ArcList, ArcListItem, ArcListAttribute, ArcListItemAttribute, ArcScrollBar, ArcScrollBarAttribute, ArcSlider, ArcSliderOptions, ArcSliderOptionsConstructorOptions, ArcSliderLayoutOptions, ArcSliderLayoutOptionsConstructorOptions, ArcSliderStyleOptions, ArcSliderStyleOptionsConstructorOptions, - ArcSliderValueOptions, ArcSliderValueOptionsConstructorOptions, - SegmentButtonV2ItemOptions, OnSelectedIndexChange, OnSelectedIndexesChange, SegmentButtonV2Item, SegmentButtonV2Items, TabSegmentButtonV2, CapsuleSegmentButtonV2, MultiCapsuleSegmentButtonV2, + ArcSliderValueOptions, ArcSliderValueOptionsConstructorOptions, ArcScrollBar, ArcScrollBarAttribute, OverlayManagerOptions, + SegmentButtonV2ItemOptions, OnSelectedIndexChange, OnSelectedIndexesChange, SegmentButtonV2Item, SegmentButtonV2Items, + TabSegmentButtonV2, CapsuleSegmentButtonV2, MultiCapsuleSegmentButtonV2, AlertDialogV2, AdvancedDialogV2Button, AdvancedDialogV2ButtonOptions, AdvancedDialogV2ButtonAction, AdvancedDialogV2OnCheckedChange, - ConfirmDialogV2, LoadingDialogV2, SelectDialogV2, TipsDialogV2, CustomContentDialogV2, PopoverDialogV2, PopoverDialogV2OnVisibleChange, PopoverDialogV2Options, ExpandMode, + ConfirmDialogV2, LoadingDialogV2, SelectDialogV2, TipsDialogV2, CustomContentDialogV2, PopoverDialogV2, PopoverDialogV2OnVisibleChange, PopoverDialogV2Options, + ExpandMode, HalfScreenLaunchComponent, ArcSliderPosition, ArcSwiper, ArcSwiperAttribute, ArcDotIndicator, ArcDirection, ArcSwiperController, TargetInfo, }; diff --git a/kits/@kit.BasicServicesKit.d.ts b/kits/@kit.BasicServicesKit.d.ts index c5f1ca0a120b26b95274c3a4239c2100b81d08bb..d3a7efc0ff63d1f43c4d04f683324432484eef84 100644 --- a/kits/@kit.BasicServicesKit.d.ts +++ b/kits/@kit.BasicServicesKit.d.ts @@ -49,7 +49,6 @@ import thermal from '@ohos.thermal'; import update from '@ohos.update'; import usb from '@ohos.usb'; import usbManager from '@ohos.usbManager'; -import serialManager from '@ohos.usbManager.serial'; import wallpaper from '@ohos.wallpaper'; import WallpaperExtensionAbility from '@ohos.WallpaperExtensionAbility'; import zlib from '@ohos.zlib'; @@ -80,6 +79,6 @@ export { UploadResponse, WallpaperExtensionAbility, appAccount, batteryInfo, batteryStats, brightness, charger, configPolicy, customConfig, deviceAttest, deviceInfo, distributedAccount, osAccount, pasteboard, power, print, request, cacheDownload, runningLock, screenLock, settings, systemCapability, systemDateTime, systemParameter, systemParameterEnhance, systemTime, - systemTimer, thermal, update, usb, usbManager, serialManager, wallpaper, zlib, commonEventManager, emitter, StaticSubscriberExtensionAbility, + systemTimer, thermal, update, usb, usbManager, wallpaper, zlib, commonEventManager, emitter, StaticSubscriberExtensionAbility, StaticSubscriberExtensionContext, systemLoad, intelligentVoice }; diff --git a/kits/@kit.DistributedServiceKit.d.ts b/kits/@kit.DistributedServiceKit.d.ts index 92b5dda4f099991f4d2311a4395577d0a0427478..34b7199444458822f30a38824875867ced13257f 100644 --- a/kits/@kit.DistributedServiceKit.d.ts +++ b/kits/@kit.DistributedServiceKit.d.ts @@ -23,10 +23,7 @@ import distributedDeviceManager from '@ohos.distributedDeviceManager'; import deviceManager from '@ohos.distributedHardware.deviceManager'; import hardwareManager from '@ohos.distributedHardware.hardwareManager'; import abilityConnectionManager from '@ohos.distributedsched.abilityConnectionManager'; -import DistributedExtensionAbility from '@ohos.application.DistributedExtensionAbility'; -import DistributedExtensionContext from '@ohos.application.DistributedExtensionContext'; export { - cooperate, deviceManager, distributedDeviceManager, hardwareManager, abilityConnectionManager, - DistributedExtensionAbility, DistributedExtensionContext + cooperate, deviceManager, distributedDeviceManager, hardwareManager, abilityConnectionManager }; diff --git a/kits/@kit.MediaLibraryKit.d.ts b/kits/@kit.MediaLibraryKit.d.ts index ee42e38089801d91f4b24e06c9c78117da2959b6..8ed251fea60f09aa1b3a00f8f873f8320871e874 100644 --- a/kits/@kit.MediaLibraryKit.d.ts +++ b/kits/@kit.MediaLibraryKit.d.ts @@ -21,12 +21,13 @@ import photoAccessHelper from '@ohos.file.photoAccessHelper'; import sendablePhotoAccessHelper from '@ohos.file.sendablePhotoAccessHelper'; import { MovingPhotoView, MovingPhotoViewController, MovingPhotoViewAttribute } from '@ohos.multimedia.movingphotoview'; -import { AlbumPickerComponent, AlbumPickerOptions, AlbumInfo } from '@ohos.file.AlbumPickerComponent'; +import { AlbumPickerComponent, AlbumPickerOptions, AlbumInfo, EmptyAreaClickCallback } from '@ohos.file.AlbumPickerComponent'; import { PhotoPickerComponent, PickerController, PickerOptions, DataType, BaseItemInfo, ItemInfo, PhotoBrowserInfo, AnimatorParams, MaxSelected, ItemType, ClickType, PickerOrientation, - SelectMode, PickerColorMode, ReminderMode, MaxCountType, PhotoBrowserRange + SelectMode, PickerColorMode, ReminderMode, MaxCountType, PhotoBrowserRange, + PhotoBrowserUIElement, ItemsDeletedCallback, ExceedMaxSelectedCallback, CurrentAlbumDeletedCallback } from '@ohos.file.PhotoPickerComponent'; import { RecentPhotoComponent, RecentPhotoCheckResultCallback, @@ -39,7 +40,8 @@ export { DataType, BaseItemInfo, ItemInfo, PhotoBrowserInfo, AnimatorParams, MaxSelected, ItemType, ClickType, PickerOrientation, SelectMode, PickerColorMode, ReminderMode, MaxCountType, PhotoBrowserRange, - AlbumPickerComponent, AlbumPickerOptions, AlbumInfo, + AlbumPickerComponent, AlbumPickerOptions, AlbumInfo, EmptyAreaClickCallback, RecentPhotoComponent, RecentPhotoCheckResultCallback, - RecentPhotoClickCallback, RecentPhotoOptions, PhotoSource + RecentPhotoClickCallback, RecentPhotoOptions, PhotoSource, + PhotoBrowserUIElement, ItemsDeletedCallback, ExceedMaxSelectedCallback, CurrentAlbumDeletedCallback }; diff --git a/kits/@kit.MultimodalAwarenessKit.d.ts b/kits/@kit.MultimodalAwarenessKit.d.ts index 783b130d24b83be799327176b4a3523c592f49e2..7c93d8decf08d3291cd6f945f992b039dbd08d9d 100644 --- a/kits/@kit.MultimodalAwarenessKit.d.ts +++ b/kits/@kit.MultimodalAwarenessKit.d.ts @@ -20,5 +20,6 @@ import stationary from '@ohos.stationary'; import motion from '@ohos.multimodalAwareness.motion'; +import deviceStatus from '@ohos.multimodalAwareness.deviceStatus'; -export { stationary, motion }; +export { stationary, motion, deviceStatus };