diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index c1157b0610b95cede09f2505b92b2a4131526ce8..a71d0c906707e05dbf31f16e3bc10dc48b5f9f61 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -274,12 +274,6 @@ interface DragItemInfo { extraInfo?: string; } -/** - * Defining syscap function. - * @since 8 - */ -declare function canIUse(syscap: string): boolean; - /** * Defining animation function. * @since 7 diff --git a/api/@internal/component/ets/form_component.d.ts b/api/@internal/component/ets/form_component.d.ts index 1d3fa7dfdd56e0ff2605ab27801d6f5ecee3ff10..d2a7037831dc6c041dfd56b1bd519d018af33ffd 100644 --- a/api/@internal/component/ets/form_component.d.ts +++ b/api/@internal/component/ets/form_component.d.ts @@ -132,6 +132,13 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + + /** + * Uninstall Card. + * @since 7 + * @systemapi + */ + onUninstall(callback: (info: { id: number }) => void): FormComponentAttribute; } declare const FormComponent: FormComponentInterface; diff --git a/api/@internal/component/ets/middle_class.d.ts b/api/@internal/component/ets/middle_class.d.ts index 05aaf273f822dd40c45e45467b007806db124d2d..69f31c3b81848fe95432ecf1c608e90137b451bd 100644 --- a/api/@internal/component/ets/middle_class.d.ts +++ b/api/@internal/component/ets/middle_class.d.ts @@ -601,7 +601,7 @@ declare class TSSwipeGestureInterface { pop(): SwipeGestureInterface; } -declare class PinchGestureInterface { +declare class TSPinchGestureInterface { create(value?: { fingers?: number; distance?: number; diff --git a/api/@internal/component/ets/progress.d.ts b/api/@internal/component/ets/progress.d.ts index 80a73a7da0072c02941a2d75bac9c207d707d251..5da637cf17327714a8e8f6be6087fa37276a5a75 100644 --- a/api/@internal/component/ets/progress.d.ts +++ b/api/@internal/component/ets/progress.d.ts @@ -13,6 +13,30 @@ * limitations under the License. */ +/** + * Defines style option for progress component. + * @since 8 + */ +declare interface ProgressStyleOption { + /** + * Defines the strokeWidth property. + * @since 8 + */ + strokeWidth?: Length; + + /** + * Defines the scaleCoun property. + * @since 8 + */ + scaleCount?: number; + + /** + * Defines the scaleWidth property. + * @since 8 + */ + scaleWidth?: Length; +} + /** * Type of progress bar * @since 7 @@ -83,17 +107,10 @@ declare class ProgressAttribute extends CommonMethod { color(value: ResourceColor): ProgressAttribute; /** - * Called when the style of the circular progress bar is set. - * @since 7 - */ - circularStyle(value: { strokeWidth?: Length; scaleCount?: number; scaleWidth?: Length }): ProgressAttribute; - - /** - * Called when the style of the cricular progress bar is set. - * @since 7 - * @deprecated since 7 + * Called when the style of progress bar is set. + * @since 8 */ - cricularStyle(value: { strokeWidth?: Length; scaleCount?: number; scaleWidth?: Length }): ProgressAttribute; + style(value: ProgressStyleOption): ProgressAttribute; } declare const Progress: ProgressInterface; diff --git a/api/@internal/component/ets/sidebar.d.ts b/api/@internal/component/ets/sidebar.d.ts index 083b948e47a5591ec05453c67190cad015912084..bc58cec23911a267fd124cbdb48b0314a8523107 100644 --- a/api/@internal/component/ets/sidebar.d.ts +++ b/api/@internal/component/ets/sidebar.d.ts @@ -17,7 +17,7 @@ * Sets the sidebar style of showing * @since 8 */ -declare enum SideBarContainerStyle { +declare enum SideBarContainerType { /** * The sidebar invisible * @since 8 @@ -73,9 +73,7 @@ interface SideBarContainerInterface { * Called when showing the sidebar of a block entry. * @since 8 */ - (options?: { showSideBarContainer?: boolean, - style?: SideBarContainerStyle, - buttonAttr?: ButtonStyle}): SideBarContainerAttribute; + (type?: SideBarContainerType): SideBarContainerAttribute; } /** @@ -84,6 +82,16 @@ interface SideBarContainerInterface { */ declare class SideBarContainerAttribute extends CommonMethod { + /** + * Callback showControlButton function when setting the status of sidebar + * @since 8 + */ + showSideBar(value: boolean): SideBarContainerAttribute; + /** + * Callback controlButton function when setting the style of button + * @since 8 + */ + controlButton(value: ButtonStyle): SideBarContainerAttribute; /** * Callback showControlButton function when setting the status of button * @since 8 diff --git a/api/@internal/component/ets/web.d.ts b/api/@internal/component/ets/web.d.ts index 6c34f1228cdd79bbb2cafafe49153075d5de5968..d51879cbbd4e20b6405b91d436d1bd7aac2b5a14 100755 --- a/api/@internal/component/ets/web.d.ts +++ b/api/@internal/component/ets/web.d.ts @@ -30,24 +30,24 @@ declare enum MessageLevel { Warn } -declare enum MixedModeContent { +declare enum MixedMode { /** - * MIXED_CONTENT_ALWAYS_ALLOW level. + * Allows all sources. * @since 8 */ - MIXED_CONTENT_ALWAYS_ALLOW, + ALL, /** - * MIXED_CONTENT_NEVER_ALLOW level. + * Allows sources Compatibly. * @since 8 */ - MIXED_CONTENT_NEVER_ALLOW, + Compatible, /** - * MIXED_CONTENT_COMPATIBILITY_MODE level. + * Don't allow unsecure sources from a secure origin. * @since 8 */ - MIXED_CONTENT_COMPATIBILITY_MODE, + None, } declare enum HitTestType { @@ -306,6 +306,14 @@ declare class WebController { */ onActive(): void; + /** + * Let the Web zoom by. + * @param factor The zoom factor. + * + * @since 8 + */ + zoom(factor: number): void; + /** * Clear the history in the Web. * @since 8 @@ -316,19 +324,19 @@ declare class WebController { * Means to load a piece of code and execute JS code in the context of the currently displayed page * @since 8 */ - runJavaScript(jscode: string, callback?: (result: string) => void); + runJavaScript(options: { script: string, callback?: (result: string) => void }); /** * Indicates that a piece of code is loaded * @since 8 */ - loadData(value: { data: string, mimeType: string, encoding: string, baseUrl?: string, historyUrl?: string }); + loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: string, historyUrl?: string }); /** * Load the given URL * @since 8 */ - loadUrl(url: string, additionalHttpHeaders?: Array<{ key: string, value: string }>); + loadUrl(options: {url: string, headers?: Array<{ key: string, value: string }> }); /** * refreshes the current URL. @@ -346,13 +354,13 @@ declare class WebController { * Registers the JavaScript object and method list. * @since 8 */ - registerJavaScriptProxy(value: { obj: object, name: string, methodList: Array }); + registerJavaScriptProxy(options: { obj: object, name: string, methodList: Array }); /** * Deletes a registered JavaScript object with given name. * @since 8 */ - deleteJavaScriptProxy(value: { name: string }); + deleteJavaScriptRegister(name: string); /** * Get the type of hit test. @@ -450,7 +458,7 @@ declare class WebAttribute extends CommonMethod { * Whether to load HTTP and HTTPS content * @since 8 */ - mixedMode(mixedMode: MixedModeContent): WebAttribute; + mixedMode(mixedMode: MixedMode): WebAttribute; /** * Sets whether the WebView supports zooming using on-screen controls or gestures @@ -468,7 +476,7 @@ declare class WebAttribute extends CommonMethod { * Inject the arkUI JS object into H5 and invoke the function of the object in H5. * @since 8 */ - javaScriptProxy(javaScriptProxy: { obj: object, name: string, methodList: Array }): WebAttribute; + javaScriptProxy(javaScriptProxy: { obj: object, name: string, methodList: Array, controller: WebController }): WebAttribute; /* * Sets whether the Web should save the password. @@ -526,6 +534,14 @@ declare class WebAttribute extends CommonMethod { */ databaseAccess(databaseAccess: boolean): WebAttribute; + /** + * Sets the Web's user agent. + * @param userAgent The Web's user agent. + * + * @since 8 + */ + userAgent(userAgent: string): WebAttribute; + /** * Triggered at the end of web page loading * @since 8 diff --git a/api/@internal/component/ets/xcomponent.d.ts b/api/@internal/component/ets/xcomponent.d.ts index 9cbc7cb1cd9c0f6264ff0072422e178da1e6d947..ef19b96d114155e22d49c5761d45f15a4d750540 100644 --- a/api/@internal/component/ets/xcomponent.d.ts +++ b/api/@internal/component/ets/xcomponent.d.ts @@ -32,6 +32,13 @@ declare class XComponentController { * @systemapi */ getXComponentSurfaceId(); + + /** + * get the context of native XComponent. + * @since 8 + * @systemapi + */ + getXComponentContext(); } /** diff --git a/api/@internal/ets/lifecycle.d.ts b/api/@internal/ets/lifecycle.d.ts index e93c7b285fe44b2b8e654613baf2e5b8786cfe96..18cff8475eb22d59cca76a92c7ce6d10701ef7d7 100644 --- a/api/@internal/ets/lifecycle.d.ts +++ b/api/@internal/ets/lifecycle.d.ts @@ -31,7 +31,6 @@ import { PacMap } from "../ability/dataAbilityHelper"; * * @name LifecycleForm * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleForm { @@ -39,7 +38,6 @@ export declare interface LifecycleForm { * Called to return a {@link formBindingData.FormBindingData} object. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the detailed information for creating a {@link formBindingData#FormBindingData}. * The {@code Want} object must include the form ID, form name, and grid style of the form, * which can be obtained from {@link formManager#FormParam#IDENTITY_KEY}, @@ -55,7 +53,6 @@ export declare interface LifecycleForm { * Called when the form provider is notified that a temporary form is successfully converted to a normal form. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form. * @return - * @FAModelOnly @@ -66,7 +63,6 @@ export declare interface LifecycleForm { * Called to notify the form provider to update a specified form. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form to update. * @return - * @FAModelOnly @@ -77,7 +73,6 @@ export declare interface LifecycleForm { * Called when the form provider receives form events from the system. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param newStatus Indicates the form events occurred. The key in the {@code Map} object indicates the form ID, * and the value indicates the event type, which can be either {@link formManager#VisibilityType#FORM_VISIBLE} * or {@link formManager#VisibilityType#FORM_INVISIBLE}. {@link formManager#VisibilityType#FORM_VISIBLE} @@ -93,7 +88,6 @@ export declare interface LifecycleForm { * JS forms. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form on which the message event is triggered, which is provided by * the client to the form provider. * @param message Indicates the value of the {@code params} field of the message event. This parameter is @@ -108,7 +102,6 @@ export declare interface LifecycleForm { * you want your application, as the form provider, to be notified of form deletion. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the deleted form. * @return - * @FAModelOnly @@ -122,7 +115,6 @@ export declare interface LifecycleForm { * this method returns {@link FormState#DEFAULT} by default.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the description of the form for which the {@link formManager#FormState} is obtained. * The description covers the bundle name, ability name, module name, form name, and form dimensions. * @return Returns the {@link formManager#FormState} object. @@ -136,7 +128,6 @@ export declare interface LifecycleForm { * * @name LifecycleApp * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleApp { @@ -144,7 +135,6 @@ export declare interface LifecycleApp { * Called back when the state of an ability changes from BACKGROUND to INACTIVE. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -154,7 +144,6 @@ export declare interface LifecycleApp { * Called back when an ability enters the BACKGROUND state. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -164,7 +153,6 @@ export declare interface LifecycleApp { * Called back before an ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -174,7 +162,6 @@ export declare interface LifecycleApp { * Called back when an ability is started for initialization. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -185,7 +172,6 @@ export declare interface LifecycleApp { * to multi-window mode or from multi-window mode to fullscreen mode. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param isShownInMultiWindow Specifies whether this ability is currently in multi-window mode. * The value {@code true} indicates the multi-window mode, and {@code false} indicates another mode. * @param newConfig Indicates the new configuration information about this Page ability. @@ -199,7 +185,6 @@ export declare interface LifecycleApp { * Asks a user whether to start the migration. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if the user allows the migration; returns {@code false} otherwise. * @FAModelOnly */ @@ -211,7 +196,6 @@ export declare interface LifecycleApp { * Scheduler Service requests data from the local ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param data Indicates the user data to save. * @return Returns {@code true} if the data is successfully saved; returns {@code false} otherwise. * @FAModelOnly @@ -225,7 +209,6 @@ export declare interface LifecycleApp { * notify the user of the successful migration and then exit the local ability.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param result Indicates the migration result code. The value {@code 0} indicates that the migration is * successful, and {@code -1} indicates that the migration fails. * @return - @@ -239,7 +222,6 @@ export declare interface LifecycleApp { * is restored. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param data Indicates the user data to restore. * @return - * @FAModelOnly @@ -251,7 +233,6 @@ export declare interface LifecycleApp { * migration is performed for the ability from the local device to the remote device. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -263,7 +244,6 @@ export declare interface LifecycleApp { * this method is used only to save temporary states. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param outState Indicates the {@code PacMap} object used for storing user data and states. This * parameter cannot be null. * @return - @@ -277,7 +257,6 @@ export declare interface LifecycleApp { * states. Generally, this method is called after the {@link #onStart(Want)} method. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param inState Indicates the {@code PacMap} object used for storing data and states. This * parameter can not be null. * @return - @@ -290,7 +269,6 @@ export declare interface LifecycleApp { * change to the BACKGROUND or ACTIVE state). * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -300,7 +278,6 @@ export declare interface LifecycleApp { * Called back when an ability enters the ACTIVE state. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -310,7 +287,6 @@ export declare interface LifecycleApp { * Called when the launch mode of an ability is set to singleton. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the new {@code want} containing information about the ability. * @return - * @FAModelOnly @@ -322,7 +298,6 @@ export declare interface LifecycleApp { * background and there is no enough memory for running as many background processes as possible. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param level Indicates the memory trim level, which shows the current memory usage status. * @return - * @FAModelOnly @@ -335,7 +310,6 @@ export declare interface LifecycleApp { * * @name LifecycleService * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleService { @@ -344,7 +318,6 @@ export declare interface LifecycleService { * an ability). * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -354,7 +327,6 @@ export declare interface LifecycleService { * Called back when Service is started. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the want of Service to start. * @param startId Indicates the number of times the Service ability has been started. The {@code startId} is * incremented by 1 every time the ability is started. For example, if the ability has been started @@ -368,7 +340,6 @@ export declare interface LifecycleService { * Called back before an ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -378,7 +349,6 @@ export declare interface LifecycleService { * Called back when a Service ability is first connected to an ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates connection information about the Service ability. * @return Returns the proxy of the Service ability. * @FAModelOnly @@ -389,7 +359,6 @@ export declare interface LifecycleService { * Called back when all abilities connected to a Service ability are disconnected. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates disconnection information about the Service ability. * @return - * @FAModelOnly @@ -404,7 +373,6 @@ export declare interface LifecycleService { * called but {@link #terminateSelf} has not.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the want of the Service ability being connected. * @return - * @FAModelOnly @@ -417,7 +385,6 @@ export declare interface LifecycleService { * * @name LifecycleData * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleData { @@ -425,7 +392,6 @@ export declare interface LifecycleData { * Updates one or more data records in the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to update. * @param valueBucket Indicates the data to update. This parameter can be null. * @param predicates Indicates filter criteria. If this parameter is null, all data records will be updated by @@ -441,7 +407,6 @@ export declare interface LifecycleData { * Queries one or more data records in the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to query. * @param columns Indicates the columns to be queried, in array, for example, {"name","age"}. You should define * the processing logic when this parameter is null. @@ -458,7 +423,6 @@ export declare interface LifecycleData { * Deletes one or more data records. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to delete. * @param predicates Indicates filter criteria. If this parameter is null, all data records will be deleted by * default. @@ -475,7 +439,6 @@ export declare interface LifecycleData { * even if the context has changed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to normalize. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. @@ -488,7 +451,6 @@ export declare interface LifecycleData { * Inserts multiple data records into the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBuckets Indicates the data to insert. * @param callback function specified by framework to receive the result, developer should call this function to @@ -503,7 +465,6 @@ export declare interface LifecycleData { * The default implementation of this method returns the original uri passed to it. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to denormalize. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. @@ -516,7 +477,6 @@ export declare interface LifecycleData { * Inserts a data record into the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBucket Indicates the data to insert. * @param callback function specified by framework to receive the result, developer should call this function to @@ -530,7 +490,6 @@ export declare interface LifecycleData { * Opens a file. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @param mode Indicates the open mode, which can be "r" for read-only access, "w" for write-only access (erasing * whatever data is currently in the file), "wt" for write access that truncates any existing file, @@ -547,7 +506,6 @@ export declare interface LifecycleData { * Obtains the MIME type of files. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the files to obtain. * @param mimeTypeFilter Indicates the MIME type of the files to obtain. This parameter cannot be set to {@code * null}. @@ -565,7 +523,6 @@ export declare interface LifecycleData { * Called to carry {@code AbilityInfo} to this ability after the ability is initialized. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param info Indicates the {@code AbilityInfo} object containing information about this ability. * @return - * @FAModelOnly @@ -579,7 +536,6 @@ export declare interface LifecycleData { *

Data abilities supports general data types, including text, HTML, and JPEG.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri of the data. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. diff --git a/api/@internal/global.d.ts b/api/@internal/global.d.ts index 03bc8cc2bc561c9b8c8cc51c0f1fff31acdb9a0e..f8a32dee04535897b8a1024318d6399f79f4304e 100644 --- a/api/@internal/global.d.ts +++ b/api/@internal/global.d.ts @@ -76,3 +76,4 @@ export declare function setTimeout(handler: Function | string, delay?: number, . export declare function clearInterval(intervalID?: number): void; export declare function clearTimeout(timeoutID?: number): void; export declare function createLocalParticleAbility(timeoutID?: number): any; +export declare function canIUse(syscap: string): boolean; diff --git a/api/@ohos.workSchedulerExtension.d.ts b/api/@ohos.WorkSchedulerExtensionAbility.d.ts similarity index 92% rename from api/@ohos.workSchedulerExtension.d.ts rename to api/@ohos.WorkSchedulerExtensionAbility.d.ts index ffecb73734b6b38751f3e7d593616aaa8bc2ba34..df30bd831e426edec007243471ac505d27209e50 100644 --- a/api/@ohos.workSchedulerExtension.d.ts +++ b/api/@ohos.WorkSchedulerExtensionAbility.d.ts @@ -16,13 +16,13 @@ import workScheduler from "./@ohos.workScheduler"; /** - * Class of the work scheduler extension. + * Class of the work scheduler extension ability. * * @since 9 * @syscap SystemCapability.ResourceSchedule.WorkScheduler * @StageModelOnly */ -export default class WorkSchedulerExtension { +export default class WorkSchedulerExtensionAbility { /** * Called back when a work is started. * diff --git a/api/@ohos.ability.dataUriUtils.d.ts b/api/@ohos.ability.dataUriUtils.d.ts index 3b978c07dd07085802a6f2f46ad3ebc2f4ba35c6..af7b6805001a1b4a9e70bf5b40afc7b81447ba2e 100644 --- a/api/@ohos.ability.dataUriUtils.d.ts +++ b/api/@ohos.ability.dataUriUtils.d.ts @@ -25,7 +25,7 @@ declare namespace dataUriUtils { * Obtains the ID attached to the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object from which the ID is to be obtained. * @return Returns the ID attached to the end of the path component; */ @@ -35,7 +35,7 @@ declare namespace dataUriUtils { * Attaches the given ID to the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri string from which the ID is to be obtained. * @param id Indicates the ID to attach. * @return Returns the uri object with the given ID attached. @@ -46,7 +46,7 @@ declare namespace dataUriUtils { * Deletes the ID from the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object from which the ID is to be deleted. * @return Returns the uri object with the ID deleted. */ @@ -56,7 +56,7 @@ declare namespace dataUriUtils { * Updates the ID in the specified uri * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object to be updated. * @param id Indicates the new ID. * @return Returns the updated uri object. diff --git a/api/@ohos.ability.errorCode.d.ts b/api/@ohos.ability.errorCode.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..155f039766c9f43e869df44ef695970b524b57f8 --- /dev/null +++ b/api/@ohos.ability.errorCode.d.ts @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2022 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. + */ + + /** + * Defines error codes used when starting an ability, for example, featureAbility.ErrorCode.NO_ERROR. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ +export enum ErrorCode { + /** + * Permission denied. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + PERMISSION_DENY = -3, + + /** + * Ability not found. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + ABILITY_NOT_FOUND = -2, + + /** + * Invalid parameter. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + INVALID_PARAMETER = -1, + + /** + * No error. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + NO_ERROR = 0 +} diff --git a/api/@ohos.ability.featureAbility.d.ts b/api/@ohos.ability.featureAbility.d.ts index 20b110239b55fe400e17329733f831436d8af0b6..44de8063d5cf4f8e46915229fe97dc5d0a0119a9 100644 --- a/api/@ohos.ability.featureAbility.d.ts +++ b/api/@ohos.ability.featureAbility.d.ts @@ -13,6 +13,7 @@ * limitations under the License. */ import { AsyncCallback } from './basic'; +import { Callback } from './basic'; import { Want } from './ability/want'; import { StartAbilityParameter } from './ability/startAbilityParameter'; import { AbilityResult } from './ability/abilityResult'; @@ -25,7 +26,7 @@ import { ContinueAbilityOptions } from './ability/continueAbilityOptions'; * A Feature Ability represents an ability with a UI and is designed to interact with users. * @name featureAbility * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -34,7 +35,7 @@ declare namespace featureAbility { * Obtain the want sended from the source ability. * * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -46,7 +47,7 @@ declare namespace featureAbility { * Starts a new ability. * * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -57,7 +58,7 @@ declare namespace featureAbility { /** * Obtains the application context. * - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns the application context. * @since 6 * @FAModelOnly @@ -68,7 +69,7 @@ declare namespace featureAbility { * Starts an ability and returns the execution result when the ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @FAModelOnly @@ -81,7 +82,7 @@ declare namespace featureAbility { * and destroys this Page ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the result to return. * @return - * @FAModelOnly @@ -93,7 +94,7 @@ declare namespace featureAbility { * Destroys this Page ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -104,7 +105,7 @@ declare namespace featureAbility { * Obtains the dataAbilityHelper. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly @@ -115,7 +116,7 @@ declare namespace featureAbility { * Checks whether the main window of this ability has window focus. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise. * @FAModelOnly */ @@ -126,7 +127,7 @@ declare namespace featureAbility { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param request The element name of the service ability * @param options The remote object instance * @return Returns the number code of the ability connected @@ -138,7 +139,7 @@ declare namespace featureAbility { * The callback interface was connect successfully. * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param connection The number code of the ability connected * @FAModelOnly */ @@ -149,7 +150,7 @@ declare namespace featureAbility { * Migrates this ability to the given device on the same distributed network. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ diff --git a/api/@ohos.ability.particleAbility.d.ts b/api/@ohos.ability.particleAbility.d.ts index fc367272ac775fa8a3e00bb24b67072e7b85b86e..f6d62b65b404768e3f2f1a8016f46eed5207da95 100644 --- a/api/@ohos.ability.particleAbility.d.ts +++ b/api/@ohos.ability.particleAbility.d.ts @@ -17,12 +17,14 @@ import { AsyncCallback } from './basic'; import { StartAbilityParameter } from './ability/startAbilityParameter'; import { DataAbilityHelper } from './ability/dataAbilityHelper'; import { NotificationRequest } from './notification/notificationRequest'; +import { ConnectOptions } from './ability/connectOptions'; +import { Want } from './ability/want'; /** * A Particle Ability represents an ability with service. * @name particleAbility * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -31,7 +33,7 @@ declare namespace particleAbility { * Service ability uses this method to start a specific ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -43,7 +45,7 @@ declare namespace particleAbility { * Destroys this service ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -54,7 +56,7 @@ declare namespace particleAbility { * Obtains the dataAbilityHelper. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly @@ -85,5 +87,27 @@ declare namespace particleAbility { */ function cancelBackgroundRunning(callback: AsyncCallback): void; function cancelBackgroundRunning(): Promise; + + /** + * Connects an ability to a Service ability. + * + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * @param request Indicates the Service ability to connect. + * @param options Callback object for the client. If this parameter is null, an exception is thrown. + * @return unique identifier of the connection between the client and the service side. + * @FAModelOnly + */ + function connectAbility(request: Want, options:ConnectOptions ): number; + + /** + * Disconnects ability to a Service ability. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * @param connection the connection id returned from connectAbility api. + * @FAModelOnly + */ + function disconnectAbility(connection: number, callback:AsyncCallback): void; + function disconnectAbility(connection: number): Promise; } export default particleAbility; diff --git a/api/@ohos.ability.wantConstant.d.ts b/api/@ohos.ability.wantConstant.d.ts index a0483c0095fcfbf5e8e4f9234deda55e593836a7..9248cae8999ee135000f740255f9b965bdf5b5e6 100644 --- a/api/@ohos.ability.wantConstant.d.ts +++ b/api/@ohos.ability.wantConstant.d.ts @@ -17,7 +17,7 @@ * the constant for action and entity in the want * @name wantConstant * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ declare namespace wantConstant { @@ -25,7 +25,7 @@ declare namespace wantConstant { * the constant for action of the want * @name Action * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Action { @@ -221,7 +221,7 @@ declare namespace wantConstant { * the constant for Entity of the want * @name Action * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Entity { @@ -293,14 +293,14 @@ declare namespace wantConstant { /** * Indicates the grant for possible persisting on the URI. * - * @hide + * @systemapi Hide this for inner system use. */ FLAG_AUTH_PERSISTABLE_URI_PERMISSION = 0x00000040, /** * Returns the result to the source ability slice. * - * @hide + * @systemapi Hide this for inner system use. */ FLAG_AUTH_PREFIX_URI_PERMISSION = 0x00000080, @@ -318,7 +318,7 @@ declare namespace wantConstant { /** * Indicates the continuation is reversible. * - * @hide + * @systemapi Hide this for inner system use. */ FLAG_ABILITY_CONTINUATION_REVERSIBLE = 0x00000400, diff --git a/api/@ohos.animator.d.ts b/api/@ohos.animator.d.ts index 2f306abcc6f27540380af20e75ef2238c5f37250..6ed9e0219b0253c60d6dfbc723d49f8cd1ebb346 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.app.abilityManager.d.ts b/api/@ohos.app.abilityManager.d.ts index 9b430de3ca7765df86929782bae19ee36ffc4cc4..8dc9575ac0d1f3db48c585962bd08d3c12f7fabd 100644 --- a/api/@ohos.app.abilityManager.d.ts +++ b/api/@ohos.app.abilityManager.d.ts @@ -22,7 +22,7 @@ import { MissionSnapshot } from './app/missionSnapshot'; * This module provides the capability to manage abilities and obtaining system task information. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from '@ohos.app.abilityManager' * @permission N/A */ @@ -38,7 +38,7 @@ declare namespace abilityManager { /** * Get information about running processes * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return a list of ActiveProcessInfo records describing each process. * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION * @systemapi hide this for inner system use @@ -49,7 +49,7 @@ declare namespace abilityManager { /** * Get information about the running ability missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit The maximum number of mission infos to return in the array. * @return an array of AbilityMissionInfo records describing each active mission. * @permission ohos.permission.ACCESS_MISSIONS @@ -61,7 +61,7 @@ declare namespace abilityManager { /** * Get information about recently run missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit The maximum number of previous mission infos to return in the array. * @return an array of AbilityMissionInfo records describing each of the previous mission. * @permission ohos.permission.ACCESS_MISSIONS_EXTRA @@ -73,13 +73,31 @@ declare namespace abilityManager { /** * Delete the specified missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param missionIds An array of missions, representing the missions that need to be deleted. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use */ function deleteMissions(missionIds: Array): Promise; function deleteMissions(missionIds: Array, callback: AsyncCallback): void; + + /** + * Is it a ram-constrained device + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return whether a ram-constrained device. + */ + function isRamConstrainedDevice(): Promise; + function isRamConstrainedDevice(callback: AsyncCallback): void; + + /** + * Get the memory size of the application + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return application memory size. + */ + function getAppMemorySize(): Promise; + function getAppMemorySize(callback: AsyncCallback): void; } export default abilityManager; diff --git a/api/@ohos.application.Ability.d.ts b/api/@ohos.application.Ability.d.ts index 65963be527b5e0901076ed6d413728e4407f4a79..e41e7e0cdf0603469f6bb4c7a85190f9fd72f1e7 100755 --- a/api/@ohos.application.Ability.d.ts +++ b/api/@ohos.application.Ability.d.ts @@ -20,21 +20,51 @@ import window from './@ohos.window'; import { Configuration } from './@ohos.application.Configuration'; import rpc from '/@ohos.rpc'; +/** + * The prototype of the listener function interface registered by the Caller. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @permission N/A + * @param msg Monitor status notification information. + * @return - + * @StageModelOnly + */ +export interface OnReleaseCallBack { + (msg: string): void; +} + +/** + * The prototype of the message listener function interface registered by the Callee. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @permission N/A + * @param indata Notification data notified from the caller. + * @return rpc.Sequenceable + * @StageModelOnly + */ +export interface CaleeCallBack { + (indata: rpc.MessageParcel): rpc.Sequenceable; +} + /** * The interface of a Caller. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ - interface Caller { +export interface Caller { /** * Notify the server of Sequenceable type data. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method The notification event string listened to by the callee. + * @param data Notification data to the callee. + * @return - * @StageModelOnly */ call(method: string, data: rpc.Sequenceable): Promise; @@ -43,8 +73,10 @@ import rpc from '/@ohos.rpc'; * Notify the server of Sequenceable type data and return the notification result. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method The notification event string listened to by the callee. + * @param data Notification data to the callee. + * @return Returns the callee's notification result data on success, and returns undefined on failure. * @StageModelOnly */ callWithResult(method: string, data: rpc.Sequenceable): Promise; @@ -53,8 +85,8 @@ import rpc from '/@ohos.rpc'; * Clear service records. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @return - * @StageModelOnly */ release(): void; @@ -63,38 +95,43 @@ import rpc from '/@ohos.rpc'; * Register death listener notification callback. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param callback Register a callback function for listening for notifications. + * @return - * @StageModelOnly */ - onRelease(callback: function): void; + onRelease(callback: OnReleaseCallBack): void; } /** * The interface of a Callee. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ - interface Callee { +export interface Callee { /** * Register data listener callback. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method A string registered to listen for notification events. + * @param callback Register a callback function that listens for notification events. + * @return - * @StageModelOnly */ - on(method: string, callback: function): void; + on(method: string, callback: CaleeCallBack): void; /** * Unregister data listener callback. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method A string registered to listen for notification events. + * @return - * @StageModelOnly */ off(method: string): void; @@ -104,7 +141,7 @@ import rpc from '/@ohos.rpc'; * The class of an ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ @@ -113,7 +150,7 @@ export default class Ability { * Indicates configuration information about an ability context. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ context: AbilityContext; @@ -122,7 +159,7 @@ export default class Ability { * Indicates ability launch want. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ launchWant: Want; @@ -131,7 +168,7 @@ export default class Ability { * Indicates ability last request want. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ lastRequestWant: Want; @@ -140,7 +177,7 @@ export default class Ability { * Call Service Stub Object. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ callee: Callee; @@ -149,7 +186,7 @@ export default class Ability { * Called back when an ability is started for initialization. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -159,7 +196,7 @@ export default class Ability { * Called back when an ability window stage is created. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -169,17 +206,28 @@ export default class Ability { * Called back when an ability window stage is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ onWindowStageDestroy(): void; + /** + * Called back when an ability window stage is restored. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param windowStage window stage to restore + * @return - + * @StageModelOnly + */ + onWindowStageRestore(windowStage: window.WindowStage): void; + /** * Called back before an ability is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -189,7 +237,7 @@ export default class Ability { * Called back when the state of an ability changes to foreground. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -199,7 +247,7 @@ export default class Ability { * Called back when the state of an ability changes to background. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -209,7 +257,7 @@ export default class Ability { * Called back when an ability prepares to migrate. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return true if ability agrees to migrate and saves data successfully, otherwise false. * @StageModelOnly */ @@ -219,9 +267,8 @@ export default class Ability { * Called when the launch mode of an ability is set to singleton. * This happens when you re-launch an ability that has been at the top of the ability stack. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -230,9 +277,8 @@ export default class Ability { /** * Called when the system configuration is updated. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ diff --git a/api/@ohos.application.AbilityConstant.d.ts b/api/@ohos.application.AbilityConstant.d.ts index d2691c2e98cdb1048738e380ceffe927876e5dfb..e43db61c8a1c4d1ab277e8b228cae536fcb11eb4 100644 --- a/api/@ohos.application.AbilityConstant.d.ts +++ b/api/@ohos.application.AbilityConstant.d.ts @@ -17,7 +17,7 @@ * The definition of AbilityConstant. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -26,7 +26,7 @@ declare namespace AbilityConstant { * Interface of launch param. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export interface LaunchParam { @@ -34,7 +34,7 @@ declare namespace AbilityConstant { * Indicates launch reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ launchReason: LaunchReason; @@ -43,7 +43,7 @@ declare namespace AbilityConstant { * Indicates last exit reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ lastExitReason: LastExitReason; @@ -53,7 +53,7 @@ declare namespace AbilityConstant { * Type of launch reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export enum LaunchReason { @@ -67,7 +67,7 @@ declare namespace AbilityConstant { * Type of last exit reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export enum LastExitReason { diff --git a/api/@ohos.application.AbilityStage.d.ts b/api/@ohos.application.AbilityStage.d.ts index 7d1762c145c62798083d80e1da61e1aae9809520..5ef07960128a6e898a806952a1257a1c5a67476c 100644 --- a/api/@ohos.application.AbilityStage.d.ts +++ b/api/@ohos.application.AbilityStage.d.ts @@ -48,7 +48,6 @@ export default class AbilityStage { /** * Called back when start specified ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return - diff --git a/api/@ohos.application.DataShareExtensionAbility.d.ts b/api/@ohos.application.DataShareExtensionAbility.d.ts index dce6c206a8ff9926c35894233dfb8fa8da70de1d..495ac85091bc5345c5e121f2de3f95345f4b063e 100644 --- a/api/@ohos.application.DataShareExtensionAbility.d.ts +++ b/api/@ohos.application.DataShareExtensionAbility.d.ts @@ -62,7 +62,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the MIME type of the matched files; returns null if there is no type that matches the Data */ - getFileTypes?(uri: string, mimeTypeFilter: string): Array; + getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void; /** * Inserts a data record into the database. This method should be implemented by a data share. @@ -74,7 +74,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the index of the newly inserted data record. */ - insert?(uri: string, valueBucket: rdb.ValuesBucket): number; + insert?(uri: string, valueBucket: rdb.ValuesBucket, callback: AsyncCallback): void; /** * Updates one or more data records in the database. This method should be implemented by a data share. @@ -88,7 +88,8 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the number of data records updated. */ - update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): number; + update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, + callback: AsyncCallback): void; /** * Deletes one or more data records. This method should be implemented by a data share. @@ -101,7 +102,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the number of data records deleted. */ - delete?(uri: string, predicates: dataAbility.DataAbilityPredicates): number; + delete?(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void; /** * Queries one or more data records in the database. This method should be implemented by a data share. @@ -116,7 +117,8 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the queried data. */ - query?(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates): ResultSet; + query?(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates, + callback: AsyncCallback): void; /** * Obtains the MIME type matching the data specified by the URI of the data share. This method should be @@ -130,7 +132,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the MIME type that matches the data specified by {@code uri}. */ - getType?(uri: string): string; + getType?(uri: string, callback: AsyncCallback): void; /** * Inserts multiple data records into the database. This method should be implemented by a data share. @@ -142,7 +144,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the number of data records inserted. */ - batchInsert?(uri: string, valueBuckets: Array): number; + batchInsert?(uri: string, valueBuckets: Array, callback: AsyncCallback): void; /** * Converts the given {@code uri} that refer to the data share into a normalized URI. A normalized URI can be @@ -155,7 +157,7 @@ export default class DataShareExtensionAbility { * @systemapi Hide this for inner system use. * @return Returns the normalized uri if the data share supports URI normalization; */ - normalizeUri?(uri: string): string; + normalizeUri?(uri: string, callback: AsyncCallback): void; /** * Converts the given normalized {@code uri} generated by {@link #normalizeUri(uri)} into a denormalized one. @@ -169,5 +171,5 @@ export default class DataShareExtensionAbility { * {@code uri} passed to this method if there is nothing to do; returns {@code null} if the data identified by * the original {@code uri} cannot be found in the current environment. */ - denormalizeUri?(uri: string): string; + denormalizeUri?(uri: string, callback: AsyncCallback): void; } \ No newline at end of file diff --git a/api/@ohos.application.ServiceExtAbility.d.ts b/api/@ohos.application.ServiceExtensionAbility.d.ts similarity index 80% rename from api/@ohos.application.ServiceExtAbility.d.ts rename to api/@ohos.application.ServiceExtensionAbility.d.ts index 57a549082fc195e6c9f0ce9c98d039428b4dfdab..a2567c8945fd3c1cf1cbe3e01885d8a581ff8169 100644 --- a/api/@ohos.application.ServiceExtAbility.d.ts +++ b/api/@ohos.application.ServiceExtensionAbility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 Huawei Device Co., Ltd. + * Copyright (c) 2021-2022 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 @@ -14,35 +14,33 @@ */ import rpc from "./@ohos.rpc"; -import ServiceExtAbilityContext from "./application/ServiceExtAbilityContext"; +import ServiceExtensionContext from "./application/ServiceExtensionContext"; import Want from './@ohos.application.Want'; /** * class of service extension ability. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ -export default class ServiceExtAbility { +export default class ServiceExtensionAbility { /** * Indicates service extension ability context. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ - context: ServiceExtAbilityContext; + context: ServiceExtensionContext; /** * Called back when a service extension is started for initialization. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -52,9 +50,8 @@ export default class ServiceExtAbility { /** * Called back before a service extension is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -64,9 +61,8 @@ export default class ServiceExtAbility { /** * Called back when a service extension is started. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want of service extension to start. * @param startId Indicates the number of times the service extension has been started. The {@code startId} is * incremented by 1 every time the service extension is started. For example, if the service extension @@ -80,9 +76,8 @@ export default class ServiceExtAbility { /** * Called back when a service extension is first connected to an ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates connection information about the Service ability. * @systemapi hide for inner use. * @return Returns the proxy of the Service ability. @@ -93,9 +88,8 @@ export default class ServiceExtAbility { /** * Called back when all abilities connected to a service extension are disconnected. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates disconnection information about the service extension. * @systemapi hide for inner use. * @return - @@ -107,9 +101,8 @@ export default class ServiceExtAbility { * Called when a new client attempts to connect to a service extension after all previous client connections to it * are disconnected. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want of the service extension being connected. * @systemapi hide for inner use. * @return - diff --git a/api/@ohos.application.StartOptions.d.ts b/api/@ohos.application.StartOptions.d.ts index 5c0b9e7d041e9e27f562824297483e010cc21b6e..b4cd41bbceab5748d8c933e5331f968ec393817e 100644 --- a/api/@ohos.application.StartOptions.d.ts +++ b/api/@ohos.application.StartOptions.d.ts @@ -18,7 +18,7 @@ * * @name StartOptions * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -27,7 +27,7 @@ export default class StartOptions { * windowMode * @default - * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ windowMode?: number; @@ -35,9 +35,8 @@ export default class StartOptions { /** * displayId * @default - - * @devices phone, tablet * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ displayId?: number; diff --git a/api/@ohos.application.Want.d.ts b/api/@ohos.application.Want.d.ts index 337e376ae1577c1a1cedb04d5fed5b48fc7d4f4e..6b2c2b0ae671dc0d0f36a7f79506d7801fa7e39d 100644 --- a/api/@ohos.application.Want.d.ts +++ b/api/@ohos.application.Want.d.ts @@ -18,7 +18,7 @@ * * @name Want * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export default class Want { @@ -26,7 +26,7 @@ export default class Want { * device id * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ deviceId?: string; @@ -34,7 +34,7 @@ export default class Want { * bundle name * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ bundleName?: string; @@ -42,14 +42,14 @@ export default class Want { * ability name * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; @@ -57,7 +57,7 @@ export default class Want { /** * The description of the type in this Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ type?: string; @@ -65,7 +65,7 @@ export default class Want { /** * The options of the flags in this Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; @@ -73,7 +73,7 @@ export default class Want { /** * The description of an action in an want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ action?: string; @@ -81,7 +81,7 @@ export default class Want { /** * The description of the WantParams object in an Want * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; @@ -89,7 +89,7 @@ export default class Want { /** * The description of a entities in a Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; diff --git a/api/@ohos.application.abilityDelegatorRegistry.d.ts b/api/@ohos.application.abilityDelegatorRegistry.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..c21a8cc64ede0a8d5e28226ba6dc2087d3b8ff97 --- /dev/null +++ b/api/@ohos.application.abilityDelegatorRegistry.d.ts @@ -0,0 +1,62 @@ +/* + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { AbilityDelegator } from './application/abilityDelegator' +import { AbilityDelegatorArgs } from './application/abilityDelegatorArgs' + +/** + * A global register used to store the AbilityDelegator and AbilityDelegatorArgs objects registered + * during application startup. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' + * @permission N/A + */ +declare namespace abilityDelegatorRegistry { + /** + * Get the AbilityDelegator object of the application. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return the AbilityDelegator object initialized when the application is started. + */ + function getAbilityDelegator(): AbilityDelegator; + + /** + * Get unit test parameters stored in the AbilityDelegatorArgs object. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return the previously registered AbilityDelegatorArgs object. + */ + function getArguments(): AbilityDelegatorArgs; + + /** + * Describes all lifecycle states of an ability. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + export enum AbilityLifecycleState { + UNINITIALIZED, + CREATE, + FOREGROUND, + BACKGROUND, + DESTROY, + } +} + +export default abilityDelegatorRegistry; \ No newline at end of file diff --git a/api/@ohos.application.abilityManager.d.ts b/api/@ohos.application.abilityManager.d.ts index ff2426a5e7bc9e4598d977d2e6bd62e604fb6fba..44885db2034653afb1593c100b4825c07143f77d 100644 --- a/api/@ohos.application.abilityManager.d.ts +++ b/api/@ohos.application.abilityManager.d.ts @@ -22,7 +22,7 @@ import { ExtensionRunningInfo } from './application/ExtensionRunningInfo'; * The class of an ability manager. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ declare namespace abilityManager { @@ -30,7 +30,7 @@ declare namespace abilityManager { /** * @name AbilityState * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export enum AbilityState { @@ -45,7 +45,7 @@ declare namespace abilityManager { * Updates the configuration by modifying the configuration. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @systemapi Hide this for inner system use. * @return - @@ -57,18 +57,18 @@ declare namespace abilityManager { * Get information about running abilitys * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @return - */ function getAbilityRunningInfos(): Promise>; function getAbilityRunningInfos(callback: AsyncCallback>): void; - + /** * Get information about running extensions * * @since 9 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit Get the maximum limit of the number of messages * @systemapi Hide this for inner system use. * @return - diff --git a/api/@ohos.application.appManager.d.ts b/api/@ohos.application.appManager.d.ts index dcb6dca86ab862ac726dd65add9cc4c67820639f..b6956e4857de6ec96b5f056e537ec1f864494dc3 100644 --- a/api/@ohos.application.appManager.d.ts +++ b/api/@ohos.application.appManager.d.ts @@ -22,7 +22,7 @@ import { ProcessRunningInfo } from './application/ProcessRunningInfo'; * This module provides the function of app manager service. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import appManager from '@ohos.application.appManager' * @permission N/A */ @@ -32,7 +32,7 @@ declare namespace appManager { * * @default - * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observer The application state observer. * @systemapi hide this for inner system use * @return Returns the number code of the observer. @@ -43,7 +43,7 @@ declare namespace appManager { * Unregister application state observer. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observerId Indicates the number code of the observer. * @systemapi hide this for inner system use * @return - @@ -55,7 +55,7 @@ declare namespace appManager { * getForegroundApplications. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use * @return Returns the list of AppStateData. */ @@ -66,7 +66,7 @@ declare namespace appManager { * Kill process with account. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName The process bundle name. * @param accountId The account id. * @systemapi hide this for inner system use @@ -79,7 +79,7 @@ declare namespace appManager { * Is user running in stability test. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return Returns true if user is running stability test. */ function isRunningInStabilityTest(callback: AsyncCallback): void; @@ -89,7 +89,7 @@ declare namespace appManager { * Get information about running processes * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @return - */ @@ -99,8 +99,7 @@ declare namespace appManager { /** * Kill processes by bundle name * @since 8 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName bundle name. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use @@ -111,8 +110,7 @@ declare namespace appManager { /** * Clear up application data by bundle name * @since 8 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName bundle name. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use diff --git a/api/@ohos.application.formBindingData.d.ts b/api/@ohos.application.formBindingData.d.ts index ad398765917917ecc7774d2e0ff1cda7225c41e0..6ede7819dcc74a2d77f89944e7461ea3339409e5 100644 --- a/api/@ohos.application.formBindingData.d.ts +++ b/api/@ohos.application.formBindingData.d.ts @@ -18,14 +18,14 @@ * * @name formBindingData * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ declare namespace formBindingData { /** * Create an FormBindingData instance. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param obj Indicates the FormBindingData instance data. * @return Returns the {@link FormBindingData} instance. */ diff --git a/api/@ohos.application.missionManager.d.ts b/api/@ohos.application.missionManager.d.ts index 94f172f8e5fc096eaf834b759b95bc4de2195a7c..cc0a560a1a05962d41412e0385ad263afe0783e9 100644 --- a/api/@ohos.application.missionManager.d.ts +++ b/api/@ohos.application.missionManager.d.ts @@ -24,7 +24,7 @@ import StartOptions from "./@ohos.application.StartOptions"; * * @name missionManager * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -33,7 +33,7 @@ declare namespace missionManager { * Register the missionListener to ams. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The index number of the MissionListener. */ function registerMissionListener(listener: MissionListener): number; @@ -42,7 +42,7 @@ declare namespace missionManager { * Unrgister the missionListener to ams. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unregisterMissionListener(listenerId: number, callback: AsyncCallback): void; @@ -52,7 +52,7 @@ declare namespace missionManager { * Get the missionInfo with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return the {@link MissionInfo} of the given id. */ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -62,7 +62,7 @@ declare namespace missionManager { * Get the missionInfo with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The array of the {@link MissionInfo}. */ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback>): void; @@ -72,7 +72,7 @@ declare namespace missionManager { * Get the mission snapshot with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The {@link MissionSnapshot} of the given id. */ function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -82,7 +82,7 @@ declare namespace missionManager { * Lock the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function lockMission(missionId: number, callback: AsyncCallback): void; @@ -92,7 +92,7 @@ declare namespace missionManager { * Unlock the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unlockMission(missionId: number, callback: AsyncCallback): void; @@ -102,7 +102,7 @@ declare namespace missionManager { * Clear the given mission in the ability manager service. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearMission(missionId: number, callback: AsyncCallback): void; @@ -112,7 +112,7 @@ declare namespace missionManager { * Clear all missions in the ability manager service. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearAllMissions(callback: AsyncCallback): void; @@ -122,7 +122,7 @@ declare namespace missionManager { * Schedule the given mission to foreground. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function moveMissionToFront(missionId: number, callback: AsyncCallback): void; diff --git a/api/@ohos.application.testRunner.d.ts b/api/@ohos.application.testRunner.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..58593017d019b48e98981fd1e5218d61cc7e77c8 --- /dev/null +++ b/api/@ohos.application.testRunner.d.ts @@ -0,0 +1,43 @@ +/* + * 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 + * + * 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. + */ + +/** + * Base class for the test framework. + * If you want to implement your own unit test framework, you must inherit this class and overrides all its methods. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import TestRunner from '@ohos.application.testRunner' + * @permission N/A + */ +export interface TestRunner { + /** + * Prepare the unit testing environment for running test cases. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onPrepare(): void; + + /** + * Run all test cases. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onRun(): void; +} + +export default TestRunner; \ No newline at end of file diff --git a/api/@ohos.application.UriPermissionManager.d.ts b/api/@ohos.application.uriPermissionManager.d.ts similarity index 72% rename from api/@ohos.application.UriPermissionManager.d.ts rename to api/@ohos.application.uriPermissionManager.d.ts index f79c74100803bf19b1987cf5a266b915bff2f50b..37cd85441c8e8f9653759a09967c58e6a360c5be 100644 --- a/api/@ohos.application.UriPermissionManager.d.ts +++ b/api/@ohos.application.uriPermissionManager.d.ts @@ -20,20 +20,22 @@ import wantConstant from "./@ohos.ability.wantConstant"; * The management class for uri of file. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ -export default class UriPermissionManager { +declare namespace uriPermissionManager { /** * Check whether the application corresponding to the accesstokenID has access rights to the URI. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri File URI. * @param flag wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION * @param accessTokenId Indicates the access token of the application. * @return Returns 0 if the verification is successful, otherwise returns -1. */ - verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback): void; - verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number): Promise; + function verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback): void; + function verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number): Promise; } + +export default uriPermissionManager; \ No newline at end of file diff --git a/api/@ohos.batteryinfo.d.ts b/api/@ohos.batteryinfo.d.ts index a139929f6d85cb3fb8640a99e1fc7d45eabf1762..265f6c4df200eb99e4a13ab50a62bed94d4f0e87 100644 --- a/api/@ohos.batteryinfo.d.ts +++ b/api/@ohos.batteryinfo.d.ts @@ -19,7 +19,7 @@ *

Battery information includes the remaining battery power, * voltage, temperature, model, and charger type. * - * @sysCap SystemCapability.PowerManager.BatteryManage.Core + * @syscap SystemCapability.PowerManager.BatteryManage.Core * @since 6 */ declare namespace batteryInfo { @@ -74,7 +74,7 @@ declare namespace batteryInfo { /** * Indicates the charger type of a device. * - * @sysCap SystemCapability.PowerManager.BatteryManage.Core + * @syscap SystemCapability.PowerManager.BatteryManage.Core * @since 6 */ export enum BatteryPluggedType { @@ -103,7 +103,7 @@ declare namespace batteryInfo { /** * Indicates the battery charging status of a device. * - * @sysCap SystemCapability.PowerManager.BatteryManage.Core + * @syscap SystemCapability.PowerManager.BatteryManage.Core * @since 6 */ export enum BatteryChargeState { @@ -132,7 +132,7 @@ declare namespace batteryInfo { /** * Indicates the battery health status of a device. * - * @sysCap SystemCapability.PowerManager.BatteryManage.Core + * @syscap SystemCapability.PowerManager.BatteryManage.Core * @since 6 */ export enum BatteryHealthState { diff --git a/api/@ohos.bluetooth.d.ts b/api/@ohos.bluetooth.d.ts index 155520f1577dba21ce71d391fa7fe83da1f8805c..b3dde1d0f94f8727c4ddc8530bf3bf44bc8dfdf8 100644 --- a/api/@ohos.bluetooth.d.ts +++ b/api/@ohos.bluetooth.d.ts @@ -121,6 +121,16 @@ declare namespace bluetooth { */ function getPairedDevices(): Array; + /** + * Obtains the connection state of profile. + * + * @param profileId The profile id. + * @return Returns the connection state. + * @since 8 + * @permission ohos.permission.USE_BLUETOOTH + */ + function getProfileConnState(profileId: ProfileId): ProfileConnectionState; + /** * Sets the confirmation of pairing with a certain device. * @@ -336,6 +346,202 @@ declare namespace bluetooth { */ function off(type: "sppRead", clientSocket: number, callback?: Callback): void; + /** + * Obtains the instance of profile. + * + * @param profileId The profile id.. + * @return Returns instance of profile. + * @since 8 + */ + function getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile; + + /** + * Base interface of profile. + */ + interface BaseProfile { + /** + * Obtains the connected devices list of profile. + * + * @return Returns the address of connected devices list. + * @since 8 + * @permission ohos.permission.USE_BLUETOOTH + */ + getConnectionDevices(): Array; + + /** + * Obtains the profile state of device. + * + * @param device The address of bluetooth device. + * @return Returns {@link ProfileConnectionState} of device. + * @since 8 + * @permission ohos.permission.USE_BLUETOOTH + */ + getDeviceState(device: string): ProfileConnectionState; + } + + /** + * Manager a2dp source profile. + */ + interface A2dpSourceProfile extends BaseProfile { + /** + * Connect to device with a2dp. + * + * @param device The address of the remote device to connect. + * @return Returns {@code true} if the connect is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + connect(device: string): boolean; + + /** + * Disconnect to device with a2dp. + * + * @param device The address of the remote device to disconnect. + * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + disconnect(device: string): boolean; + + /** + * Subscribe the event reported when the profile connection state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + on(type: "connectionStateChange", callback: Callback): void; + + /** + * Unsubscribe the event reported when the profile connection state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + off(type: "connectionStateChange", callback?: Callback): void; + + /** + * Obtains the playing state of device. + * + * @param device The address of the remote device. + * @return Returns {@link PlayingState} of the remote device. + * + */ + getPlayingState(device: string): PlayingState; + } + + /** + * Manager handsfree AG profile. + */ + interface HandsFreeAudioGatewayProfile extends BaseProfile { + /** + * Connect to device with hfp. + * + * @param device The address of the remote device to connect. + * @return Returns {@code true} if the connect is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + connect(device: string): boolean; + + /** + * Disconnect to device with hfp. + * + * @param device The address of the remote device to disconnect. + * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + disconnect(device: string): boolean; + + /** + * Obtains the sco state of device. + * + * @param device The address of the remote device. + * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.USE_BLUETOOTH + */ + getScoState(device: string): number; + + /** + * Create audio channel. + * + * @param device The address of the remote device. + * @return Returns {@code true} if the request is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + connectSco(device: string): boolean; + + /** + * Close audio channel. + * + * @param device The address of the remote device. + * @return Returns {@code true} if the request is in process; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + disconnectSco(device: string): boolean; + + /** + * Subscribe the event reported when the profile connection state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + on(type: "connectionStateChange", callback: Callback): void; + + /** + * Unsubscribe the event reported when the profile connection state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + off(type: "connectionStateChange", callback?: Callback): void; + + /** + * Subscribe the event reported when the sco state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + on(type: "scoStateChange", callback: Callback): void; + + /** + * Unsubscribe the event reported when the sco state changes . + * + * @param type Type of the profile connection state changes event to listen for . + * @param callback Callback used to listen for event. + * @since 8 + */ + off(type: "scoStateChange", callback?: Callback): void; + + /** + * Open voice recognition function. + * + * @param device The address of the remote device to disconnect. + * @return Returns {@code true} if success; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + openVoiceRecognition(device: string): boolean; + + /** + * Close voice recognition function. + * + * @param device The address of the remote device to disconnect. + * @return Returns {@code true} if success; returns {@code false} otherwise. + * @since 8 + * @permission permission ohos.permission.DISCOVER_BLUETOOTH + */ + closeVoiceRecognition(device: string): boolean; + } + namespace BLE { /** * create a JavaScript Gatt server instance. @@ -1306,6 +1512,64 @@ declare namespace bluetooth { HEALTH_GENERIC_HEALTH_MANAGER = 0x0938, HEALTH_PERSONAL_MOBILITY_DEVICE = 0x093C, } + + /** + * Profile state change parameters. + * + * @since 8 + */ + interface StateChangeParam { + /** The address of device */ + deviceId: string; + + /** Profile state value */ + state: ProfileConnectionState; + } + + /** + * Sco state change parameters. + * + * @since 8 + */ + Interface ScoStateParam { + /** The address of device */ + deviceId: string, + + /** Sco state value */ + state: ScoState + } + + /** + * The enum of a2dp playing state. + * + * @since 8 + */ + enum PlayingState { + STATE_NOT_PLAYING, + STATE_PLAYING, + } + + /** + * The enum of sco audio state. + * + * @since 8 + */ + enum ScoState { + SCO_DISCONNECTED, + SCO_CONNECTING, + SCO_DISCONNECTING, + SCO_CONNECTED + } + + /** + * The enum of profile id. + * + * @since 8 + */ + enum ProfileId { + PROFILE_A2DP_SOURCE = 1, + PROFILE_HANDS_FREE_AUDIO_GATEWAY = 4, + } } export default bluetooth; diff --git a/api/@ohos.brightness.d.ts b/api/@ohos.brightness.d.ts index f12bc7a706745b47aa73eda3fb6a1c0ad3745153..bb8b0988049e37d66b524897ad8c45d672ee5326 100644 --- a/api/@ohos.brightness.d.ts +++ b/api/@ohos.brightness.d.ts @@ -18,7 +18,7 @@ import { AsyncCallback } from './basic'; /** * Provides interfaces to control the power of display. * - * @sysCap SystemCapability.PowerManager.DisplayPowerManager + * @syscap SystemCapability.PowerManager.DisplayPowerManager * @since 7 */ declare namespace brightness { @@ -26,7 +26,6 @@ declare namespace brightness { * Sets the screen brightness. * * @param value Brightness value, ranging from 0 to 255. - * @sysCap SystemCapability.PowerManager.DisplayPowerManager * @systemapi * @since 7 */ diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts index 8d2be229f4907e7bfdafb13592a25f9d9f47a9b2..0a7500990c94666069df485ce9b844edce4db5b2 100644 --- a/api/@ohos.bundle.d.ts +++ b/api/@ohos.bundle.d.ts @@ -20,9 +20,9 @@ import { AbilityInfo } from './bundle/abilityInfo'; import { ExtensionAbilityInfo } from './bundle/extensionAbilityInfo'; import { Want } from './ability/want'; import { BundleInstaller } from './bundle/bundleInstaller'; -import { ShortcutInfo } from './bundle/shortcutInfo'; import { ModuleUsageRecord } from './bundle/moduleUsageRecord'; import { PermissionDef } from './bundle/PermissionDef'; +import image from './@ohos.multimedia.image'; /** * bundle. @@ -384,6 +384,19 @@ declare namespace bundle { */ function getBundleInstaller(callback: AsyncCallback): void; function getBundleInstaller(): Promise; + + /** + * Obtains information about the current ability. + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @param bundleName Indicates the application bundle name to be queried. + * @param abilityName Indicates the ability name. + * @return Returns the AbilityInfo object for the current ability. + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO + */ + function getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback): void; + function getAbilityInfo(bundleName: string, abilityName: string): Promise; /** * Obtains based on a given bundle name. @@ -393,12 +406,13 @@ declare namespace bundle { * @param bundleName Indicates the application bundle name to be queried. * @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo object * that will be returned. - * @param userId Indicates the user ID. + * @param userId Indicates the user ID or do not pass user ID. * @return Returns the ApplicationInfo object. * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO */ function getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback) : void; - function getApplicationInfo(bundleName: string, bundleFlags: number, userId: number) : Promise; + function getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback) : void; + function getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number) : Promise; /** * Query the AbilityInfo by the given Want. @@ -439,12 +453,13 @@ declare namespace bundle { * @syscap SystemCapability.BundleManager.BundleFramework * @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo objects * that will be returned. - * @param userId Indicates the user ID. + * @param userId Indicates the user ID or do not pass user ID. * @return Returns a list of ApplicationInfo objects. * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED */ function getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback>) : void; - function getAllApplicationInfo(bundleFlags: number, userId: number) : Promise>; + function getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback>) : void; + function getAllApplicationInfo(bundleFlags: number, userId?: number) : Promise>; /** * Obtains bundle name by the given uid. @@ -471,8 +486,6 @@ declare namespace bundle { function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback) : void function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise; - /** - /** * Obtains the Want for starting the main ability of an application based on the * given bundle name. The main ability of an application is the ability that has the @@ -489,18 +502,6 @@ declare namespace bundle { function getLaunchWantForBundle(bundleName: string, callback: AsyncCallback): void; function getLaunchWantForBundle(bundleName: string): Promise; - /** - * Obtains information about the shortcuts of the application. - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @param bundleName Indicates the bundle name of the application. - * @return Returns a list of ShortcutInfo objects containing shortcut information about the application. - * @permission ohos.permission.MANAGE_SHORTCUTS - */ - function getAllShortcutInfo(bundleName: string, callback: AsyncCallback>): void; - function getAllShortcutInfo(bundleName: string): Promise>; - /** * get module usage record list in descending order of lastLaunchTime. * @@ -582,6 +583,54 @@ declare namespace bundle { */ function getPermissionDef(permissionName: string, callback: AsyncCallback): void; function getPermissionDef(permissionName: string): Promise; + + /** + * Obtains the label of a specified ability. + * + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * @param bundleName Indicates the bundle name of the application to which the ability belongs. + * @param abilityName Indicates the ability name. + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + * @return Returns the label representing the label of the specified ability. + */ + function getAbilityLabel(bundleName: string, abilityName: string, callback: AsyncCallback): void; + function getAbilityLabel(bundleName: string, abilityName: string): Promise; + + /** + * Obtains the icon of a specified ability. + * + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * @param bundleName Indicates the bundle name of the application to which the ability belongs. + * @param abilityName Indicates the ability name. + * @return Returns the PixelMap object representing the icon of the specified ability. + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + */ + function getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback): void; + function getAbilityIcon(bundleName: string, abilityName: string): Promise; + + /** + * Checks whether a specified ability is enabled. + * + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * @param info Indicates information about the ability to check. + * @returns Returns true if the ability is enabled; returns false otherwise. + */ + function isAbilityEnabled(info: AbilityInfo, callback: AsyncCallback): void; + function isAbilityEnabled(info: AbilityInfo): Promise; + + /** + * Checks whether a specified application is enabled. + * + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * @param bundleName Indicates the bundle name of the application. + * @returns Returns true if the application is enabled; returns false otherwise. + */ + function isApplicationEnabled(bundleName: string, callback: AsyncCallback): void; + function isApplicationEnabled(bundleName: string): Promise; } export default bundle; diff --git a/api/@ohos.bundleState.d.ts b/api/@ohos.bundleState.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..eb724fd056044215e00f8d7b64e79b1b2906762e --- /dev/null +++ b/api/@ohos.bundleState.d.ts @@ -0,0 +1,265 @@ +/* + * Copyright (c) 2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { AsyncCallback } from './basic'; + +/** + * Provides methods for managing bundle usage statistics, + * including the methods for querying bundle usage information and state data. + * + *

You can use the methods defined in this class to query + * the usage history and states of bundles in a specified period. + * The system stores the query result in a {@link BundleStateInfo} or {@link BundleActiveState} instance and + * then returns it to you. + * + * @since 7 + */ +declare namespace bundleState { + + /** + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + */ + interface BundleStateInfo { + /** + * the identifier of BundleStateInfo. + */ + id: number; + /** + * the total duration, in milliseconds. + */ + abilityInFgTotalTime?: number; + /** + * the last time when the application was accessed, in milliseconds. + */ + abilityPrevAccessTime?: number; + /** + * the last time when the application was visible in the foreground, in milliseconds. + */ + abilityPrevSeenTime?: number; + /** + * the total duration, in milliseconds. + */ + abilitySeenTotalTime?: number; + /** + * the bundle name of the application. + */ + bundleName?: string; + /** + * the total duration, in milliseconds. + */ + fgAbilityAccessTotalTime?: number; + /** + * the last time when the foreground application was accessed, in milliseconds. + */ + fgAbilityPrevAccessTime?: number; + /** + * the time of the first bundle usage record in this {@code BundleActiveInfo} object, + * in milliseconds. + */ + infosBeginTime?: number; + /** + * the time of the last bundle usage record in this {@code BundleActiveInfo} object, + * in milliseconds. + */ + infosEndTime?: number; + + /** + * Merges a specified {@link BundleActiveInfo} object with this {@link BundleActiveInfo} object. + * The bundle name of both objects must be the same. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param toMerge Indicates the {@link BundleActiveInfo} object to merge. + * if the bundle names of the two {@link BundleActiveInfo} objects are different. + */ + merge(toMerge: BundleStateInfo): void; + } + + /** + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + */ + interface BundleActiveState { + /** + * the usage priority group of the application. + */ + appUsagePriorityGroup?: number; + /** + * the bundle name. + */ + bundleName?: string; + /** + * the shortcut ID. + */ + indexOfLink?: string; + /** + * the class name. + */ + nameOfClass?: string; + /** + * the time when this state occurred, in milliseconds. + */ + stateOccurredTime?: number; + /** + * the state type. + */ + stateType?: number; + } + + /** + * Checks whether the application with a specified bundle name is in the idle state. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param bundleName Indicates the bundle name of the application to query. + * @return Returns {@code true} if the application is idle in a particular period; + * returns {@code false} otherwise. The time range of the particular period is defined by the system, + * which may be hours or days. + */ + function isIdleState(bundleName: string, callback: AsyncCallback): void; + function isIdleState(bundleName: string): Promise; + + /** + * Queries the usage priority group of the calling application. + * + *

The priority defined in a priority group restricts the resource usage of an application, + * for example, restricting the running of background tasks.

+ * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @return Returns the usage priority group of the calling application. + */ + function queryAppUsagePriorityGroup(callback: AsyncCallback): void; + function queryAppUsagePriorityGroup(): Promise; + + /** + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + */ + interface BundleActiveInfoResponse { + [key: string]: BundleStateInfo; + } + + /** + * Queries usage information about each bundle within a specified period. + * + *

This method queries usage information at the {@link #BY_OPTIMIZED} interval by default.

+ * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param begin Indicates the start time of the query period, in milliseconds. + * @param end Indicates the end time of the query period, in milliseconds. + * @return Returns the {@link BundleActiveInfoResponse} objects containing the usage information about each bundle. + */ + function queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback): void; + function queryBundleStateInfos(begin: number, end: number): Promise; + + /** + * Declares interval type. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + */ + export enum IntervalType { + /** + * Indicates the interval type that will determine the optimal interval based on the start and end time. + */ + BY_OPTIMIZED = 0, + + /** + * Indicates the daily interval. + */ + BY_DAILY = 1, + + /** + * Indicates the weekly interval. + */ + BY_WEEKLY = 2, + + /** + * Indicates the monthly interval. + */ + BY_MONTHLY = 3, + + /** + * Indicates the annually interval. + */ + BY_ANNUALLY = 4 + } + + /** + * Queries usage information about each bundle within a specified period at a specified interval. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param byInterval Indicates the interval at which the usage statistics are queried. + * The value can be {@link #BY_OPTIMIZED}, {@link #BY_DAILY}, + * {@link #BY_WEEKLY}, {@link #BY_MONTHLY}, or {@link #BY_ANNUALLY}. + * @param begin Indicates the start time of the query period, in milliseconds. + * @param end Indicates the end time of the query period, in milliseconds. + * @return Returns the list of {@link BundleStateInfo} objects containing the usage information about each bundle. + */ + function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback>): void; + function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise>; + + /** + * Queries state data of all bundles within a specified period identified by the start and end time. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param begin Indicates the start time of the query period, in milliseconds. + * @param end Indicates the end time of the query period, in milliseconds. + * @return Returns the list of {@link BundleActiveState} objects containing the state data of all bundles. + */ + function queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback>): void; + function queryBundleActiveStates(begin: number, end: number): Promise>; + + /** + * Queries state data of the current bundle within a specified period. + * + * @since 7 + * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App. + * @permission ohos.permission.BUNDLE_ACTIVE_INFO. + * @systemapi Hide this for inner system use. + * @param begin Indicates the start time of the query period, in milliseconds. + * @param end Indicates the end time of the query period, in milliseconds. + * @return Returns the {@link BundleActiveState} object Array containing the state data of the current bundle. + */ + function queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback>): void; + function queryCurrentBundleActiveStates(begin: number, end: number): Promise>; +} + +export default bundleState; \ No newline at end of file diff --git a/api/@ohos.commonEvent.d.ts b/api/@ohos.commonEvent.d.ts index e9b04424dc98e1dddef6814796df654253435606..f6a59b218ee165e505f7d5d10e5377df6ffa9614 100644 --- a/api/@ohos.commonEvent.d.ts +++ b/api/@ohos.commonEvent.d.ts @@ -170,6 +170,12 @@ declare namespace commonEvent { */ COMMON_EVENT_SCREEN_ON = "usual.event.SCREEN_ON", + /** + * this commonEvent means when the thermal state level change + * @since 8 + */ + COMMON_EVENT_THERMAL_LEVEL_CHANGED = "usual.event.THERMAL_LEVEL_CHANGED", + /** * this commonEvent means when the user is present after the device waked up. */ @@ -890,35 +896,35 @@ declare namespace commonEvent { /** * The external storage was removed. * This is a protected common event that can only be sent by system. - * @since 8 + * @since 9 */ COMMON_EVENT_VOLUME_REMOVED = "usual.event.data.VOLUME_REMOVED", /** * The external storage was unmounted. * This is a protected common event that can only be sent by system. - * @since 8 + * @since 9 */ COMMON_EVENT_VOLUME_UNMOUNTED = "usual.event.data.VOLUME_UNMOUNTED", /** * The external storage was mounted. * This is a protected common event that can only be sent by system. - * @since 8 + * @since 9 */ COMMON_EVENT_VOLUME_MOUNTED = "usual.event.data.VOLUME_MOUNTED", /** * The external storage was bad removal. * This is a protected common event that can only be sent by system. - * @since 8 + * @since 9 */ COMMON_EVENT_VOLUME_BAD_REMOVAL = "usual.event.data.VOLUME_BAD_REMOVAL", /** * The external storage was eject. * This is a protected common event that can only be sent by system. - * @since 8 + * @since 9 */ COMMON_EVENT_VOLUME_EJECT = "usual.event.data.VOLUME_EJECT", diff --git a/api/@ohos.configPolicy.d.ts b/api/@ohos.configPolicy.d.ts index 32ef672ca08824e798623f0eccb68857b4f4b5f3..d12690c30faca84069c5fedcbef457ed789f20f1 100644 --- a/api/@ohos.configPolicy.d.ts +++ b/api/@ohos.configPolicy.d.ts @@ -19,7 +19,7 @@ import {AsyncCallback} from "./basic"; * Provides file path related APIS. * * @since 8 - * @sysCap SystemCapability.Customization.ConfigPolicy + * @syscap SystemCapability.Customization.ConfigPolicy */ declare namespace configPolicy { /** @@ -27,7 +27,7 @@ declare namespace configPolicy { * * @since 8 * @systemapi Hide this for inner system use. - * @sysCap SystemCapability.Customization.ConfigPolicy + * @syscap SystemCapability.Customization.ConfigPolicy * @param relPath the relative path of the config file. * @return Returns the path of the highest priority config file. */ @@ -39,7 +39,7 @@ declare namespace configPolicy { * * @since 8 * @systemapi Hide this for inner system use. - * @sysCap SystemCapability.Customization.ConfigPolicy + * @syscap SystemCapability.Customization.ConfigPolicy * @param relPath the relative path of the config file. * @return Returns paths of config files. */ @@ -51,7 +51,7 @@ declare namespace configPolicy { * * @since 8 * @systemapi Hide this for inner system use. - * @sysCap SystemCapability.Customization.ConfigPolicy + * @syscap SystemCapability.Customization.ConfigPolicy * @return Returns paths of config directories. */ function getCfgDirList(callback: AsyncCallback>); diff --git a/api/ohos.contact.d.ts b/api/@ohos.contact.d.ts similarity index 100% rename from api/ohos.contact.d.ts rename to api/@ohos.contact.d.ts diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts index 1ffd9819ad5008827d0a5ed60c7d78f796165608..c4166aaf662edd5390f9136cdc292ed5ac716941 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.data.preferences.d.ts b/api/@ohos.data.preferences.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..000599ed5d287eb42bd8ea5e9894562ac7905021 --- /dev/null +++ b/api/@ohos.data.preferences.d.ts @@ -0,0 +1,199 @@ +/* +* Copyright (c) 2022 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ +import { AsyncCallback, Callback } from './basic'; +import Context from "./application/Context"; + +/** + * Provides interfaces to obtain and modify preferences data. + * + * @name preferences + * @since 9 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * + */ +declare namespace preferences { + /** + * Obtains a {@link Preferences} instance matching a specified preferences file name. + * + *

The {@link references} instance loads all data of the preferences file and + * resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory. + * + * @param context Indicates the context of application or capability. + * @param name Indicates the preferences file name. + * @return Returns the {@link Preferences} instance matching the specified preferences file name. + * @throws BusinessError if invoked failed + * @since 9 + */ + function getPreferences(context: Context, name: string, callback: AsyncCallback): void; + function getPreferences(context: Context, name: string): Promise; + + /** + * Deletes a {@link Preferences} instance matching a specified preferences file name + * from the cache which is performed by removePreferencesFromCache and deletes the + * preferences file. + * + *

When deleting the {@link Preferences} instance, you must release all references + * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency + * will occur. + * + * @param context Indicates the context of application or capability. + * @param name Indicates the preferences file name. + * @throws BusinessError if invoked failed + * @since 9 + */ + function deletePreferences(context: Context, name: string, callback: AsyncCallback): void; + function deletePreferences(context: Context, name: string): Promise; + + /** + * Deletes a {@link Preferences} instance matching a specified preferences file name + * from the cache. + * + *

When deleting the {@link Preferences} instance, you must release all references + * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency + * will occur. + * + * @param context Indicates the context of application or capability. + * @param name Indicates the preferences file name. + * @throws BusinessError if invoked failed + * @since 9 + */ + function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void; + function removePreferencesFromCache(context: Context, name: string): Promise; + + /** + * Provides interfaces to obtain and modify preferences data. + * + *

The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory. + * You can use getPreferences to obtain the {@link Preferences} instance matching + * the file that stores preferences data, and use emovePreferencesFromCache + * to remove the {@link Preferences} instance from the memory. + * + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + * + * @since 9 + */ + interface Preferences { + /** + * Obtains the value of a preferences in the int format. + * + *

If the value is {@code null} or not in the int format, the default value is returned. + * + * @param key Indicates the key of the preferences. It cannot be {@code null} or empty. + * @param defValue Indicates the default value to return. + * @return Returns the value matching the specified key if it is found; returns the default value otherwise. + * @throws BusinessError if invoked failed + * @since 9 + */ + get(key: string, defValue: ValueType, callback: AsyncCallback): void; + get(key: string, defValue: ValueType): Promise; + + /** + * Checks whether the {@link Preferences} object contains a preferences matching a specified key. + * + * @param key Indicates the key of the preferences to check for. + * @return Returns {@code true} if the {@link Preferences} object contains a preferences with the specified key; + * returns {@code false} otherwise. + * @throws BusinessError if invoked failed + * @since 9 + */ + has(key: string, callback: AsyncCallback): boolean; + has(key: string): Promise; + + /** + * Sets an int value for the key in the {@link Preferences} object. + * + *

You can call the {@link #flush} method to save the {@link Preferences} object to the + * file. + * + * @param key Indicates the key of the preferences to modify. It cannot be {@code null} or empty. + * @param value Indicates the value of the preferences. + * MAX_KEY_LENGTH. + * @throws BusinessError if invoked failed + * @since 9 + */ + put(key: string, value: ValueType, callback: AsyncCallback): void; + put(key: string, value: ValueType): Promise; + + /** + * Deletes the preferences with a specified key from the {@link Preferences} object. + * + *

You can call the {@link #flush} method to save the {@link Preferences} object to the + * file. + * + * @param key Indicates the key of the preferences to delete. It cannot be {@code null} or empty. + * MAX_KEY_LENGTH. + * @throws BusinessError if invoked failed + * @since 9 + */ + delete(key: string, callback: AsyncCallback): void; + delete(key: string): Promise; + + /** + * Clears all preferences from the {@link Preferences} object. + * + *

You can call the {@link #flush} method to save the {@link Preferences} object to the + * file. + * + * @throws BusinessError if invoked failed + * @since 9 + */ + clear(callback: AsyncCallback): void; + clear(): Promise; + + /** + * Asynchronously saves the {@link Preferences} object to the file. + * + * @throws BusinessError if invoked failed + * @since 9 + */ + flush(callback: AsyncCallback): void; + flush(): Promise; + + /** + * Registers an observer to listen for the change of a {@link Preferences} object. + * + * @param callback Indicates the callback when preferences changes. + * @throws BusinessError if invoked failed + * @since 9 + */ + on(type: 'change', callback: Callback<{ key: string }>): void; + + /** + * Unregisters an existing observer. + * + * @param callback Indicates the registered callback. + * @throws BusinessError if invoked failed + * @since 9 + */ + off(type: 'change', callback: Callback<{ key: string }>): void; + } + + /** + * Indicates possible value types + */ + type ValueType = number | string | boolean; + + /** + * Indicates the maximum length of a key (80 characters). + */ + const MAX_KEY_LENGTH: 80; + + /** + * Indicates the maximum length of a string (8192 characters). + */ + const MAX_VALUE_LENGTH: 8192; +} + +export default preferences; diff --git a/api/@ohos.data.storage.d.ts b/api/@ohos.data.storage.d.ts index 10190d3808fe2cdc1d4ab1e511c6181f537527a5..3da37c191e7ac942c553c335a441516a376b5ccb 100644 --- a/api/@ohos.data.storage.d.ts +++ b/api/@ohos.data.storage.d.ts @@ -19,8 +19,9 @@ import { AsyncCallback, Callback } from './basic'; * * @name storage * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. * @syscap SystemCapability.DistributedDataManager.Preferences.Core - * + * */ declare namespace storage { /** @@ -33,7 +34,9 @@ declare namespace storage { * @return Returns the {@link Storage} instance matching the specified storage file name. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ + function getStorageSync(path: string): Storage; function getStorage(path: string, callback: AsyncCallback): void; function getStorage(path: string): Promise; @@ -50,6 +53,7 @@ declare namespace storage { * @param path Indicates the path of storage file * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ function deleteStorageSync(path: string): void; function deleteStorage(path: string, callback: AsyncCallback): void; @@ -66,6 +70,7 @@ declare namespace storage { * @param path Indicates the path of storage file. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ function removeStorageFromCacheSync(path: string): void; function removeStorageFromCache(path: string, callback: AsyncCallback): void; @@ -80,8 +85,9 @@ declare namespace storage { * to remove the {@link Storage} instance from the memory. * * @syscap SystemCapability.DistributedDataManager.Preferences.Core - * + * * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ interface Storage { /** @@ -94,6 +100,7 @@ declare namespace storage { * @return Returns the value matching the specified key if it is found; returns the default value otherwise. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ getSync(key: string, defValue: ValueType): ValueType; get(key: string, defValue: ValueType, callback: AsyncCallback): void; @@ -107,6 +114,7 @@ declare namespace storage { * returns {@code false} otherwise. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ hasSync(key: string): boolean; has(key: string, callback: AsyncCallback): boolean; @@ -123,6 +131,7 @@ declare namespace storage { * MAX_KEY_LENGTH. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ putSync(key: string, value: ValueType): void; put(key: string, value: ValueType, callback: AsyncCallback): void; @@ -138,6 +147,7 @@ declare namespace storage { * MAX_KEY_LENGTH. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ deleteSync(key: string): void; delete(key: string, callback: AsyncCallback): void; @@ -151,6 +161,7 @@ declare namespace storage { * * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ clearSync(): void; clear(callback: AsyncCallback): void; @@ -161,6 +172,7 @@ declare namespace storage { * * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ flushSync(): void; flush(callback: AsyncCallback): void; @@ -172,6 +184,7 @@ declare namespace storage { * @param callback Indicates the callback when storage changes. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ on(type: 'change', callback: Callback): void; @@ -181,6 +194,7 @@ declare namespace storage { * @param callback Indicates the registered callback. * @throws BusinessError if invoked failed * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ off(type: 'change', callback: Callback): void; } @@ -194,8 +208,9 @@ declare namespace storage { * Define the change data information object. * * @syscap SystemCapability.DistributedDataManager.Preferences.Core - * + * * @since 5 + * @deprecated since 9, please use @ohos.data.preferences instead. */ interface StorageObserver { /** @@ -215,4 +230,4 @@ declare namespace storage { const MAX_VALUE_LENGTH: 8192; } -export default storage; \ No newline at end of file +export default storage; diff --git a/api/@ohos.deviceInfo.d.ts b/api/@ohos.deviceInfo.d.ts index 18cca631741489f9a1ba67241cfafc5ef11ecdc4..8e91729a901cf1b776dfa7611728b7a507c71410 100644 --- a/api/@ohos.deviceInfo.d.ts +++ b/api/@ohos.deviceInfo.d.ts @@ -17,7 +17,7 @@ * A static class pertaining to the product information. * * @since 6 - * @Syscap SystemCapability.Startup.SysInfo + * @syscap SystemCapability.Startup.SysInfo */ declare namespace deviceInfo { /** diff --git a/api/@ohos.display.d.ts b/api/@ohos.display.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..024a10daef116b2e7106cb3ebb8439430354318b --- /dev/null +++ b/api/@ohos.display.d.ts @@ -0,0 +1,171 @@ +/* +* 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 +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import { AsyncCallback, Callback } from './basic'; + +/** + * interface of display manager + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 7 + */ +declare namespace display { + /** + * get the default display + * @since 7 + */ + function getDefaultDisplay(callback: AsyncCallback): void; + + /** + * get the default display + * @since 7 + */ + function getDefaultDisplay(): Promise; + + /** + * get all displays + * @since 7 + */ + function getAllDisplay(callback: AsyncCallback>): void; + + /** + * get all displays + * @since 7 + */ + function getAllDisplay(): Promise>; + + /** + * register the callback of display change + * @param type: type of callback + * @since 7 + */ + function on(type: 'add' | 'remove' | 'change', callback: Callback): void; + + /** + * unregister the callback of display change + * @param type: type of callback + * @since 7 + */ + function off(type: 'add' | 'remove' | 'change', callback?: Callback): void; + + /** + * the state of display + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 7 + */ + enum DisplayState { + /** + * unknown + */ + STATE_UNKNOWN = 0, + /** + * screen off + */ + STATE_OFF, + /** + * screen on + */ + STATE_ON, + /** + * doze, but it will update for some important system messages + */ + STATE_DOZE, + /** + * doze and not update + */ + STATE_DOZE_SUSPEND, + /** + * VR node + */ + STATE_VR, + /** + * screen on and not update + */ + STATE_ON_SUSPEND, + } + + /** + * Properties of display, it couldn't update automatically + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 7 + */ + interface Display { + /** + * display id + */ + id: number; + + /** + * display name + */ + name: string; + + /** + * the display is alive + */ + alive: boolean; + + /** + * the state of display + */ + state: DisplayState; + + /** + * refresh rate, unit: Hz + */ + refreshRate: number; + + /** + * the rotation degrees of the display + */ + rotation: number; + + /** + * the width of display, unit: pixel + */ + width: number; + + /** + * the height of display, unit: pixel + */ + height: number; + + /** + * indicates the display resolution. + */ + densityDPI: number; + + /** + * indicates the display density in pixels. The value of a low-resolution display is 1.0 + */ + densityPixels: number; + + /** + * indicates the text scale density of a display. + */ + scaledDensity: number; + + /** + * the DPI on X-axis. + */ + xDPI: number; + + /** + * the DPI on Y-axis. + */ + yDPI: number; + } +} + +export default display; \ No newline at end of file diff --git a/api/@ohos.distributedBundle.d.ts b/api/@ohos.distributedBundle.d.ts index 90aef0113a27acab1b229dbcdb05bfc4fa8bf73a..e9fea81850f660acc8f9a24d55b3d5006c313f54 100644 --- a/api/@ohos.distributedBundle.d.ts +++ b/api/@ohos.distributedBundle.d.ts @@ -23,6 +23,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @since 8 * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @permission NA + * @systemapi Hide this for inner system use */ declare namespace distributedBundle { /** @@ -32,7 +33,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @param elementName Indicates the elementName. * @return Returns the ability info of the remote device. - * @permission ohos.permission.GET_REMOTE_ABILITY_INFO_PRIVILEGED + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @systemapi */ function getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback): void; @@ -45,7 +46,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @param elementNames Indicates the elementNames, Maximum array length ten. * @return Returns the ability infos of the remote device. - * @permission ohos.permission.GET_REMOTE_ABILITY_INFO_PRIVILEGED + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @systemapi */ function getRemoteAbilityInfos(elementNames: Array, callback: AsyncCallback>): void; diff --git a/api/@ohos.fileManager.d.ts b/api/@ohos.fileManager.d.ts index f6df405e7ed3a6456173db27dc557aa37e8ff197..5486431568c4f16b31bffd1884068eca9dc6e903 100644 --- a/api/@ohos.fileManager.d.ts +++ b/api/@ohos.fileManager.d.ts @@ -30,7 +30,7 @@ declare namespace filemanager { * * @note N/A * @syscap SystemCapability.FileManagement.FileManagerService - * @since 8 + * @since 9 * @permission N/A * @function listFile * @param {string} path - path. @@ -51,7 +51,7 @@ declare function listFile(path: string, type: string, options?: {dev?: DevInfo, * * @note N/A * @syscap SystemCapability.FileManagement.FileManagerService - * @since 8 + * @since 9 * @permission N/A * @function getRoot * @param {Object} options - options @@ -68,7 +68,7 @@ declare function getRoot(options?: {dev?: DevInfo}, callback: AsyncCallback) : void; @@ -290,14 +290,14 @@ declare namespace geolocation { * satellite status information * * @since 8 - * @SysCap SystemCapability.Location.Location.Gnss + * @syscap SystemCapability.Location.Location.Gnss * @permission ohos.permission.LOCATION */ export interface SatelliteStatusInfo { satellitesNumber: number; satelliteIds: Array; carrierToNoiseDensitys: Array; - altitude: Array; + altitudes: Array; azimuths: Array; carrierFrequencies: Array; } @@ -306,7 +306,7 @@ declare namespace geolocation { * parameters for requesting to report cache location information * * @since 8 - * @SysCap SystemCapability.Location.Location.Gnss + * @syscap SystemCapability.Location.Location.Gnss * @permission ohos.permission.LOCATION */ export interface CachedGnssLoactionsRequest { @@ -318,7 +318,7 @@ declare namespace geolocation { * configuring parameters in geo fence requests * * @since 8 - * @SysCap SystemCapability.Location.Location.Geofence + * @syscap SystemCapability.Location.Location.Geofence * @permission ohos.permission.LOCATION */ export interface GeofenceRequest { @@ -331,7 +331,7 @@ declare namespace geolocation { * configuring parameters in geo fence requests * * @since 8 - * @SysCap SystemCapability.Location.Location.Geofence + * @syscap SystemCapability.Location.Location.Geofence * @permission ohos.permission.LOCATION */ export interface Geofence { @@ -346,7 +346,7 @@ declare namespace geolocation { * * @since 8 * @systemapi - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION * @param type indicates location privacy protocol type. * @param callback indicates the callback for reporting the location privacy protocol confirmation status. @@ -359,7 +359,7 @@ declare namespace geolocation { * * @since 8 * @systemapi - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION * @param type indicates location privacy protocol type. * @param isConfirmed indicates whether the location privacy protocol has been confirmed. @@ -372,7 +372,7 @@ declare namespace geolocation { * configuring parameters in reverse geocode requests * * @since 7 - * @SysCap SystemCapability.Location.Location.Geocoder + * @syscap SystemCapability.Location.Location.Geocoder * @permission ohos.permission.LOCATION */ export interface ReverseGeoCodeRequest { @@ -386,7 +386,7 @@ declare namespace geolocation { * configuring parameters in geocode requests * * @since 7 - * @SysCap SystemCapability.Location.Location.Geocoder + * @syscap SystemCapability.Location.Location.Geocoder * @permission ohos.permission.LOCATION */ export interface GeoCodeRequest { @@ -403,7 +403,7 @@ declare namespace geolocation { * data struct describes geographic locations. * * @since 7 - * @SysCap SystemCapability.Location.Location.Geocoder + * @syscap SystemCapability.Location.Location.Geocoder * @permission ohos.permission.LOCATION */ export interface GeoAddress { @@ -431,7 +431,7 @@ declare namespace geolocation { * configuring parameters in location requests * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export interface LocationRequest { @@ -446,7 +446,7 @@ declare namespace geolocation { * configuring parameters in current location requests * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export interface CurrentLocationRequest { @@ -460,7 +460,7 @@ declare namespace geolocation { * provides information about geographic locations * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export interface Location { @@ -480,7 +480,7 @@ declare namespace geolocation { * enum for location priority * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export enum LocationRequestPriority { @@ -494,7 +494,7 @@ declare namespace geolocation { * enum for location scenario * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export enum LocationRequestScenario { @@ -510,7 +510,7 @@ declare namespace geolocation { * enum for error code * * @since 7 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export enum GeoLocationErrorCode { @@ -527,7 +527,7 @@ declare namespace geolocation { * enum for location privacy type * * @since 8 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export enum LocationPrivacyType { @@ -540,7 +540,7 @@ declare namespace geolocation { * Location subsystem command structure * * @since 8 - * @SysCap SystemCapability.Location.Location.Core + * @syscap SystemCapability.Location.Location.Core * @permission ohos.permission.LOCATION */ export interface LocationCommand { diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index cec604281101c1f0c31084b969968bd8370d1153..b8dc57ffdc71da03f96bcd0d055c1b8c62438992 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -16,14 +16,14 @@ /** * Provides international settings related APIs. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 7 */ declare namespace i18n { /** * Obtains the country or region name localized for display on a given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param country The locale whose country or region name will be displayed. * @param locale The locale used to display the country or region. * @param sentenceCase Specifies whether the country or region name is displayed in sentence case. @@ -35,7 +35,7 @@ export function getDisplayCountry(country: string, locale: string, sentenceCase? /** * Obtains the language name localized for display on a given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The locale whose language name will be displayed. * @param locale The locale used to display the language. * @param sentenceCase Specifies whether the language name is displayed in sentence case. @@ -47,7 +47,7 @@ export function getDisplayLanguage(language: string, locale: string, sentenceCas /** * Obtain all languages supported by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns all languages supported by the system. * @since 7 * @systemapi Hide this for inner system use. @@ -57,7 +57,7 @@ export function getSystemLanguages(): Array; /** * Obtain all regions supported by the system in the language. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language used to get the list of regions. * @return Returns all regions supported by the system in the language. * @since 7 @@ -68,7 +68,7 @@ export function getSystemCountries(language: string): Array; /** * Determine whether the current language or region is recommended. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language code. * @param region The region code. * @return Returns whether the current language or region is recommended. @@ -80,7 +80,7 @@ export function isSuggested(language: string, region?: string): boolean; /** * Obtain the language currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the language currently used by the system. * @since 7 */ @@ -89,7 +89,7 @@ export function getSystemLanguage(): string; /** * Set the language currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -99,7 +99,7 @@ export function setSystemLanguage(language: string): boolean; /** * Obtain the region currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the region currently used by the system. * @since 7 */ @@ -108,7 +108,7 @@ export function getSystemRegion(): string; /** * Set the region currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param region The region to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -118,7 +118,7 @@ export function setSystemRegion(region: string): boolean; /** * Obtain the locale currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the locale currently used by the system. * @since 7 */ @@ -127,7 +127,7 @@ export function getSystemLocale(): string; /** * Set the locale currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -137,14 +137,14 @@ export function setSystemLocale(locale: string): boolean; /** * Provides util functions. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface Util { /** * Convert from unit to to unit and format according to the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param fromUnit Information of the unit to be converted. * @param toUnit Information about the unit to be converted to. * @param value Indicates the number to be formatted. @@ -158,7 +158,7 @@ export interface Util { /** * Provides the options of unit. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface UnitInfo { @@ -176,7 +176,7 @@ export interface UnitInfo { /** * Provides the options of PhoneNumberFormat. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface PhoneNumberFormatOptions { @@ -189,14 +189,14 @@ export interface PhoneNumberFormatOptions { /** * Provides the API for formatting phone number strings * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class PhoneNumberFormat { /** * A constructor used to create a PhoneNumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param country Indicates a character string containing the country information for the PhoneNumberFormat object. * @param type Indicates the type used to format the phone number, includes: "E164", "RFC3966", "INTERNATIONAL", "NATIONAL". * @since 8 @@ -206,7 +206,7 @@ export class PhoneNumberFormat { /** * Judges whether phone number is valid. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the input phone number to be judged. * @return Returns a boolean indicates whether the input phone number is valid. * @since 8 @@ -216,7 +216,7 @@ export class PhoneNumberFormat { /** * Obtains the formatted phone number strings of number. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the input phone number to be formatted. * @return Returns the formatted phone number. * @since 8 @@ -227,7 +227,7 @@ export class PhoneNumberFormat { /** * Get a Calendar instance specified by locale and type. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale used to get calendar. * @param type If type is not specified, get locale's default Calendar, else get the specified type of Calendar. * such as buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, @@ -240,7 +240,7 @@ export class Calendar { /** * set the date. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Date object used to set the time and date. * @since 8 */ @@ -249,7 +249,7 @@ export class Calendar { /** * set the time. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param time Indicates the elapsed milliseconds from 1970.1.1 00:00:00 GMT. * @since 8 */ @@ -258,7 +258,7 @@ export class Calendar { /** * Set the time * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param year The year field of the calendar, ranges from 0 to 9999. * @param month The month field of the calendar, ranges from 0 to 11. * @param date The day field of the calendar, ranges from 1 to 31. @@ -272,7 +272,7 @@ export class Calendar { /** * Set the timezone of this calendar. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param timezone The id of a timezone. * @since 8 */ @@ -281,7 +281,7 @@ export class Calendar { /** * Get the timezone id of this calendar instance. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the timezone id of this calendar. * @since 8 */ @@ -290,7 +290,7 @@ export class Calendar { /** * Get the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns start day of a week. * @since 8 */ @@ -299,7 +299,7 @@ export class Calendar { /** * Set the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value Indicates the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * @since 8 */ @@ -308,7 +308,7 @@ export class Calendar { /** * Get the minimal days of a week, which is needed for the first day of a year. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the minimal days of a week. * @since 8 */ @@ -317,7 +317,7 @@ export class Calendar { /** * Set the minimal days of a week, which is needed for the first week of a year. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value The value to be set. * @since 8 */ @@ -326,7 +326,7 @@ export class Calendar { /** * Get the associated value with the field. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param field Field values such as era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week * day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, * dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month. @@ -338,7 +338,7 @@ export class Calendar { /** * Get calendar's name localized for display in the given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Locale used to get the localized name for this calendar. * @return Returns the localized name of this calendar. * @since 8 @@ -349,7 +349,7 @@ export class Calendar { * Returns true if the given date is a weekend day. If the date is not given, * the date object of this calendar is used. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Date object whose attribute is desired. * @return Returns whether the date is a weekend day. * @since 8 @@ -360,7 +360,7 @@ export class Calendar { /** * Judge whether the locale is RTL locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale to be used. * @return Returns true representing the locale is an RTL locale * @@ -371,7 +371,7 @@ export function isRTL(locale: string): boolean; /** * Obtains a BreakIterator object for finding the location of break point in text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale the returned BreakIterator will adapt the rule, specified by the locale, to break text. * @return Returns a newly constructed BreakIterator object. * @since 8 @@ -381,14 +381,14 @@ export function isRTL(locale: string): boolean; /** * The BreakIterator class is used for finding the location of break point in text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class BreakIterator { /** * Obtains the current position of the BreakIterator instance. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the current position of the BreakIterator instance. * @since 8 */ @@ -398,7 +398,7 @@ export class BreakIterator { * Set the BreakIterator's position to the first break point, the first break point is always the beginning of the * processed text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the first break point. * @since 8 */ @@ -408,7 +408,7 @@ export class BreakIterator { * Set the BreakIterator's position to the last break point. the last break point is always the index beyond the * last character of the processed text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the last break point. * @since 8 */ @@ -417,7 +417,7 @@ export class BreakIterator { /** * Set the BreakItertor's position to the nth break point from the current break point. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param index indicates the number of break points to advance. If index is not given, n is treated as 1. * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 @@ -427,7 +427,7 @@ export class BreakIterator { /** * Set the BreakItertor's position to the break point preceding the current break point. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 */ @@ -436,7 +436,7 @@ export class BreakIterator { /** * Set the text to be processed. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param text Indicates the text to be processed by the BreakIterator. * @since 8 */ @@ -445,7 +445,7 @@ export class BreakIterator { /** * Set the BreakIterator's position to the first break point following the specified offset. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 */ @@ -454,7 +454,7 @@ export class BreakIterator { /** * Obtains the text being processed. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the text that is processed by the BreakIterator. * @since 8 */ @@ -465,7 +465,7 @@ export class BreakIterator { * position will be set to the position indicated by the offset if it returns true, otherwise the BreakIterator * will be moved to the break point following the offset. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param offset The offset to be checked. * @return Returns true if the offset is a break point. * @since 8 @@ -477,14 +477,14 @@ export class BreakIterator { * Sequence text can be grouped under the specified area, * and grouping index with different lengths can be specified. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class IndexUtil { /** * Get IndexUtil object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the NumberFormat object. * @return Returns IndexUtil object. @@ -495,7 +495,7 @@ export class IndexUtil { /** * Get a list of labels for use as a UI index * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a list of labels * @since 8 */ @@ -504,7 +504,7 @@ export class IndexUtil { /** * Add the index characters from a Locale to the index. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale whose index characters are to be added. * @since 8 */ @@ -513,7 +513,7 @@ export class IndexUtil { /** * Get corresponding index of the input text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param text input text * @since 8 */ @@ -523,14 +523,14 @@ export class IndexUtil { /** * Provides the API for accessing unicode character properties, sunch as whether a character is a digit. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class Character { /** * Determines whether the specified code point is a digit character * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a digit character */ @@ -539,7 +539,7 @@ export class Character { /** * Determines if the specified character is a space character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a space character */ @@ -548,7 +548,7 @@ export class Character { /** * Determines if the specified character is a whitespace character * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a whitespace character */ @@ -557,7 +557,7 @@ export class Character { /** * Determines if the specified character is a RTL character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a RTL character */ @@ -566,7 +566,7 @@ export class Character { /** * Determines if the specified character is a Ideographic character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a Ideographic character */ @@ -575,7 +575,7 @@ export class Character { /** * Determines if the specified character is a Letter or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a Letter */ @@ -584,7 +584,7 @@ export class Character { /** * Determines if the specified character is a LowerCase character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a LowerCase character */ @@ -593,7 +593,7 @@ export class Character { /** * Determines if the specified character is a UpperCase character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a UpperCase character */ @@ -602,7 +602,7 @@ export class Character { /** * Get the general category value of the specified character. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns the general category of the specified character. */ @@ -612,7 +612,7 @@ export class Character { /** * check out whether system is 24-hour system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a boolean represent whether system is 24-hour system. * @since 8 */ @@ -621,7 +621,7 @@ export class Character { /** * set 24-hour system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param option represent the boolean to be set. * @return Returns a boolean represent whether setting 24-hour system success. * @since 8 @@ -631,7 +631,7 @@ export class Character { /** * Add one language to preferred language List. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language the language to be added. * @param index the position of preferred language list to be inserted. * @return Returns a boolean represent whether language added success. @@ -642,7 +642,7 @@ export function addPreferredLanguage(language: string, index?: number): boolean; /** * Remove one language from preferred language list. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param index the position of removed language in preferred language list. * @return Returns a boolean represent whether removed success. * @since 8 @@ -652,7 +652,7 @@ export function removePreferredLanguage(index: number): boolean; /** * Access the system preferred language list. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a string Array represent the preferred language list. * @since 8 */ @@ -661,7 +661,7 @@ export function getPreferredLanguageList(): Array; /** * Get the first preferred language of system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a string represent the first preferred language of system. * @since 8 */ diff --git a/api/@ohos.intl.d.ts b/api/@ohos.intl.d.ts index 2a1bcdda7275691cb16a09c5fef05809dce04de5..5bf8f664ee8afb4982d3f80f293a2fd960d43ed3 100755 --- a/api/@ohos.intl.d.ts +++ b/api/@ohos.intl.d.ts @@ -16,7 +16,7 @@ /** * Provides internationalization related APIs. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ declare namespace intl { @@ -24,7 +24,7 @@ declare namespace intl { * Provides the options of Locale. * * @since 8 - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface LocaleOptions { /** @@ -73,14 +73,14 @@ export interface LocaleOptions { /** * Provides APIs for obtaining locale information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ export class Locale { /** * A constructor used to create a Locale object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region. * @since 6 @@ -90,7 +90,7 @@ export class Locale { /** * Indicates the language of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ language: string @@ -98,7 +98,7 @@ export class Locale { /** * Indicates the script of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ script: string @@ -106,7 +106,7 @@ export class Locale { /** * Indicates the region of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ region: string @@ -115,7 +115,7 @@ export class Locale { * Indicates the basic locale information, which is returned as a substring of * a complete locale string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ baseName: string @@ -153,7 +153,7 @@ export class Locale { /** * Convert the locale information to string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns locale information in string form. */ toString(): string; @@ -161,7 +161,7 @@ export class Locale { /** * Maximize the locale's base information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns maximized locale. */ maximize(): Locale; @@ -169,7 +169,7 @@ export class Locale { /** * Minimize the locale's base information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns minimized locale. */ minimize(): Locale; @@ -178,7 +178,7 @@ export class Locale { /** * Provides the options of date time format. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface DateTimeOptions { /** @@ -280,14 +280,14 @@ export interface DateTimeOptions { /** * Provides the API for formatting date strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ export class DateTimeFormat { /** * A constructor used to create a DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -295,7 +295,7 @@ export class DateTimeFormat { /** * A constructor used to create a DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates character string containing the locale information, including * the language and optionally the script and region, for the DateTimeFormat object. * @param options Indicates the options used to format the date. @@ -306,7 +306,7 @@ export class DateTimeFormat { /** * Obtains the formatted date strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Indicates the Date object to be formatted. * @return Returns a date string formatted based on the specified locale. * @since 6 @@ -316,7 +316,7 @@ export class DateTimeFormat { /** * Obtains the formatted date strings of a date range. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param startDate Indicates the start date of the date range. * @param endDate Indicates the end date of the date range. * @return Returns a date string formatted based on the specified locale. @@ -327,7 +327,7 @@ export class DateTimeFormat { /** * Obtains the options of the DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the options of the DateTimeFormat object. * @since 6 */ @@ -337,7 +337,7 @@ export class DateTimeFormat { /** * Provides the options of number format. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface NumberOptions { /** @@ -439,13 +439,13 @@ export interface NumberOptions { /** * Provides the API for formatting number strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export class NumberFormat { /** * A constructor used to create a NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -453,7 +453,7 @@ export class NumberFormat { /** * A constructor used to create a NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the NumberFormat object. * @param options Indicates the options used to format the number. @@ -464,7 +464,7 @@ export class NumberFormat { /** * Obtains the formatted number string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the number to be formatted. * @return Returns a number string formatted based on the specified locale. * @since 6 @@ -474,7 +474,7 @@ export class NumberFormat { /** * Obtains the options of the NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the options of the NumberFormat object. * @since 6 */ @@ -484,7 +484,7 @@ export class NumberFormat { /** * Provides the options of Collator * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface CollatorOptions { @@ -533,21 +533,21 @@ export interface CollatorOptions { /** * Enable language-sensitive string comparison. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class Collator { /** * A constructor used to create Collator object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); /** * A constructor used to create Collator Object; * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the Collator object. * @param options Indicates the options used to initialize Collator object. @@ -558,7 +558,7 @@ export class Collator { /** * compares two strings according to the sort order of this Collator object * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param first The first string to compare. * @param second The second string to compare. * @return Returns a number indicating how first compare to second: @@ -573,7 +573,7 @@ export class Collator { * Returns a new object with properties reflecting the locale and collation options computed * during initialization of the object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a CollatorOptions object reflecting the properties of this object. * @since 8 */ @@ -583,7 +583,7 @@ export class Collator { /** * Provides the options of PluralRules * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface PluralRulesOptions { @@ -633,14 +633,14 @@ export interface PluralRulesOptions { /** * Enables plural-sensitive formatting and plural-related language rules. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class PluralRules { /** * A constructor used to create PluralRules object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -648,7 +648,7 @@ export class PluralRules { /** * A constructor used to create PluralRules object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the PluralRules object. * @param options Indicates the options used to initialize PluralRules object. @@ -659,7 +659,7 @@ export class PluralRules { /** * Returns a string indicating which plural rule to use for locale-aware formatting. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param n The number to get a plural rule for. * @return A string representing the pluralization category of the number, * can be one of zero, one, two, few, many or other. @@ -671,7 +671,7 @@ export class PluralRules { /** * Provides the input options of RelativeTimeFormat. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface RelativeTimeFormatInputOptions { @@ -697,7 +697,7 @@ export class PluralRules { /** * Provides the resolved options of RelativeTimeFormat. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface RelativeTimeFormatResolvedOptions { @@ -728,14 +728,14 @@ export interface RelativeTimeFormatResolvedOptions { * Given a Time period length value and a unit, RelativeTimeFormat object enables * language-sensitive relative time formatting. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @since 8 */ export class RelativeTimeFormat { /** * A constructor used to create RelativeTimeFormat object. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -743,7 +743,7 @@ export class RelativeTimeFormat { /** * A constructor used to create RelativeTimeFormat object. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the RelativeTimeFormat object. * @param options Indicates the options used to initialize RelativeTimeFormat object. @@ -754,7 +754,7 @@ export class RelativeTimeFormat { /** * formats a value and unit according to the locale and formatting options of this object. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @param value Numeric value to use in the internationalized relative time message. * @param unit Unit to use in the relative time internationalized message. * Possible values are: year, quarter, month, week, day, hour, minute, second. @@ -767,7 +767,7 @@ export class RelativeTimeFormat { * returns an Array of objects representing the relative time format in parts that can be used for * custom locale-aware formatting * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @param value Numeric value to use in the internationalized relative time message. * @param unit to use in the relative time internationalized message. * Possible values are: year, quarter, month, week, day, hour, minute, second. @@ -780,7 +780,7 @@ export class RelativeTimeFormat { * Returns a new object with properties reflecting the locale and formatting options computed during * initialization of the object. * - * @sysCap SystemCapability.Intl + * @syscap SystemCapability.Global.I18n * @returns RelativeTimeFormatOptions which reflecting the locale and formatting options of the object. * @since 8 */ diff --git a/api/@ohos.matrix4.d.ts b/api/@ohos.matrix4.d.ts index 635a260179ca9879324b6c25558f6dd2759501a0..30158cb8cc984c074fcdfb835113425b543d65b1 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 fe889218bf4c2fbc32eb5beb197e38dc4c4db719..011ea459d14f1cff726090d1e3b405ae469d5157 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.multimedia.audio.d.ts b/api/@ohos.multimedia.audio.d.ts index 9970a64dabd8d1d6632dcfc0ce5793c0aacf190f..817083957e6d243884cd00266677a5fed62cb7fe 100644 --- a/api/@ohos.multimedia.audio.d.ts +++ b/api/@ohos.multimedia.audio.d.ts @@ -690,6 +690,7 @@ declare namespace audio { * Interrupt force type. * @since 8 * @syscap SystemCapability.Multimedia.Audio.Renderer + * @systemapi */ enum InterruptForceType { /** @@ -782,7 +783,7 @@ declare namespace audio { * Enumerates audio scenes. * @since 8 * @syscap SystemCapability.Multimedia.Audio.Communication - */ + */ enum AudioScene { /** * Default audio scene @@ -1030,12 +1031,14 @@ declare namespace audio { * This method uses an asynchronous callback to return the execution result. * @since 8 * @syscap SystemCapability.Multimedia.Audio.Communication + * @systemapi */ setAudioScene(scene: AudioScene, callback: AsyncCallback ): void; /** * Sets the audio scene mode to change audio strategy. This method uses a promise to return the execution result. * @since 8 * @syscap SystemCapability.Multimedia.Audio.Communication + * @systemapi */ setAudioScene(scene: AudioScene): Promise; /** @@ -1043,7 +1046,7 @@ declare namespace audio { * @since 8 * @syscap SystemCapability.Multimedia.Audio.Communication */ - getAudioScene(callback: AsyncCallback ): void; + getAudioScene(callback: AsyncCallback): void; /** * Obtains the system audio scene mode. This method uses a promise to return the execution result. * @since 8 @@ -1391,6 +1394,7 @@ declare namespace audio { * @return InterruptEvent callback. * @since 8 * @syscap SystemCapability.Multimedia.Audio.Renderer + * @systemapi */ on(type: 'interrupt', callback: Callback): void; /** diff --git a/api/@ohos.multimedia.image.d.ts b/api/@ohos.multimedia.image.d.ts index da3700eec7a52597c2696687190e670e9e4f6825..74aef73ea4ae607f1f2fb7a083bea55be07da74f 100644 --- a/api/@ohos.multimedia.image.d.ts +++ b/api/@ohos.multimedia.image.d.ts @@ -162,6 +162,7 @@ declare namespace image { * The componet type of image. * @since 8 * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @systemapi */ enum ComponentType { /** @@ -374,6 +375,7 @@ declare namespace image { * Describes image color components. * @since 8 * @syscap SystemCapability.Multimedia.Image.Core + * @systemapi */ interface Component { /** @@ -483,6 +485,7 @@ declare namespace image { * {@link ImageFormat} constants. Note that not all formats are supported, like ImageFormat.NV21. * @param capacity The maximum number of images the user will want to access simultaneously. * @return Returns the ImageReceiver instance if the operation is successful; returns null otherwise. + * @systemapi */ function createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver; @@ -817,6 +820,7 @@ declare namespace image { * Provides basic image operations, including obtaining image information, and reading and writing image data. * @since 8 * @syscap SystemCapability.Multimedia.Image.Core + * @systemapi */ interface Image { /** @@ -879,6 +883,7 @@ declare namespace image { * Image receiver object. * @since 8 * @syscap SystemCapability.Multimedia.Image.ImageReceiver + * @systemapi */ interface ImageReceiver { /** diff --git a/api/@ohos.multimedia.media.d.ts b/api/@ohos.multimedia.media.d.ts old mode 100755 new mode 100644 index c33f70bef3721965f684172ae32d90933aa3329b..c08a3fb85b99b7d3acc14cbf6d3648ac7abba111 --- a/api/@ohos.multimedia.media.d.ts +++ b/api/@ohos.multimedia.media.d.ts @@ -62,6 +62,7 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @import import media from '@ohos.multimedia.media' * @param callback Callback used to return AudioPlayer instance if the operation is successful; returns null otherwise. + * @systemapi */ function createVideoRecorder(callback: AsyncCallback): void; /** @@ -70,6 +71,7 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @import import media from '@ohos.multimedia.media' * @return A Promise instance used to return VideoRecorder instance if the operation is successful; returns null otherwise. + * @systemapi */ function createVideoRecorder(): Promise; @@ -349,12 +351,40 @@ declare namespace media { * @deprecated since 8 */ enum AudioEncoder { + /** + * Default audio encoding format, which is AMR-NB. + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + DEFAULT = 0, + + /** + * Indicates the AMR-NB audio encoding format. + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + AMR_NB = 1, + + /** + * Indicates the AMR-WB audio encoding format. + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + AMR_WB = 2, + /** * Advanced Audio Coding Low Complexity (AAC-LC). * @since 6 * @syscap SystemCapability.Multimedia.Media.AudioRecorder */ AAC_LC = 3, + + /** + * High-Efficiency Advanced Audio Coding (HE-AAC). + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + HE_AAC = 4 } /** @@ -365,6 +395,13 @@ declare namespace media { * @deprecated since 8 */ enum AudioOutputFormat { + /** + * Default audio output format, which is Moving Pictures Expert Group 4 (MPEG-4). + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + DEFAULT = 0, + /** * Indicates the Moving Picture Experts Group-4 (MPEG4) media format. * @since 6 @@ -372,6 +409,20 @@ declare namespace media { */ MPEG_4 = 2, + /** + * Indicates the Adaptive Multi-Rate Narrowband (AMR-NB) media format. + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + AMR_NB = 3, + + /** + * Indicates the Adaptive Multi-Rate Wideband (AMR-WB) media format. + * @since 6 + * @syscap SystemCapability.Multimedia.Media.AudioRecorder + */ + AMR_WB = 4, + /** * Audio Data Transport Stream (ADTS), a transmission stream format of Advanced Audio Coding (AAC) audio. * @since 6 @@ -559,6 +610,7 @@ declare namespace media { * Describes video recorder states. * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder + * @systemapi */ type VideoRecordState = 'idle' | 'prepared' | 'playing' | 'paused' | 'stopped' | 'error'; @@ -567,6 +619,7 @@ declare namespace media { * to create an VideoRecorder instance. * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder + * @systemapi */ interface VideoRecorder { /** @@ -1158,6 +1211,7 @@ declare namespace media { * Provides the video recorder profile definitions. * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder + * @systemapi */ interface VideoRecorderProfile { /** @@ -1236,6 +1290,7 @@ declare namespace media { * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @import import media from '@ohos.multimedia.media' + * @systemapi */ enum AudioSourceType { /** @@ -1257,6 +1312,7 @@ declare namespace media { * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @import import media from '@ohos.multimedia.media' + * @systemapi */ enum VideoSourceType { /** @@ -1277,6 +1333,7 @@ declare namespace media { * Provides the video recorder configuration definitions. * @since 8 * @syscap SystemCapability.Multimedia.Media.VideoRecorder + * @systemapi */ interface VideoRecorderConfig { /** diff --git a/api/@ohos.multimedia.mediaLibrary.d.ts b/api/@ohos.multimedia.mediaLibrary.d.ts index 32b8fd0b1add3e489963b3b240982c1344889f00..45a0cbd12502e79e1bab4a00677720d3d313b626 100644 --- a/api/@ohos.multimedia.mediaLibrary.d.ts +++ b/api/@ohos.multimedia.mediaLibrary.d.ts @@ -13,8 +13,8 @@ * limitations under the License. */ -import { AsyncCallback } from './basic'; -import Context from './@ohos.ability'; +import { AsyncCallback, Callback } from './basic'; +import { Context } from './app/context'; import image from './@ohos.multimedia.image'; /** @@ -38,7 +38,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @StageModelOnly - * @param Hap context information + * @param context hap context information * @return Instance of MediaLibrary */ function getMediaLibrary(context: Context): MediaLibrary; @@ -262,62 +262,71 @@ declare namespace mediaLibrary { * If it is a directory where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param callback, Callback return the result of isDerectory. + * @permission ohos.permission.READ_MEDIA + * @param callback Callback return the result of isDerectory. */ isDirectory(callback: AsyncCallback): void; /** * If it is a directory where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA */ isDirectory():Promise; /** * Modify meta data where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param callback, no value will be returned. + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA + * @param callback no value will be returned. */ commitModify(callback: AsyncCallback): void; /** * Modify meta data where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA */ commitModify(): Promise; /** * Open the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param mode, mode for open, for example: rw, r, w. - * @param callback, Callback return the fd of the file. + * @permission ohos.permission.READ_MEDIA | ohos.permission.WRITE_MEDIA + * @param mode mode for open, for example: rw, r, w. + * @param callback Callback return the fd of the file. */ open(mode: string, callback: AsyncCallback): void; /** * Open the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param mode, mode for open, for example: rw, r, w. + * @permission ohos.permission.READ_MEDIA | ohos.permission.WRITE_MEDIA + * @param mode mode for open, for example: rw, r, w. */ open(mode: string): Promise; /** * Close the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param fd, fd of the file which had been opened - * @param callback, no value will be returned. + * @permission ohos.permission.READ_MEDIA | ohos.permission.WRITE_MEDIA + * @param fd fd of the file which had been opened + * @param callback no value will be returned. */ close(fd: number, callback: AsyncCallback): void; /** * Close the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param fd, fd of the file which had been opened + * @permission ohos.permission.READ_MEDIA | ohos.permission.WRITE_MEDIA + * @param fd fd of the file which had been opened */ close(fd: number): Promise; /** * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the thumbnail's pixelmap. */ getThumbnail(callback: AsyncCallback): void; @@ -325,7 +334,8 @@ declare namespace mediaLibrary { * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param size, thumbnail's size + * @permission ohos.permission.READ_MEDIA + * @param size thumbnail's size * @param callback Callback used to return the thumbnail's pixelmap. */ getThumbnail(size: Size, callback: AsyncCallback): void; @@ -333,13 +343,15 @@ declare namespace mediaLibrary { * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param size, thumbnail's size + * @permission ohos.permission.READ_MEDIA + * @param size thumbnail's size */ getThumbnail(size?: Size): Promise; /** * Set favorite for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param isFavorite ture is favorite file, false is not favorite file * @param callback Callback used to return, No value is returned. */ @@ -348,6 +360,7 @@ declare namespace mediaLibrary { * Set favorite for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param isFavorite ture is favorite file, false is not favorite file */ favorite(isFavorite: boolean): Promise; @@ -355,6 +368,7 @@ declare namespace mediaLibrary { * If the file is favorite when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. */ isFavorite(callback: AsyncCallback): void; @@ -362,27 +376,31 @@ declare namespace mediaLibrary { * If the file is favorite when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA */ isFavorite():Promise; /** * Set trash for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file - * @param callback Callback used to return, No value is returned. + * @param callback Callback used to return, No value is returned. */ trash(isTrash: boolean, callback: AsyncCallback): void; /** * Set trash for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file */ - trash(isTrash: boolean,): Promise; + trash(isTrash: boolean): Promise; /** * If the file is in trash when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. */ isTrash(callback: AsyncCallback): void; @@ -390,6 +408,7 @@ declare namespace mediaLibrary { * If the file is in trash when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA */ isTrash():Promise; } @@ -535,7 +554,7 @@ declare namespace mediaLibrary { */ selectionArgs: Array; /** - * Sorting criterion of the retrieval results, for example, order: "datetaken DESC,_display_name DESC, _id DESC". + * Sorting criterion of the retrieval results, for example, order: "datetaken DESC,display_name DESC, file_id DESC". * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core */ @@ -731,6 +750,7 @@ declare namespace mediaLibrary { * Modify the meta data for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param callback, no value will be returned. */ commitModify(callback: AsyncCallback): void; @@ -738,12 +758,14 @@ declare namespace mediaLibrary { * Modify the meta data for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA */ commitModify(): Promise; /** * SObtains files in an album. This method uses an asynchronous callback to return the files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the files in the format of a FetchFileResult instance. */ getFileAssets(callback: AsyncCallback): void; @@ -751,6 +773,7 @@ declare namespace mediaLibrary { * SObtains files in an album. This method uses an asynchronous callback to return the files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return the files in the format of a FetchFileResult instance. */ @@ -759,6 +782,7 @@ declare namespace mediaLibrary { * Obtains files in an album. This method uses a promise to return the files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @return A Promise instance used to return the files in the format of a FetchFileResult instance. */ @@ -821,15 +845,15 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type, public directory predefined in DirectoryType. - * @param callback, Callback return the FetchFileResult. + * @param callback Callback return the FetchFileResult. */ getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; /** * get system predefined root dir, use to create file asset by relative path * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param type, public directory predefined in DirectoryType. - * @param return A promise instance used to return the public directory in the format of string + * @param type public directory predefined in DirectoryType. + * @return A promise instance used to return the public directory in the format of string */ getPublicDirectory(type: DirectoryType): Promise; /** @@ -837,6 +861,7 @@ declare namespace mediaLibrary { * if need all data, getAllObject from FetchFileResult * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param options, Media retrieval options. * @param callback, Callback return the FetchFileResult. */ @@ -846,33 +871,35 @@ declare namespace mediaLibrary { * if need all data, getAllObject from FetchFileResult * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param options, Media retrieval options. + * @permission ohos.permission.READ_MEDIA + * @param options Media retrieval options. * @return A promise instance used to return the files in the format of a FetchFileResult instance */ getFileAssets(options: MediaFetchOptions): Promise; /** - * Trun on mornitor the data changes by media type + * Turn on mornitor the data changes by media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param type, mediaType + * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned */ - on(type: 'Device'|'Album'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback: () => {}): void; + on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback): void; /** - * Trun off Mornitor the data changes by media type + * Turn off mornitor the data changes by media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param type, mediaType + * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned */ - off(type: 'Device'|'Album'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback?: () => {}): void; + off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback): void; /** * Create File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param mediaType, mediaType for example:IMAGE, VIDEO, AUDIO, FILE - * @param displayName, file name - * @param relativePath, relative path + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA + * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE + * @param displayName file name + * @param relativePath relative path * @param callback Callback used to return the FileAsset */ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback): void; @@ -880,9 +907,10 @@ declare namespace mediaLibrary { * Create File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param mediaType, mediaType for example:IMAGE, VIDEO, AUDIO, FILE - * @param displayName, file name - * @param relativePath, relative path + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA + * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE + * @param displayName file name + * @param relativePath relative path * @return A Promise instance used to return the FileAsset */ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise; @@ -890,22 +918,27 @@ declare namespace mediaLibrary { * Delete File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param uri, FileAsset's URI + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA + * @param uri FileAsset's URI * @param callback no value returned + * @systemapi */ deleteAsset(uri: string, callback: AsyncCallback): void; /** * Delete File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA * @param uri, FileAsset's URI * @return A Promise instance, no value returned + * @systemapi */ deleteAsset(uri: string): Promise; /** * Obtains albums based on the media retrieval options. This method uses an asynchronous callback to return. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return an album array. */ @@ -914,6 +947,7 @@ declare namespace mediaLibrary { * Obtains albums based on the media retrieval options. This method uses a promise to return the albums. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @return A Promise instance used to return an album array. */ @@ -985,6 +1019,7 @@ declare namespace mediaLibrary { * Get Active Peer device information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @permission ohos.permission.READ_MEDIA * @systemapi * @param callback, Callback return the list of the active peer devices' information */ @@ -993,6 +1028,7 @@ declare namespace mediaLibrary { * Get Active Peer device information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @permission ohos.permission.READ_MEDIA * @systemapi * @return Promise used to return the list of the active peer devices' information */ @@ -1001,14 +1037,16 @@ declare namespace mediaLibrary { * Get all the peer devices' information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @permission ohos.permission.READ_MEDIA * @systemapi - * @param callback, Callback return the list of the all the peer devices' information + * @param callback Callback return the list of the all the peer devices' information */ getAllPeers(callback: AsyncCallback>): void; /** * Get all the peer devices' information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @permission ohos.permission.READ_MEDIA * @systemapi * @return Promise used to return the list of the all the peer devices' information */ @@ -1017,7 +1055,7 @@ declare namespace mediaLibrary { * Release MediaLibrary instance * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core - * @param callback, no value returned + * @param callback no value returned */ release(callback: AsyncCallback): void; /** diff --git a/api/@ohos.multimodalInput.inputConsumer.d.ts b/api/@ohos.multimodalInput.inputConsumer.d.ts index 389f62a0139347e7ba83d2f08cc101962ecbab8f..e10019666ddd9e967e9eefb947365fc997357501 100755 --- a/api/@ohos.multimodalInput.inputConsumer.d.ts +++ b/api/@ohos.multimodalInput.inputConsumer.d.ts @@ -13,7 +13,7 @@ * limitations under the License. */ -import { AsyncCallback } from './basic'; +import { Callback } from './basic'; /** * The event of key input management module is configured to subscribe and unsubscribe system keys. @@ -47,11 +47,11 @@ declare namespace inputConsumer { * @since 8 * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @permission N/A - * @param type type of the keyevent about input which is to be subscribed. + * @param type type of the inputevent about input which is to be subscribed. * @param keyOption the key events about input which is to be subscribed. * @param callback callback function, receive reported data. */ - function on(type: string, keyOption: KeyOptions, callback: AsyncCallback): void; + function on(type: "key", keyOptions: KeyOptions, callback: Callback): void; /** * Subscribe system keys. @@ -59,11 +59,11 @@ declare namespace inputConsumer { * @since 8 * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @permission N/A - * @param type type of the keyevent about input which is to be subscribed. + * @param type type of the inputevent about input which is to be subscribed. * @param keyOption the key events about input which is to be subscribed. * @param callback callback function, receive reported data. */ - function off(type: string, keyOption: KeyOptions, callback: AsyncCallback): void; + function off(type: "key", keyOptions: KeyOptions, callback?: Callback): void; } export default inputConsumer; \ No newline at end of file diff --git a/api/@ohos.net.http.d.ts b/api/@ohos.net.http.d.ts index 9d555afdde77c8873a33342ed88cf9752506fed7..b6ecab57c160bc35a91f068d04def36f56c23288 100644 --- a/api/@ohos.net.http.d.ts +++ b/api/@ohos.net.http.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 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 @@ -71,13 +71,38 @@ declare namespace http { /** * Registers an observer for HTTP Response Header events. + * + * @deprecated use on_headersReceive instead since 8. */ on(type: "headerReceive", callback: AsyncCallback): void; /** * Unregisters the observer for HTTP Response Header events. + * + * @deprecated use off_headersReceive instead since 8. */ off(type: "headerReceive", callback?: AsyncCallback): void; + + /** + * Registers an observer for HTTP Response Header events. + * + * @since 8 + */ + on(type: "headersReceive", callback: Callback): void; + + /** + * Unregisters the observer for HTTP Response Header events. + * + * @since 8 + */ + off(type: "headersReceive", callback?: Callback): void; + + /** + * Registers a one-time observer for HTTP Response Header events. + * + * @since 8 + */ + once(type: "headersReceive", callback: Callback): void; } export enum RequestMethod { @@ -131,7 +156,7 @@ declare namespace http { export interface HttpResponse { /** - * result can be a string or an Object (API 6) or an ArrayBuffer(API 8). + * result can be a string (API 6) or an ArrayBuffer(API 8). Object is deprecated from API 8. */ result: string | Object | ArrayBuffer; /** diff --git a/api/@ohos.net.socket.d.ts b/api/@ohos.net.socket.d.ts index ccabf9041a3e6fed0a43eb75f8b84bf296ec5dc8..fb88669e14f1127a0b3b1a7d1f2b7df8e3341610 100644 --- a/api/@ohos.net.socket.d.ts +++ b/api/@ohos.net.socket.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback, Callback, ErrorCallback} from "./basic"; import connection from "./@ohos.net.connection"; diff --git a/api/@ohos.net.statistics.d.ts b/api/@ohos.net.statistics.d.ts deleted file mode 100644 index 9f1446839dabd36a14b78a7e5fd01baea7dbc620..0000000000000000000000000000000000000000 --- a/api/@ohos.net.statistics.d.ts +++ /dev/null @@ -1,157 +0,0 @@ -/* - * Copyright (C) 2022 Huawei Device Co., Ltd. - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import {AsyncCallback, Callback} from "./basic"; - -/** - * Obtains traffic statistics. - * - * @since 8 - * @syscap SystemCapability.Communication.NetManager.Core - */ -declare namespace statistics { - /** - * Queries the data traffic (including all TCP and UDP data packets) received through a specified NIC. - * - * @param nic Indicates the NIC name. - * @param callback Returns the data traffic received through the specified NIC. - */ - function getIfaceRxBytes(nic: string, callback: AsyncCallback): void; - function getIfaceRxBytes(nic: string): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) sent through a specified NIC. - * - * @param nic Indicates the NIC name. - * @param callback Returns the data traffic sent through the specified NIC. - */ - function getIfaceTxBytes(nic: string, callback: AsyncCallback): void; - function getIfaceTxBytes(nic: string): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) received through the cellular network. - * - * @param callback Returns the data traffic received through the cellular network. - */ - function getCellularRxBytes(callback: AsyncCallback): void; - function getCellularRxBytes(): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) sent through the cellular network. - * - * @param callback Returns the data traffic sent through the cellular network. - */ - function getCellularTxBytes(callback: AsyncCallback): void; - function getCellularTxBytes(): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. - * - * @param callback Returns the data traffic sent through all NICs. - */ - function getAllTxBytes(callback: AsyncCallback): void; - function getAllTxBytes(): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. - * - * @param callback Returns the data traffic received through all NICs. - */ - function getAllRxBytes(callback: AsyncCallback): void; - function getAllRxBytes(): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) received by a specified application. - * This method applies only to system applications and your own applications. - * - * @param uid Indicates the process ID of the application. - * @param callback Returns the data traffic received by the specified application. - */ - function getUidRxBytes(uid: number, callback: AsyncCallback): void; - function getUidRxBytes(uid: number): Promise; - - /** - * Queries the data traffic (including all TCP and UDP data packets) sent by a specified application. - * This method applies only to system applications and your own applications. - * - * @param uid Indicates the process ID of the application. - * @param callback Returns the data traffic sent by the specified application. - */ - function getUidTxBytes(uid: number, callback: AsyncCallback): void; - function getUidTxBytes(uid: number): Promise; - - /** - * Register notifications of network traffic updates, restrictions, and warnings. - * - * @permission ohos.permission.GET_NETSTATS_SUMMARY - * @systemapi Hide this for inner system use. - */ - function on(type: 'netStatsChange', callback: Callback<{ iface: string, uid?: number }>): void; - - /** - * @systemapi Hide this for inner system use. - */ - function off(type: 'netStatsChange', callback?: Callback<{ iface: string, uid?: number }>): void; - - /** - * Get the traffic usage details of the network interface in the specified time period. - * - * @param IfaceInfo Indicates the handle. See {@link IfaceInfo}. - * @permission ohos.permission.GET_NETSTATS_SUMMARY - * @systemapi Hide this for inner system use. - */ - function getIfaceStats(ifaceInfo: IfaceInfo, callback: AsyncCallback): void; - function getIfaceStats(ifaceInfo: IfaceInfo): Promise; - - /** - * Get the traffic usage details of the specified time period of the application. - * - * @param UidStatsInfo Indicates the handle. See {@link UidStatsInfo}. - * @permission ohos.permission.GET_NETSTATS_SUMMARY - * @systemapi Hide this for inner system use. - */ - function getIfaceUidStats(uidStatsInfo: UidStatsInfo, callback: AsyncCallback): void; - function getIfaceUidStats(uidStatsInfo: UidStatsInfo): Promise; - - /** - * @systemapi Hide this for inner system use. - */ - export interface IfaceInfo { - iface: string; - startTime: number; - endTime: number; - } - - /** - * @systemapi Hide this for inner system use. - */ - export interface UidStatsInfo { - /*See {@link IfaceInfo}*/ - ifaceInfo: IfaceInfo; - uid: number; - } - - /** - * @systemapi Hide this for inner system use. - */ - export interface NetStatsInfo { - rxBytes: number; - txBytes: number; - rxPackets: number; - txPackets: number; - } -} - -export default statistics; \ No newline at end of file diff --git a/api/@ohos.net.webSocket.d.ts b/api/@ohos.net.webSocket.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..cbb967bee4a57a447048c9ab4d135df7a8da7385 --- /dev/null +++ b/api/@ohos.net.webSocket.d.ts @@ -0,0 +1,126 @@ +/* + * Copyright (C) 2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AsyncCallback, ErrorCallback} from "./basic"; + +/** + * Provides WebSocket APIs. + * + * @since 6 + * @syscap SystemCapability.Communication.NetStack + */ +declare namespace webSocket { + /** + * Creates a web socket connection. + */ + function createWebSocket(): WebSocket; + + export interface WebSocketRequestOptions { + /** + * HTTP request header. + */ + header?: Object; + } + + export interface WebSocketCloseOptions { + /** + * Error code. + */ + code?: number; + /** + * Error cause. + */ + reason?: string; + } + + export interface WebSocket { + /** + * Initiates a WebSocket request to establish a WebSocket connection to a given URL. + * + * @param url URL for establishing a WebSocket connection. + * @param options Optional parameters {@link WebSocketRequestOptions}. + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + connect(url: string, callback: AsyncCallback): void; + connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void; + connect(url: string, options?: WebSocketRequestOptions): Promise; + + /** + * Sends data through a WebSocket connection. + * + * @param data Data to send. It can be a string(API 6) or an ArrayBuffer(API 8). + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + send(data: string | ArrayBuffer, callback: AsyncCallback): void; + send(data: string | ArrayBuffer): Promise; + + /** + * Closes a WebSocket connection. + * + * @param options Optional parameters {@link WebSocketCloseOptions}. + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + close(callback: AsyncCallback): void; + close(options: WebSocketCloseOptions, callback: AsyncCallback): void; + close(options?: WebSocketCloseOptions): Promise; + + /** + * Enables listening for the open events of a WebSocket connection. + */ + on(type: 'open', callback: AsyncCallback): void; + + /** + * Cancels listening for the open events of a WebSocket connection. + */ + off(type: 'open', callback?: AsyncCallback): void; + + /** + * Enables listening for the message events of a WebSocket connection. + * data in AsyncCallback can be a string(API 6) or an ArrayBuffer(API 8). + */ + on(type: 'message', callback: AsyncCallback): void; + + /** + * Cancels listening for the message events of a WebSocket connection. + * data in AsyncCallback can be a string(API 6) or an ArrayBuffer(API 8). + */ + off(type: 'message', callback?: AsyncCallback): void; + + /** + * Enables listening for the close events of a WebSocket connection. + */ + on(type: 'close', callback: AsyncCallback<{ code: number, reason: string }>): void; + + /** + * Cancels listening for the close events of a WebSocket connection. + */ + off(type: 'close', callback?: AsyncCallback<{ code: number, reason: string }>): void; + + /** + * Enables listening for the error events of a WebSocket connection. + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Cancels listening for the error events of a WebSocket connection. + */ + off(type: 'error', callback?: ErrorCallback): void; + } +} + +export default webSocket; \ No newline at end of file diff --git a/api/@ohos.nfc.cardEmulation.d.ts b/api/@ohos.nfc.cardEmulation.d.ts new file mode 100755 index 0000000000000000000000000000000000000000..505b3626541da02b08e77fa90e2e684296e0518d --- /dev/null +++ b/api/@ohos.nfc.cardEmulation.d.ts @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2021-2022 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. + */ + +/** + * Provides methods to operate or manage NFC card emulation. + * + * @import import cardEmulation from '@ohos.nfc.cardEmulation'; + * + * @since 6 + * @syscap SystemCapability.Communication.NFC.Core + */ +declare namespace cardEmulation { + enum Featuretype { + /** This constant is used to check whether HCE card emulation is supported. */ + HCE = 0, + + /** This constant is used to check whether SIM card emulation is supported. */ + UICC = 1, + + /** This constant is used to check whether eSE card emulation is supported. */ + ESE = 2, + } + + /** + * Checks whether a specified type of card emulation is supported. + * + *

This method is used to check Whether the host or secure element supports card emulation. + * + * @param feature Indicates the card emulation type, {@code HCE}, {@code UICC}, or {@code ESE}. + * @return Returns {@code true} if the specified type of card emulation is supported; returns + * {@code false} otherwise. + * + * @since 6 + */ + function isSupported(feature: number):boolean; + + /** + * A class for NFC host application. + * + *

The NFC host application use this class, then Nfc service can access the application + * installation information and connect to services of the application. + * + * @since 8 + * @syscap SystemCapability.Communication.NFC.Core + */ + export class HceService { + /** + * start HCE + * + * @return Returns {@code true} if HCE is enabled or has been enabled; returns {@code false} otherwise. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + startHCE(aidList: string[]): boolean; + + /** + * stop HCE + * + * @return Returns {@code true} if HCE is disabled or has been disabled; returns {@code false} otherwise. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + stopHCE(): boolean; + + + /** + * register HCE event to receive the APDU data. + * + * @param type the type to register. + * @param callback Callback used to listen for HCE data device received. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + + on(type: "hceCmd", callback: AsyncCallback): void; + + /** + * Sends a response APDU to the remote device. + * + *

This method is used by a host application when swiping card. + * + * @param responseApdu Indicates the response, which is a byte array. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + sendResponse(responseApdu: number[]): void; + } +} +export default cardEmulation; diff --git a/api/@ohos.nfc.controller.d.ts b/api/@ohos.nfc.controller.d.ts new file mode 100755 index 0000000000000000000000000000000000000000..35c767cb74618c89ea51714b075c0c164d8ad750 --- /dev/null +++ b/api/@ohos.nfc.controller.d.ts @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Callback } from './basic'; + +/** + * Provides methods to operate or manage NFC. + * + * @import import controller from '@ohos.nfc.controller'; + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +declare namespace nfcController { + enum NfcState { + /** Indicates that NFC is disabled. */ + STATE_OFF = 1, + + /** Indicates that NFC is being enabled. */ + STATE_TURNING_ON = 2, + + /** Indicates that NFC is enabled. */ + STATE_ON = 3, + + /** Indicates that NFC is being disabled. */ + STATE_TURNING_OFF = 4, + } + + /** + * Checks whether a device supports NFC. + * + * @return Returns {@code true} if the device supports NFC; returns {@code false} otherwise. + * + * @since 7 + */ + function isNfcAvailable(): boolean + + /** + * register nfc state changed event. + * + * @param type the type to register. + * @param callback Callback used to listen for the nfc state changed event. + * + * @since 7 + */ + + function on(type: "nfcStateChange", callback: Callback): void + + /** + * unregister nfc state changed event. + * + * @param type the type to unregister. + * @param callback Callback used to listen for the nfc state changed event. + * + * @since 7 + */ + + function off(type: "nfcStateChange", callback?: Callback): void + + /** + * Enables NFC. + * + * @return Returns {@code true} if NFC is enabled or has been enabled; returns {@code false} otherwise. + * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * + * @since 7 + */ + function openNfc(): boolean + + /** + * Disables NFC. + * + * @return Returns {@code true} if NFC is disabled or has been disabled; returns {@code false} otherwise. + * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * + * @since 7 + */ + function closeNfc(): boolean + + /** + * Checks whether NFC is enabled. + * + * @return Returns {@code true} if NFC is enabled; returns {@code false} otherwise. + * + * @since 7 + */ + function isNfcOpen(): boolean + + /** + * Obtains the NFC status. + * + *

The NFC status can be any of the following:

  • {@link #STATE_OFF}: Indicates that NFC + * is disabled.
  • {@link #STATE_TURNING_ON}: Indicates that NFC is being enabled. + *
  • {@link #STATE_ON}: Indicates that NFC is enabled.
  • {@link #STATE_TURNING_OFF}: Indicates + * that NFC is being disabled.
+ * + * @return Returns the NFC status. + * + * @since 7 + */ + function getNfcState(): boolean +} + +export default nfcController; \ No newline at end of file diff --git a/api/@ohos.nfc.tag.d.ts b/api/@ohos.nfc.tag.d.ts new file mode 100755 index 0000000000000000000000000000000000000000..78ec3e6702cef7f4ee06df2694a3091ad41dafea --- /dev/null +++ b/api/@ohos.nfc.tag.d.ts @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { NfcATag, NfcBTag, NfcFTag, NfcVTag } from './tag/nfctech'; + +/** + * Provides methods to operate or manage NFC tag. + * + * @import import tag from '@ohos.nfc.tag'; + * + * @since 7 + * @sysCap SystemCapability.Communication.NFC.Core + */ +declare namespace tag { + /** Indicates an NFC-A tag. */ + const NFC_A = 1; + + /** Indicates an NFC-B tag. */ + const NFC_B = 2; + + /** Indicates an ISO-DEP tag. */ + const ISO_DEP = 3; + + /** Indicates an NFC-F tag. */ + const NFC_F = 4; + + /** Indicates an NFC-V tag. */ + const NFC_V = 5; + + /** Indicated an NDEF tag. */ + const NDEF = 6; + + /** Indicates a MifareClassic tag. */ + const MIFARE_CLASSIC = 8; + + /** Indicates a MifareUltralight tag. */ + const MIFARE_ULTRALIGHT = 9; + + /** + * Obtains an {@code NfcATag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-A technology, an {@code NfcATag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcATag(tagInfo: TagInfo): NfcATag + + /** + * Obtains an {@code NfcBTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-B technology, an {@code NfcBTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcBTag(tagInfo: TagInfo): NfcBTag + + /** + * Obtains an {@code NfcFTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-F technology, an {@code NfcFTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcFTag(tagInfo: TagInfo): NfcFTag + + /** + * Obtains an {@code NfcVTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-V technology, an {@code NfcVTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcVTag(tagInfo: TagInfo): NfcVTag + + + /** + * Provides tag information. + * + *

This class provides the technology a tag supports, for example, NFC-A. Applications can create + * different tags based on the supported technology. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + * @permission ohos.permission.NFC_TAG + */ + export interface TagInfo { + supportedProfiles: number[]; + } +} +export default tag; \ No newline at end of file diff --git a/api/@ohos.notification.d.ts b/api/@ohos.notification.d.ts index 4bee96a6281c82105770c76312fc3190a9855c69..5ca1f74e4f1ff58c64eecb618e970888fa9a561b 100644 --- a/api/@ohos.notification.d.ts +++ b/api/@ohos.notification.d.ts @@ -55,6 +55,8 @@ declare namespace notification { * @since 8 * @param Publishes a notification. * @param userId of subscriber receiving the notification + * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER * */ function publish(request: NotificationRequest, userId: number, callback: AsyncCallback): void; @@ -91,6 +93,7 @@ declare namespace notification { * This parameter must be specified. * @param callback callback function * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function addSlot(slot: NotificationSlot, callback: AsyncCallback): void; @@ -101,6 +104,7 @@ declare namespace notification { * This parameter must be specified. * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function addSlot(slot: NotificationSlot): Promise; @@ -120,6 +124,7 @@ declare namespace notification { * This parameter must be specified. * @param callback callback function * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function addSlots(slots: Array, callback: AsyncCallback): void; @@ -130,6 +135,7 @@ declare namespace notification { * This parameter must be specified. * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function addSlots(slots: Array): Promise; @@ -325,6 +331,7 @@ declare namespace notification { * isNotificationEnabled * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback): void; @@ -332,6 +339,7 @@ declare namespace notification { * isNotificationEnabled * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function isNotificationEnabled(bundle: BundleOption): Promise; @@ -339,29 +347,33 @@ declare namespace notification { * isNotificationEnabled * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function isNotificationEnabled(callback: AsyncCallback): void; /** - * Checks whether this application has permission to publish notifications under the user. + * isNotificationEnabled * - * since 8 * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ - function isNotificationEnabled(userId: number, callback: AsyncCallback): void; - function isNotificationEnabled(userId: number): Promise; + function isNotificationEnabled(): Promise; /** - * isNotificationEnabled + * Checks whether this application has permission to publish notifications under the user. * + * since 8 * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ - function isNotificationEnabled(): Promise; + function isNotificationEnabled(userId: number, callback: AsyncCallback): void; + function isNotificationEnabled(userId: number): Promise; /** * displayBadge * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void; @@ -369,6 +381,7 @@ declare namespace notification { * displayBadge * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function displayBadge(bundle: BundleOption, enable: boolean): Promise; @@ -376,6 +389,7 @@ declare namespace notification { * isBadgeDisplayed * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback): void; @@ -383,6 +397,7 @@ declare namespace notification { * isBadgeDisplayed * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function isBadgeDisplayed(bundle: BundleOption): Promise; @@ -422,6 +437,7 @@ declare namespace notification { * getSlotNumByBundle * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback): void; @@ -429,6 +445,7 @@ declare namespace notification { * getSlotNumByBundle * * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ function getSlotNumByBundle(bundle: BundleOption): Promise; @@ -601,25 +618,66 @@ declare namespace notification { * * @since 8 * @param templateName Name of template to be Obtained + * @param callback callback function */ function isSupportTemplate(templateName: string, callback: AsyncCallback): void; function isSupportTemplate(templateName: string): Promise; /** - * Query notification sending permission. + * Request permission to send notification. * * @since 8 */ - function isNotificationEnabledSelf(callback: AsyncCallback): void; - function isNotificationEnabledSelf(): Promise; + function requestEnableNotification(callback: AsyncCallback): void; + function requestEnableNotification(): Promise; /** - * Request permission to send notification. + * Sets whether the device supports distributed notification. * * @since 8 + * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER */ - function requestEnableNotification(callback: AsyncCallback): void; - function requestEnableNotification(): Promise; + function enableDistributed(enable: boolean, callback: AsyncCallback): void; + function enableDistributed(enable: boolean): Promise; + + /** + * Obtains whether the device supports distributed notification. + * + * @since 8 + */ + function isDistributedEnabled(callback: AsyncCallback): void; + function isDistributedEnabled(): Promise; + + /** + * Sets whether an application supports distributed notification. + * + * @since 8 + * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER + */ + function enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void; + function enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise; + + /** + * Obtains whether an application supports distributed notification. + * + * @since 8 + * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER + */ + function isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback): void; + function isDistributedEnabledByBundle(bundle: BundleOption): Promise; + + /** + * Obtains the remind modes of the notification. + * + * @since 8 + * @systemapi Hide this for inner system use. + * @permission ohos.permission.NOTIFICATION_CONTROLLER + */ + function getDeviceRemindType(callback: AsyncCallback): void; + function getDeviceRemindType(): Promise; /** * Describes a BundleOption. @@ -638,34 +696,59 @@ declare namespace notification { } /** - * DisturbMode + * The type of the Do Not Disturb. * + * @since 8 * @systemapi Hide this for inner system use. */ - export enum DoNotDisturbMode { - ALLOW_UNKNOWN, + export enum DoNotDisturbType { + /** + * Non do not disturb type notification + */ + TYPE_NONE = 0, + + /** + * Execute do not disturb once in the set time period (only watch hours and minutes) + */ + TYPE_ONCE = 1, + + /** + * Execute do not disturb every day with a set time period (only watch hours and minutes) + */ + TYPE_DAILY = 2, /** - * Indicates that all notifications are allowed to interrupt the user in Do Not Disturb mode. + * Execute in the set time period (specify the time, month, day and hour) */ - ALLOW_ALL, + TYPE_CLEARLY = 3, + } + /** + * Describes a DoNotDisturbDate instance. + * + * @systemapi Hide this for inner system use. + */ + export interface DoNotDisturbDate { /** - * Indicates that only notifications meeting the specified priority criteria are allowed to interrupt - * the user in Do Not Disturb mode. + * the type of the Do Not Disturb. + * + * @since 8 */ - ALLOW_PRIORITY, + type: DoNotDisturbType; /** - * Indicates that no notifications are allowed to interrupt the user in Do Not Disturb mode. + * the start time of the Do Not Disturb. + * + * @since 8 */ - ALLOW_NONE, + begin: Date; /** - * Indicates that only notifications of the {@link NotificationRequest#CLASSIFICATION_ALARM} category - * are allowed to interrupt the user in Do Not Disturb mode. + * the end time of the Do Not Disturb. + * + * @since 8 */ - ALLOW_ALARMS + end: Date; } /** @@ -725,26 +808,31 @@ declare namespace notification { } /** - * Notification source type + * The remind type of the nofication. * * @since 8 * @systemapi Hide this for inner system use. */ - export enum SourceType { + export enum DeviceRemindType { + /** + * The device is not in use, no reminder + */ + IDLE_DONOT_REMIND = 0, + /** - * General notification + * The device is not in use, remind */ - TYPE_NORMAL = 0x00000000, + IDLE_REMIND = 1, /** - * Continuous notification + * The device is in use, no reminder */ - TYPE_CONTINUOUS = 0x00000001, + ACTIVE_DONOT_REMIND = 2, /** - * Scheduled notification + * The device is in use, reminder */ - TYPE_TIMER = 0x00000002, + ACTIVE_REMIND = 3, } } diff --git a/api/@ohos.pasteboard.d.ts b/api/@ohos.pasteboard.d.ts index facf37ba9e9c95a0364d2dfd745615445eae1977..e1e14bcded6bb0fc22c2d3b13fcf6e486128b140 100644 --- a/api/@ohos.pasteboard.d.ts +++ b/api/@ohos.pasteboard.d.ts @@ -17,7 +17,7 @@ import { Want } from './ability/want'; /** * systemPasteboard - * @sysCap SystemCapability.Miscservices.Pasteboard + * @syscap SystemCapability.Miscservices.Pasteboard * @devices phone, tablet, tv, wearable, car * @import import pasteboard from '@ohos.pasteboard'; */ diff --git a/api/@ohos.pluginComponent.d.ts b/api/@ohos.pluginComponent.d.ts index c73c4d73425768829d2d391d37ddd2bbc5533979..4e54e395009ae6df1089ed92e84abe6f36c10e8a 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.power.d.ts b/api/@ohos.power.d.ts index 90da7f50996ed0b348cd8d0ba52b0e04b8760bf0..5f59da72f5ad0406eb6b09f4d603f6dee2447a9b 100644 --- a/api/@ohos.power.d.ts +++ b/api/@ohos.power.d.ts @@ -18,7 +18,7 @@ import {AsyncCallback} from './basic'; /** * Provides interfaces to manage power. * - * @sysCap SystemCapability.PowerManager.PowerManager.Core + * @syscap SystemCapability.PowerManager.PowerManager.Core * @since 7 */ declare namespace power { diff --git a/api/@ohos.prompt.d.ts b/api/@ohos.prompt.d.ts index 40dc9faa4b18c9c75cb416bbd43d2c7e4e301150..0cdce80386482f0bb27f39606b87d378238fd213 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.reminderAgent.d.ts b/api/@ohos.reminderAgent.d.ts index 67c0841c9b1ebc62b1d0901820b766c0385c4edf..bcf473de5bb5f58a631a2a0f9760a9a57e781c85 100644 --- a/api/@ohos.reminderAgent.d.ts +++ b/api/@ohos.reminderAgent.d.ts @@ -188,6 +188,28 @@ declare namespace reminderAgent { abilityName: string; } + /** + * Max screen want agent information. + * + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent + */ + interface MaxScreenWantAgent { + /** + * Name of the package that is automatically started when the reminder arrives and the device is not in use. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + pkgName: string; + + /** + * Name of the ability that is automatically started when the reminder arrives and the device is not in use. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + abilityName: string; + } + /** * Reminder Common information. * @@ -217,6 +239,35 @@ declare namespace reminderAgent { */ wantAgent?: WantAgent; + /** + * Information about the ability that is automatically started when the reminder arrives. + * If the device is in use, a notification will be displayed. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent + */ + maxScreenWantAgent?: MaxScreenWantAgent; + + /** + * Ringing duration. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + ringDuration?: number; + + /** + * Number of reminder snooze times. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + snoozeTimes?: number; + + /** + * Reminder snooze interval. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + timeInterval?: number; + /** * Reminder title. * @since 7 @@ -232,12 +283,19 @@ declare namespace reminderAgent { content?: string; /** - * Content to be displayed when the reminder is snoozing. + * Content to be displayed when the reminder is expired. * @since 7 * @syscap SystemCapability.Notification.ReminderAgent */ expiredContent?: string; + /** + * Content to be displayed when the reminder is snoozing. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + snoozeContent?: string; + /** * notification id. If there are reminders with the same ID, the later one will overwrite the earlier one. * @since 7 @@ -253,6 +311,29 @@ declare namespace reminderAgent { slotType?: notification.SlotType; } + interface ReminderRequestCalendar extends ReminderRequest { + /** + * Reminder time. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + dateTime: LocalDateTime; + + /** + * Month in which the reminder repeats. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + repeatMonths?: Array; + + /** + * Date on which the reminder repeats. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + repeatDays?: Array; + } + /** * Alarm reminder information. * @@ -291,5 +372,49 @@ declare namespace reminderAgent { interface ReminderRequestTimer extends ReminderRequest { triggerTimeInSeconds: number; } + + interface LocalDateTime { + /** + * value of year. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + year: number; + + /** + * value of month. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + month: number; + + /** + * value of day. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + day: number; + + /** + * value of hour. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + hour: number; + + /** + * value of minute. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + minute: number; + + /** + * value of minute. + * @since 7 + * @syscap SystemCapability.Notification.ReminderAgent. + */ + second? number; + } } -export default reminderAgent; \ No newline at end of file +export default reminderAgent; diff --git a/api/@ohos.resourceManager.d.ts b/api/@ohos.resourceManager.d.ts index 258978388031bccc282f99ee03478c28fb0acb3e..55fe1e882ca6968e90400ae8c748bf78dbb5af1d 100644 --- a/api/@ohos.resourceManager.d.ts +++ b/api/@ohos.resourceManager.d.ts @@ -230,48 +230,6 @@ export function getResourceManager(): Promise; */ export function getResourceManager(bundleName: string): Promise; -/** - * Obtains the ResourceManager object of the current application. - * - * @param ctx The Context object. - * @param callback Indicates the callback containing the ResourceManager object. - * @since 9 preview - * @StageModelOnly - */ -export function getResourceManager(ctx: Context, callback: AsyncCallback); - -/** - * Obtains the ResourceManager object of the specified application. - * - * @param ctx The Context object. - * @param bundleName Indicates the bundle name of the specified application. - * @param callback Indicates the callback containing the ResourceManager object. - * @since 9 preview - * @StageModelOnly - */ -export function getResourceManager(ctx: Context, bundleName: string, callback: AsyncCallback); - -/** - * Obtains the ResourceManager object of the current application. - * - * @param ctx The Context object. - * @return Returns that the ResourceManager object is returned in Promise mode. - * @since 9 preview - * @StageModelOnly - */ -export function getResourceManager(ctx: Context): Promise; - -/** - * Obtains the ResourceManager object of the specified application. - * - * @param ctx The Context object. - * @param bundleName Indicates the bundle name of the specified application. - * @return Returns that the ResourceManager object is returned in Promise mode. - * @since 9 preview - * @StageModelOnly - */ -export function getResourceManager(ctx: Context, bundleName: string): Promise; - /** * Provides the capability of accessing application resources. * @@ -444,6 +402,24 @@ export interface ResourceManager { */ getRawFileDescriptor(path: string): Promise; + /** + * Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode. + * + * @param path Indicates the resource relative path. + * @param callback Indicates the asynchronous callback used to return result close raw file resource descriptor. + * @since 8 + */ + closeRawFileDescriptor(path: string, callback: AsyncCallback): void; + + /** + * Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode. + * + * @param path Indicates the resource relative path. + * @return Returns result close raw file resource descriptor corresponding to the specified resource path. + * @since 8 + */ + closeRawFileDescriptor(path: string): Promise; + /** * Obtains release resourceManager. * diff --git a/api/@ohos.router.d.ts b/api/@ohos.router.d.ts index dc9fb60ca4840efc0c3b7b49194eb743a58b939b..74a6234d489d2dc72ecebd5e72d6c4cf458b093b 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/@ohos.rpc.d.ts b/api/@ohos.rpc.d.ts index 8932f4c6bb6c5fe5c1b9e79683ed37e5eee0ebed..abd5e0e15ff41d90e9f94cf6c59d9e69395f3da3 100644 --- a/api/@ohos.rpc.d.ts +++ b/api/@ohos.rpc.d.ts @@ -941,21 +941,25 @@ declare namespace rpc { class MessageOption { /** * Indicates synchronous call. + * @since 7 */ TF_SYNC = 0; /** * Indicates asynchronous call. + * @since 7 */ TF_ASYNC = 1; /** * Indicates the sendRequest API for returning the file descriptor. + * @since 7 */ TF_ACCEPT_FDS = 0x10; /** * Indicates the wait time for RPC, in seconds. It is NOT used in IPC case. + * @since 7 */ TF_WAIT_TIME = 4; @@ -1127,16 +1131,19 @@ declare namespace rpc { class RemoteProxy implements IRemoteObject { /** * Indicates the message code for a Ping operation. + * @since 7 */ PING_TRANSACTION = ('_' << 24) | ('P' << 16) | ('N' << 8) | 'G'; /** * Indicates the message code for a dump operation. + * @since 7 */ DUMP_TRANSACTION = ('_' << 24) | ('D' << 16) | ('M' << 8) | 'P'; /** * Indicates the message code for a transmission. + * @since 7 */ INTERFACE_TRANSACTION = ('_' << 24) | ('N' << 16) | ('T' << 8) | 'F'; @@ -1144,6 +1151,7 @@ declare namespace rpc { * Indicates the minimum value of a valid message code. * *

This constant is used to check the validity of an operation. + * @since 7 */ MIN_TRANSACTION_ID = 0x1; @@ -1151,6 +1159,7 @@ declare namespace rpc { * Indicates the maximum value of a valid message code. * *

This constant is used to check the validity of an operation. + * @since 7 */ MAX_TRANSACTION_ID = 0x00FFFFFF; diff --git a/api/@ohos.screenshot.d.ts b/api/@ohos.screenshot.d.ts index 7fa60edc4b63b3d9c2a59f6eb8dec54bc2c750d0..cbb2a2f69f853bf9f468fffc3d5f0dacd1d4e68b 100644 --- a/api/@ohos.screenshot.d.ts +++ b/api/@ohos.screenshot.d.ts @@ -23,6 +23,14 @@ import image from './@ohos.multimedia.image'; * @since 7 */ declare namespace screenshot { + /** + * Takes a screenshot and saves it as a PixelMap object + * @param options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters + * @permission ohos.permission.CAPTURE_SCREEN + * @since 7 + */ + function save(options?: ScreenshotOptions, callback: AsyncCallback): void; + /** * Takes a screenshot and saves it as a PixelMap object * @param options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters diff --git a/api/@ohos.security.huks.d.ts b/api/@ohos.security.huks.d.ts index 4e31ac7dd237af06e5de868103c7be289e6424ff..7745e387fbb8a3ce0943b67e754f830d28ac06ee 100755 --- a/api/@ohos.security.huks.d.ts +++ b/api/@ohos.security.huks.d.ts @@ -133,22 +133,46 @@ declare namespace huks { */ function getSdkVersion(options: HuksOptions) : string; + /** + * Interface of huks param. + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export interface HuksParam { tag: HuksTag; value: boolean | number | bigint | Uint8Array; } + /** + * Interface of huks handle. + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export interface HuksHandle { errorCode: number; handle: number; token?: Uint8Array; } + /** + * Interface of huks option. + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export interface HuksOptions { properties?: Array; inData?: Uint8Array; } + /** + * Interface of huks result. + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export interface HuksResult { errorCode: number; outData?: Uint8Array; @@ -156,6 +180,12 @@ declare namespace huks { certChains?: Array; } + /** + * @name HuksErrorCode + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksErrorCode { HUKS_SUCCESS = 0, HUKS_FAILURE = -1, @@ -228,6 +258,12 @@ declare namespace huks { HUKS_ERROR_UNKNOWN_ERROR = -1000, } + /** + * @name HuksKeyPurpose + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyPurpose { HUKS_KEY_PURPOSE_ENCRYPT = 1, /* Usable with RSA, EC and AES keys. */ HUKS_KEY_PURPOSE_DECRYPT = 2, /* Usable with RSA, EC and AES keys. */ @@ -240,6 +276,12 @@ declare namespace huks { HUKS_KEY_PURPOSE_AGREE = 256, /* Usable with agree. */ } + /** + * @name HuksKeyDigest + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyDigest { HUKS_DIGEST_NONE = 0, HUKS_DIGEST_MD5 = 1, @@ -250,6 +292,12 @@ declare namespace huks { HUKS_DIGEST_SHA512 = 14, } + /** + * @name HuksKeyPadding + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyPadding { HUKS_PADDING_NONE = 0, HUKS_PADDING_OAEP = 1, @@ -259,6 +307,12 @@ declare namespace huks { HUKS_PADDING_PKCS7 = 5, } + /** + * @name HuksCipherMode + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksCipherMode { HUKS_MODE_ECB = 1, HUKS_MODE_CBC = 2, @@ -268,6 +322,12 @@ declare namespace huks { HUKS_MODE_GCM = 32, } + /** + * @name HuksKeySize + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeySize { HUKS_RSA_KEY_SIZE_512 = 512, HUKS_RSA_KEY_SIZE_768 = 768, @@ -293,6 +353,12 @@ declare namespace huks { HUKS_DH_KEY_SIZE_4096 = 4096, } + /** + * @name HuksKeyAlg + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyAlg { HUKS_ALG_RSA = 1, HUKS_ALG_ECC = 2, @@ -309,12 +375,24 @@ declare namespace huks { HUKS_ALG_DH = 103, } + /** + * @name HuksKeyGenerateType + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyGenerateType { HUKS_KEY_GENERATE_TYPE_DEFAULT = 0, HUKS_KEY_GENERATE_TYPE_DERIVE = 1, HUKS_KEY_GENERATE_TYPE_AGREE = 2, } + /** + * @name HuksKeyFlag + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyFlag { HUKS_KEY_FLAG_IMPORT_KEY = 1, HUKS_KEY_FLAG_GENERATE_KEY = 2, @@ -322,16 +400,34 @@ declare namespace huks { HUKS_KEY_FLAG_DERIVE_KEY = 4, } + /** + * @name HuksKeyStorageType + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksKeyStorageType { HUKS_STORAGE_TEMP = 0, HUKS_STORAGE_PERSISTENT = 1, } + /** + * @name HuksSendType + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksSendType { HUKS_SEND_TYPE_ASYNC = 0, HUKS_SEND_TYPE_SYNC = 1, } + /** + * @name HuksTagType + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ declare enum HuksTagType { HUKS_TAG_TYPE_INVALID = 0 << 28, HUKS_TAG_TYPE_INT = 1 << 28, @@ -341,6 +437,12 @@ declare namespace huks { HUKS_TAG_TYPE_BYTES = 5 << 28, } + /** + * @name HuksTag + * @since 8 + * @syscap SystemCapability.Security.Huks + * @permission N/A + */ export enum HuksTag { /* Invalid TAG */ HUKS_TAG_INVALID = HuksTagType.HUKS_TAG_TYPE_INVALID | 0, diff --git a/api/@ohos.sensor.d.ts b/api/@ohos.sensor.d.ts old mode 100755 new mode 100644 index 231c236f6b769c3d5c54007416f3c3e0297858d7..79297988d263eb61d2cfbfbf4062ecaa8ab407a8 --- a/api/@ohos.sensor.d.ts +++ b/api/@ohos.sensor.d.ts @@ -12,7 +12,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { AsyncCallback } from './basic'; +import { AsyncCallback, Callback } from "./basic"; /** * This module provides the capability to subscribe to sensor data. @@ -32,7 +32,7 @@ declare namespace sensor { * @syscap SystemCapability.Sensors.Sensor * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback, options?: Options): void; /** @@ -43,7 +43,7 @@ declare namespace sensor { * @syscap SystemCapability.Sensors.Sensor * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback: Callback, options?: Options): void; /** @@ -54,7 +54,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback, options?: Options): void; /** @@ -65,7 +65,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback: Callback, options?: Options): void; /** @@ -76,7 +76,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback, options?: Options): void; /** @@ -87,7 +87,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback, options?: Options): void; /** @@ -98,7 +98,7 @@ declare namespace sensor { * @permission ohos.permission.GRYOSCOPE * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback, options?: Options): void; /** @@ -109,7 +109,7 @@ declare namespace sensor { * @permission ohos.permission.GRYOSCOPE * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback: Callback, options?: Options): void; /** @@ -120,7 +120,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback, options?: Options): void; /** @@ -131,7 +131,7 @@ declare namespace sensor { * @permission ohos.permission.HEALTH_DATA * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback, options?: Options): void; /** @@ -142,7 +142,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback, options?: Options): void; /** @@ -153,7 +153,7 @@ declare namespace sensor { * @permission ohos.permission.ACCELEROMETER * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback: Callback, options?: Options): void; /** @@ -164,7 +164,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback, options?: Options): void; /** @@ -175,7 +175,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback: Callback, options?: Options): void; /** @@ -186,7 +186,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback, options?: Options): void; /** @@ -197,7 +197,7 @@ declare namespace sensor { * @permission ohos.permission.ACTIVITY_MOTION * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback, options?: Options): void; /** @@ -208,7 +208,7 @@ declare namespace sensor { * @permission ohos.permission.ACTIVITY_MOTION * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback, options?: Options): void; /** @@ -219,7 +219,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback, options?: Options): void; /** @@ -230,7 +230,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback, options?: Options): void; /** @@ -241,7 +241,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback, options?: Options): void; /** @@ -252,7 +252,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback, + function on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback, options?: Options): void; /** @@ -262,7 +262,7 @@ declare namespace sensor { * @permission ohos.permission.ACCELEROMETER * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback): void; /** * Subscribe to sensor data once. @@ -271,7 +271,7 @@ declare namespace sensor { * @permission ohos.permission.ACCELEROMETER * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback: Callback): void; /** * Subscribe to sensor data once. @@ -280,7 +280,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback): void; /** * Subscribe to sensor data once. @@ -289,7 +289,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback: Callback): void; /** * Subscribe to sensor data once. @@ -298,7 +298,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback): void; /** * Subscribe to sensor data once. @@ -307,7 +307,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback): void; /** * Subscribe to sensor data once. @@ -316,7 +316,7 @@ declare namespace sensor { * @permission ohos.permission.GYROSCOPE * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback): void; /** * Subscribe to sensor data once. @@ -325,7 +325,7 @@ declare namespace sensor { * @permission ohos.permission.GYROSCOPE * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback: Callback): void; /** * Subscribe to sensor data once. @@ -334,7 +334,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback): void; /** * Subscribe to sensor data once. @@ -343,7 +343,7 @@ declare namespace sensor { * @permission ohos.permission.HEART_RATE * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback): void; /** * Subscribe to sensor data once. @@ -352,7 +352,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback): void; /** * Subscribe to sensor data once. @@ -361,7 +361,7 @@ declare namespace sensor { * @permission ohos.permission.ACCELERATION * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback: Callback): void; /** * Subscribe to sensor data once. @@ -370,7 +370,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback): void; /** * Subscribe to sensor data once. @@ -379,7 +379,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback: Callback): void; /** * Subscribe to sensor data once. @@ -388,7 +388,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback): void; /** * Subscribe to sensor data once. @@ -397,7 +397,7 @@ declare namespace sensor { * @permission ohos.permission.ACTIVITY_MOTION * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback): void; /** * Subscribe to sensor data once. @@ -406,7 +406,7 @@ declare namespace sensor { * @permission ohos.permission.ACTIVITY_MOTION * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback): void; /** * Subscribe to sensor data once. @@ -415,7 +415,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback): void; /** * Subscribe to sensor data once. @@ -424,7 +424,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback): void; /** * Subscribe to sensor data once. @@ -433,7 +433,7 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback): void; /** * Subscribe to sensor data once. @@ -442,16 +442,197 @@ declare namespace sensor { * @permission N/A * @since 8 */ - function once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback): void; + function once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback): void; /** - * Unsubscribe to sensor data once. - * @param type Indicate the sensor type to listen for, {@code SensorType}. + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_ACCELEROMETER}. + * @permission ohos.permission.ACCELEROMETER + * @syscap SystemCapability.Sensors.Sensor + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED}. + * @permission ohos.permission.ACCELEROMETER + * @syscap SystemCapability.Sensors.Sensor + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, + callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_BAROMETER}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_GRAVITY}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_GYROSCOPE}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.GRYOSCOPE + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.GRYOSCOPE + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_HALL}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_HEART_RATE}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.HEALTH_DATA + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_HUMIDITY}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACCELEROMETER + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_ORIENTATION}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_PEDOMETER}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACTIVITY_MOTION + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION}. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACTIVITY_MOTION + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_PROXIMITY}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION}. + * @syscap SystemCapability.Sensors.Sensor + * @permission N/A + * @since 8 + */ + function off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback): void; + + /** + * Unsubscribe to sensor data. + * @param type Indicate the sensor type to unsubscribe, {@code SensorType.SENSOR_TYPE_ID_WEAR_DETECTION}. * @syscap SystemCapability.Sensors.Sensor * @permission N/A * @since 8 */ - function off(type: SensorType, callback: AsyncCallback): void; + function off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback): void; /** * Indicates geographic location. diff --git a/api/@ohos.settings.d.ts b/api/@ohos.settings.d.ts index 90c9e382fcc038a3bf58c2ea8118ee026aa19381..c2ffe4e43a02c8125869bfe1019b8e562bfaec69 100644 --- a/api/@ohos.settings.d.ts +++ b/api/@ohos.settings.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 Huawei Device Co., Ltd. + * Copyright (c) 2022 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 @@ -12,47 +12,854 @@ * See the License for the specific language governing permissions and * limitations under the License. */ +import { AsyncCallback } from './basic'; import { DataAbilityHelper } from './ability/dataAbilityHelper'; /** * This module provides settings data access abilities. * - * @since 8 + * @since 7 * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Applictaions.settings.Core * @import import settings from '@ohos.settings' * @permission N/A */ declare namespace settings { + /** + * Provides methods for setting time and date formats. + * + * @since 7 + */ + namespace date { + /** + * Indicates the date format. + * + *

The formats {@code mm/dd/yyyy}, {@code dd/mm/yyyy}, and {@code yyyy/mm/dd} are available. + * + * @since 7 + */ + const DATE_FORMAT: string + + /** + * Specifies whether the time is displayed in 12-hour or 24-hour format. + * + *

If the value is {@code 12}, the 12-hour format is used. If the value is {@code 24}, the 24-hour format + * is used. + * + * @since 7 + */ + const TIME_FORMAT: string + + /** + * Specifies whether the date, time, and time zone are automatically obtained from the Network + * Identity and Time Zone (NITZ). + * + *

If the value is {@code true}, the information is automatically obtained from NITZ. + * If the value is {@code false}, the information is not obtained from NITZ. + * + * @since 7 + */ + const AUTO_GAIN_TIME: string + + /** + * Specifies whether the time zone is automatically obtained from NITZ. + * + *

If the value is {@code true}, the information is automatically obtained from NITZ. If the value + * is {@code false}, the information is not obtained from NITZ. + * + * @since 7 + */ + const AUTO_GAIN_TIME_ZONE: string + } + + /** + * Provides methods for setting the display effect, including the font size, screen brightness, screen rotation, + * animation factor, and display color. + * + * @since 7 + */ + namespace display { + /** + * Indicates the scaling factor of fonts, which is a float number. + * + * @since 7 + */ + const FONT_SCALE: string + + /** + * Indicates the screen brightness. The value ranges from 0 to 255. + * + * @since 7 + */ + const SCREEN_BRIGHTNESS_STATUS: string + + /** + * Specifies whether automatic screen brightness adjustment is enabled. + * + *

If the value is {@code 1}, automatic adjustment is enabled. If the value is {@code 0}, automatic + * adjustment is disabled. + * + * @since 7 + */ + const AUTO_SCREEN_BRIGHTNESS: string + + /** + * Indicates the value of {@code AUTO_SCREEN_BRIGHTNESS} when automatic screen brightness adjustment is used. + * + * @since 7 + */ + const AUTO_SCREEN_BRIGHTNESS_MODE: number + + /** + * Indicates the value of {@code AUTO_SCREEN_BRIGHTNESS} when manual screen brightness adjustment is used. + * + * @since 7 + */ + const MANUAL_SCREEN_BRIGHTNESS_MODE: number + + /** + * Indicates the duration that the device waits before going to sleep after a period of inactivity, in + * milliseconds. + * + * @since 7 + */ + const SCREEN_OFF_TIMEOUT: string + + /** + * Indicates the screen rotation when no other policy is available. + * + *

This constant is invalid when auto-rotation is enabled. When auto-rotation is disabled, the following + * values are available: + * + *

    + *
  • {@code 0} - The screen rotates 0 degrees. + *
  • {@code 1} - The screen rotates 90 degrees. + *
  • {@code 2} - The screen rotates 180 degrees. + *
  • {@code 3} - The screen rotates 270 degrees. + *
+ * + * @since 7 + */ + const DEFAULT_SCREEN_ROTATION: string + + /** + * Indicates the scaling factor for the animation duration. + * + *

This affects the start delay and duration of all such animations. If the value is {@code 0}, + * the animation ends immediately. The default value is {@code 1}. + * + * @since 7 + */ + const ANIMATOR_DURATION_SCALE: string + + /** + * Indicates the scaling factor for transition animations. + * If the value is {@code 0}, transition animations are disabled. + * + * @since 7 + */ + const TRANSITION_ANIMATION_SCALE: string + + /** + * Indicates the scaling factor for normal window animations. + * If the value is {@code 0}, window animations are disabled. + * + * @since 7 + */ + const WINDOW_ANIMATION_SCALE: string + + /** + * Specifies whether display color inversion is enabled. + * + *

If the value is {@code 1}, display color inversion is enabled. If the value is {@code 0}, display color + * inversion is disabled. + * + * @since 7 + */ + const DISPLAY_INVERSION_STATUS: string + } + + /** + * Provides methods for setting general information about devices, including the device name, startup wizard, + * airplane mode, debugging information, accessibility feature switch, and touch exploration status. + * + * @since 7 + */ + namespace general { + /** + * Specifies whether the startup wizard has been run. + * + *

If the value is {@code 0}, the startup wizard has not been run. If the value is not {@code 0}, the startup + * wizard has been run. + * + * @since 7 + */ + const SETUP_WIZARD_FINISHED: string + + /** + * Specifies what happens after the user presses the call end button if the user is not in a call. + * + *

    + *
  • {@code 0} - Nothing happens. + *
  • {@code 1} - The home screen is displayed. + *
  • {@code 2} - The device enters the sleep state and the screen is locked. + *
  • {@code 3} - The home screen is displayed. If the user is already on the home screen, the device enters + * the sleep state. + *
+ * + * @since 7 + */ + const END_BUTTON_ACTION: string + + /** + * Specifies whether the accelerometer is used to change screen orientation, that is, whether auto-rotation is + * enabled. + * + *

The value {@code 1} indicates that the accelerometer is enabled by default, and {@code 0} indicates that + * the accelerometer is disabled by default. + * + * @since 7 + */ + const ACCELEROMETER_ROTATION_STATUS: string + + /** + * Specifies whether airplane mode is enabled. + * + *

If the value is {@code 1}, airplane mode is enabled. If the value is {@code 0}, airplane mode is disabled. + * + * @since 7 + */ + const AIRPLANE_MODE_STATUS: string + + /** + * Specifies whether the device is provisioned. + * + *

On a multi-user device with a single system user, the screen may be locked when the value is {@code true}. + * In addition, other abilities cannot be started on the system user unless they are marked to display over + * the screen lock. + * + * @since 7 + */ + const DEVICE_PROVISION_STATUS: string + + /** + * Specifies whether the hard disk controller (HDC) on USB devices is enabled. + * + *

If the value is {@code true}, the HDC is enabled. If the value is {@code false}, the HDC is disabled. + * + * @since 7 + */ + const HDC_STATUS: string + + /** + * Indicates the number of boot operations after the device is powered on. + * + * @since 7 + */ + const BOOT_COUNTING: string + + /** + * Specifies whether contact metadata synchronization is enabled. + * + *

If the value is {@code true}, synchronization is enabled. If the value is {@code false}, + * synchronization is disabled. + * + * @since 7 + */ + const CONTACT_METADATA_SYNC_STATUS: string + + /** + * Specifies whether developer options are enabled. + * + *

If the value is {@code true}, developer options are enabled. + * If the value is {@code false}, developer options are disabled. + * + * @since 7 + */ + const DEVELOPMENT_SETTINGS_STATUS: string + + /** + * Indicates the device name. + * + * @since 7 + */ + const DEVICE_NAME: string + + /** + * Specifies whether USB mass storage is enabled. + * + *

If the value is {@code true}, USB mass storage is enabled. + * If the value is {@code false}, USB mass storage is disabled. + * + * @since 7 + */ + const USB_STORAGE_STATUS: string + + /** + * Specifies whether the device waits for the debugger when starting an application to debug. + * + *

If the value is {@code 1}, the device waits for the debugger. + * If the value is {@code 0}, the system does not wait for the debugger, and so the application runs normally. + * + * @since 7 + */ + const DEBUGGER_WAITING: string + + /** + * Indicates the bundle name of the application to debug. + * + * @since 7 + */ + const DEBUG_APP_PACKAGE: string + + /** + * Specifies whether any accessibility feature is enabled. + * + *

If the value is {@code 1}, the accessibility feature is enabled. If the value is {@code 0}, the + * accessibility feature is disabled. + * + * @since 7 + */ + const ACCESSIBILITY_STATUS: string + + /** + * Indicates the list of accessibility features that have been activated. + * + * @since 7 + */ + const ACTIVATED_ACCESSIBILITY_SERVICES: string + + /** + * Indicates the default geographical location that can be used by the browser. Multiple geographical locations + * are separated by spaces. + * + * @since 7 + */ + const GEOLOCATION_ORIGINS_ALLOWED: string + + /** + * Specifies whether an application should attempt to skip all introductory hints at the first startup. This is + * intended for temporary users or users who are familiar with the environment. + * + *

If the value is {@code 1}, the application attempts to skip all introductory hints at the first startup. + * If the value is {@code 0}, the application does not skip introductory hints at the first startup. + * + * @since 7 + */ + const SKIP_USE_HINTS: string + + /** + * Indicates whether touch exploration is enabled. + * + *

If the value is {@code 1}, touch exploration is enabled. If the value is {@code 0}, touch exploration is + * disabled. + * + * @since 7 + */ + const TOUCH_EXPLORATION_STATUS: string + } + + /** + * Provides methods for setting information about input methods, including automatic capitalization, automatic + * punctuation, autocorrect, password presentation, input method engine, and input method subtypes. + * + * @since 7 + */ + namespace input { + /** + * Indicates the default input method and its ID. + * + * @since 7 + */ + const DEFAULT_INPUT_METHOD: string + + /** + * Indicates the default input method keyboard type and its ID. + * + * @since 7 + */ + const ACTIVATED_INPUT_METHOD_SUB_MODE: string + + /** + * Indicates the list of input methods that have been activated. + * + *

The list is a string that contains the IDs of activated input methods. The IDs are separated by colons + * (:), and keyboardTypes of an input method are separated by semicolons (;). An example format is + * {@code ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0}. The type of imaID is ElementName, + * and the type of keyboard is int. + * + * @since 7 + */ + const ACTIVATED_INPUT_METHODS: string + + /** + * Specifies whether the input method selector is visible. + * + *

If the value is {@code 1}, the input method selector is visible. If the value is {@code 0}, the input + * method selector is invisible. + * + * @since 7 + */ + const SELECTOR_VISIBILITY_FOR_INPUT_METHOD: string + + /** + * Specifies whether automatic capitalization is enabled for the text editor. + * + *

If the value is {@code 0}, automatic capitalization is disabled. If the value {@code 1}, automatic + * capitalization is enabled. + * + * @since 7 + */ + const AUTO_CAPS_TEXT_INPUT: string + + /** + * Specifies whether automatic punctuation is enabled for the text editor. Automatic punctuation enables the + * text editor to convert two spaces into a period (.) and a space. + * + *

If the value is {@code 0}, automatic punctuation is disabled. If the value {@code 1}, automatic + * punctuation is enabled. + * + * @since 7 + */ + const AUTO_PUNCTUATE_TEXT_INPUT: string + + /** + * Specifies whether autocorrect is enabled for the text editor. Autocorrect enables the text editor to correct + * typos. + * + *

If the value is {@code 0}, autocorrect is disabled. If the value {@code 1}, autocorrect is enabled. + * + * @since 7 + */ + const AUTO_REPLACE_TEXT_INPUT: string + + /** + * Specifies whether password presentation is enabled in the text editor. Password presentation enables the + * text editor to show password characters when the user types them. + * + *

If the value is {@code 0}, password presentation is disabled. If the value {@code 1}, password + * presentation is enabled. + * + * @since 7 + */ + const SHOW_PASSWORD_TEXT_INPUT: string + } + + /** + * Provides methods for setting network information, including the data roaming status, HTTP proxy configurations, + * and preferred networks. + * + * @since 7 + */ + namespace network { + /** + * Specifies whether data roaming is enabled. + * + *

If the value is {@code true}, data roaming is enabled. If the value is {@code false}, + * data roaming is disabled. + * + * @since 7 + */ + const DATA_ROAMING_STATUS: string + + /** + * Indicates the host name and port number of the global HTTP proxy. + * The host name and port number are separated by a colon (:). + * + * @since 7 + */ + const HTTP_PROXY_CFG: string + + /** + * Indicates the user preferences of the network to use. + * + * @since 7 + */ + const NETWORK_PREFERENCE_USAGE: string + } + + /** + * Provides methods for setting the answering mode of incoming and outgoing calls. + * + * @since 7 + */ + namespace phone { + /** + * Specifies whether real-time text (RTT) calling is enabled. If enabled, incoming and outgoing calls are + * answered as RTT calls when supported by the device and carrier. If the value is {@code 1}, RTT calling is + * enabled. If the value is {@code 0}, RTT calling is disabled. + * + * @since 7 + */ + const RTT_CALLING_STATUS: string + } + + /** + * Provides methods for setting the sound effect, including the ringtone, dial tone, alarm sound, notification tone, + * and haptic feedback. + * + * @since 7 + */ + namespace sound { + /** + * Indicates whether the device vibrates when it is ringing for an incoming call. + * + *

This constant will be used by Phone and Settings applications. The value is of the boolean type. + * This constant affects only the scenario where the device rings for an incoming call. It does not affect + * any other application or scenario. + * + * @since 7 + */ + const VIBRATE_WHILE_RINGING: string + + /** + * Indicates the storage area of the system default alarm. + * + *

You can obtain the URI of the system default alarm. + * + * @since 7 + */ + const DEFAULT_ALARM_ALERT: string + + /** + * Indicates the type of the dual-tone multifrequency (DTMF) tone played when dialing. + * + *

The value {@code 0} indicates the normal short sound effect, and {@code 1} indicates the long sound + * effect. + * + * @since 7 + */ + const DTMF_TONE_TYPE_WHILE_DIALING: string + + /** + * Specifies whether the DTMF tone is played when dialing. + * + *

If the value is {@code 1}, the DTMF tone is played. If the value is {@code 0}, the DTMF tone is not + * played. + * + * @since 7 + */ + const DTMF_TONE_WHILE_DIALING: string + + /** + * Specifies which audio streams are affected by changes on the ringing mode and Do Not Disturb (DND) mode. + * + *

If you want a specific audio stream to be affected by changes of the ringing mode and DDN mode, set the + * corresponding bit to {@code 1}. + * + * @since 7 + */ + const AFFECTED_MODE_RINGER_STREAMS: string + + /** + * Specifies which audio streams are affected by the mute mode. + * + *

If you want a specific audio stream to remain muted in mute mode, set the corresponding bit to {@code 1}. + * + * @since 7 + */ + const AFFECTED_MUTE_STREAMS: string + + /** + * Indicates the storage area of the system default notification tone. + * + *

You can obtain the URI of the system default notification tone. + * + * @since 7 + */ + const DEFAULT_NOTIFICATION_SOUND: string + + /** + * Indicates the storage area of the system default ringtone. + * + *

You can obtain the URI of the system default ringtone. + * + * @since 7 + */ + const DEFAULT_RINGTONE: string + + /** + * Specifies whether the sound effects are enabled. + * + *

If the value is {@code 0}, the sound effects are disabled. If the value is {@code 1}, the sound effects + * are enabled. + * + * @since 7 + */ + const SOUND_EFFECTS_STATUS: string + + /** + * Specifies whether the device vibrates for an event. This parameter is used inside the system. + * + *

If the value is {@code 1}, the device vibrates for an event. If the value is {@code 0}, the device does + * not vibrate for an event. + * + * @since 7 + */ + const VIBRATE_STATUS: string + + /** + * Indicates whether the device enables haptic feedback. + * + *

The value is of the boolean type. + * + * @since 7 + */ + const HAPTIC_FEEDBACK_STATUS: string + } + + /** + * Provides methods for setting information about text-to-speech (TTS) conversion, including the pitch, speech rate, + * engine, and plug-ins. + * + * @since 7 + */ + namespace TTS { + /** + * Indicates the default pitch of the text-to-speech (TTS) engine. + * + *

100 = 1x. If the value is set to {@code 200}, the frequency is twice the normal sound frequency. + * + * @since 7 + */ + const DEFAULT_TTS_PITCH: string + + /** + * Indicates the default speech rate of the TTS engine. 100 = 1x. + * + * @since 7 + */ + const DEFAULT_TTS_RATE: string + + /** + * Indicates the default TTS engine. + * + * @since 7 + */ + const DEFAULT_TTS_SYNTH: string + + /** + * Indicates the list of activated plug-in packages used for TTS. Multiple plug-in packages are separated by + * spaces. + * + * @since 7 + */ + const ENABLED_TTS_PLUGINS: string + } + + /** + * Provides methods for setting radio network information, including information about Bluetooth, Wi-Fi, Near Field + * Communication (NFC), and the airplane mode. + * + * @since 7 + */ + namespace wireless { + /** + * Specifies whether the device can be discovered or connected by other devices through Bluetooth. + * + * If the value is {@code 0}, the device cannot be connected or discovered. If the value is {@code 1}, the + * device can be connected but cannot be discovered. If the value is {@code 2}, the device can be connected + * and discovered. + * + * @since 7 + */ + const BLUETOOTH_DISCOVER_ABILITY_STATUS: string + + /** + * Indicates the duration (in seconds) that the device can be discovered through Bluetooth. + * + *

After the duration expires, the device cannot be discovered through Bluetooth. + * + * @since 7 + */ + const BLUETOOTH_DISCOVER_TIMEOUT: string + + /** + * Indicates the list of radio signals to be disabled when airplane mode is enabled. Multiple radio + * signals are separated by commas (,). + * + *

    + *
  • {@code BLUETOOTH_RADIO} - Bluetooth is disabled in airplane mode. + *
  • {@code CELL_RADIO} - Cellular radio is disabled in airplane mode. + *
  • {@code NFC_RADIO} - NFC is disabled in airplane mode. + *
  • {@code WIFI_RADIO} - Wi-Fi is disabled in airplane mode. + *
+ * + * @since 7 + */ + const AIRPLANE_MODE_RADIOS: string /** - * get settingsdata uri - * @since 8 - * @param name uri parameter - * @return settingsdata uri + * Specifies whether Bluetooth is enabled. + * + *

If the value is {@code true}, Bluetooth is enabled. If the value is {@code false}, Bluetooth is disabled. + * + * @since 7 */ - function getUri(name: string): string; + const BLUETOOTH_STATUS: string /** - * get value from settingsdata - * @since 8 - * @param dataAbilityHelper dataAbilityHelper instance - * @param name name - * @param defValue default value - * @return settingsdata value + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that Bluetooth is disabled in airplane mode. + * + * @since 7 */ - function getValue(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string; + const BLUETOOTH_RADIO: string /** - * set settingsdata value - * @need permission ohos.permission.WRITE_SYSTEM_SETTING - * @since 8 - * @param dataAbilityHelper dataAbilityHelper instance - * @param name name - * @param value value - * @return value set result + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that cellular radio is disabled in airplane mode. + * + * @since 7 */ - function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean; + const CELL_RADIO: string + + /** + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that NFC is disabled in airplane mode. + * + * @since 7 + */ + const NFC_RADIO: string + + /** + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that Wi-Fi is disabled in airplane mode. + * + * @since 7 + */ + const WIFI_RADIO: string + + /** + * Specifies whether the Wi-Fi configuration created by the application of the device owner should be + * locked down. + * + *

If the value is {@code true}, the Wi-Fi configuration should be locked down. + * If the value is {@code false}, the Wi-Fi configuration should not be locked down. + * + * @since 7 + */ + const OWNER_LOCKDOWN_WIFI_CFG: string + + /** + * Indicates the maximum number of attempts to obtain an IP address from the DHCP server. + * + * @since 7 + */ + const WIFI_DHCP_MAX_RETRY_COUNT: string + + /** + * Indicates the maximum duration to hold a wake lock when waiting for the mobile data connection to + * establish after the Wi-Fi connection is disconnected. + * + * @since 7 + */ + const WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT: string + + /** + * Specifies whether Wi-Fi is enabled. + * + *

If the value is {@code true}, Wi-Fi is enabled. If the value is {@code false}, Wi-Fi is disabled. + * + * @since 7 + */ + const WIFI_STATUS: string + + /** + * Specifies whether Wi-Fi watchdog is enabled. + * + *

If the value is {@code true}, Wi-Fi watchdog is enabled. + * If the value is {@code false}, Wi-Fi watchdog is disabled. + * + * @since 7 + */ + const WIFI_WATCHDOG_STATUS: string + } + + /** + * Constructs a URI for a specific name-value pair for monitoring data of the ability that uses the Data + * template. + * + * @param name Indicates the name of the setting to set. + * @return Returns the corresponding URI; returns {@code null} if the URI does not exist. + * @since 7 + */ + function getURI(name: string, callback: AsyncCallback): void; + function getURI(name: string): Promise; + + /** + * Obtains the value of a specified character string in the database. + * + * @param dataAbilityHelper Indicates the {@link ohos.aafwk.ability.DataAbilityHelper} used to access + * the database. + * @param name Indicates the name of the character string. + * @return Returns the value of the character string in the table if any is found; returns {@code null} + * otherwise. + * @since 7 + */ + function getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback): void; + function getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise; + + /** + * Saves a character string name and its value to the database. + * + * @param dataAbilityHelper Indicates the {@link ohos.aafwk.ability.DataAbilityHelper} used to access + * the database. + * @param name Indicates the name of the character string. + * @param value Indicates the value of the character string. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + * @since 7 + * @systemapi Hide this for inner system use. + */ + function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback): void; + function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise; + + /** + * Enables or disables airplane mode. + * + * @param enable Specifies whether to enable airplane mode. The value {@code true} means to enable airplane + * mode, and {@code false} means to disable airplane mode. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + * @since 7 + */ + function enableAirplaneMode(enable: boolean, callback: AsyncCallback): void; + function enableAirplaneMode(enable: boolean): Promise; + + /** + * Checks whether a specified application can show as float window. + * + * @param context Indicates the application context. + * @return Returns {@code true} if the application can draw over other applications; returns {@code false} + * otherwise. + * @since 7 + */ + function canShowFloating(callback: AsyncCallback): void; + function canShowFloating(): Promise; + + /** + * get settingsdata uri(synchronization method) + * @since 8 + * @param name Indicates the name of the setting to set. + * @return Return settingsdata uri. + */ + function getUriSync(name: string): string; + /** + * get value from settingsdata(synchronization method) + * @since 8 + * @param dataAbilityHelper Indicates dataAbilityHelper instance + * @param name Indicates the name of the character string. + * @param defValue Indicates the default value of the character string. + * @return settingsdata value + */ + function getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string; + + /** + * set settingsdata value(synchronization method) + * @need permission ohos.permission.WRITE_SYSTEM_SETTING + * @since 8 + * @param dataAbilityHelper Indicates dataAbilityHelper instance + * @param name Indicates the name of the character string. + * @param value Indicates the value of the character string. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + */ + function setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean; } -export default settings; +export default settings; \ No newline at end of file diff --git a/api/@ohos.storageStatistics.d.ts b/api/@ohos.storageStatistics.d.ts index 7fb9e06aed970630a3bf192671313746a163eb4f..e8fa8d8634bdd6d3f46cc90e5d514d25c80eaddb 100644 --- a/api/@ohos.storageStatistics.d.ts +++ b/api/@ohos.storageStatistics.d.ts @@ -40,7 +40,7 @@ declare namespace storageStatistics { /** * Get the bundlestat * - * @since 8 + * @since 9 */ export interface BundleStats { @@ -48,8 +48,8 @@ declare namespace storageStatistics { cacheSize: number; dataSize: number; } - function getBundleStats(volumeUuid: string, packageName: string, callback: AsyncCallback): void; - function getBundleStats(volumeUuid: string, packageName: string): Promise; + function getBundleStats(packageName: string, callback: AsyncCallback): void; + function getBundleStats(packageName: string): Promise; } diff --git a/api/@ohos.systemTime.d.ts b/api/@ohos.systemTime.d.ts index 9071438b0ea18674ecaa7efc934630dca7ccf933..8a15765fcbe99d75634d843f1225bb5677b169a8 100755 --- a/api/@ohos.systemTime.d.ts +++ b/api/@ohos.systemTime.d.ts @@ -18,7 +18,7 @@ import { AsyncCallback, ErrorCallback } from './basic'; /** * System time and timezone. * @since 7 - * @sysCap SystemCapability.Miscservices.Time + * @syscap SystemCapability.Miscservices.Time * @devices phone, tablet, tv, wearable, car * @import systemTime from '@ohos.systemTime'; */ diff --git a/api/@ohos.systemparameter.d.ts b/api/@ohos.systemparameter.d.ts index 57a2906095657ffc8e63ede552c582984f76bf39..c0d4adafa76399df80f37af8f41f9d47d066453a 100644 --- a/api/@ohos.systemparameter.d.ts +++ b/api/@ohos.systemparameter.d.ts @@ -19,8 +19,8 @@ import { AsyncCallback, BusinessError } from './basic'; * The interface of system parameters class. * * @since 6 - * @Syscap SystemCapability.Startup.SysInfo - * @hide + * @syscap SystemCapability.Startup.SysInfo + * @systemapi Hide this for inner system use. */ declare namespace systemParameter { /** diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index 7b5a03dd6165bea613bd31b10cac7002b0f2f7d1..96816be1f73218cc187011b08e712b40e868e691 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback, Callback} from "./basic"; @@ -38,6 +38,16 @@ declare namespace call { function dial(phoneNumber: string, options: DialOptions, callback: AsyncCallback): void; function dial(phoneNumber: string, options?: DialOptions): Promise; + /** + * Go to the dial screen and the called number is displayed. + * + * @param phoneNumber Indicates the called number. + * @syscap SystemCapability.Applications.Contacts + * @since 7 + */ + function makeCall(phoneNumber: string, callback: AsyncCallback): void; + function makeCall(phoneNumber: string): Promise; + /** * Checks whether a call is ongoing. * @@ -414,9 +424,9 @@ declare namespace call { * @since 8 */ export interface CallTransferInfo { - transferNum: string, - type: CallTransferType, - settingType: CallTransferSettingType + transferNum: string; + type: CallTransferType; + settingType: CallTransferSettingType; } /** @@ -446,16 +456,16 @@ declare namespace call { * @since 7 */ export interface CallAttributeOptions { - accountNumber: string, - speakerphoneOn: boolean, - accountId: number, - videoState: VideoStateType, - startTime: number, - isEcc: boolean, - callType: CallType, - callId: number, - callState: DetailedCallState, - conferenceState: ConferenceState, + accountNumber: string; + speakerphoneOn: boolean; + accountId: number; + videoState: VideoStateType; + startTime: number; + isEcc: boolean; + callType: CallType; + callId: number; + callState: DetailedCallState; + conferenceState: ConferenceState; } /** @@ -510,9 +520,9 @@ declare namespace call { * @since 8 */ export interface CallRestrictionInfo { - type: CallRestrictionType, - password: string - mode: CallRestrictionMode + type: CallRestrictionType; + password: string; + mode: CallRestrictionMode; } /** diff --git a/api/@ohos.telephony.data.d.ts b/api/@ohos.telephony.data.d.ts index 24a6fa755671be2a349c21d7184f81325b2ff9cb..d32d033a35fb9102b344307e8198246ffc9974a2 100644 --- a/api/@ohos.telephony.data.d.ts +++ b/api/@ohos.telephony.data.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; diff --git a/api/@ohos.telephony.observer.d.ts b/api/@ohos.telephony.observer.d.ts index e7d6294044df12f73a131bcd017a0265da5de68f..8193aca0556d6a93da396099949fda566c6e06a1 100644 --- a/api/@ohos.telephony.observer.d.ts +++ b/api/@ohos.telephony.observer.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 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 @@ -162,12 +162,12 @@ declare namespace observer { * @since 7 */ export interface SimStateData { - type: CardType, - state: SimState, + type: CardType; + state: SimState; /** * @since 8 */ - reason: LockReason + reason: LockReason; } /** diff --git a/api/@ohos.telephony.radio.d.ts b/api/@ohos.telephony.radio.d.ts index cae3d90ff79ea82b000e84a7e08579f3114e1bde..c7486d60a3605c3ca85ed67a85e245f78494f02b 100644 --- a/api/@ohos.telephony.radio.d.ts +++ b/api/@ohos.telephony.radio.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; @@ -143,6 +143,7 @@ declare namespace radio { * supported by the device. * @param callback Returns the IMEI; returns an empty string if the IMEI does not exist. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getIMEI(callback: AsyncCallback): void; @@ -158,6 +159,7 @@ declare namespace radio { * supported by the device. * @param callback Returns the MEID; returns an empty string if the MEID does not exist. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getMEID(callback: AsyncCallback): void; @@ -177,6 +179,7 @@ declare namespace radio { * supported by the device. * @param callback Returns the unique device ID; returns an empty string if the unique device ID does not exist. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getUniqueDeviceId(callback: AsyncCallback): void; @@ -233,27 +236,42 @@ declare namespace radio { function isNrSupported(slotId: number): boolean; /** + * Checks whether the radio service is enabled. + * + * @param slotId Indicates the card slot index number, + * ranging from 0 to the maximum card slot index number supported by the device. * @permission ohos.permission.GET_NETWORK_INFO * @since 7 */ function isRadioOn(callback: AsyncCallback): void; - function isRadioOn(): Promise; + function isRadioOn(slotId: number, callback: AsyncCallback): void + function isRadioOn(slotId?: number): Promise; /** + * Turn on the radio service. + * + * @param slotId Indicates the card slot index number, + * ranging from 0 to the maximum card slot index number supported by the device. * @permission ohos.permission.SET_TELEPHONY_STATE * @systemapi Hide this for inner system use. * @since 7 */ function turnOnRadio(callback: AsyncCallback): void; - function turnOnRadio(): Promise; + function turnOnRadio(slotId: number, callback: AsyncCallback): void; + function turnOnRadio(slotId?: number): Promise; /** + * Turn off the radio service. + * + * @param slotId Indicates the card slot index number, + * ranging from 0 to the maximum card slot index number supported by the device. * @permission ohos.permission.SET_TELEPHONY_STATE * @systemapi Hide this for inner system use. * @since 7 */ function turnOffRadio(callback: AsyncCallback): void; - function turnOffRadio(): Promise; + function turnOffRadio(slotId: number, callback: AsyncCallback): void; + function turnOffRadio(slotId?: number): Promise; /** * @since 7 @@ -623,11 +641,11 @@ declare namespace radio { * @since 8 */ export interface CdmaCellInformation { - baseId: number, - latitude: number, - longitude: number, - nid: number, - sid: number, + baseId: number; + latitude: number; + longitude: number; + nid: number; + sid: number; } /** diff --git a/api/@ohos.telephony.sim.d.ts b/api/@ohos.telephony.sim.d.ts index 35b4253181c565e3546fcf2cd6f3f4399d635701..3b3eac8443bfc48caf9dc75eee94365c89388fc3 100644 --- a/api/@ohos.telephony.sim.d.ts +++ b/api/@ohos.telephony.sim.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; @@ -133,6 +133,8 @@ declare namespace sim { * ranging from 0 to the maximum card slot index number supported by the device. * @param callback Returns the ICCID; returns an empty string if no SIM card is inserted. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. + * @since 7 */ function getSimIccId(slotId: number, callback: AsyncCallback): void; function getSimIccId(slotId: number): Promise; @@ -147,6 +149,7 @@ declare namespace sim { * @param callback Returns the voice mailbox alpha identifier; * returns an empty string if no voice mailbox alpha identifier is written into the SIM card. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getVoiceMailIdentifier(slotId: number, callback: AsyncCallback): void; @@ -162,6 +165,7 @@ declare namespace sim { * @param callback Returns the voice mailbox number; * returns an empty string if no voice mailbox number is written into the SIM card. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getVoiceMailNumber(slotId: number, callback: AsyncCallback): void; @@ -186,6 +190,7 @@ declare namespace sim { * @param callback Returns the MSISDN; returns an empty string if no SIM card is inserted or * no MSISDN is recorded in the EFMSISDN file. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 8 */ function getSimTelephoneNumber(slotId: number, callback: AsyncCallback): void; @@ -202,7 +207,8 @@ declare namespace sim { * @param callback Returns the GID1; returns an empty string if no SIM card is inserted or * no GID1 in the SIM card. * @permission ohos.permission.GET_TELEPHONY_STATE - * @since 8 + * @systemapi Hide this for inner system use. + * @since 7 */ function getSimGid1(slotId: number, callback: AsyncCallback): void; function getSimGid1(slotId: number): Promise; diff --git a/api/@ohos.telephony.sms.d.ts b/api/@ohos.telephony.sms.d.ts index 2a18155c134cf483126082fc6bef0aae38ca780b..d67425155519d9338bd5cd242cfdf8cd38016359 100644 --- a/api/@ohos.telephony.sms.d.ts +++ b/api/@ohos.telephony.sms.d.ts @@ -1,17 +1,17 @@ /* -* 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 -* -* 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. -*/ + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; @@ -98,6 +98,7 @@ declare namespace sms { * @param slotId Indicates the ID of the slot holding the SIM card for sending SMS messages. * @param smscAddr Indicates the SMSC address. * @permission ohos.permission.SET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 7 */ function setSmscAddr(slotId: number, smscAddr: string, callback: AsyncCallback): void; @@ -111,6 +112,7 @@ declare namespace sms { * @param slotId Indicates the ID of the slot holding the SIM card for sending SMS messages. * @param callback Returns the SMSC address. * @permission ohos.permission.GET_TELEPHONY_STATE + * @systemapi Hide this for inner system use. * @since 7 */ function getSmscAddr(slotId: number, callback: AsyncCallback): void; diff --git a/api/@ohos.usb.d.ts b/api/@ohos.usb.d.ts index ac295ca5d22d2b986af8dc1134ff92654a0faf74..4d8b08a6a231d7699653bba38e1faf9522e3af82 100644 --- a/api/@ohos.usb.d.ts +++ b/api/@ohos.usb.d.ts @@ -161,19 +161,22 @@ declare namespace usb { * Represents the USB endpoint from which data is sent or received. * You can obtain the USB endpoint through USBInterface {@link USBInterface}. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBEndpoint { /** * Endpoint address. - * + * + * @syscap SystemCapability.USB.USBManager * @since 8 */ address: number; /** * Endpoint attributes. - * + * + * @syscap SystemCapability.USB.USBManager * @since 8 */ attributes: number; @@ -181,6 +184,7 @@ declare namespace usb { /** * Endpoint interval. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interval: number; @@ -188,6 +192,7 @@ declare namespace usb { /** * Maximun size of data packets on the endpoint. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ maxPacketSize: number; @@ -195,6 +200,7 @@ declare namespace usb { /** * Endpoint direction. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ direction: USBRequestDirection; @@ -202,6 +208,7 @@ declare namespace usb { /** * Endpoint number. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ number: number; @@ -209,6 +216,7 @@ declare namespace usb { /** * Endpoint type * + * @syscap SystemCapability.USB.USBManager * @since 8 */ type: number; @@ -216,6 +224,7 @@ declare namespace usb { /** * Unique ID of the interface to which the endpoint belongs {@link USBInterface.id} * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interfaceId: number; @@ -226,12 +235,14 @@ declare namespace usb { * Represents a USB interface. One USBconfig {@link USBConfig} can contain multiple USBInterface instances, * each providing a specific function. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBInterface { /** * Unique ID of the USB interface. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ id: number; @@ -239,6 +250,7 @@ declare namespace usb { /** * Interface protocol. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ protocol: number; @@ -246,6 +258,7 @@ declare namespace usb { /** * Device type. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ clazz: number; @@ -253,6 +266,7 @@ declare namespace usb { /** * Device subclass. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ subClass: number; @@ -260,6 +274,7 @@ declare namespace usb { /** * Alternating between descripors of the same USB interface. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ alternateSetting: number; @@ -267,6 +282,7 @@ declare namespace usb { /** * Interface name. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ name: string; @@ -274,6 +290,7 @@ declare namespace usb { /** * Endpoints {@link USBEndpoint} that belongs to the USB interface. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ endpoints: Array; @@ -282,21 +299,22 @@ declare namespace usb { /** * Represents the USB configuration. One USBDevice{@link USBDevice} can contain multiple USBConfig instances. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBConfig { /** * Unique ID if the USB configuration. * + * @syscap SystemCapability.USB.USBManager * @since 8 - * - * */ id: number; /** * Configuration attributes. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ attributes: number; @@ -304,6 +322,7 @@ declare namespace usb { /** * Maximum power consumption, in mA. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ maxPower: number; @@ -311,6 +330,7 @@ declare namespace usb { /** * Configuration name, which can be left empty. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ name: string; @@ -318,6 +338,7 @@ declare namespace usb { /** * Support for remote wakeup. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ isRemoteWakeup: boolean; @@ -325,6 +346,7 @@ declare namespace usb { /** * Support for independent power supplies. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ isSelfPowered: boolean; @@ -332,6 +354,7 @@ declare namespace usb { /** * Supported interface attributes {@link USBInterface}. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interfaces: Array; @@ -340,84 +363,98 @@ declare namespace usb { /** * Represents a USB device. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBDevice { /** * Bus address. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ busNum: number; /** * Device address. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ devAddress: number; /** * Device SN. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ serial: string; /** * Device name. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ name: string; /** * Device manufacturer. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ manufacturerName: string; /** * Product name. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ productName: string; /** * Product version. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ version: string; /** * Vendor ID. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ vendorId: number; /** * Product ID. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ productId: number; /** * Device class. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ clazz: number; /** * Device subclass. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ subClass: number; /** * Device protocol code. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ protocol: number; /** * Device configuration descriptor information {@link USBConfig}. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ configs: Array; @@ -426,18 +463,21 @@ declare namespace usb { /** * Represents a USB device pipe, which is used to determine the USB device. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBDevicePipe { /** * Bus address. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ busNum: number; /** * Device address. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ devAddress: number; @@ -446,41 +486,49 @@ declare namespace usb { /** * Represents control transfer parameters. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ interface USBControlParams { /** * Request type. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ request: number; /** * Request target tyoe. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ target: USBRequestTargetType; /** * Request control type. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ reqType: USBControlRequestType; /** * Request parameter value. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ value: number; /** * Index of the parameter value. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ index: number; /** * Data written to or read from the buffer. + * + * @syscap SystemCapability.USB.USBManager * @since 8 */ data: Uint8Array; @@ -489,30 +537,35 @@ declare namespace usb { /** * Enumerates USB request target types. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ enum USBRequestTargetType { /** * Device. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TARGET_DEVICE = 0, /** * Interface. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TARGET_INTERFACE, /** * Endpoint. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TARGET_ENDPOINT, /** * Others. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TARGET_OTHER @@ -520,24 +573,29 @@ declare namespace usb { /** * Enumerates control request types. + * + * @syscap SystemCapability.USB.USBManager * @since 8 */ enum USBControlRequestType { /** * Standard. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TYPE_STANDARD = 0, /** * Class. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TYPE_CLASS, /** * Verdor. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_TYPE_VENDOR @@ -545,18 +603,22 @@ declare namespace usb { /** * Enumerates request directions. + * + * @syscap SystemCapability.USB.USBManager * @since 8 */ enum USBRequestDirection { /** * Request for writing data from the host to the device. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_DIR_TO_DEVICE = 0, /** * Request for reading data from the device to the host. * + * @syscap SystemCapability.USB.USBManager * @since 8 */ USB_REQUEST_DIR_FROM_DEVICE = 0x80 diff --git a/api/@ohos.userIAM.userAuth.d.ts b/api/@ohos.userIAM.userAuth.d.ts index faf424d0e50b01eb82e78bbcb8db415980b019b5..8a6e1960872a739c276814c3d63ce2a4010934b2 100644 --- a/api/@ohos.userIAM.userAuth.d.ts +++ b/api/@ohos.userIAM.userAuth.d.ts @@ -92,7 +92,6 @@ declare namespace userAuth { /** * Auth types - * @deprecated since 8 */ type AuthType = "ALL" | "FACE_ONLY"; diff --git a/api/@ohos.volumeManager.d.ts b/api/@ohos.volumeManager.d.ts index 0aa1f212770084f558eb0e7db56542c78ded51af..563201404be96ca0a8ca0ec2af8604d405583725 100644 --- a/api/@ohos.volumeManager.d.ts +++ b/api/@ohos.volumeManager.d.ts @@ -18,7 +18,7 @@ import {AsyncCallback, Callback} from "./basic"; /** * Provides volumemanager statistics APIs * - * @since 8 + * @since 9 * @syscap SystemCapability.FileManagement.StorageService.Volume */ declare namespace volumeManager { @@ -26,10 +26,10 @@ declare namespace volumeManager { /** * Get All Volumes * - * @since 8 + * @since 9 */ export interface Volume { - id: number; + id: string; uuid: string; description: string; removeAble: boolean; @@ -43,7 +43,7 @@ function getAllVolumes(): Promise>; /** * Mount * - * @since 8 + * @since 9 */ function mount(volumeId: string, callback: AsyncCallback): void; function mount(volumeId: string): Promise; @@ -51,7 +51,7 @@ function mount(volumeId: string): Promise; /** * UnMount * - * @since 8 + * @since 9 */ function unmount(volumeId: string, callback: AsyncCallback): void; function unmount(volumeId: string): Promise; diff --git a/api/@ohos.wallpaper.d.ts b/api/@ohos.wallpaper.d.ts index b0f83f66f4de0cce8882ae534cd803761bbc1ce9..9b1776d5c45807ccd9aeaf14ead70f2fd694e916 100644 --- a/api/@ohos.wallpaper.d.ts +++ b/api/@ohos.wallpaper.d.ts @@ -17,7 +17,7 @@ import image from './@ohos.multimedia.image' /** * System wallpaper - * @sysCap SystemCapability.Miscservices.WallpaperFramework + * @syscap SystemCapability.Miscservices.WallpaperFramework * @devices phone, tablet, tv, wearable, car * @import import wallpaper from '@ohos.wallpaper'; * @since 7 diff --git a/api/@ohos.wantAgent.d.ts b/api/@ohos.wantAgent.d.ts index 17dd1c8aa2d855ada9d3e36a8b994b45eb4ca9e5..15a908ec67113cf100b8d14dbf9df351101c24b5 100644 --- a/api/@ohos.wantAgent.d.ts +++ b/api/@ohos.wantAgent.d.ts @@ -24,7 +24,7 @@ import { TriggerInfo } from './wantAgent/triggerInfo'; * * @name wantAgent * @since 7 - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import wantAgent from '@ohos.wantAgent'; * @permission N/A */ diff --git a/api/@ohos.wifi.d.ts b/api/@ohos.wifi.d.ts index f778a933ff90a61600b0a9acb191e72360717a08..e0cecd1eb2f00ddaa9e6894cf24b45d13fb288a9 100644 --- a/api/@ohos.wifi.d.ts +++ b/api/@ohos.wifi.d.ts @@ -444,6 +444,7 @@ declare namespace wifi { * @return Returns the P2P connection information. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function getP2pLinkedInfo(): Promise; function getP2pLinkedInfo(callback: AsyncCallback): void; @@ -454,6 +455,7 @@ declare namespace wifi { * @return Returns the current group information. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ function getCurrentGroup(): Promise; function getCurrentGroup(callback: AsyncCallback): void; @@ -464,26 +466,29 @@ declare namespace wifi { * @return Returns the found devices list. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ - function getP2pDevices(): Promise; - function getP2pDevices(callback: AsyncCallback): void; + function getP2pPeerDevices(): Promise; + function getP2pPeerDevices(callback: AsyncCallback): void; /** * Creates a P2P group. * * @param config Indicates the configuration for creating a group. - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function createGroup(config: WifiP2PConfig): boolean; /** * Removes a P2P group. * - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function removeGroup(): boolean; @@ -491,36 +496,40 @@ declare namespace wifi { * Initiates a P2P connection to a device with the specified configuration. * * @param config Indicates the configuration for connecting to a specific group. - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ function p2pConnect(config: WifiP2PConfig): boolean; /** * Canceling a P2P connection. * - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function p2pCancelConnect(): boolean; /** * Discovers Wi-Fi P2P devices. * - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ function startDiscoverDevices(): boolean; /** * Stops discovering Wi-Fi P2P devices. * - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function stopDiscoverDevices(): boolean; @@ -528,9 +537,11 @@ declare namespace wifi { * Deletes the persistent P2P group with the specified network ID. * * @param netId Indicates the network ID of the group to be deleted. - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION + * @systemapi Hide this for inner system use. */ function deletePersistentGroup(netId: number): boolean; @@ -538,9 +549,11 @@ declare namespace wifi { * Sets the name of the Wi-Fi P2P device. * * @param devName Indicates the name to be set. - * @return Returns {@code true} if the scanning is successful; returns {@code false} otherwise. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION + * @systemapi Hide this for inner system use. */ function setDeviceName(devName: string): boolean; @@ -723,6 +736,7 @@ declare namespace wifi { * @return Returns 1: idle, 2: starting, 3:started, 4: closing, 5: closed * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function on(type: "p2pStateChange", callback: Callback): void; @@ -731,6 +745,7 @@ declare namespace wifi { * * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function off(type: "p2pStateChange", callback?: Callback): void; @@ -740,6 +755,7 @@ declare namespace wifi { * @return Returns WifiP2pLinkedInfo * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function on(type: "p2pConnectionChange", callback: AsyncCallback): void; @@ -748,6 +764,7 @@ declare namespace wifi { * * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function off(type: "p2pConnectionChange", callback?: AsyncCallback): void; @@ -757,6 +774,7 @@ declare namespace wifi { * @return Returns WifiP2pDevice * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ function on(type: "p2pDeviceChange", callback: AsyncCallback): void; @@ -766,6 +784,7 @@ declare namespace wifi { * @return Returns WifiP2pDevice * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.LOCATION */ function off(type: "p2pDeviceChange", callback?: AsyncCallback): void; @@ -775,6 +794,7 @@ declare namespace wifi { * @return Returns WifiP2pDevice[] * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION */ function on(type: "p2pPeerDeviceChange", callback: AsyncCallback): void; @@ -783,6 +803,7 @@ declare namespace wifi { * * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.LOCATION */ function off(type: "p2pPeerDeviceChange", callback?: AsyncCallback): void; @@ -792,6 +813,7 @@ declare namespace wifi { * @return Returns void * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function on(type: "p2pPersistentGroupChange", callback: Callback): void; @@ -800,6 +822,7 @@ declare namespace wifi { * * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function off(type: "p2pPersistentGroupChange", callback?: Callback): void; @@ -809,6 +832,7 @@ declare namespace wifi { * @return Returns 0: initial state, 1: discovery succeeded * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function on(type: "p2pDiscoveryChange", callback: Callback): void; @@ -817,6 +841,7 @@ declare namespace wifi { * * @since 8 * @syscap SystemCapability.Communication.WiFi.P2P + * @permission ohos.permission.GET_WIFI_INFO */ function off(type: "p2pDiscoveryChange", callback?: Callback): void; @@ -825,6 +850,7 @@ declare namespace wifi { * * @since 6 * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.STA */ interface WifiDeviceConfig { /** Wi-Fi SSID: the maximum length is 32 */ @@ -875,7 +901,8 @@ declare namespace wifi { * Wi-Fi IP configuration information. * * @since 7 - * @systemapi + * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.STA */ interface IpConfig { ipAddress: number; @@ -888,6 +915,7 @@ declare namespace wifi { * Describes the scanned Wi-Fi information. * * @since 6 + * @syscap SystemCapability.Communication.WiFi.STA */ interface WifiScanInfo { /** Wi-Fi SSID: the maximum length is 32 */ @@ -922,6 +950,7 @@ declare namespace wifi { * Describes the wifi security type. * * @since 6 + * @syscap SystemCapability.Communication.WiFi.Core */ enum WifiSecurityType { /** Invalid security type */ @@ -944,6 +973,7 @@ declare namespace wifi { * Wi-Fi connection information. * * @since 7 + * @syscap SystemCapability.Communication.WiFi.STA */ interface WifiLinkedInfo { /** The SSID of the Wi-Fi hotspot */ @@ -1000,6 +1030,7 @@ declare namespace wifi { * Wi-Fi IP information. * * @since 7 + * @syscap SystemCapability.Communication.WiFi.STA */ interface IpInfo { /** The IP address of the Wi-Fi connection */ @@ -1028,7 +1059,8 @@ declare namespace wifi { * Wi-Fi hotspot configuration information. * * @since 7 - * @systemapi + * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.AP */ interface HotspotConfig { /** The SSID of the Wi-Fi hotspot */ @@ -1051,7 +1083,8 @@ declare namespace wifi { * Wi-Fi station information. * * @since 7 - * @systemapi + * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.AP */ interface StationInfo { /** the network name of the Wi-Fi client */ @@ -1068,7 +1101,8 @@ declare namespace wifi { * Wi-Fi IP type enumeration. * * @since 7 - * @systemapi + * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.STA */ enum IpType { /** Use statically configured IP settings */ @@ -1085,7 +1119,8 @@ declare namespace wifi { * The state of the supplicant enumeration. * * @since 7 - * @systemapi + * @systemapi Hide this for inner system use. + * @syscap SystemCapability.Communication.WiFi.STA */ export enum SuppState { /** The supplicant is not associated with or is disconnected from the AP. */ @@ -1129,6 +1164,7 @@ declare namespace wifi { * The state of Wi-Fi connection enumeration. * * @since 7 + * @syscap SystemCapability.Communication.WiFi.STA */ export enum ConnState { /** The device is searching for an available AP. */ @@ -1160,6 +1196,7 @@ declare namespace wifi { * P2P device information. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ interface WifiP2pDevice { /** Device name */ @@ -1182,6 +1219,7 @@ declare namespace wifi { * P2P config. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ interface WifiP2PConfig { /** Device mac address */ @@ -1207,6 +1245,7 @@ declare namespace wifi { * P2P group information. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ interface WifiP2pGroupInfo { /** Indicates whether it is group owner */ @@ -1241,6 +1280,7 @@ declare namespace wifi { * P2P connection status. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ enum P2pConnectState { DISCONNECTED = 0, @@ -1251,6 +1291,7 @@ declare namespace wifi { * P2P linked information. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ interface WifiP2pLinkedInfo { /** Connection status */ @@ -1267,6 +1308,7 @@ declare namespace wifi { * P2P device status. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ enum P2pDeviceStatus { CONNECTED = 0, @@ -1280,6 +1322,7 @@ declare namespace wifi { * P2P group owner band. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.P2P */ enum GroupOwnerBand { GO_BAND_AUTO = 0, diff --git a/api/@ohos.wifiext.d.ts b/api/@ohos.wifiext.d.ts index eaad6e06a8e76e34bbb1ce71bc546357f6960395..83c6bdade80a0b5fed3febef6ef0e72c0907ff39 100644 --- a/api/@ohos.wifiext.d.ts +++ b/api/@ohos.wifiext.d.ts @@ -85,6 +85,7 @@ declare namespace wifiext { * The power model enumeration. * * @since 8 + * @syscap SystemCapability.Communication.WiFi.HotspotExt */ export enum PowerModel { /** Sleeping model. */ diff --git a/api/@ohos.window.d.ts b/api/@ohos.window.d.ts index 868d38934dcaecbf529b13934f6d49f7003b2166..f75000180e1c3387cad4f1b81c7970bfd1f1b967 100644 --- a/api/@ohos.window.d.ts +++ b/api/@ohos.window.d.ts @@ -14,15 +14,16 @@ */ import { AsyncCallback, Callback } from './basic' ; import { Context } from './app/context'; -import { ContenStorage } from './@internal/component/ets/stateManagement' +import { ContentStorage } from './@internal/component/ets/stateManagement' /** * Window manager. * @syscap SystemCapability.WindowManager.WindowManager.Core -*/ + */ declare namespace window { /** * The type of a window. * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 7 */ enum WindowType { /** @@ -64,89 +65,6 @@ declare namespace window { FLOATING } - /** - * Create a sub window with a specific id and type, only support 7. - * @param id Indicates window id. - * @param type Indicates window type. - * @since 7 - */ - function create(id: string, type: WindowType, callback: AsyncCallback): void; - - /** - * Create a sub window with a specific id and type, only support 7. - * @param id Indicates window id. - * @param type Indicates window type. - * @since 7 - */ - function create(id: string, type: WindowType): Promise; - - /** - * Create a system window with a specific id and type. - * @param ctx Indicates the context on which the window depends - * @param id Indicates window id. - * @param type Indicates window type. - * @systemapi Hide this for inner system use. - * @since 8 - */ - function create(ctx: Context, id: string, type: WindowType): Promise; - - /** - * Find the window by id. - * @param id Indicates window id. - * @since 7 - */ - function find(id: string, callback: AsyncCallback): void; - - /** - * Find the window by id. - * @param id Indicates window id. - * @since 7 - */ - function find(id: string): Promise; - - /** - * Get the final show window. - * @param id Indicates window id. - * @since 6 - */ - function getTopWindow(callback: AsyncCallback): void; - - /** - * Get the final show window. - * @since 6 - */ - function getTopWindow(): Promise; - - /** - * Get the final show window. - * @param ctx Indicates the context on which the window depends - * @since 8 - */ - function getTopWindow(ctx: Context): Promise; - - /** - * Get the final show window. - * @param ctx Indicates the context on which the window depends - * @since 8 - */ - function getTopWindow(ctx: Context, callback: AsyncCallback): void; - - /** - * register the callback of systemBarTintChange - * @param type: 'systemBarTintChange' - * @systemapi Hide this for inner system use. - * @since 8 - */ - function on(type: 'systemBarTintChange', callback: Callback): void; - - /** - * unregister the callback of systemBarTintChange - * @param type: 'systemBarTintChange' - * @systemapi Hide this for inner system use. - * @since 8 - */ - function off(type: 'systemBarTintChange', callback?: Callback): void; - /** * Properties of status bar and navigation bar, it couldn't update automatically * @syscap SystemCapability.WindowManager.WindowManager.Core @@ -325,7 +243,7 @@ declare namespace window { /** * Whether the window layout is in full screen mode(whether the window is immersive). The default value is false. - * @since 6 + * @since 7 */ isLayoutFullScreen: boolean @@ -337,7 +255,7 @@ declare namespace window { /** * Whether the window is touchable. The default value is false - * @since 6 + * @since 7 */ touchable: boolean } @@ -357,41 +275,136 @@ declare namespace window { WIDE_GAMUT, } + /** + * Create a sub window with a specific id and type, only support 7. + * @param id Indicates window id. + * @param type Indicates window type. + * @since 7 + */ + function create(id: string, type: WindowType, callback: AsyncCallback): void; + + /** + * Create a sub window with a specific id and type, only support 7. + * @param id Indicates window id. + * @param type Indicates window type. + * @since 7 + */ + function create(id: string, type: WindowType): Promise; + + /** + * Create a system or float window with a specific id and type. + * @param ctx Indicates the context on which the window depends + * @param id Indicates window id. + * @param type Indicates window type. + * @systemapi Hide this for inner system use. + * @permission ohos.permission.SYSTEM_FLOAT_WINDOW + * @since 8 + */ + function create(ctx: Context, id: string, type: WindowType): Promise; + + /** + * Create a system or float window with a specific id and type. + * @param ctx Indicates the context on which the window depends + * @param id Indicates window id. + * @param type Indicates window type. + * @systemapi Hide this for inner system use. + * @permission ohos.permission.SYSTEM_FLOAT_WINDOW + * @since 8 + */ + function create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback): void; + + /** + * Find the window by id. + * @param id Indicates window id. + * @since 7 + */ + function find(id: string, callback: AsyncCallback): void; + + /** + * Find the window by id. + * @param id Indicates window id. + * @since 7 + */ + function find(id: string): Promise; + + /** + * Get the final show window. + * @param id Indicates window id. + * @since 6 + */ + function getTopWindow(callback: AsyncCallback): void; + + /** + * Get the final show window. + * @since 6 + */ + function getTopWindow(): Promise; + + /** + * Get the final show window. + * @param ctx Indicates the context on which the window depends + * @since 8 + */ + function getTopWindow(ctx: Context): Promise; + + /** + * Get the final show window. + * @param ctx Indicates the context on which the window depends + * @since 8 + */ + function getTopWindow(ctx: Context, callback: AsyncCallback): void; + + /** + * register the callback of systemBarTintChange + * @param type: 'systemBarTintChange' + * @systemapi Hide this for inner system use. + * @since 8 + */ + function on(type: 'systemBarTintChange', callback: Callback): void; + + /** + * unregister the callback of systemBarTintChange + * @param type: 'systemBarTintChange' + * @systemapi Hide this for inner system use. + * @since 8 + */ + function off(type: 'systemBarTintChange', callback?: Callback): void; + interface Window { /** - * hide sub window. + * hide window. * @systemapi Hide this for inner system use. * @since 7 */ hide (callback: AsyncCallback): void; /** - * hide sub window. + * hide window. * @systemapi Hide this for inner system use. * @since 7 */ hide(): Promise; /** - * show sub window. + * show window. * @since 7 */ show(callback: AsyncCallback): void; /** - * show sub window. + * show window. * @since 7 */ show(): Promise; /** - * Destroy the sub window. + * Destroy the window. * @since 7 */ destroy(callback: AsyncCallback): void; /** - * Destroy the sub window. + * Destroy the window. * @since 7 */ destroy(): Promise; @@ -434,21 +447,21 @@ declare namespace window { /** * Set the type of a window. - * @param windowType Indicate the type of a window. + * @param type Indicate the type of a window. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ - setWindowType(windowType: WindowType): Promise; + setWindowType(type: WindowType): Promise; /** * Set the type of a window. - * @param windowType Indicate the type of a window. + * @param type Indicate the type of a window. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ - setWindowType(windowType: WindowType, callback: AsyncCallback): void; + setWindowType(type: WindowType, callback: AsyncCallback): void; /** * get the properties of current window @@ -549,23 +562,24 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ - loadContent(path: string, storage: ContenStorage, callback: AsyncCallback): void; + loadContent(path: string, storage: ContentStorage, callback: AsyncCallback): void; /** * Loads content * @param path path of the page to which the content will be loaded + * @param storage storage The data object shared within the content instance loaded by the window * @syscap SystemCapability.WindowManager.WindowManager.Core - * @since 7 + * @since 9 */ - loadContent(path: string, callback: AsyncCallback): void; + loadContent(path: string, storage?: ContentStorage): Promise; /** * Loads content - * @param path path of the page to which the content will be loaded + * @param path path of the page to which the content will be loaded2 * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ - loadContent(path: string, storage?: ContenStorage): Promise; + loadContent(path: string, callback: AsyncCallback): void; /** * Checks whether the window is displayed @@ -651,7 +665,11 @@ declare namespace window { */ getColorSpace(callback: AsyncCallback): void; } - + /** + * window stage callback event type + * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 9 + */ enum WindowStageEventType { FOREGROUND = 1, ACTIVE, @@ -661,6 +679,7 @@ declare namespace window { /** * WindowStage * @syscap SystemCapability.WindowManager.WindowManager.Core + * @since 9 */ interface WindowStage { /** @@ -702,21 +721,22 @@ declare namespace window { * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ - loadContent(path: string, storage: ContenStorage, callback: AsyncCallback): void; + loadContent(path: string, storage: ContentStorage, callback: AsyncCallback): void; /** * Loads content * @param path path of the page to which the content will be loaded + * @param storage storage The data object shared within the content instance loaded by the window * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ - loadContent(path: string, callback: AsyncCallback): void; + loadContent(path: string, storage?: ContentStorage): Promise; /** * Loads content * @param path path of the page to which the content will be loaded * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ - loadContent(path: string, storage?: ContenStorage): Promise; + loadContent(path: string, callback: AsyncCallback): void; /** * window stage event callback on. * @since 9 diff --git a/api/@system.sensor.d.ts b/api/@system.sensor.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..ec89fd8622e5bf3cc799a60c0b4764d9260eddf3 --- /dev/null +++ b/api/@system.sensor.d.ts @@ -0,0 +1,878 @@ +/* + * 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 + * + * 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. + */ + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.ACCELEROMETER + * @since 3 + * @deprecated since 8 + */ +export interface AccelerometerResponse { + /** + * X-coordinate + * @since 3 + */ + x: number; + + /** + * Y-coordinate + * @since 3 + */ + y: number; + + /** + * Z-coordinate + * @since 3 + */ + z: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.ACCELEROMETER + * @since 3 + * @deprecated since 8 + */ +export interface subscribeAccelerometerOptions { + /** + * Execution frequency of the callback function for listening to acceleration sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 3 + */ + interval: string; + + /** + * Called when acceleration sensor data changes. + * @since 3 + */ + success: (data: AccelerometerResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface CompassResponse { + /** + * Direction of the device (in degrees). + * @since 3 + */ + direction: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeCompassOptions { + /** + * Called when compass sensor data changes. + * @since 3 + */ + success: (data: CompassResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface ProximityResponse { + /** + * Distance between a visible object and the device screen + * @since 3 + */ + distance: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeProximityOptions { + /** + * Called when distance sensor data changes. + * @since 3 + */ + success: (data: ProximityResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface LightResponse { + /** + * Light intensity, in lux. + * @since 3 + */ + intensity: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeLightOptions { + /** + * Called when ambient light sensor data changes. + * @since 3 + */ + success: (data: LightResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.ACTIVITY_MOTION + * @since 3 + * @deprecated since 8 + */ +export interface StepCounterResponse { + /** + * Number of steps counted. + * Each time the device restarts, the value is recalculated from 0 in phone, tablet. + * @since 3 + */ + steps: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.ACTIVITY_MOTION + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeStepCounterOptions { + /** + * Called when step counter sensor data changes. + * @since 3 + */ + success: (data: StepCounterResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface BarometerResponse { + /** + * Pressure, in pascal. + * @since 3 + */ + pressure: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeBarometerOptions { + /** + * Called when the barometer sensor data changes. + * @since 3 + */ + success: (data: BarometerResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.READ_HEALTH_DATA + * @since 3 + * @deprecated since 8 + */ +export interface HeartRateResponse { + /** + * Heart rate. + * 255 indicates an invalid value in lite wearable. + * @since 3 + */ + heartRate: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.READ_HEALTH_DATA + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeHeartRateOptions { + /** + * Called when the heart rate sensor data changes. + * @since 3 + */ + success: (data: HeartRateResponse) => void; + + /** + * Called when the listening fails + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface OnBodyStateResponse { + /** + * Whether the sensor is worn. + * @since 3 + */ + value: boolean; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface SubscribeOnBodyStateOptions { + /** + * Called when the wearing status changes. + * @since 3 + */ + success: (data: OnBodyStateResponse) => void; + + /** + * Called when the listening fails. + * @since 3 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 3 + * @deprecated since 8 + */ +export interface GetOnBodyStateOptions { + /** + * Called when the sensor wearing state is obtained + * @since 3 + */ + success: (data: OnBodyStateResponse) => void; + + /** + * Called when the sensor wearing state fails to be obtained + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed + * @since 3 + */ + complete?: () => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 6 + * @deprecated since 8 + */ +export interface DeviceOrientationResponse { + /** + * alpha + * @since 6 + */ + alpha: number; + + /** + * beta + * @since 6 + */ + beta: number; + + /** + * gamma + * @since 6 + */ + gamma: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 6 + * @deprecated since 8 + */ +export interface SubscribeDeviceOrientationOptions { + /** + * Execution frequency of the callback function for listening to device orientation sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 6 + */ + interval: string; + + /** + * Called when device orientation sensor data changes. + * @since 6 + */ + success: (data: DeviceOrientationResponse) => void; + + /** + * Called when the listening fails. + * @since 6 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.GYROSCOPE + * @since 6 + * @deprecated since 8 + */ +export interface GyroscopeResponse { + /** + * X-coordinate + * @since 6 + */ + x: number; + + /** + * Y-coordinate + * @since 6 + */ + y: number; + + /** + * Z-coordinate + * @since 6 + */ + z: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @permission ohos.permission.GYROSCOPE + * @since 6 + * @deprecated since 8 + */ +export interface SubscribeGyroscopeOptions { + /** + * Execution frequency of the callback function for listening to gyroscope sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 6 + */ + interval: string; + + /** + * Called when gyroscope sensor data changes. + * @since 6 + */ + success: (data: GyroscopeResponse) => void; + + /** + * Called when the listening fails. + * @since 6 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface GravityResponse { + /** + * X-coordinate + * @since 7 + */ + x: number; + + /** + * Y-coordinate + * @since 7 + */ + y: number; + + /** + * Z-coordinate + * @since 7 + */ + z: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface SubscribeGravityOptions { + /** + * Execution frequency of the callback function for listening to gravity sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 7 + */ + interval: string; + + /** + * Called when gravity sensor data changes. + * @since 7 + */ + success: (data: GravityResponse) => void; + + /** + * Called when the listening fails. + * @since 7 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface MagneticResponse { + /** + * X-coordinate + * @since 7 + */ + x: number; + + /** + * Y-coordinate + * @since 7 + */ + y: number; + + /** + * Z-coordinate + * @since 7 + */ + z: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface SubscribeMagneticOptions { + /** + * Execution frequency of the callback function for listening to magnetic sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 7 + */ + interval: string; + + /** + * Called when magnetic sensor data changes. + * @since 7 + */ + success: (data: MagneticResponse) => void; + + /** + * Called when the listening fails. + * @since 7 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface HallResponse { + /** + * Indicates the hall sensor data. + * @since 7 + */ + value: number; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export interface SubscribeHallOptions { + /** + * Execution frequency of the callback function for listening to hall sensor data. + * Available values are as follows: + * 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming. + * 2. ui: High frequency (60 ms per callback), which is applicable to UI updating. + * 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption. + * The default value is normal. + * @since 7 + */ + interval: string; + + /** + * Called when hall sensor data changes. + * @since 7 + */ + success: (data: HallResponse) => void; + + /** + * Called when the listening fails. + * @since 7 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @syscap SystemCapability.Sensors.Sensor + * @import import sensor from '@system.sensor'; + * @since 7 + * @deprecated since 8 + */ +export default class Sensor { + /** + * Listens to acceleration sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACCELEROMETER + * @since 3 + * @deprecated since 8 + */ + static subscribeAccelerometer(options: subscribeAccelerometerOptions): void; + + /** + * Cancels listening to acceleration sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACCELEROMETER + * @since 3 + * @deprecated since 8 + */ + static unsubscribeAccelerometer(): void; + + /** + * Listens to compass sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static subscribeCompass(options: SubscribeCompassOptions): void; + + /** + * Cancels listening to compass sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static unsubscribeCompass(): void; + + /** + * Listens to distance sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static subscribeProximity(options: SubscribeProximityOptions): void; + + /** + * Cancels listening to distance sensor data. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static unsubscribeProximity(): void; + + /** + * Listens to ambient light sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static subscribeLight(options: SubscribeLightOptions): void; + + /** + * Cancels listening to ambient light sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static unsubscribeLight(): void; + + /** + * Listens to step counter sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACTIVITY_MOTION + * @since 3 + * @deprecated since 8 + */ + static subscribeStepCounter(options: SubscribeStepCounterOptions): void; + + /** + * Cancels listening to step counter sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.ACTIVITY_MOTION + * @since 3 + * @deprecated since 8 + */ + static unsubscribeStepCounter(): void; + + /** + * Listens to barometer sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static subscribeBarometer(options: SubscribeBarometerOptions): void; + + /** + * Cancels listening to barometer sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static unsubscribeBarometer(): void; + + /** + * Listens to changes of heart rate sensor data. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.READ_HEALTH_DATA + * @since 3 + * @deprecated since 8 + */ + static subscribeHeartRate(options: SubscribeHeartRateOptions): void; + + /** + * Cancels listening to heart rate sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.READ_HEALTH_DATA + * @since 3 + * @deprecated since 8 + */ + static unsubscribeHeartRate(): void; + + /** + * Listens to whether a sensor is worn. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static subscribeOnBodyState(options: SubscribeOnBodyStateOptions): void; + + /** + * Cancels listening to whether the sensor is worn. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static unsubscribeOnBodyState(): void; + + /** + * Obtains the sensor wearing state. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 3 + * @deprecated since 8 + */ + static getOnBodyState(options: GetOnBodyStateOptions): void; + + /** + * Listens to device orientation sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 6 + * @deprecated since 8 + */ + static subscribeDeviceOrientation(options: SubscribeDeviceOrientationOptions): void; + + /** + * Cancels listening to device orientation sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 6 + * @deprecated since 8 + */ + static unsubscribeDeviceOrientation(): void; + + /** + * Listens to gyroscope sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.GYROSCOPE + * @since 6 + * @deprecated since 8 + */ + static subscribeGyroscope(options: SubscribeGyroscopeOptions): void; + + /** + * Cancels listening to gyroscope sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @permission ohos.permission.GYROSCOPE + * @since 6 + * @deprecated since 8 + */ + static unsubscribeGyroscope(): void; + + /** + * Listens to gravity sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static subscribeGravity(options: SubscribeGravityOptions): void; + + /** + * Cancels listening to gravity sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static unsubscribeGravity(): void; + + /** + * Listens to magnetic sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static subscribeMagnetic(options: SubscribeMagneticOptions): void; + + /** + * Cancels listening to magnetic sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static unsubscribeMagnetic(): void; + + /** + * Listens to hall sensor data changes. + * If this API is called multiple times, the last call takes effect. + * @param options Options. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static subscribeHall(options: SubscribeHallOptions): void; + + /** + * Cancels listening to hall sensor data. + * @syscap SystemCapability.Sensors.Sensor + * @since 7 + * @deprecated since 8 + */ + static unsubscribeHall(): void; +} diff --git a/api/@system.vibrator.d.ts b/api/@system.vibrator.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..f8fd9d1be2962baa1b34bfa92fa54e26cbda0f38 --- /dev/null +++ b/api/@system.vibrator.d.ts @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2020 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. + */ + +/** + * @syscap SystemCapability.Sensors.MiscDevice + * @import import vibrator from '@system.vibrator'; + * @permission ohos.permission.VIBRATE + * @since 3 + * @deprecated since 8 + */ +export interface VibrateOptions { + /** + * Vibration mode. The value long indicates long vibration, and short indicates short vibration. + * The default value is long. + * @since 3 + */ + mode?: "long" | "short"; + + /** + * Called when success to trigger vibration. + * @since 3 + */ + success: () => void; + + /** + * Called when fail to trigger vibration. + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 3 + */ + complete?: () => void; +} + +/** + * @syscap SystemCapability.Sensors.MiscDevice + * @import import vibrator from '@system.vibrator'; + * @permission ohos.permission.VIBRATE + * @since 3 + * @deprecated since 8 + */ +export default class Vibrator { + /** + * Triggers vibration. + * @param options Options. + * @permission ohos.permission.VIBRATE + * @since 3 + * @deprecated since 8 + */ + static vibrate(options?: VibrateOptions): void; +} diff --git a/api/ability/abilityResult.d.ts b/api/ability/abilityResult.d.ts index bac8cd8756c1b766d842dedc839cff4747d0de56..253243e97fbd0b5f0468ea7c29002334892777a2 100644 --- a/api/ability/abilityResult.d.ts +++ b/api/ability/abilityResult.d.ts @@ -16,7 +16,7 @@ import { Want } from './want'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export interface AbilityResult { @@ -25,7 +25,7 @@ export interface AbilityResult { * code to identify an error. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ resultCode: number; @@ -34,7 +34,7 @@ export interface AbilityResult { * This parameter can be null. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ want?: Want; } \ No newline at end of file diff --git a/api/ability/connectOptions.d.ts b/api/ability/connectOptions.d.ts index 1604b9bf5e0797c5dc51dcd8842a15d40fd95c81..8b283b0da1d8f6cfd808a204f86451702f10fcf4 100644 --- a/api/ability/connectOptions.d.ts +++ b/api/ability/connectOptions.d.ts @@ -17,7 +17,7 @@ import rpc from './../@ohos.rpc'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ConnectOptions { @@ -26,7 +26,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability * @param remoteObject The remote object instance */ @@ -37,7 +37,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability */ onDisconnect: (elementName: ElementName) => void; @@ -47,7 +47,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param code The error code of the failed. */ onFailed: (code: number) => void; diff --git a/api/ability/continueAbilityOptions.d.ts b/api/ability/continueAbilityOptions.d.ts index 32c09d141425de7df7c76477511658ea6505d8c6..12f2772298c217a41ec02a4b6260e65282abccde 100755 --- a/api/ability/continueAbilityOptions.d.ts +++ b/api/ability/continueAbilityOptions.d.ts @@ -15,7 +15,7 @@ /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ContinueAbilityOptions { @@ -24,7 +24,7 @@ export interface ContinueAbilityOptions { * * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ deviceId: string; @@ -35,7 +35,7 @@ export interface ContinueAbilityOptions { * * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ reversible?: boolean; diff --git a/api/ability/dataAbilityHelper.d.ts b/api/ability/dataAbilityHelper.d.ts index f1cf3feefbda2e86dcbfc99117cd44f9ba789af8..1fd91039bf98cbb768df1d8c99b11604d37986c6 100644 --- a/api/ability/dataAbilityHelper.d.ts +++ b/api/ability/dataAbilityHelper.d.ts @@ -22,7 +22,7 @@ import rdb from '../@ohos.data.rdb'; /** * DataAbilityHelper - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * * @since 7 * @FAModelOnly @@ -32,7 +32,7 @@ export interface DataAbilityHelper { * Opens a file in a specified remote path. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @param mode Indicates the file open mode, which can be "r" for read-only access, "w" for write-only access * (erasing whatever data is currently in the file), "wt" for write access that truncates any existing @@ -49,7 +49,7 @@ export interface DataAbilityHelper { * Registers an observer to observe data specified by the given uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param type dataChange. * @param uri Indicates the path of the data to operate. * @param callback Indicates the callback when dataChange. @@ -62,7 +62,7 @@ export interface DataAbilityHelper { * Deregisters an observer used for monitoring data specified by the given uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param type dataChange. * @param uri Indicates the path of the data to operate. * @param callback Indicates the registered callback. @@ -75,7 +75,7 @@ export interface DataAbilityHelper { * Obtains the MIME type of the date specified by the given URI. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to operate. * @return Returns the MIME type that matches the data specified by uri. * @FAModelOnly @@ -87,7 +87,7 @@ export interface DataAbilityHelper { * Obtains the MIME types of files supported. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the files to obtain. * @param mimeTypeFilter Indicates the MIME types of the files to obtain. * @return Returns the matched MIME types Array. @@ -100,7 +100,7 @@ export interface DataAbilityHelper { * Converts the given uri that refers to the Data ability into a normalized uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri object to normalize. * @return Returns the normalized uri object if the Data ability supports URI normalization or null. * @FAModelOnly @@ -112,7 +112,7 @@ export interface DataAbilityHelper { * Converts the given normalized uri generated by normalizeUri(uri) into a denormalized one. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri object to normalize. * @return Returns the denormalized uri object if the denormalization is successful. * @FAModelOnly @@ -124,7 +124,7 @@ export interface DataAbilityHelper { * Notifies the registered observers of a change to the data resource specified by uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to operate. * @return - * @FAModelOnly @@ -136,7 +136,7 @@ export interface DataAbilityHelper { * Inserts a single data record into the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to insert. * @param valuesBucket Indicates the data record to insert. If this parameter is null, a blank row will be inserted. * @return Returns the index of the inserted data record. @@ -149,7 +149,7 @@ export interface DataAbilityHelper { * Inserts multiple data records into the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to batchInsert. * @param valuesBuckets Indicates the data records to insert. * @return Returns the number of data records inserted. @@ -162,7 +162,7 @@ export interface DataAbilityHelper { * Deletes one or more data records from the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to delete. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. * @return Returns the number of data records deleted. @@ -175,7 +175,7 @@ export interface DataAbilityHelper { * Updates data records in the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of data to update. * @param valuesBucket Indicates the data to update. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. @@ -189,7 +189,7 @@ export interface DataAbilityHelper { * Queries data in the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of data to query. * @param columns Indicates the columns to query. If this parameter is null, all columns are queried. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. @@ -198,4 +198,44 @@ export interface DataAbilityHelper { */ query(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void; query(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates): Promise; + + /** + * Calls the extended API of the DataAbility. This method uses a promise to return the result. + * + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * @param uri URI of the Data ability. Example: "dataability:///com.example.xxx.xxxx" + * @param method Indicates the method to call. + * @param arg Indicates the parameter of the String type. + * @param extras Indicates the parameter of the PacMap type. + * If a custom Sequenceable object is put in the PacMap object and will be transferred across processes, + * you must call BasePacMap.setClassLoader(ClassLoader) to set a class loader for the custom object. + * If the PacMap object is to be transferred to a non-OHOS process, + * values of primitive types are supported, but not custom Sequenceable objects. + * @return Returns the query result {@link PacMap}. + * @FAModelOnly + */ + call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback): void; + call(uri: string, method: string, arg: string, extras: PacMap): Promise; +} + +/** + * Defines a PacMap object for storing a series of values. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * @FAModelOnly + */ + export interface PacMap { + + /** + * Indicates the parameter of the PacMap type. + * If a custom Sequenceable object is put in the PacMap object and will be transferred across processes, + * you must call BasePacMap.setClassLoader(ClassLoader) to set a class loader for the custom object. + * If the PacMap object is to be transferred to a non-OHOS process, + * values of primitive types are supported, but not custom Sequenceable objects. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * @FAModelOnly + */ + [key: string]: number | string | boolean | Array | null; } diff --git a/api/ability/dataAbilityOperation.d.ts b/api/ability/dataAbilityOperation.d.ts index 4d961357d179bf0883bb3e92f8599ef2392533ea..8b8a1ca9c85cced12ffde98cb12b164ba4d98985 100644 --- a/api/ability/dataAbilityOperation.d.ts +++ b/api/ability/dataAbilityOperation.d.ts @@ -19,7 +19,7 @@ import rdb from '../@ohos.data.rdb'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface DataAbilityOperation { @@ -27,7 +27,7 @@ export interface DataAbilityOperation { * Indicates the path of data to operate. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri: string; @@ -36,7 +36,7 @@ export interface DataAbilityOperation { * Indicates a operation type. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ type: featureAbility.DataAbilityOperationType; @@ -45,7 +45,7 @@ export interface DataAbilityOperation { * Indicates the data values to be set. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valuesBucket?: rdb.ValuesBucket; @@ -54,7 +54,7 @@ export interface DataAbilityOperation { * Indicates the valuesBucket object containing a set of key-value pairs. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valueBackReferences?: rdb.ValuesBucket; @@ -64,7 +64,7 @@ export interface DataAbilityOperation { * will be operated by default. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicates?: dataAbility.DataAbilityPredicates; @@ -73,7 +73,7 @@ export interface DataAbilityOperation { * Indicates the back reference to be used as a filter criterion in predicates. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicatesBackReferences?: Map; @@ -82,7 +82,7 @@ export interface DataAbilityOperation { * Specifies whether a batch operation can be interrupted. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ interrupted?: boolean; @@ -91,7 +91,7 @@ export interface DataAbilityOperation { * Indicates the expected number of rows to update or delete. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ expectedCount?: number; diff --git a/api/ability/dataAbilityResult.d.ts b/api/ability/dataAbilityResult.d.ts index e7c53bc8f7054960adce5c645ff839d8ede37234..4b6600d6823b46d3e785619ba25c3acd8caabab4 100644 --- a/api/ability/dataAbilityResult.d.ts +++ b/api/ability/dataAbilityResult.d.ts @@ -16,7 +16,7 @@ /** * @name DataAbilityResult * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface DataAbilityResult { @@ -24,7 +24,7 @@ export interface DataAbilityResult { * Indicates the path of data to operate. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri?: string; @@ -33,7 +33,7 @@ export interface DataAbilityResult { * Indicates the number of rows affected by the operation. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ count?:number; diff --git a/api/ability/startAbilityParameter.d.ts b/api/ability/startAbilityParameter.d.ts index 7ad38dddddcdaf822ab5cafcc3294a1589a982e5..29a635d29c12969611ff3e77d7724217684c49d4 100644 --- a/api/ability/startAbilityParameter.d.ts +++ b/api/ability/startAbilityParameter.d.ts @@ -16,7 +16,7 @@ import { Want } from './want'; /** * @since 3 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface StartAbilityParameter { @@ -25,7 +25,7 @@ export interface StartAbilityParameter { * * @default - * @since 3 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ want: Want; @@ -35,7 +35,7 @@ export interface StartAbilityParameter { * * @default - * @since 3 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ abilityStartSetting?: {[key: string]: any}; diff --git a/api/ability/want.d.ts b/api/ability/want.d.ts index f6c264684fd49365ed0c2b57de5d99c2e846b20a..40bfe433ae5c723c7d76bc7ca7aaf7289c9b0654 100644 --- a/api/ability/want.d.ts +++ b/api/ability/want.d.ts @@ -17,7 +17,7 @@ * Want is the basic communication component of the system. * @name Want * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export declare interface Want { @@ -25,7 +25,7 @@ export declare interface Want { * device id * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ deviceId?: string; @@ -33,7 +33,7 @@ export declare interface Want { * bundle name * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ bundleName?: string; @@ -41,14 +41,14 @@ export declare interface Want { * ability name * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; @@ -56,7 +56,7 @@ export declare interface Want { /** * The description of the type in this Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ type?: string; @@ -64,7 +64,7 @@ export declare interface Want { /** * The options of the flags in this Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; @@ -72,7 +72,7 @@ export declare interface Want { /** * The description of an action in an want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ action?: string; @@ -80,7 +80,7 @@ export declare interface Want { /** * The description of the WantParams object in an Want * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; @@ -88,7 +88,7 @@ export declare interface Want { /** * The description of a entities in a Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; @@ -96,7 +96,7 @@ export declare interface Want { /** * The description of a extension ability name in a Want. * @since 9 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityName?: string; @@ -104,7 +104,7 @@ export declare interface Want { /** * The description of a extension ability type in a Want. * @since 9 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityType?: number; diff --git a/api/app/abilityMissionInfo.d.ts b/api/app/abilityMissionInfo.d.ts index 19c7870cd494ba9675f0ea585dcec0b7fe1ae93d..082993e8962af9fdecb94d985e49b77b8e852e02 100644 --- a/api/app/abilityMissionInfo.d.ts +++ b/api/app/abilityMissionInfo.d.ts @@ -18,7 +18,7 @@ import { ElementName } from '../bundle/elementName'; /** * @name Mission information corresponding to ability * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import AbilityMissionInfo from 'app/abilityMissionInfo' * @permission N/A */ @@ -26,7 +26,7 @@ export interface AbilityMissionInfo { /** * @default Unique identification of task stack information corresponding to ability * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ missionId: number; @@ -34,7 +34,7 @@ export interface AbilityMissionInfo { * @default The component launched as the first ability in the task stack * This can be considered the "application" of this task stack * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ bottomAbility: ElementName; @@ -42,14 +42,14 @@ export interface AbilityMissionInfo { * @default The ability component at the top of the history stack of the task * This is what the user is currently doing * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ topAbility: ElementName; /** * @default The corresponding ability description information in the task stack * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ windowMode: number; } diff --git a/api/app/activeProcessInfo.d.ts b/api/app/activeProcessInfo.d.ts index 68571a2d497043434fef4f91c793ef7b937b3ec9..72ac4eb1bb42a9e6398b23f7638fe520d4f314e4 100644 --- a/api/app/activeProcessInfo.d.ts +++ b/api/app/activeProcessInfo.d.ts @@ -16,7 +16,7 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import app from 'app/activeProcessInfo' * @permission N/A */ @@ -24,28 +24,28 @@ export interface ActiveProcessInfo { /** * @default process id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default an array of the bundleNames running in the process * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ bundleNames: Array; } diff --git a/api/app/appVersionInfo.d.ts b/api/app/appVersionInfo.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..9aa63fc268138c05f0759e914f0964cc399061ba --- /dev/null +++ b/api/app/appVersionInfo.d.ts @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2022 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. + */ + +/** + * Defines an AppVersionInfo object. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ +export interface AppVersionInfo { + + /** + * Application name. + * @default appName + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + readonly appName: string; + + /** + * Application version number. + * @default versionCode + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + readonly versionCode: number; + + /** + * Application version name. + * @default versionName + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + readonly versionName: string; +} diff --git a/api/app/context.d.ts b/api/app/context.d.ts index 6bdb28af617e7c24e8254c20f63846d43420ee53..048c033f5d69808828fdc83738ef7efd44deaeba 100644 --- a/api/app/context.d.ts +++ b/api/app/context.d.ts @@ -18,6 +18,10 @@ import { ApplicationInfo } from '../bundle/applicationInfo'; import { ProcessInfo } from './processInfo'; import { ElementName } from '../bundle/elementName'; import BaseContext from '../application/BaseContext'; +import { HapModuleInfo } from '../bundle/hapModuleInfo'; +import { AppVersionInfo } from './appVersionInfo'; +import { AbilityInfo } from '../bundle/abilityInfo'; + /** * The context of an ability or an application. It allows access to @@ -25,7 +29,7 @@ import BaseContext from '../application/BaseContext'; * Can only be obtained through the ability. * * @since 6 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from 'app/context' * @permission N/A * @FAModelOnly @@ -39,7 +43,7 @@ export interface Context extends BaseContext { * the ability; if in the context of the application, return the * root dir of the application. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return the root dir * @FAModelOnly */ @@ -54,7 +58,7 @@ export interface Context extends BaseContext { * @note Pid and uid are optional. If you do not pass in pid and uid, * it will check your own permission. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return asynchronous callback with {@code 0} if the PID * and UID have the permission; callback with {@code -1} otherwise. * @FAModelOnly @@ -68,7 +72,7 @@ export interface Context extends BaseContext { * @param permissions Indicates the list of permissions to be requested. This parameter cannot be null. * @param requestCode Indicates the request code to be passed to the PermissionRequestResult * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestPermissionsFromUser(permissions: Array, requestCode: number, resultCallback: AsyncCallback): void; @@ -76,7 +80,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current application. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getApplicationInfo(callback: AsyncCallback): void @@ -85,7 +89,7 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the current ability. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getBundleName(callback: AsyncCallback): void @@ -94,7 +98,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current process, including the process ID and name. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessInfo(callback: AsyncCallback): void @@ -103,7 +107,7 @@ export interface Context extends BaseContext { /** * Obtains the ohos.bundle.ElementName object of the current ability. This method is available only to Page abilities. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getElementName(callback: AsyncCallback): void @@ -112,7 +116,7 @@ export interface Context extends BaseContext { /** * Obtains the name of the current process. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessName(callback: AsyncCallback): void @@ -121,17 +125,108 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the ability that called the current ability. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getCallingBundle(callback: AsyncCallback): void getCallingBundle(): Promise; + + /** + * Obtains the file directory of this application on the internal storage. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getFilesDir(callback: AsyncCallback): void; + getFilesDir(): Promise; + + /** + * Obtains the cache directory of this application on the internal storage. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getCacheDir(callback: AsyncCallback): void; + getCacheDir(): Promise; + + /** + * Obtains the distributed file path for storing ability or application data files. + * If the distributed file path does not exist, the system will create a path and return the created path. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getOrCreateDistributedDir(): Promise; + getOrCreateDistributedDir(callback: AsyncCallback): void; + + /** + * Obtains the application type. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getAppType(callback: AsyncCallback): void + getAppType(): Promise; + + /** + * Obtains the ModuleInfo object for this application. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getHapModuleInfo(callback: AsyncCallback): void + getHapModuleInfo(): Promise; + + /** + * Obtains the application version information. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getAppVersionInfo(callback: AsyncCallback): void + getAppVersionInfo(): Promise; + + /** + * Obtains the context of this application. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getApplicationContext(): Context; + + /** + * Checks the detailed information of this ability. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + getAbilityInfo(callback: AsyncCallback): void + getAbilityInfo(): Promise; + + /** + * Checks whether the configuration of this ability is changing. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return true if the configuration of this ability is changing and false otherwise. + * @FAModelOnly + */ + isUpdatingConfigurations(): Promise; + isUpdatingConfigurations(callback: AsyncCallback): void; + + /** + * Informs the system of the time required for drawing this Page ability. + * @since 7 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @FAModelOnly + */ + printDrawnCompleted(): Promise; + printDrawnCompleted(callback: AsyncCallback): void; } /** * @name the result of requestPermissionsFromUser with asynchronous callback * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @FAModelOnly */ @@ -139,7 +234,7 @@ interface PermissionRequestResult { /** * @default The request code passed in by the user * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestCode: number; @@ -147,7 +242,7 @@ interface PermissionRequestResult { /** * @default The permissions passed in by the user * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ permissions: Array; @@ -155,7 +250,7 @@ interface PermissionRequestResult { /** * @default The results for the corresponding request permissions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ authResults: Array; @@ -164,7 +259,7 @@ interface PermissionRequestResult { /** * @name PermissionOptions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @FAModelOnly */ @@ -172,7 +267,7 @@ interface PermissionOptions { /** * @default The process id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ pid?: number; @@ -180,8 +275,8 @@ interface PermissionOptions { /** * @default The user id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ uid?: number; -} \ No newline at end of file +} diff --git a/api/app/processInfo.d.ts b/api/app/processInfo.d.ts index cd25a592d8978806e77b31e8fed30ef26c6464a1..5f3c2a825d89ac46e030cdb4cf2b524a879f97dd 100644 --- a/api/app/processInfo.d.ts +++ b/api/app/processInfo.d.ts @@ -16,7 +16,7 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import ProcessInfo from 'app/processInfo' * @permission N/A */ @@ -26,7 +26,7 @@ export interface ProcessInfo { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; @@ -35,7 +35,7 @@ export interface ProcessInfo { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ - processName: string; + processName: string; } \ No newline at end of file diff --git a/api/application/AbilityContext.d.ts b/api/application/AbilityContext.d.ts index 442c46a5d07d4cb904e775c2375a2ff8223c8c7b..8f81e74730f0ce069aa15df4e907925d3b76b587 100755 --- a/api/application/AbilityContext.d.ts +++ b/api/application/AbilityContext.d.ts @@ -24,12 +24,13 @@ import StartOptions from "../@ohos.application.StartOptions"; import PermissionRequestResult from "./PermissionRequestResult"; import { Configuration } from '../@ohos.application.Configuration'; import Caller from '../@ohos.application.Ability'; +import { ContentStorage } from '../@internal/component/ets/state_management'; /** * The context of an ability. It allows access to ability-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -38,7 +39,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ abilityInfo: AbilityInfo; @@ -47,7 +48,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an module. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ currentHapModuleInfo: HapModuleInfo; @@ -56,7 +57,7 @@ export default class AbilityContext extends Context { * Indicates configuration information. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ config: Configuration; @@ -65,7 +66,7 @@ export default class AbilityContext extends Context { * Starts a new ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return - * @StageModelOnly @@ -77,20 +78,19 @@ export default class AbilityContext extends Context { /** * Get the caller object of the startup capability * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk - * @param parameter Indicates the ability to start. - * @return Caller + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param want Indicates the ability to start. + * @return Returns to the Caller interface on success Returns empty or undefined on failure * @StageModelOnly */ - startAbilityByCall(want: Want): Promise; + startAbilityByCall(want: Want): Promise; /** * Starts a new ability with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want info to start. * @param want Indicates the account to start. * @systemapi hide for inner use. @@ -105,7 +105,7 @@ export default class AbilityContext extends Context { * Starts an ability and returns the execution result when the ability is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @StageModelOnly @@ -118,7 +118,7 @@ export default class AbilityContext extends Context { * Starts an ability and returns the execution result when the ability is destroyed with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want info to start. * @param want Indicates the account to start. * @systemapi hide for inner use. @@ -133,7 +133,7 @@ export default class AbilityContext extends Context { * Destroys this Page ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -145,7 +145,7 @@ export default class AbilityContext extends Context { * and destroys this Page ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the result to return. * @return - * @StageModelOnly @@ -157,10 +157,10 @@ export default class AbilityContext extends Context { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want The element name of the service ability * @param options The remote object instance - * @hide hide for inner use. + * @systemapi Hide this for inner system use. * @return Returns the number code of the ability connected * @StageModelOnly */ @@ -170,7 +170,7 @@ export default class AbilityContext extends Context { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want The element name of the service ability * @param options The remote object instance * @param accountId The account to connect @@ -184,9 +184,9 @@ export default class AbilityContext extends Context { * The callback interface was connect successfully. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param connection The number code of the ability connected - * @hide hide for inner use. + * @systemapi Hide this for inner system use. * @StageModelOnly */ disconnectAbility(connection: number, callback:AsyncCallback): void; @@ -196,7 +196,7 @@ export default class AbilityContext extends Context { * Set mission label of current ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param label The label of ability that showed in recent missions. * @StageModelOnly */ @@ -207,10 +207,21 @@ export default class AbilityContext extends Context { * Requests certain permissions from the system. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param permissions Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @StageModelOnly */ requestPermissionsFromUser(permissions: Array, requestCallback: AsyncCallback) : void; requestPermissionsFromUser(permissions: Array) : Promise; + + /** + * Restore window stage data in ability continuation + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param contentStorage the storage data used to restore window stage + * @StageModelOnly + */ + restoreWindowStage(contentStorage: ContentStorage) : void; + } \ No newline at end of file diff --git a/api/application/AbilityRunningInfo.d.ts b/api/application/AbilityRunningInfo.d.ts index 41bff388cefc203e2f6f1391602360b3e33a6182..243f1b482710745dddf13f173adf87447296bb81 100644 --- a/api/application/AbilityRunningInfo.d.ts +++ b/api/application/AbilityRunningInfo.d.ts @@ -20,49 +20,49 @@ import abilityManager from '../@ohos.application.abilityManager'; * The class of an ability running information. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface AbilityRunningInfo { /** * @default ability element name * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ ability: ElementName; /** * @default process id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; - + /** * @default the name of the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default Enumerates state of the ability state info * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ abilityState: abilityManager.AbilityState; } \ No newline at end of file diff --git a/api/application/AbilityStateData.d.ts b/api/application/AbilityStateData.d.ts index 653d556b05b5a56640fdb7d0f89520f4b8b4f27e..0f32059761ff63dca219ea171c1bd8169d32ca2b 100644 --- a/api/application/AbilityStateData.d.ts +++ b/api/application/AbilityStateData.d.ts @@ -17,7 +17,7 @@ * The ability or extension state data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class AbilityStateData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class AbilityStateData { * The ability name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ abilityName: string; @@ -44,7 +44,7 @@ export default class AbilityStateData { * The pid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ pid: number; @@ -53,7 +53,7 @@ export default class AbilityStateData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -62,7 +62,7 @@ export default class AbilityStateData { * The application state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ state: number; @@ -70,9 +70,8 @@ export default class AbilityStateData { /** * The ability type, page or service and so on. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ abilityType: number; diff --git a/api/application/AppStateData.d.ts b/api/application/AppStateData.d.ts index 62ae586ba60a945b27300bd822d9f467fe53f347..753f38cc356f785c82aa85535803e6c1a233c943 100644 --- a/api/application/AppStateData.d.ts +++ b/api/application/AppStateData.d.ts @@ -17,7 +17,7 @@ * The application state data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class AppStateData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class AppStateData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -44,7 +44,7 @@ export default class AppStateData { * The application state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ state: number; diff --git a/api/application/ApplicationStateObserver.d.ts b/api/application/ApplicationStateObserver.d.ts index 5ce1e00ba543d1334e6ce9aaf06955af556c2435..96341bd8a353877a4c6ea313e527c8ab4b4ec8b6 100644 --- a/api/application/ApplicationStateObserver.d.ts +++ b/api/application/ApplicationStateObserver.d.ts @@ -21,7 +21,7 @@ import ProcessData from "./ProcessData"; * The application state observer. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -30,7 +30,7 @@ export default class ApplicationStateObserver { * Will be called when foreground or background application changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param appStateData State changed Application info. * @systemapi hide for inner use. * @return - @@ -41,7 +41,7 @@ export default class ApplicationStateObserver { * Will be called when ability state changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param abilityStateData State changed ability info. * @systemapi hide for inner use. * @return - @@ -52,7 +52,7 @@ export default class ApplicationStateObserver { * Will be called when process created. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. * @return - @@ -63,7 +63,7 @@ export default class ApplicationStateObserver { * Will be called when process died. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. * @return - diff --git a/api/application/BaseContext.d.ts b/api/application/BaseContext.d.ts index 7b63cc832dff0ff702a8ccdda8003be62412b6a4..50ab781d4c89f84d667680aae1b0ba251b025c70 100644 --- a/api/application/BaseContext.d.ts +++ b/api/application/BaseContext.d.ts @@ -18,7 +18,7 @@ * 'application.Context' for Stage Mode. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export default interface BaseContext { @@ -26,7 +26,7 @@ export default interface BaseContext { * Indicates the context is FA Mode or Stage Mode. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ stageMode: boolean; } \ No newline at end of file diff --git a/api/application/Context.d.ts b/api/application/Context.d.ts index e8678b43276c66040a4184285842bc073b0f1024..80a556f1d3cc1d30e2f25b9a22f2295061fd9e32 100755 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -23,7 +23,7 @@ import EventHub from "./EventHub"; * application-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -32,7 +32,7 @@ export default class Context extends BaseContext { * Indicates the capability of accessing application resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ resourceManager: resmgr.ResourceManager; @@ -41,7 +41,7 @@ export default class Context extends BaseContext { * Indicates configuration information about an application. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ applicationInfo: ApplicationInfo; @@ -50,7 +50,7 @@ export default class Context extends BaseContext { * Indicates app cache dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ cacheDir: string; @@ -59,7 +59,7 @@ export default class Context extends BaseContext { * Indicates app temp dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ tempDir: string; @@ -68,7 +68,7 @@ export default class Context extends BaseContext { * Indicates app files dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ filesDir : string; @@ -77,7 +77,7 @@ export default class Context extends BaseContext { * Indicates app database dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ databaseDir : string; @@ -86,7 +86,7 @@ export default class Context extends BaseContext { * Indicates app storage dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ storageDir : string; @@ -95,7 +95,7 @@ export default class Context extends BaseContext { * Indicates app bundle code dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ bundleCodeDir : string; @@ -104,7 +104,7 @@ export default class Context extends BaseContext { * Indicates app distributed files dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ distributedFilesDir: string; @@ -113,7 +113,7 @@ export default class Context extends BaseContext { * Indicates event hub. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ eventHub: EventHub; @@ -122,7 +122,7 @@ export default class Context extends BaseContext { * Create a bundle context * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @param bundleName Indicates the bundle name. * @return application context @@ -134,7 +134,7 @@ export default class Context extends BaseContext { * Get application context * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return application context * @StageModelOnly */ @@ -144,16 +144,21 @@ export default class Context extends BaseContext { * Switch file area * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param mode file area. * @StageModelOnly */ switchArea(mode: AreaMode): void; } +/** + * File area mode + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @StageModelOnly + */ export enum AreaMode { EL1 = 0, - EL2 = 1, - EL3 = 2, - EL4 = 3 + EL2 = 1 } \ No newline at end of file diff --git a/api/application/EventHub.d.ts b/api/application/EventHub.d.ts index 8c198ce678f19d2b61f049ec3950dfdba52d1a39..cbc9cbdc8b52946d1a78035c0be3fbac91e74a67 100644 --- a/api/application/EventHub.d.ts +++ b/api/application/EventHub.d.ts @@ -17,8 +17,7 @@ * The event center of a context, support the subscription and publication of events. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -26,9 +25,8 @@ export default class EventHub { /** * Subscribe to an event. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -39,9 +37,8 @@ export default class EventHub { /** * Unsubscribe from an event. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -52,9 +49,8 @@ export default class EventHub { /** * Trigger the event callbacks. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param args Indicates the callback arguments. * @return - diff --git a/api/application/ExtensionRunningInfo.d.ts b/api/application/ExtensionRunningInfo.d.ts index 17cd0bd6e7c765a731eec4dbc5a435b8da8feda5..21b196d36414bc24a32b44e162334a6b2ada95a8 100644 --- a/api/application/ExtensionRunningInfo.d.ts +++ b/api/application/ExtensionRunningInfo.d.ts @@ -20,56 +20,56 @@ import bundle from '../@ohos.bundle'; * The class of an extension running information. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ExtensionRunningInfo { /** * @default Indicates the extension of the extension info * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ extension: ElementName; /** * @default process id * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default All package names under the current process * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ clientPackage: Array; /** * @default Enumerates types of the entension info * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ type: bundle.ExtensionAbilityType; } \ No newline at end of file diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index dd2d16bc81cb98b14817a9b96a0e5e6472a91fb3..c3bd85bdb2f8203f402104992f7d2fc28a8c967e 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -22,7 +22,7 @@ import formBindingData from '../@ohos.application.formBindingData'; * formExtension-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -34,7 +34,7 @@ export default class FormExtensionContext extends ExtensionContext { *

You can use this method to update the given form

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission ohos.permission.REQUIRE_FORM. * @param formId Indicates the given form. * @param formBindingData Indicates the form data. diff --git a/api/application/MissionInfo.d.ts b/api/application/MissionInfo.d.ts index 0b2a3e92a177b5dbcb194a7ba7a40b82515fbd91..5233bce35ebd239f203655f55dfa93045eece809 100644 --- a/api/application/MissionInfo.d.ts +++ b/api/application/MissionInfo.d.ts @@ -19,8 +19,7 @@ import Want from "../@ohos.application.Want"; * Mission information corresponding to ability. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -29,7 +28,7 @@ export interface MissionInfo { * Indicates mission id. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ missionId: number; @@ -37,7 +36,7 @@ export interface MissionInfo { * Indicates running state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ runningState: number; @@ -45,7 +44,7 @@ export interface MissionInfo { * Indicates locked state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ lockedState: boolean; @@ -53,7 +52,7 @@ export interface MissionInfo { * Indicates the recent create or update time of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ timestamp: string; @@ -61,7 +60,7 @@ export interface MissionInfo { * Indicates want of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ want: Want; @@ -69,7 +68,7 @@ export interface MissionInfo { * Indicates label of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ label: string; @@ -77,7 +76,7 @@ export interface MissionInfo { * Indicates icon path of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ iconPath: string; @@ -85,7 +84,7 @@ export interface MissionInfo { * Indicates whether the mision is continuable. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ continuable: boolean; } \ No newline at end of file diff --git a/api/application/MissionListener.d.ts b/api/application/MissionListener.d.ts index d9f36505f5de78a1843504bac720d42a7af37510..12bd9e64bd142a1f8a3a8aad306bcd67f31501b5 100644 --- a/api/application/MissionListener.d.ts +++ b/api/application/MissionListener.d.ts @@ -18,7 +18,7 @@ * * @name MissionListener * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -27,7 +27,7 @@ * Called by system when mission created. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionCreated(mission: number): void; @@ -36,7 +36,7 @@ * Called by system when mission destroyed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionDestroyed(mission: number): void; @@ -45,7 +45,7 @@ * Called by system when mission shapshot changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionSnapshotChanged(mission: number): void; @@ -54,7 +54,7 @@ * Called by system when mission moved to fornt. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionMovedToFront(mission: number): void; diff --git a/api/application/MissionSnapshot.d.ts b/api/application/MissionSnapshot.d.ts index d7b85a300f5a037e4090eb8f48fac12f5bcedc9e..3fa0dd05878ad1bb7db96bcb761bfd91b50b15f7 100644 --- a/api/application/MissionSnapshot.d.ts +++ b/api/application/MissionSnapshot.d.ts @@ -20,7 +20,7 @@ import { image } from '../@ohos.multimedia.image'; * Mission snapshot corresponding to mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -29,7 +29,7 @@ export interface MissionSnapshot { * Indicates the ability elementName of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ ability: ElementName; @@ -37,7 +37,7 @@ export interface MissionSnapshot { * Indicates mission snapshot. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ snapshot: image.PixelMap; } \ No newline at end of file diff --git a/api/application/PermissionRequestResult.d.ts b/api/application/PermissionRequestResult.d.ts index 6c44ea461f8be4c4a7c03b20ed9c48c9540ec04f..bd84e1f626d862d0e58a83b5c4c94e70d63b0d04 100755 --- a/api/application/PermissionRequestResult.d.ts +++ b/api/application/PermissionRequestResult.d.ts @@ -17,7 +17,7 @@ * The result of requestPermissionsFromUser with asynchronous callback. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @StageModelOnly */ @@ -26,7 +26,7 @@ export default class PermissionRequestResult { * The permissions passed in by the user. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ permissions: Array; @@ -36,7 +36,7 @@ export default class PermissionRequestResult { * permission is granted, and the value -1 indicates not. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ authResults: Array; diff --git a/api/application/ProcessData.d.ts b/api/application/ProcessData.d.ts index 3bd242710666869cbdc89bb76375a0352a15e96b..8be5e311efff552f8eb946333d61bd2c7c7f7f33 100644 --- a/api/application/ProcessData.d.ts +++ b/api/application/ProcessData.d.ts @@ -17,7 +17,7 @@ * The process data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class ProcessData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class ProcessData { * The pid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ pid: number; @@ -44,7 +44,7 @@ export default class ProcessData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ uid: number; diff --git a/api/application/ProcessRunningInfo.d.ts b/api/application/ProcessRunningInfo.d.ts index 9349cb9135ecdf064806690211e3ac8592d9f3e9..ba19a3b55b473a5a6c2319ae60d3892194630abc 100644 --- a/api/application/ProcessRunningInfo.d.ts +++ b/api/application/ProcessRunningInfo.d.ts @@ -17,35 +17,35 @@ * The class of an process running information. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A */ export interface ProcessRunningInfo { /** * @default process id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ pid: number; /** * @default user id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ uid: number; - + /** * @default the name of the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ processName: string; - + /** * @default an array of the bundleNames running in the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ bundleNames: Array; } \ No newline at end of file diff --git a/api/application/ServiceExtAbilityContext.d.ts b/api/application/ServiceExtAbilityContext.d.ts deleted file mode 100644 index 6ffe342387e66323cc19ba25e4cab726dc761553..0000000000000000000000000000000000000000 --- a/api/application/ServiceExtAbilityContext.d.ts +++ /dev/null @@ -1,127 +0,0 @@ -/* - * 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 - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { AsyncCallback } from "../basic"; -import { ConnectOptions } from "../ability/connectOptions"; -import ExtAbilityContext from "./ExtAbilityContext"; -import Want from "../@ohos.application.Want"; -import StartOptions from "../@ohos.application.StartOptions"; - -/** - * The context of service extension. It allows access to - * serviceExtension-specific resources. - * - * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car - * @systemapi hide for inner use. - * @permission N/A - * @StageModelOnly - */ -export default class ServiceExtAbilityContext extends ExtAbilityContext { - /** - * Service extension uses this method to start a specific ability. - * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @param parameter Indicates the ability to start. - * @systemapi hide for inner use. - * @return - - * @StageModelOnly - */ - startAbility(want: Want, callback: AsyncCallback): void; - startAbility(want: Want, options: StartOptions, callback: AsyncCallback): void; - startAbility(want: Want, options?: StartOptions): Promise; - - /** - * Service extension uses this method to start a specific ability with account. - * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @param parameter Indicates the ability to start. - * @param parameter Indicates the accountId to start. - * @systemapi hide for inner use. - * @return - - * @StageModelOnly - */ - startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; - startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; - startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; - - /** - * Destroys this service extension. - * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @systemapi hide for inner use. - * @return - - * @StageModelOnly - */ - terminateSelf(callback: AsyncCallback): void; - terminateSelf(): Promise; - - /** - * Connects an ability to a Service extension. - * - *

This method can be called by an ability or service extension, but the destination of the connection must be a - * service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target - * service extension when the Service extension is connected.

- * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @param request Indicates the service extension to connect. - * @systemapi hide for inner use. - * @return connection id, int value. - * @StageModelOnly - */ - connectAbility(want: Want, options: ConnectOptions): number; - - /** - * Connects an ability to a Service extension with account. - * - *

This method can be called by an ability or service extension, but the destination of the connection must be a - * service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target - * service extension when the Service extension is connected.

- * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @param request Indicates the service extension to connect. - * @param request Indicates the account to connect. - * @systemapi hide for inner use. - * @return connection id, int value. - * @StageModelOnly - */ - connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; - - /** - * Disconnects an ability to a service extension, in contrast to - * {@link connectAbility}. - * - * @devices phone, tablet, tv, wearable, car - * @since 9 - * @sysCap AAFwk - * @param connection the connection id returned from connectAbility api. - * @systemapi hide for inner use. - * @return - - * @StageModelOnly - */ - disconnectAbility(connection: number, callback:AsyncCallback): void; - disconnectAbility(connection: number): Promise; -} \ No newline at end of file diff --git a/api/application/ServiceExtensionContext.d.ts b/api/application/ServiceExtensionContext.d.ts index ce5e61f0654409a57810d33d2bb64108bf4c0509..d07171a1fde4c9d0e7970cd4aed4e5ed67b555db 100644 --- a/api/application/ServiceExtensionContext.d.ts +++ b/api/application/ServiceExtensionContext.d.ts @@ -25,7 +25,7 @@ import { ExtensionAbilityInfo } from "../bundle/extensionAbilityInfo"; * serviceExtension-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A * @StageModelOnly @@ -35,7 +35,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension information. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ extensionAbilityInfo: ExtensionAbilityInfo; @@ -43,7 +43,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension uses this method to start a specific ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @systemapi hide for inner use. * @return - @@ -57,7 +57,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension uses this method to start a specific ability with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @param parameter Indicates the accountId to start. * @systemapi hide for inner use. @@ -72,7 +72,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Destroys this service extension. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -88,7 +88,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * service extension when the Service extension is connected.

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param request Indicates the service extension to connect. * @systemapi hide for inner use. * @return connection id, int value. @@ -104,7 +104,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * service extension when the Service extension is connected.

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param request Indicates the service extension to connect. * @param request Indicates the account to connect. * @systemapi hide for inner use. @@ -118,7 +118,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * {@link connectAbility}. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param connection the connection id returned from connectAbility api. * @systemapi hide for inner use. * @return - diff --git a/api/application/abilityDelegator.d.ts b/api/application/abilityDelegator.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..f937ee0ea25ef8a0e9133bb03cfb80b1cc8760c4 --- /dev/null +++ b/api/application/abilityDelegator.d.ts @@ -0,0 +1,153 @@ +/* + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { AsyncCallback } from '../basic'; +import { Ability } from '../@ohos.application.Ability' +import { AbilityMonitor } from './abilityMonitor' +import { Context } from '../app/context' +import { ShellCmdResult } from './shellCmdResult' + +/** + * A global test utility interface used for adding AbilityMonitor objects and control lifecycle states of abilities. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import AbilityDelegator from 'application/abilityDelegator.d' + * @permission N/A + */ +export interface AbilityDelegator { + /** + * Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param monitor AbilityMonitor object + */ + addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void; + addAbilityMonitor(monitor: AbilityMonitor): Promise; + + /** + * Remove a specified AbilityMonitor object from the application memory. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param monitor AbilityMonitor object + */ + removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void; + removeAbilityMonitor(monitor: AbilityMonitor): Promise; + + /** + * Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param monitor AbilityMonitor object + * @param timeout Maximum wait time, in milliseconds + * @return success: return the Ability object, failure: return null + */ + waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void; + waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback): void; + waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise; + + /** + * Obtain the application context. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return App Context + */ + getAppContext(): Context; + + /** + * Obtain the lifecycle state of a specified ability. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param ability The Ability object + * @return The state of the Ability object. enum AbilityLifecycleState + */ + getAbilityState(ability: Ability): number; + + /** + * Obtain the ability that is currently being displayed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @return The top ability of the current application + */ + getCurrentTopAbility(callback: AsyncCallback): void; + getCurrentTopAbility(): Promise + + /** + * Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param ability The ability object + * @return true: success false: failure + */ + doAbilityForeground(ability: Ability, callback: AsyncCallback): void; + doAbilityForeground(ability: Ability): Promise; + + /** + * Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param ability The ability object + * @return true: success false: failure + */ + doAbilityBackground(ability: Ability, callback: AsyncCallback): void; + doAbilityBackground(ability: Ability): Promise; + + /** + * Prints log information to the unit testing console. + * The total length of the log information to be printed cannot exceed 1000 characters. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param msg Log information + */ + print(msg: string, callback: AsyncCallback): void; + print(msg: string): Promise; + + /** + * Execute the given command in the aa tools side. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param cmd Shell command + * @param timeoutSecs Timeout, in seconds + * @return ShellCmdResult object + */ + executeShellCommand(cmd: string, callback: AsyncCallback): void; + executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback): void; + executeShellCommand(cmd: string, timeoutSecs?: number): Promise; + + /** + * Prints log information to the unit testing console. + * The total length of the log information to be printed cannot exceed 1000 characters. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi Hide this for inner system use. + * @param msg Log information + * @param code Result code + */ + finishTest(msg: string, code: number, callback: AsyncCallback): void; + finishTest(msg: string, code: number): Promise; +} + +export default AbilityDelegator; \ No newline at end of file diff --git a/api/application/abilityDelegatorArgs.d.ts b/api/application/abilityDelegatorArgs.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..321a68e0d256c10e48f33031dafaff2138b24167 --- /dev/null +++ b/api/application/abilityDelegatorArgs.d.ts @@ -0,0 +1,59 @@ +/* + * 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 + * + * 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. + */ + + +/** + * Store unit testing-related parameters, including test case names, and test runner name. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import AbilityDelegatorArgs from 'application/abilityDelegatorArgs.d' + * @permission N/A + */ +export interface AbilityDelegatorArgs { + /** + * the bundle name of the application being tested. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + bundleName: string; + + /** + * the parameters used for unit testing. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + parameters: {[key: string]: string}; + + /** + * the class names of all test cases. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + testCaseNames: string; + + /** + * the class name of the test runner used to execute test cases. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + testRunnerClassName: string; +} + +export default AbilityDelegatorArgs; \ No newline at end of file diff --git a/api/application/abilityMonitor.d.ts b/api/application/abilityMonitor.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..81806c4369611e8fb3aaefa64ab368a0c452dc68 --- /dev/null +++ b/api/application/abilityMonitor.d.ts @@ -0,0 +1,91 @@ +/* + * 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 + * + * 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. + */ + +/** + * Provide methods for matching monitored Ability objects that meet specified conditions. + * The most recently matched Ability objects will be saved in the AbilityMonitor object. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import AbilityMonitor from 'application/abilityMonitor.d' + * @permission N/A + */ +export interface AbilityMonitor { + /** + * The name of the ability to monitor. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + abilityName: string; + + /** + * Called back when the ability is started for initialization. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onAbilityCreate?:() => void; + + /** + * Called back when the state of the ability changes to foreground. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onAbilityForeground?:() => void; + + /** + * Called back when the state of the ability changes to background. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onAbilityBackground?:() => void; + + /** + * Called back before the ability is destroyed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onAbilityDestroy?:() => void; + + /** + * Called back when an ability window stage is created. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onWindowStageCreate?:() => void; + + /** + * Called back when an ability window stage is restored. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onWindowStageRestore?:() => void; + + /** + * Called back when an ability window stage is destroyed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + onWindowStageDestroy?:() => void; +} + +export default AbilityMonitor; \ No newline at end of file diff --git a/api/application/ExtAbilityContext.d.ts b/api/application/shellCmdResult.d.ts similarity index 56% rename from api/application/ExtAbilityContext.d.ts rename to api/application/shellCmdResult.d.ts index c8cccfb6b2d788463029406016e348d5eca01d97..b8cc3f894a8eb9629dbcd60d3d53d6a1d60ed076 100644 --- a/api/application/ExtAbilityContext.d.ts +++ b/api/application/shellCmdResult.d.ts @@ -1,6 +1,6 @@ /* * Copyright (c) 2021 Huawei Device Co., Ltd. - * Licensed under the Apache License, Version 2.0 (the "License"), + * 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 * @@ -13,26 +13,30 @@ * limitations under the License. */ -import { HapModuleInfo } from "../bundle/hapModuleInfo"; -import Context from "./Context"; - /** - * The context of an extension. It allows access to extension-specific resources. + * A object that records the result of shell command executes. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @import import ShellCmdResult from 'application/shellCmdResult.d' * @permission N/A - * @StageModelOnly */ -export default class ExtAbilityContext extends Context { +export interface ShellCmdResult { + /** + * the cmd standard result. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + stdResult: String; /** - * Indicates configuration information about an module. + * shell cmd exec result. * * @since 9 - * @sysCap AAFwk - * @StageModelOnly + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ - currentHapModuleInfo: HapModuleInfo; -} \ No newline at end of file + exitCode: number; +} + +export default ShellCmdResult; \ No newline at end of file diff --git a/api/bundle/abilityInfo.d.ts b/api/bundle/abilityInfo.d.ts index 87bd8399bc566e9c80a386ddadbc71fe3337ddd8..099ba7a1b75925ecb5664c3972350e15fb5c1246 100644 --- a/api/bundle/abilityInfo.d.ts +++ b/api/bundle/abilityInfo.d.ts @@ -225,7 +225,7 @@ export interface AbilityInfo { readonly metadata: Array; /** - * @default Indicates the metadata of ability + * @default Indicates whether the ability is enabled * @since 8 * @syscap SystemCapability.BundleManager.BundleFramework */ diff --git a/api/bundle/hapModuleInfo.d.ts b/api/bundle/hapModuleInfo.d.ts index 9c428d4376b4c4a901ef1a19be14d7597ad17232..477ca86021fed8caf1c892dee53f3f2de6160065 100644 --- a/api/bundle/hapModuleInfo.d.ts +++ b/api/bundle/hapModuleInfo.d.ts @@ -15,6 +15,7 @@ import { AbilityInfo } from "./abilityInfo"; import { ExtensionAbilityInfo } from "./extensionAbilityInfo"; +import { Metadata } from './metadata' /** * @name Obtains configuration information about an module. @@ -128,4 +129,11 @@ export interface HapModuleInfo { * @syscap SystemCapability.BundleManager.BundleFramework */ readonly extensionAbilityInfo: Array; + /** + * @default Indicates the metadata of ability + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + * + */ + readonly metadata: Array; } \ No newline at end of file diff --git a/api/common/@internal/console.d.ts b/api/common/@internal/console.d.ts index 69aa3336d55ea8a95641b051e8ec6aad51abb54d..f1eec6e6d8cc561a926c9883d15b91e5adc897d9 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 36a6d6d1822f8ef784c9d2efea65c5447b48d359..0f902fb46960a1d39f9ae8baa83cba0f166bbc64 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,14 +48,22 @@ 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 */ export declare function clearTimeout(timeoutID?: number): void; +/** + * Defining syscap function. + * @since 8 + */ +export declare function canIUse(syscap: string): boolean; + /** * Obtain the objects exposed in app.js + * @syscap SystemCapability.ArkUI.ArkUI.Full * @devices tv, phone, tablet, wearable, smartVision * @since 6 */ @@ -60,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 { @@ -92,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 { @@ -115,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 { /** @@ -156,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 @@ -170,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 149e18bb6e9a29450e68f5da0a8acd7b2731c4cf..062a8d2c2a21601f2bd126cb8680da94ef70f70a 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