From 64745745d9057d81d61baaec26a6ffd17ade6892 Mon Sep 17 00:00:00 2001 From: kukixi Date: Wed, 2 Mar 2022 19:32:45 +0800 Subject: [PATCH] add arkui api syscap Signed-off-by: kukixi Change-Id: I5994bbd6ab7d5a4c07854adcf593a35d2fcc5533 --- api/@ohos.animator.d.ts | 1 + api/@ohos.curves.d.ts | 1 + api/@ohos.matrix4.d.ts | 1 + api/@ohos.mediaquery.d.ts | 17 +++++--- api/@ohos.pluginComponent.d.ts | 2 + api/@ohos.prompt.d.ts | 1 + api/@ohos.router.d.ts | 4 ++ api/common/@internal/console.d.ts | 1 + api/common/@internal/global.d.ts | 13 ++++++ api/common/@internal/viewmodel.d.ts | 62 ++++++++++++++++++++++++++- api/common/@system.app.d.ts | 10 +++++ api/common/@system.configuration.d.ts | 6 +++ api/common/@system.mediaquery.d.ts | 10 +++++ api/common/@system.prompt.d.ts | 26 +++++++++++ api/common/@system.router.d.ts | 29 +++++++++++++ 15 files changed, 178 insertions(+), 6 deletions(-) diff --git a/api/@ohos.animator.d.ts b/api/@ohos.animator.d.ts index 2f306abcc6..6ed9e0219b 100644 --- a/api/@ohos.animator.d.ts +++ b/api/@ohos.animator.d.ts @@ -14,6 +14,7 @@ */ /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices phone, tablet, wearable, tv, car * @since 6 */ diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts index 1ffd9819ad..c4166aaf66 100644 --- a/api/@ohos.curves.d.ts +++ b/api/@ohos.curves.d.ts @@ -16,6 +16,7 @@ /** * Contains interpolator functions such as initialization, third-order Bezier curves, and spring curves. * @import import Curves from '@ohos.curves' + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices phone, tablet, tv, wearable * @since 7 */ diff --git a/api/@ohos.matrix4.d.ts b/api/@ohos.matrix4.d.ts index 635a260179..30158cb8cc 100644 --- a/api/@ohos.matrix4.d.ts +++ b/api/@ohos.matrix4.d.ts @@ -16,6 +16,7 @@ /** * Used to do matrix operations * @import import Matrix4 from '@ohos.matrix4' + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices phone, tablet, tv, wearable * @since 7 */ diff --git a/api/@ohos.mediaquery.d.ts b/api/@ohos.mediaquery.d.ts index fe889218bf..011ea459d1 100644 --- a/api/@ohos.mediaquery.d.ts +++ b/api/@ohos.mediaquery.d.ts @@ -15,6 +15,13 @@ import {Callback} from './basic'; +/** + * Used to do mediaquery operations. + * @import import mediaquery from '@ohos.mediaquery' + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @devices phone, tablet, tv, wearable + * @since 7 + */ declare namespace mediaquery { interface MediaQueryResult { @@ -22,14 +29,14 @@ declare namespace mediaquery { /** * Whether the match condition is met. * This parameter is read-only. - * @since 8 + * @since 7 */ readonly matches: boolean; /** * Matching condition of a media event. * This parameter is read-only. - * @since 8 + * @since 7 */ readonly media: string; } @@ -39,21 +46,21 @@ declare namespace mediaquery { /** * Registers a callback with the corresponding query condition by using the handle. * This callback is triggered when the media attributes change. - * @since 8 + * @since 7 */ on(type: 'change', callback: Callback): void; /** * Deregisters a callback with the corresponding query condition by using the handle. * This callback is not triggered when the media attributes chang. - * @since 8 + * @since 7 */ off(type: 'change', callback?: Callback): void; } /** * Sets the media query criteria and returns the corresponding listening handle - * @since 8 + * @since 7 */ function matchMediaSync(condition: string): MediaQueryListener; } diff --git a/api/@ohos.pluginComponent.d.ts b/api/@ohos.pluginComponent.d.ts index c73c4d7342..4e54e39500 100644 --- a/api/@ohos.pluginComponent.d.ts +++ b/api/@ohos.pluginComponent.d.ts @@ -18,6 +18,7 @@ import { Want } from './ability/want'; /** * Plugin component template property. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ interface PluginComponentTemplate { @@ -27,6 +28,7 @@ interface PluginComponentTemplate { /** * Plugin component manager interface. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ declare namespace pluginComponentManager { diff --git a/api/@ohos.prompt.d.ts b/api/@ohos.prompt.d.ts index 40dc9faa4b..0cdce80386 100644 --- a/api/@ohos.prompt.d.ts +++ b/api/@ohos.prompt.d.ts @@ -16,6 +16,7 @@ import {AsyncCallback} from './basic'; /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @import prompt from '@ohos.prompt'; */ diff --git a/api/@ohos.router.d.ts b/api/@ohos.router.d.ts index dc9fb60ca4..74a6234d48 100644 --- a/api/@ohos.router.d.ts +++ b/api/@ohos.router.d.ts @@ -16,6 +16,7 @@ import {Callback} from './basic'; /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 * @import router from '@ohos.router'; */ @@ -33,6 +34,7 @@ declare namespace router { * pages/index/index * pages/detail/detail * 2. Particular path. If the URI is a slash (/), the home page is displayed. + * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 8 */ url: string; @@ -41,6 +43,7 @@ declare namespace router { * 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.) + * @syscap SystemCapability.ArkUI.ArkUI.Lite * @since 8 */ params?: Object; @@ -54,6 +57,7 @@ declare namespace router { /** * Returns to the page of the specified path. * If the page with the specified path does not exist in the page stack, router.back() is called by default. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ path?: string; diff --git a/api/common/@internal/console.d.ts b/api/common/@internal/console.d.ts index 69aa3336d5..f1eec6e6d8 100644 --- a/api/common/@internal/console.d.ts +++ b/api/common/@internal/console.d.ts @@ -14,6 +14,7 @@ */ /** + * @syscap SystemCapability.ArkUI.ArkUI.Lite * @devices tv, phone, tablet, wearable, liteWearable, smartVision * @since 3 */ diff --git a/api/common/@internal/global.d.ts b/api/common/@internal/global.d.ts index 128c337c20..ef9c48b7fb 100644 --- a/api/common/@internal/global.d.ts +++ b/api/common/@internal/global.d.ts @@ -15,6 +15,7 @@ /** * Sets the interval for repeatedly calling a function. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @param handler Indicates the function to be called after the timer goes off. For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. For devices of "lite wearable" and "smartVision" types, this parameter must be a function. * @param delay Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. @@ -26,6 +27,7 @@ export declare function setInterval(handler: Function | string, delay: number, . /** * Sets a timer after which a function will be executed. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @param handler Indicates the function to be called after the timer goes off. For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. For devices of "lite wearable" and "smartVision" types, this parameter must be a function. * @param delay Indicates the delay (in milliseconds) after which the function will be called. If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. @@ -37,6 +39,7 @@ export declare function setTimeout(handler: Function | string, delay?: number, . /** * Cancels the interval set by " setInterval()". + * @syscap SystemCapability.ArkUI.ArkUI.Lite * @param intervalID Indicates the timer ID returned by "setInterval()". * @devices tv, phone, tablet, wearable, liteWearable, smartVision * @since 3 @@ -45,6 +48,7 @@ export declare function clearInterval(intervalID?: number): void; /** * Cancels the timer set by "setTimeout()". + * @syscap SystemCapability.ArkUI.ArkUI.Lite * @param timeoutID Indicates the timer ID returned by "setTimeout()". * @devices tv, phone, tablet, wearable, liteWearable, smartVision * @since 3 @@ -59,6 +63,7 @@ export declare function clearTimeout(timeoutID?: number): void; /** * Obtain the objects exposed in app.js + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable, smartVision * @since 6 */ @@ -66,6 +71,7 @@ export declare function getApp(): object; /** * You can create an Image object by calling new Image(). + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export declare class Image { @@ -98,6 +104,7 @@ export declare class Image { /** * An ImageData object is a common object that stores the actual pixel data of a Canvas object. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export declare class ImageData { @@ -121,6 +128,7 @@ export declare class ImageData { /** * OffscreenCanvas provides a Canvas object that can be rendered off-screen. * It works in both window and Web worker environments. + * @syscap SystemCapability.ArkUI.ArkUI.Full */ export declare class OffscreenCanvas { /** @@ -162,6 +170,9 @@ export declare class OffscreenCanvas { transferToImageBitmap(): ImageBitmap; } +/** + * @syscap SystemCapability.ArkUI.ArkUI.Full + */ export declare class ImageBitmap { /** * The height of the Image Bitmap object @@ -176,10 +187,12 @@ export declare class ImageBitmap { /** * Conditional compilation for rich equipment + * @syscap SystemCapability.ArkUI.ArkUI.Full */ export declare const STANDARD: string; /** * Conditional compilation for lite equipment + * @syscap SystemCapability.ArkUI.ArkUI.Full */ export declare const LITE: string; diff --git a/api/common/@internal/viewmodel.d.ts b/api/common/@internal/viewmodel.d.ts index 149e18bb6e..062a8d2c2a 100644 --- a/api/common/@internal/viewmodel.d.ts +++ b/api/common/@internal/viewmodel.d.ts @@ -18,6 +18,7 @@ import { WebGLContextAttributes, WebGLRenderingContext } from "../webgl/webgl"; import { WebGL2RenderingContext } from "../webgl/webgl2"; /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface FocusParamObj { @@ -28,6 +29,7 @@ export interface FocusParamObj { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface RectObj { @@ -50,6 +52,7 @@ export interface RectObj { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface ContextAttrOptions { @@ -57,6 +60,7 @@ export interface ContextAttrOptions { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface AnimateStyle { @@ -131,6 +135,7 @@ export interface AnimateStyle { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface TransformObject { @@ -302,6 +307,7 @@ export interface TransformObject { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface AnimateOptions { @@ -365,6 +371,7 @@ export interface AnimateOptions { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface AnimationResult { @@ -440,6 +447,7 @@ export interface AnimationResult { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface Element { @@ -520,6 +528,9 @@ export interface Element { setStyle(name: string, value: string): boolean } +/** + * @syscap SystemCapability.ArkUI.ArkUI.Full + */ export interface observer { /** * Turn on the listener. @@ -534,6 +545,7 @@ export interface observer { /** * animation element + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface AnimationElement extends Element { @@ -565,6 +577,7 @@ export interface AnimationElement extends Element { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface ScrollParam { @@ -588,6 +601,7 @@ export interface ScrollParam { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface CurrentOffsetResultValue { @@ -605,6 +619,7 @@ export interface CurrentOffsetResultValue { } /** + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable, liteWearable, smartVision */ export interface ListScrollToOptions { @@ -616,6 +631,7 @@ export interface ListScrollToOptions { /** * The component provides a list container. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface ListElement extends Element { @@ -703,6 +719,7 @@ export interface ListElement extends Element { /** * The component provides a swiper container. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface SwiperElement extends Element { @@ -732,6 +749,7 @@ export interface SwiperElement extends Element { /** * @devices tv, phone, tablet, wearable + * @syscap SystemCapability.ArkUI.ArkUI.Full */ export interface CameraTakePhotoOptions { /** @@ -762,7 +780,8 @@ export interface CameraTakePhotoOptions { } /** - * The component provides preview and photographing functions.. + * The component provides preview and photographing functions. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface CameraElement extends Element { @@ -776,6 +795,7 @@ export interface CameraElement extends Element { /** * The component is a container for displaying web page content. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet */ export interface WebElement extends Element { @@ -788,6 +808,7 @@ export interface WebElement extends Element { /** * The component is a custom pop-up container. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface DialogElement extends Element { @@ -805,6 +826,7 @@ export interface DialogElement extends Element { /** * The component is used to provide an image frame animator. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface ImageAnimatorElement extends Element { @@ -841,6 +863,7 @@ export interface ImageAnimatorElement extends Element { /** * The component inserts scrolling text, which is displayed in a single line by default. * When the text length exceeds the display area of the component, the marquee effect is displayed. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface MarqueeElement extends Element { @@ -859,6 +882,7 @@ export interface MarqueeElement extends Element { /** * The component provides menus as temporary pop-up windows to display operations that can be performed by users. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet */ export interface MenuElement extends Element { @@ -878,6 +902,7 @@ export interface MenuElement extends Element { /** * The component displays line charts, gauge charts, and bar charts. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface ChartElement extends Element { @@ -902,6 +927,7 @@ export interface ChartElement extends Element { /** * The component provides an interactive interface to receive user input, which is displayed in a single line by default. + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable */ export interface InputElement extends Element { @@ -930,6 +956,7 @@ export interface InputElement extends Element { /** * The