From 8a54f04223da9a0963e03fd6312f44009fe9d323 Mon Sep 17 00:00:00 2001 From: guyuanzhang Date: Sat, 12 Feb 2022 10:57:26 +0800 Subject: [PATCH] IssueNo: #I4TEF8 Description: add aafwk syscap info Sig: SIG_ApplicationFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: guyuanzhang zhangguyuan@huawei.com Change-Id: I7ba1b2156a074d0e84015af531816232e79519cc --- api/@internal/ets/lifecycle.d.ts | 138 ++++++------------ api/@ohos.ability.dataUriUtils.d.ts | 15 +- api/@ohos.ability.featureAbility.d.ts | 34 ++--- api/@ohos.ability.particleAbility.d.ts | 12 +- api/@ohos.ability.wantConstant.d.ts | 9 +- api/@ohos.app.abilityManager.d.ts | 15 +- api/@ohos.application.Ability.d.ts | 30 ++-- api/@ohos.application.AbilityConstant.d.ts | 13 +- api/@ohos.application.AbilityStage.d.ts | 8 +- api/@ohos.application.Configuration.d.ts | 5 +- api/@ohos.application.FormExtension.d.ts | 23 +-- api/@ohos.application.ServiceExtension.d.ts | 23 +-- api/@ohos.application.StartOptions.d.ts | 6 +- api/@ohos.application.Want.d.ts | 30 ++-- api/@ohos.application.abilityManager.d.ts | 15 +- api/@ohos.application.appManager.d.ts | 21 +-- api/@ohos.application.formBindingData.d.ts | 6 +- api/@ohos.application.missionManager.d.ts | 33 ++--- api/ability/abilityResult.d.ts | 11 +- api/ability/connectOptions.d.ts | 14 +- api/ability/continueAbilityOptions.d.ts | 11 +- api/ability/dataAbilityHelper.d.ts | 41 ++---- api/ability/dataAbilityOperation.d.ts | 29 ++-- api/ability/dataAbilityResult.d.ts | 12 +- api/ability/startAbilityParameter.d.ts | 11 +- api/ability/want.d.ts | 36 ++--- api/app/abilityMissionInfo.d.ts | 11 +- api/app/activeProcessInfo.d.ts | 11 +- api/app/context.d.ts | 50 +++---- api/app/processInfo.d.ts | 9 +- api/application/AbilityContext.d.ts | 40 ++--- api/application/AbilityRunningInfo.d.ts | 15 +- api/application/AbilityStageContext.d.ts | 5 +- api/application/AbilityStateData.d.ts | 18 +-- api/application/AppStateData.d.ts | 12 +- api/application/ApplicationStateObserver.d.ts | 18 +-- api/application/BaseContext.d.ts | 5 +- api/application/Context.d.ts | 29 ++-- api/application/EventHub.d.ts | 8 +- api/application/ExtensionContext.d.ts | 5 +- api/application/ExtensionRunningInfo.d.ts | 17 +-- api/application/FormExtensionContext.d.ts | 6 +- api/application/MissionInfo.d.ts | 16 +- api/application/MissionListener.d.ts | 15 +- api/application/MissionSnapshot.d.ts | 7 +- api/application/PermissionRequestResult.d.ts | 7 +- api/application/ProcessData.d.ts | 12 +- api/application/ProcessRunningInfo.d.ts | 11 +- api/application/ServiceExtensionContext.d.ts | 21 +-- 49 files changed, 367 insertions(+), 582 deletions(-) diff --git a/api/@internal/ets/lifecycle.d.ts b/api/@internal/ets/lifecycle.d.ts index 6aa70affb5..d95232fa18 100644 --- a/api/@internal/ets/lifecycle.d.ts +++ b/api/@internal/ets/lifecycle.d.ts @@ -31,17 +31,15 @@ import { PacMap } from "../ability/dataAbilityHelper"; * * @name LifecycleForm * @since 7 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleForm { /** * Called to return a {@link formBindingData.FormBindingData} object. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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}, @@ -56,9 +54,8 @@ export declare interface LifecycleForm { /** * Called when the form provider is notified that a temporary form is successfully converted to a normal form. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form. * @return - * @FAModelOnly @@ -68,9 +65,8 @@ export declare interface LifecycleForm { /** * Called to notify the form provider to update a specified form. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form to update. * @return - * @FAModelOnly @@ -80,9 +76,8 @@ export declare interface LifecycleForm { /** * Called when the form provider receives form events from the system. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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} @@ -97,9 +92,8 @@ export declare interface LifecycleForm { * Called when a specified message event defined by the form provider is triggered. This method is valid only for * JS forms. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 @@ -113,9 +107,8 @@ export declare interface LifecycleForm { * Called to notify the form provider that a specified form has been deleted. Override this method if * you want your application, as the form provider, to be notified of form deletion. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the deleted form. * @return - * @FAModelOnly @@ -128,9 +121,8 @@ export declare interface LifecycleForm { *

You must override this callback if you want this ability to return the actual form state. Otherwise, * this method returns {@link FormState#DEFAULT} by default.

* - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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. @@ -144,17 +136,15 @@ export declare interface LifecycleForm { * * @name LifecycleApp * @since 7 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleApp { /** * Called back when the state of an ability changes from BACKGROUND to INACTIVE. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -163,9 +153,8 @@ export declare interface LifecycleApp { /** * Called back when an ability enters the BACKGROUND state. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -174,9 +163,8 @@ export declare interface LifecycleApp { /** * Called back before an ability is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -185,9 +173,8 @@ export declare interface LifecycleApp { /** * Called back when an ability is started for initialization. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -197,9 +184,8 @@ export declare interface LifecycleApp { * Called when the window display mode of this ability changes, for example, from fullscreen mode * to multi-window mode or from multi-window mode to fullscreen mode. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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. @@ -212,9 +198,8 @@ export declare interface LifecycleApp { /** * Asks a user whether to start the migration. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if the user allows the migration; returns {@code false} otherwise. * @FAModelOnly */ @@ -225,9 +210,8 @@ export declare interface LifecycleApp { * After the migration is triggered and the local ability is ready, this method is called when the Distributed * Scheduler Service requests data from the local ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 @@ -240,9 +224,8 @@ export declare interface LifecycleApp { *

You can define the processing logic after the migration is complete. For example, you can display a prompt to * notify the user of the successful migration and then exit the local ability.

* - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 - @@ -255,9 +238,8 @@ export declare interface LifecycleApp { * ability is created on the remote device. Lifecycle scheduling for the ability starts only after the user data * is restored. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param data Indicates the user data to restore. * @return - * @FAModelOnly @@ -268,9 +250,8 @@ export declare interface LifecycleApp { * Called to notify the local device when a running ability on the remote device is destroyed after a reversible * migration is performed for the ability from the local device to the remote device. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -281,9 +262,8 @@ export declare interface LifecycleApp { * situation, for example, when the screen orientation changes or the user touches the Home key. Generally, * this method is used only to save temporary states. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 - @@ -296,9 +276,8 @@ export declare interface LifecycleApp { * unexpectedly destroyed and the {@link #onSaveAbilityState(PacMap)} method was called to save its user data and * states. Generally, this method is called after the {@link #onStart(Want)} method. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 - @@ -310,9 +289,8 @@ export declare interface LifecycleApp { * Called back when an ability enters the INACTIVE state (an ability in this state is not interactive and may * change to the BACKGROUND or ACTIVE state). * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -321,9 +299,8 @@ export declare interface LifecycleApp { /** * Called back when an ability enters the ACTIVE state. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -332,9 +309,8 @@ export declare interface LifecycleApp { /** * Called when the launch mode of an ability is set to singleton. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the new {@code want} containing information about the ability. * @return - * @FAModelOnly @@ -345,9 +321,8 @@ export declare interface LifecycleApp { * Called when the system has determined to trim the memory, for example, when the ability is running in the * background and there is no enough memory for running as many background processes as possible. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param level Indicates the memory trim level, which shows the current memory usage status. * @return - * @FAModelOnly @@ -360,8 +335,7 @@ export declare interface LifecycleApp { * * @name LifecycleService * @since 7 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleService { @@ -369,9 +343,8 @@ export declare interface LifecycleService { * Called back when an ability is started for initialization (it can be called only once in the entire lifecycle of * an ability). * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -380,9 +353,8 @@ export declare interface LifecycleService { /** * Called back when Service is started. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 @@ -395,9 +367,8 @@ export declare interface LifecycleService { /** * Called back before an ability is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -406,9 +377,8 @@ export declare interface LifecycleService { /** * Called back when a Service ability is first connected to an ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates connection information about the Service ability. * @return Returns the proxy of the Service ability. * @FAModelOnly @@ -418,9 +388,8 @@ export declare interface LifecycleService { /** * Called back when all abilities connected to a Service ability are disconnected. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates disconnection information about the Service ability. * @return - * @FAModelOnly @@ -434,9 +403,8 @@ export declare interface LifecycleService { *

The Service ability must have been started but not been destroyed, that is, {@link #startAbility} has been * called but {@link #terminateSelf} has not.

* - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the want of the Service ability being connected. * @return - * @FAModelOnly @@ -449,17 +417,15 @@ export declare interface LifecycleService { * * @name LifecycleData * @since 7 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode * @FAModelOnly */ export declare interface LifecycleData { /** * Updates one or more data records in the database. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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 @@ -473,9 +439,8 @@ export declare interface LifecycleData { /** * Queries one or more data records in the database. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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. @@ -489,9 +454,8 @@ export declare interface LifecycleData { /** * Deletes one or more data records. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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. @@ -503,9 +467,8 @@ export declare interface LifecycleData { /** * Performs batch operations on the database. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param ops Indicates the data operation list, which can contain multiple operations on the database. * @return Returns the result of each operation, in array. * @FAModelOnly @@ -517,9 +480,8 @@ export declare interface LifecycleData { * used across devices, persisted, backed up, and restored. It can refer to the same item in the Data ability * even if the context has changed. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to normalize. * @return Returns the normalized uri if the Data ability supports URI normalization; * @FAModelOnly @@ -529,9 +491,8 @@ export declare interface LifecycleData { /** * Inserts multiple data records into the database. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBuckets Indicates the data to insert. * @return Returns the number of data records inserted. @@ -543,9 +504,8 @@ export declare interface LifecycleData { * Converts the given normalized {@code uri} generated by {@link #normalizeUri(uri)} into a denormalized one. * The default implementation of this method returns the original uri passed to it. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to denormalize. * @return Returns the denormalized {@code uri} object if the denormalization is successful; returns the original * {@code uri} passed to this method if there is nothing to do; returns {@code null} if the data identified by @@ -557,9 +517,8 @@ export declare interface LifecycleData { /** * Inserts a data record into the database. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBucket Indicates the data to insert. * @return Returns the index of the newly inserted data record. @@ -570,9 +529,8 @@ export declare interface LifecycleData { /** * Opens a file. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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, @@ -586,9 +544,8 @@ export declare interface LifecycleData { /** * Obtains the MIME type of files. This method should be implemented by a Data ability. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @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}. @@ -603,9 +560,8 @@ export declare interface LifecycleData { /** * Defines a method in this Data ability (implementation depending on child classes). * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param method Indicates the method name. * @param arg Indicates the parameter transferred by the method. * @param extras Indicates the parameter transferred by the method. @@ -617,9 +573,8 @@ export declare interface LifecycleData { /** * Called to carry {@code AbilityInfo} to this ability after the ability is initialized. * - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param info Indicates the {@code AbilityInfo} object containing information about this ability. * @return - * @FAModelOnly @@ -632,9 +587,8 @@ export declare interface LifecycleData { * *

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

* - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri of the data. * @return Returns the MIME type that matches the data specified by {@code uri}. * @FAModelOnly diff --git a/api/@ohos.ability.dataUriUtils.d.ts b/api/@ohos.ability.dataUriUtils.d.ts index 671b784787..3b978c07dd 100644 --- a/api/@ohos.ability.dataUriUtils.d.ts +++ b/api/@ohos.ability.dataUriUtils.d.ts @@ -17,17 +17,15 @@ * A utility class used for handling objects that use the DataAbilityHelper scheme. * @name dataUriUtils * @since 7 - * @sysCap AAFwk - * @devices phone, tablet + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ declare namespace dataUriUtils { /** * Obtains the ID attached to the end of the path component of the given uri. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @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; */ @@ -36,9 +34,8 @@ declare namespace dataUriUtils { /** * Attaches the given ID to the end of the path component of the given uri. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @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. @@ -48,9 +45,8 @@ declare namespace dataUriUtils { /** * Deletes the ID from the end of the path component of the given uri. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @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. */ @@ -59,9 +55,8 @@ declare namespace dataUriUtils { /** * Updates the ID in the specified uri * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @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.featureAbility.d.ts b/api/@ohos.ability.featureAbility.d.ts index 2b085c5781..20b110239b 100644 --- a/api/@ohos.ability.featureAbility.d.ts +++ b/api/@ohos.ability.featureAbility.d.ts @@ -25,8 +25,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 AAFwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -34,9 +33,8 @@ declare namespace featureAbility { /** * Obtain the want sended from the source ability. * - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -47,9 +45,8 @@ declare namespace featureAbility { /** * Starts a new ability. * - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -60,6 +57,7 @@ declare namespace featureAbility { /** * Obtains the application context. * + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns the application context. * @since 6 * @FAModelOnly @@ -69,9 +67,8 @@ declare namespace featureAbility { /** * Starts an ability and returns the execution result when the ability is destroyed. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @FAModelOnly @@ -83,9 +80,8 @@ declare namespace featureAbility { * Sets the result code and data to be returned by this Page ability to the caller * and destroys this Page ability. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the result to return. * @return - * @FAModelOnly @@ -96,9 +92,8 @@ declare namespace featureAbility { /** * Destroys this Page ability. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -108,9 +103,8 @@ declare namespace featureAbility { /** * Obtains the dataAbilityHelper. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly @@ -120,9 +114,8 @@ declare namespace featureAbility { /** * Checks whether the main window of this ability has window focus. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise. * @FAModelOnly */ @@ -132,9 +125,8 @@ declare namespace featureAbility { /** * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * @default - - * @devices phone, tablet * @since 7 - * @SysCap aafwk + * @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 @@ -145,9 +137,8 @@ declare namespace featureAbility { /** * The callback interface was connect successfully. * @default - - * @devices phone, tablet * @since 7 - * @SysCap aafwk + * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param connection The number code of the ability connected * @FAModelOnly */ @@ -157,9 +148,8 @@ declare namespace featureAbility { /** * Migrates this ability to the given device on the same distributed network. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ diff --git a/api/@ohos.ability.particleAbility.d.ts b/api/@ohos.ability.particleAbility.d.ts index cc64f223e1..cbe4d5bdd8 100644 --- a/api/@ohos.ability.particleAbility.d.ts +++ b/api/@ohos.ability.particleAbility.d.ts @@ -21,8 +21,7 @@ import { DataAbilityHelper } from './ability/dataAbilityHelper'; * A Particle Ability represents an ability with service. * @name particleAbility * @since 7 - * @sysCap AAFwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -30,9 +29,8 @@ declare namespace particleAbility { /** * Service ability uses this method to start a specific ability. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -43,9 +41,8 @@ declare namespace particleAbility { /** * Destroys this service ability. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -55,9 +52,8 @@ declare namespace particleAbility { /** * Obtains the dataAbilityHelper. * - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly diff --git a/api/@ohos.ability.wantConstant.d.ts b/api/@ohos.ability.wantConstant.d.ts index be53f506bb..977adac918 100644 --- a/api/@ohos.ability.wantConstant.d.ts +++ b/api/@ohos.ability.wantConstant.d.ts @@ -17,8 +17,7 @@ * the constant for action and entity in the want * @name wantConstant * @since 6 - * @sysCap aafwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ declare namespace wantConstant { @@ -26,8 +25,7 @@ declare namespace wantConstant { * the constant for action of the want * @name Action * @since 6 - * @sysCap aafwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Action { @@ -223,8 +221,7 @@ declare namespace wantConstant { * the constant for Entity of the want * @name Action * @since 6 - * @sysCap aafwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Entity { diff --git a/api/@ohos.app.abilityManager.d.ts b/api/@ohos.app.abilityManager.d.ts index 69380fc7d5..9b430de3ca 100644 --- a/api/@ohos.app.abilityManager.d.ts +++ b/api/@ohos.app.abilityManager.d.ts @@ -22,8 +22,7 @@ import { MissionSnapshot } from './app/missionSnapshot'; * This module provides the capability to manage abilities and obtaining system task information. * * @since 7 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from '@ohos.app.abilityManager' * @permission N/A */ @@ -39,8 +38,7 @@ declare namespace abilityManager { /** * Get information about running processes * @since 7 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @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 @@ -51,8 +49,7 @@ declare namespace abilityManager { /** * Get information about the running ability missions * @since 7 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @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 @@ -64,8 +61,7 @@ declare namespace abilityManager { /** * Get information about recently run missions * @since 7 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @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 @@ -77,8 +73,7 @@ declare namespace abilityManager { /** * Delete the specified missions * @since 7 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @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 diff --git a/api/@ohos.application.Ability.d.ts b/api/@ohos.application.Ability.d.ts index 130fd64dcd..822a6d7038 100644 --- a/api/@ohos.application.Ability.d.ts +++ b/api/@ohos.application.Ability.d.ts @@ -22,8 +22,7 @@ import window from './@ohos.window'; * The class of an ability. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -32,7 +31,7 @@ export default class Ability { * Indicates configuration information about an ability context. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ context: AbilityContext; @@ -41,7 +40,7 @@ export default class Ability { * Indicates ability launch want. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ launchWant: Want; @@ -50,7 +49,7 @@ export default class Ability { * Indicates ability last request want. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ lastRequestWant: Want; @@ -58,9 +57,8 @@ export default class Ability { /** * Called back when an ability is started for initialization. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -69,9 +67,8 @@ export default class Ability { /** * Called back when an ability window stage is created. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -80,9 +77,8 @@ export default class Ability { /** * Called back when an ability window stage is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -91,9 +87,8 @@ export default class Ability { /** * Called back before an ability is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -102,9 +97,8 @@ export default class Ability { /** * Called back when the state of an ability changes to foreground. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -113,9 +107,8 @@ export default class Ability { /** * Called back when the state of an ability changes to background. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -124,9 +117,8 @@ export default class Ability { /** * Called back when an ability prepares to migrate. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return true if ability agrees to migrate and saves data successfully, otherwise false. * @StageModelOnly */ diff --git a/api/@ohos.application.AbilityConstant.d.ts b/api/@ohos.application.AbilityConstant.d.ts index 0315b14c5d..d2691c2e98 100644 --- a/api/@ohos.application.AbilityConstant.d.ts +++ b/api/@ohos.application.AbilityConstant.d.ts @@ -17,8 +17,7 @@ * The definition of AbilityConstant. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -27,7 +26,7 @@ declare namespace AbilityConstant { * Interface of launch param. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export interface LaunchParam { @@ -35,7 +34,7 @@ declare namespace AbilityConstant { * Indicates launch reason. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ launchReason: LaunchReason; @@ -44,7 +43,7 @@ declare namespace AbilityConstant { * Indicates last exit reason. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ lastExitReason: LastExitReason; @@ -54,7 +53,7 @@ declare namespace AbilityConstant { * Type of launch reason. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export enum LaunchReason { @@ -68,7 +67,7 @@ declare namespace AbilityConstant { * Type of last exit reason. * * @since 9 - * @sysCap AAFwk + * @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 6d4c0d63ac..60fbfac572 100644 --- a/api/@ohos.application.AbilityStage.d.ts +++ b/api/@ohos.application.AbilityStage.d.ts @@ -19,8 +19,7 @@ import AbilityStageContext from "./application/AbilityStageContext"; * The class of an ability stage. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -29,7 +28,7 @@ export default class AbilityStage { * Indicates configuration information about context. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ context: AbilityStageContext; @@ -37,9 +36,8 @@ export default class AbilityStage { /** * Called back when an ability stage is started for initialization. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ diff --git a/api/@ohos.application.Configuration.d.ts b/api/@ohos.application.Configuration.d.ts index ff9681efa8..777ba6a5d0 100644 --- a/api/@ohos.application.Configuration.d.ts +++ b/api/@ohos.application.Configuration.d.ts @@ -18,8 +18,7 @@ * * @name Configuration * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ export interface Configuration { @@ -27,7 +26,7 @@ export interface Configuration { * Indicates the current language of the application. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ language: string; } diff --git a/api/@ohos.application.FormExtension.d.ts b/api/@ohos.application.FormExtension.d.ts index 4a9912fe8a..a994f1aa60 100644 --- a/api/@ohos.application.FormExtension.d.ts +++ b/api/@ohos.application.FormExtension.d.ts @@ -21,8 +21,7 @@ import Want from './@ohos.application.Want'; * class of form extension. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export default class FormExtension { @@ -30,7 +29,7 @@ export default class FormExtension { * Indicates form extension context. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ context: FormExtensionContext; @@ -38,9 +37,8 @@ export default class FormExtension { /** * Called to return a {@link formBindingData#FormBindingData} object. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @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. * Such form information must be managed as persistent data for further form @@ -53,9 +51,8 @@ export default class FormExtension { /** * Called when the form provider is notified that a temporary form is successfully converted to a normal form. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param formId Indicates the ID of the form. * @return - * @StageModelOnly @@ -65,9 +62,8 @@ export default class FormExtension { /** * Called to notify the form provider to update a specified form. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param formId Indicates the ID of the form to update. * @return - * @StageModelOnly @@ -77,9 +73,8 @@ export default class FormExtension { /** * Called when the form provider receives form events from the system. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @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} @@ -94,9 +89,8 @@ export default class FormExtension { * Called when a specified message event defined by the form provider is triggered. This method is valid only for * JS forms. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @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 @@ -110,9 +104,8 @@ export default class FormExtension { * Called to notify the form provider that a specified form has been destroyed. Override this method if * you want your application, as the form provider, to be notified of form deletion. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param formId Indicates the ID of the destroyed form. * @return - * @StageModelOnly diff --git a/api/@ohos.application.ServiceExtension.d.ts b/api/@ohos.application.ServiceExtension.d.ts index 87345bf96e..10f89d545f 100644 --- a/api/@ohos.application.ServiceExtension.d.ts +++ b/api/@ohos.application.ServiceExtension.d.ts @@ -21,8 +21,7 @@ import Want from './@ohos.application.Want'; * class of service extension. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ @@ -31,7 +30,7 @@ export default class ServiceExtension { * Indicates service extension context. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ @@ -40,9 +39,8 @@ export default class ServiceExtension { /** * 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 ServiceExtension { /** * 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 ServiceExtension { /** * 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 ServiceExtension { /** * 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 ServiceExtension { /** * 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 ServiceExtension { * 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 41f6bd95d5..17b7bcc7da 100644 --- a/api/@ohos.application.StartOptions.d.ts +++ b/api/@ohos.application.StartOptions.d.ts @@ -18,8 +18,7 @@ * * @name StartOptions * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -27,9 +26,8 @@ export default class StartOptions { /** * windowMode * @default - - * @devices phone, tablet * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ windowMode?: number; diff --git a/api/@ohos.application.Want.d.ts b/api/@ohos.application.Want.d.ts index 3a6db54e56..337e376ae1 100644 --- a/api/@ohos.application.Want.d.ts +++ b/api/@ohos.application.Want.d.ts @@ -18,88 +18,78 @@ * * @name Want * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ export default class Want { /** * device id * @default - - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ deviceId?: string; /** * bundle name * @default - - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ bundleName?: string; /** * ability name * @default - - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; /** * The description of the type in this Want. - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ type?: string; /** * The options of the flags in this Want. - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; /** * The description of an action in an want. - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ action?: string; /** * The description of the WantParams object in an Want - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; /** * The description of a entities in a Want. - * @devices phone, tablet * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; diff --git a/api/@ohos.application.abilityManager.d.ts b/api/@ohos.application.abilityManager.d.ts index 5f996d8366..866c22c2b5 100644 --- a/api/@ohos.application.abilityManager.d.ts +++ b/api/@ohos.application.abilityManager.d.ts @@ -22,8 +22,7 @@ import { ExtensionRunningInfo } from './application/ExtensionRunningInfo'; * The class of an ability manager. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ declare namespace abilityManager { @@ -31,8 +30,7 @@ declare namespace abilityManager { /** * @name AbilityState * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export enum AbilityState { @@ -46,9 +44,8 @@ declare namespace abilityManager { /** * Updates the configuration by modifying the configuration. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap AAFwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @systemapi Hide this for inner system use. * @return - @@ -59,9 +56,8 @@ declare namespace abilityManager { /** * Get information about running abilitys * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap AAFwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @systemapi Hide this for inner system use. * @return - @@ -72,9 +68,8 @@ declare namespace abilityManager { /** * Get information about running extensions * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap AAFwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @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 51669d2cb4..f37fada10a 100644 --- a/api/@ohos.application.appManager.d.ts +++ b/api/@ohos.application.appManager.d.ts @@ -22,8 +22,7 @@ import { ProcessRunningInfo } from './application/ProcessRunningInfo'; * This module provides the function of app manager service. * * @since 8 - * @SysCap appexecfwk - * @devices phone, tablet, tv, wearable, car + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import appManager from '@ohos.application.appManager' * @permission N/A */ @@ -32,9 +31,8 @@ declare namespace appManager { * Register application state observer. * * @default - - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param observer The application state observer. * @return Returns the number code of the observer. */ @@ -43,9 +41,8 @@ declare namespace appManager { /** * Unregister application state observer. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param observerId Indicates the number code of the observer. * @return - */ @@ -55,9 +52,8 @@ declare namespace appManager { /** * getForegroundApplications. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @return Returns the list of AppStateData. */ function getForegroundApplications(callback: AsyncCallback>): void; @@ -66,9 +62,8 @@ declare namespace appManager { /** * Kill process with account. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName The process bundle name. * @param accountId The account id. * @systemapi hide this for inner system use @@ -80,9 +75,8 @@ declare namespace appManager { /** * Is user running in stability test. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @return Returns true if user is running stability test. */ function isRunningInStabilityTest(callback: AsyncCallback): void; @@ -91,9 +85,8 @@ declare namespace appManager { /** * Get information about running processes * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @return - */ diff --git a/api/@ohos.application.formBindingData.d.ts b/api/@ohos.application.formBindingData.d.ts index 1b9ee8f39e..ad39876591 100644 --- a/api/@ohos.application.formBindingData.d.ts +++ b/api/@ohos.application.formBindingData.d.ts @@ -18,16 +18,14 @@ * * @name formBindingData * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ declare namespace formBindingData { /** * Create an FormBindingData instance. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @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 0c4d323a2f..fcab539dbb 100644 --- a/api/@ohos.application.missionManager.d.ts +++ b/api/@ohos.application.missionManager.d.ts @@ -23,8 +23,7 @@ import { MissionSnapshot } from './application/MissionSnapshot'; * * @name missionManager * @since 8 - * @sysCap AAFwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -32,9 +31,8 @@ declare namespace missionManager { /** * Register the missionListener to ams. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return The index number of the MissionListener. */ function registerMissionListener(listener: MissionListener): number; @@ -42,9 +40,8 @@ declare namespace missionManager { /** * Unrgister the missionListener to ams. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unregisterMissionListener(listenerId: number, callback: AsyncCallback): void; @@ -53,9 +50,8 @@ declare namespace missionManager { /** * Get the missionInfo with the given missionId. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return the {@link MissionInfo} of the given id. */ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -64,9 +60,8 @@ declare namespace missionManager { /** * Get the missionInfo with the given missionId. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return The array of the {@link MissionInfo}. */ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback>): void; @@ -75,9 +70,8 @@ declare namespace missionManager { /** * Get the mission snapshot with the given missionId. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return The {@link MissionSnapshot} of the given id. */ function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -86,9 +80,8 @@ declare namespace missionManager { /** * Lock the mission. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function lockMission(missionId: number, callback: AsyncCallback): void; @@ -97,9 +90,8 @@ declare namespace missionManager { /** * Unlock the mission. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unlockMission(missionId: number, callback: AsyncCallback): void; @@ -108,9 +100,8 @@ declare namespace missionManager { /** * Clear the given mission in the ability manager service. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearMission(missionId: number, callback: AsyncCallback): void; @@ -119,9 +110,8 @@ declare namespace missionManager { /** * Clear all missions in the ability manager service. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearAllMissions(callback: AsyncCallback): void; @@ -130,9 +120,8 @@ declare namespace missionManager { /** * Schedule the given mission to foreground. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function moveMissionToFront(missionId: number, callback: AsyncCallback): void; diff --git a/api/ability/abilityResult.d.ts b/api/ability/abilityResult.d.ts index 834f9b505d..bac8cd8756 100644 --- a/api/ability/abilityResult.d.ts +++ b/api/ability/abilityResult.d.ts @@ -14,14 +14,18 @@ */ import { Want } from './want'; +/** + * @since 7 + * @sysCap SystemCapability.Ability.AbilityBase + * @permission N/A + */ export interface AbilityResult { /** * Indicates the result code returned after the ability is destroyed. You can define the result * code to identify an error. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ resultCode: number; @@ -29,9 +33,8 @@ export interface AbilityResult { * Indicates the data returned after the ability is destroyed. You can define the data returned. * This parameter can be null. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @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 c718f678c3..1604b9bf5e 100644 --- a/api/ability/connectOptions.d.ts +++ b/api/ability/connectOptions.d.ts @@ -15,14 +15,18 @@ import { ElementName } from '../bundle/elementName'; import rpc from './../@ohos.rpc'; +/** + * @since 7 + * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + */ export interface ConnectOptions { /** * The callback interface was connect successfully. * * @default - - * @devices phone, tablet * @since 7 - * @SysCap aafwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability * @param remoteObject The remote object instance */ @@ -32,9 +36,8 @@ export interface ConnectOptions { * The callback interface was disconnect successfully. * * @default - - * @devices phone, tablet * @since 7 - * @SysCap aafwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability */ onDisconnect: (elementName: ElementName) => void; @@ -43,9 +46,8 @@ export interface ConnectOptions { * The callback interface was connect failed. * * @default - - * @devices phone, tablet * @since 7 - * @SysCap aafwk + * @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 9d1ce3c640..8bbf1a5c01 100755 --- a/api/ability/continueAbilityOptions.d.ts +++ b/api/ability/continueAbilityOptions.d.ts @@ -13,14 +13,18 @@ * limitations under the License. */ + /** + * @since 7 + * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + */ export interface ContinueAbilityOptions { /** * Indicates the ID of the target device where this ability will be migrated to. * * @default - - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ deviceId: string; @@ -29,9 +33,8 @@ export interface ContinueAbilityOptions { * This is a reserved field. * * @default - - * @devices phone, tablet, tv, wearable, car * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ reversible?: boolean; } \ No newline at end of file diff --git a/api/ability/dataAbilityHelper.d.ts b/api/ability/dataAbilityHelper.d.ts index 73b9b82c25..f1cf3feefb 100644 --- a/api/ability/dataAbilityHelper.d.ts +++ b/api/ability/dataAbilityHelper.d.ts @@ -22,7 +22,7 @@ import rdb from '../@ohos.data.rdb'; /** * DataAbilityHelper - * @devices phone, tablet + * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel * * @since 7 * @FAModelOnly @@ -31,9 +31,8 @@ export interface DataAbilityHelper { /** * Opens a file in a specified remote path. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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,9 +48,8 @@ export interface DataAbilityHelper { /** * Registers an observer to observe data specified by the given uri. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -63,9 +61,8 @@ export interface DataAbilityHelper { /** * Deregisters an observer used for monitoring data specified by the given uri. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param type dataChange. * @param uri Indicates the path of the data to operate. * @param callback Indicates the registered callback. @@ -77,9 +74,8 @@ export interface DataAbilityHelper { /** * Obtains the MIME type of the date specified by the given URI. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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 @@ -90,9 +86,8 @@ export interface DataAbilityHelper { /** * Obtains the MIME types of files supported. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -104,9 +99,8 @@ export interface DataAbilityHelper { /** * Converts the given uri that refers to the Data ability into a normalized uri. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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 @@ -117,9 +111,8 @@ export interface DataAbilityHelper { /** * Converts the given normalized uri generated by normalizeUri(uri) into a denormalized one. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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 @@ -130,9 +123,8 @@ export interface DataAbilityHelper { /** * Notifies the registered observers of a change to the data resource specified by uri. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to operate. * @return - * @FAModelOnly @@ -143,9 +135,8 @@ export interface DataAbilityHelper { /** * Inserts a single data record into the database. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -157,9 +148,8 @@ export interface DataAbilityHelper { /** * Inserts multiple data records into the database. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -171,9 +161,8 @@ export interface DataAbilityHelper { /** * Deletes one or more data records from the database. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -185,9 +174,8 @@ export interface DataAbilityHelper { /** * Updates data records in the database. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. @@ -200,9 +188,8 @@ export interface DataAbilityHelper { /** * Queries data in the database. * - * @devices phone, tablet * @since 7 - * @SysCap AAFwk + * @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. diff --git a/api/ability/dataAbilityOperation.d.ts b/api/ability/dataAbilityOperation.d.ts index a87a732cd0..4d961357d1 100644 --- a/api/ability/dataAbilityOperation.d.ts +++ b/api/ability/dataAbilityOperation.d.ts @@ -17,13 +17,17 @@ import featureAbility from '../@ohos.ability.featureAbility'; import dataAbility from '../@ohos.data.dataAbility'; import rdb from '../@ohos.data.rdb'; + /** + * @since 7 + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @permission N/A + */ export interface DataAbilityOperation { /** * Indicates the path of data to operate. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri: string; @@ -31,9 +35,8 @@ export interface DataAbilityOperation { /** * Indicates a operation type. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ type: featureAbility.DataAbilityOperationType; @@ -41,9 +44,8 @@ export interface DataAbilityOperation { /** * Indicates the data values to be set. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valuesBucket?: rdb.ValuesBucket; @@ -51,9 +53,8 @@ export interface DataAbilityOperation { /** * Indicates the valuesBucket object containing a set of key-value pairs. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valueBackReferences?: rdb.ValuesBucket; @@ -62,9 +63,8 @@ export interface DataAbilityOperation { * Indicates the filter criteria to set. If this parameter is null, all data records * will be operated by default. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicates?: dataAbility.DataAbilityPredicates; @@ -72,9 +72,8 @@ export interface DataAbilityOperation { /** * Indicates the back reference to be used as a filter criterion in predicates. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicatesBackReferences?: Map; @@ -82,9 +81,8 @@ export interface DataAbilityOperation { /** * Specifies whether a batch operation can be interrupted. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ interrupted?: boolean; @@ -92,9 +90,8 @@ export interface DataAbilityOperation { /** * Indicates the expected number of rows to update or delete. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ expectedCount?: number; diff --git a/api/ability/dataAbilityResult.d.ts b/api/ability/dataAbilityResult.d.ts index 96393e5886..e7c53bc8f7 100644 --- a/api/ability/dataAbilityResult.d.ts +++ b/api/ability/dataAbilityResult.d.ts @@ -13,13 +13,18 @@ * limitations under the License. */ + /** + * @name DataAbilityResult + * @since 7 + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @permission N/A + */ export interface DataAbilityResult { /** * Indicates the path of data to operate. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri?: string; @@ -27,9 +32,8 @@ export interface DataAbilityResult { /** * Indicates the number of rows affected by the operation. * @default - - * @devices phone, tablet * @since 7 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ count?:number; diff --git a/api/ability/startAbilityParameter.d.ts b/api/ability/startAbilityParameter.d.ts index 77b0d56e90..7ad38ddddd 100644 --- a/api/ability/startAbilityParameter.d.ts +++ b/api/ability/startAbilityParameter.d.ts @@ -14,14 +14,18 @@ */ import { Want } from './want'; + /** + * @since 3 + * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @permission N/A + */ export interface StartAbilityParameter { /** * Indicates the Want containing information about the target ability to start. * * @default - - * @devices phone, tablet * @since 3 - * @SysCap aafwk + * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ want: Want; @@ -30,9 +34,8 @@ export interface StartAbilityParameter { * Indicates the special start setting used in starting ability. * * @default - - * @devices phone, tablet * @since 3 - * @SysCap aafwk + * @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 e34b658e4e..f6c264684f 100644 --- a/api/ability/want.d.ts +++ b/api/ability/want.d.ts @@ -17,106 +17,94 @@ * Want is the basic communication component of the system. * @name Want * @since 6 - * @sysCap AAFwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityBase * @permission N/A */ export declare interface Want { /** * device id * @default - - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ deviceId?: string; /** * bundle name * @default - - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ bundleName?: string; /** * ability name * @default - - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; /** * The description of the type in this Want. - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ type?: string; /** * The options of the flags in this Want. - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; /** * The description of an action in an want. - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ action?: string; /** * The description of the WantParams object in an Want - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; /** * The description of a entities in a Want. - * @devices phone, tablet * @since 6 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; /** * The description of a extension ability name in a Want. - * @devices phone, tablet * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityName?: string; /** * The description of a extension ability type in a Want. - * @devices phone, tablet * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityType?: number; diff --git a/api/app/abilityMissionInfo.d.ts b/api/app/abilityMissionInfo.d.ts index 0bb23da716..19c7870cd4 100644 --- a/api/app/abilityMissionInfo.d.ts +++ b/api/app/abilityMissionInfo.d.ts @@ -18,16 +18,15 @@ import { ElementName } from '../bundle/elementName'; /** * @name Mission information corresponding to ability * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import AbilityMissionInfo from 'app/abilityMissionInfo' * @permission N/A - * @devices phone, tablet, tv, wearable, car */ export interface AbilityMissionInfo { /** * @default Unique identification of task stack information corresponding to ability * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ missionId: number; @@ -35,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.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ bottomAbility: ElementName; @@ -43,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.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ topAbility: ElementName; /** * @default The corresponding ability description information in the task stack * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ windowMode: number; } diff --git a/api/app/activeProcessInfo.d.ts b/api/app/activeProcessInfo.d.ts index 4ab5a6aa3d..68571a2d49 100644 --- a/api/app/activeProcessInfo.d.ts +++ b/api/app/activeProcessInfo.d.ts @@ -16,37 +16,36 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import app from 'app/activeProcessInfo' * @permission N/A - * @devices phone, tablet, tv, wearable, car */ export interface ActiveProcessInfo { /** * @default process id * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default an array of the bundleNames running in the process * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ bundleNames: Array; } diff --git a/api/app/context.d.ts b/api/app/context.d.ts index dd43071451..6bdb28af61 100644 --- a/api/app/context.d.ts +++ b/api/app/context.d.ts @@ -25,8 +25,7 @@ import BaseContext from '../application/BaseContext'; * Can only be obtained through the ability. * * @since 6 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from 'app/context' * @permission N/A * @FAModelOnly @@ -40,8 +39,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.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return the root dir * @FAModelOnly */ @@ -56,8 +54,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.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @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 @@ -71,8 +68,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.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestPermissionsFromUser(permissions: Array, requestCode: number, resultCallback: AsyncCallback): void; @@ -80,8 +76,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current application. * @since 7 - * @sysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getApplicationInfo(callback: AsyncCallback): void @@ -90,8 +85,7 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the current ability. * @since 7 - * @sysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getBundleName(callback: AsyncCallback): void @@ -100,8 +94,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current process, including the process ID and name. * @since 7 - * @sysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessInfo(callback: AsyncCallback): void @@ -110,8 +103,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.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getElementName(callback: AsyncCallback): void @@ -120,8 +112,7 @@ export interface Context extends BaseContext { /** * Obtains the name of the current process. * @since 7 - * @sysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessName(callback: AsyncCallback): void @@ -130,8 +121,7 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the ability that called the current ability. * @since 7 - * @sysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getCallingBundle(callback: AsyncCallback): void @@ -141,16 +131,15 @@ export interface Context extends BaseContext { /** * @name the result of requestPermissionsFromUser with asynchronous callback * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A - * @devices phone, tablet, tv, wearable, car * @FAModelOnly */ interface PermissionRequestResult { /** * @default The request code passed in by the user * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestCode: number; @@ -158,7 +147,7 @@ interface PermissionRequestResult { /** * @default The permissions passed in by the user * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ permissions: Array; @@ -166,17 +155,24 @@ interface PermissionRequestResult { /** * @default The results for the corresponding request permissions * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ authResults: Array; } +/** + * @name PermissionOptions + * @since 7 + * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + * @FAModelOnly + */ interface PermissionOptions { /** * @default The process id * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ pid?: number; @@ -184,7 +180,7 @@ interface PermissionOptions { /** * @default The user id * @since 7 - * @SysCap SystemCapability.Appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ uid?: number; diff --git a/api/app/processInfo.d.ts b/api/app/processInfo.d.ts index b98ef59b9b..cd25a592d8 100644 --- a/api/app/processInfo.d.ts +++ b/api/app/processInfo.d.ts @@ -16,19 +16,17 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core * @import import ProcessInfo from 'app/processInfo' * @permission N/A - * @devices phone, tablet, tv, wearable */ export interface ProcessInfo { /** * The id of the current process * * @default - - * @devices phone, tablet, tv, wearable * @since 7 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; @@ -36,9 +34,8 @@ export interface ProcessInfo { * The name of the current process * * @default - - * @devices phone, tablet, tv, wearable * @since 7 - * @SysCap appexecfwk + * @SysCap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; } \ No newline at end of file diff --git a/api/application/AbilityContext.d.ts b/api/application/AbilityContext.d.ts index 1757c2c771..68cf988156 100644 --- a/api/application/AbilityContext.d.ts +++ b/api/application/AbilityContext.d.ts @@ -27,8 +27,7 @@ import PermissionRequestResult from "./PermissionRequestResult"; * The context of an ability. It allows access to ability-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -37,7 +36,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an ability. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ abilityInfo: AbilityInfo; @@ -46,7 +45,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an module. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ currentHapModuleInfo: HapModuleInfo; @@ -54,9 +53,8 @@ export default class AbilityContext extends Context { /** * Starts a new ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return - * @StageModelOnly @@ -68,9 +66,8 @@ export default class AbilityContext extends Context { /** * Starts a new ability with account. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @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. @@ -84,9 +81,8 @@ export default class AbilityContext extends Context { /** * Starts an ability and returns the execution result when the ability is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @StageModelOnly @@ -98,9 +94,8 @@ export default class AbilityContext extends Context { /** * Starts an ability and returns the execution result when the ability is destroyed with account. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @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. @@ -114,9 +109,8 @@ export default class AbilityContext extends Context { /** * Destroys this Page ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -127,9 +121,8 @@ export default class AbilityContext extends Context { * Sets the result code and data to be returned by this Page ability to the caller * and destroys this Page ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the result to return. * @return - * @StageModelOnly @@ -140,9 +133,8 @@ export default class AbilityContext extends Context { /** * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @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. @@ -154,9 +146,8 @@ export default class AbilityContext extends Context { /** * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template with account. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @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 @@ -169,9 +160,8 @@ export default class AbilityContext extends Context { /** * The callback interface was connect successfully. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param connection The number code of the ability connected * @hide hide for inner use. * @StageModelOnly @@ -182,9 +172,8 @@ export default class AbilityContext extends Context { /** * Set mission label of current ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param label The label of ability that showed in recent missions. * @StageModelOnly */ @@ -194,9 +183,8 @@ export default class AbilityContext extends Context { /** * Requests certain permissions from the system. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param permissions Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @StageModelOnly */ diff --git a/api/application/AbilityRunningInfo.d.ts b/api/application/AbilityRunningInfo.d.ts index d9aa19f856..41bff388ce 100644 --- a/api/application/AbilityRunningInfo.d.ts +++ b/api/application/AbilityRunningInfo.d.ts @@ -20,50 +20,49 @@ import abilityManager from '../@ohos.application.abilityManager'; * The class of an ability running information. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface AbilityRunningInfo { /** * @default ability element name * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ ability: ElementName; /** * @default process id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default Enumerates state of the ability state info * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ abilityState: abilityManager.AbilityState; } \ No newline at end of file diff --git a/api/application/AbilityStageContext.d.ts b/api/application/AbilityStageContext.d.ts index d9d3588f0a..b99a73330b 100644 --- a/api/application/AbilityStageContext.d.ts +++ b/api/application/AbilityStageContext.d.ts @@ -20,8 +20,7 @@ import Context from "./Context"; * The context of an abilityStage. It allows access to abilityStage-specific resources. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export default class AbilityStageContext extends Context { @@ -30,7 +29,7 @@ export default class AbilityStageContext extends Context { * Indicates configuration information about an module. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ currentHapModuleInfo: HapModuleInfo; } \ No newline at end of file diff --git a/api/application/AbilityStateData.d.ts b/api/application/AbilityStateData.d.ts index 066ec21a46..e9ef7709b5 100644 --- a/api/application/AbilityStateData.d.ts +++ b/api/application/AbilityStateData.d.ts @@ -17,8 +17,7 @@ * The ability or extension state data. * * @since 8 - * @sysCap appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,9 +25,8 @@ export default class AbilityStateData { /** * The bundle name. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -36,9 +34,8 @@ export default class AbilityStateData { /** * The ability name. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ abilityName: string; @@ -46,9 +43,8 @@ export default class AbilityStateData { /** * The pid. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ pid: number; @@ -56,9 +52,8 @@ export default class AbilityStateData { /** * The uid. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -66,9 +61,8 @@ export default class AbilityStateData { /** * The application state. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ state: number; diff --git a/api/application/AppStateData.d.ts b/api/application/AppStateData.d.ts index 2c9ddc7720..62ae586ba6 100644 --- a/api/application/AppStateData.d.ts +++ b/api/application/AppStateData.d.ts @@ -17,8 +17,7 @@ * The application state data. * * @since 8 - * @sysCap appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,9 +25,8 @@ export default class AppStateData { /** * The bundle name. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -36,9 +34,8 @@ export default class AppStateData { /** * The uid. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -46,9 +43,8 @@ export default class AppStateData { /** * The application state. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @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 fd3a39fbd4..3392bbf00b 100644 --- a/api/application/ApplicationStateObserver.d.ts +++ b/api/application/ApplicationStateObserver.d.ts @@ -21,8 +21,7 @@ import ProcessData from "./ProcessData"; * The application state observer. * * @since 8 - * @sysCap appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -30,9 +29,8 @@ export default class ApplicationStateObserver { /** * Will be called when foreground or background application changed. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param appStateData State changed Application info. * @systemapi hide for inner use. * @return - @@ -42,9 +40,8 @@ export default class ApplicationStateObserver { /** * Will be called when ability state changed. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param abilityStateData State changed ability info. * @systemapi hide for inner use. * @return - @@ -54,9 +51,8 @@ export default class ApplicationStateObserver { /** * Will be called when extension state changed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param abilityStateData State changed extension info. * @systemapi hide for inner use. * @return - @@ -66,9 +62,8 @@ export default class ApplicationStateObserver { /** * Will be called when process created. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. * @return - @@ -78,9 +73,8 @@ export default class ApplicationStateObserver { /** * Will be called when process died. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @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 9461fdde36..7b63cc832d 100644 --- a/api/application/BaseContext.d.ts +++ b/api/application/BaseContext.d.ts @@ -18,8 +18,7 @@ * 'application.Context' for Stage Mode. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export default interface BaseContext { @@ -27,7 +26,7 @@ export default interface BaseContext { * Indicates the context is FA Mode or Stage Mode. * * @since 8 - * @sysCap AAFwk + * @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 51c0417238..3006ab4faf 100644 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -23,8 +23,7 @@ import EventHub from "./EventHub"; * application-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -33,7 +32,7 @@ export default class Context extends BaseContext { * Indicates the capability of accessing application resources. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ resourceManager: resmgr.ResourceManager; @@ -42,7 +41,7 @@ export default class Context extends BaseContext { * Indicates configuration information about an application. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ applicationInfo: ApplicationInfo; @@ -51,7 +50,7 @@ export default class Context extends BaseContext { * Indicates app cache dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ cacheDir: string; @@ -60,7 +59,7 @@ export default class Context extends BaseContext { * Indicates app temp dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ tempDir: string; @@ -69,7 +68,7 @@ export default class Context extends BaseContext { * Indicates app files dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ filesDir : string; @@ -78,7 +77,7 @@ export default class Context extends BaseContext { * Indicates app database dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ databaseDir : string; @@ -87,7 +86,7 @@ export default class Context extends BaseContext { * Indicates app storage dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ storageDir : string; @@ -96,7 +95,7 @@ export default class Context extends BaseContext { * Indicates app bundle code dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ bundleCodeDir : string; @@ -105,7 +104,7 @@ export default class Context extends BaseContext { * Indicates app distributed files dir. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ distributedFilesDir: string; @@ -114,7 +113,7 @@ export default class Context extends BaseContext { * Indicates event hub. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ eventHub: EventHub; @@ -122,9 +121,8 @@ export default class Context extends BaseContext { /** * Create a bundle context * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @param bundleName Indicates the bundle name. * @return application context @@ -135,9 +133,8 @@ export default class Context extends BaseContext { /** * Get application context * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @return application context * @StageModelOnly */ diff --git a/api/application/EventHub.d.ts b/api/application/EventHub.d.ts index 7f0099bf51..8c198ce678 100644 --- a/api/application/EventHub.d.ts +++ b/api/application/EventHub.d.ts @@ -17,7 +17,7 @@ * The event center of a context, support the subscription and publication of events. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @devices phone, tablet, tv, wearable, car * @permission N/A * @StageModelOnly @@ -28,7 +28,7 @@ export default class EventHub { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -41,7 +41,7 @@ export default class EventHub { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -54,7 +54,7 @@ export default class EventHub { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param args Indicates the callback arguments. * @return - diff --git a/api/application/ExtensionContext.d.ts b/api/application/ExtensionContext.d.ts index ab86068a27..cbe63e444a 100644 --- a/api/application/ExtensionContext.d.ts +++ b/api/application/ExtensionContext.d.ts @@ -20,8 +20,7 @@ import Context from "./Context"; * The context of an extension. It allows access to extension-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -31,7 +30,7 @@ export default class ExtensionContext extends Context { * Indicates configuration information about an module. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ currentHapModuleInfo: HapModuleInfo; diff --git a/api/application/ExtensionRunningInfo.d.ts b/api/application/ExtensionRunningInfo.d.ts index 5cf4804550..bc694c4fd1 100644 --- a/api/application/ExtensionRunningInfo.d.ts +++ b/api/application/ExtensionRunningInfo.d.ts @@ -20,57 +20,56 @@ import bundle from '../@ohos.bundle'; * The class of an extension running information. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ExtensionRunningInfo { /** * @default Indicates the extension of the extension info * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ extension: ElementName; /** * @default process id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default All package names under the current process * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core */ clientPackage: Array; /** * @default Enumerates types of the entension info * @since 9 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ type: bundle.ExtensionAbilityType; diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index 39ea06079a..dd2d16bc81 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -22,8 +22,7 @@ import formBindingData from '../@ohos.application.formBindingData'; * formExtension-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -34,9 +33,8 @@ export default class FormExtensionContext extends ExtensionContext { * *

You can use this method to update the given form

* - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @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 6a4d3e94c1..6f3efb0987 100644 --- a/api/application/MissionInfo.d.ts +++ b/api/application/MissionInfo.d.ts @@ -19,7 +19,7 @@ import Want from "../@ohos.application.Want"; * Mission information corresponding to ability. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @devices phone, tablet, tv, wearable, car * @permission N/A * @systemapi hide for inner use. @@ -29,7 +29,7 @@ export interface MissionInfo { * Indicates mission id. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ missionId: number; @@ -37,7 +37,7 @@ export interface MissionInfo { * Indicates running state. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ runningState: number; @@ -45,7 +45,7 @@ export interface MissionInfo { * Indicates locked state. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ lockedState: number; @@ -53,7 +53,7 @@ export interface MissionInfo { * Indicates the recent create or update time of the mission. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ timestamp: string; @@ -61,7 +61,7 @@ export interface MissionInfo { * Indicates want of the mission. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ want: Want; @@ -69,7 +69,7 @@ export interface MissionInfo { * Indicates label of the mission. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ label: string; @@ -77,7 +77,7 @@ export interface MissionInfo { * Indicates icon path of the mission. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ iconPath: string; } \ No newline at end of file diff --git a/api/application/MissionListener.d.ts b/api/application/MissionListener.d.ts index 92c1758f00..d9f36505f5 100644 --- a/api/application/MissionListener.d.ts +++ b/api/application/MissionListener.d.ts @@ -18,8 +18,7 @@ * * @name MissionListener * @since 8 - * @sysCap AAFwk - * @devices phone, tablet + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -27,9 +26,8 @@ /** * Called by system when mission created. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionCreated(mission: number): void; @@ -37,9 +35,8 @@ /** * Called by system when mission destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionDestroyed(mission: number): void; @@ -47,9 +44,8 @@ /** * Called by system when mission shapshot changed. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionSnapshotChanged(mission: number): void; @@ -57,9 +53,8 @@ /** * Called by system when mission moved to fornt. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap AAFwk + * @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 394fcdb2bb..d7b85a300f 100644 --- a/api/application/MissionSnapshot.d.ts +++ b/api/application/MissionSnapshot.d.ts @@ -20,8 +20,7 @@ import { image } from '../@ohos.multimedia.image'; * Mission snapshot corresponding to mission. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -30,7 +29,7 @@ export interface MissionSnapshot { * Indicates the ability elementName of the mission. * * @since 8 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ ability: ElementName; @@ -38,7 +37,7 @@ export interface MissionSnapshot { * Indicates mission snapshot. * * @since 8 - * @sysCap AAFwk + * @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 c031d326ad..6c44ea461f 100755 --- a/api/application/PermissionRequestResult.d.ts +++ b/api/application/PermissionRequestResult.d.ts @@ -17,8 +17,7 @@ * The result of requestPermissionsFromUser with asynchronous callback. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @StageModelOnly */ @@ -27,7 +26,7 @@ export default class PermissionRequestResult { * The permissions passed in by the user. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ permissions: Array; @@ -37,7 +36,7 @@ export default class PermissionRequestResult { * permission is granted, and the value -1 indicates not. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ authResults: Array; diff --git a/api/application/ProcessData.d.ts b/api/application/ProcessData.d.ts index 50806b4fb3..3bd2427106 100644 --- a/api/application/ProcessData.d.ts +++ b/api/application/ProcessData.d.ts @@ -17,8 +17,7 @@ * The process data. * * @since 8 - * @sysCap appexecfwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A */ @@ -26,9 +25,8 @@ export default class ProcessData { /** * The bundle name. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ bundleName: string; @@ -36,9 +34,8 @@ export default class ProcessData { /** * The pid. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ pid: number; @@ -46,9 +43,8 @@ export default class ProcessData { /** * The uid. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @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 db9414888a..9349cb9135 100644 --- a/api/application/ProcessRunningInfo.d.ts +++ b/api/application/ProcessRunningInfo.d.ts @@ -17,36 +17,35 @@ * The class of an process running information. * * @since 8 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A */ export interface ProcessRunningInfo { /** * @default process id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ pid: number; /** * @default user id * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ uid: number; /** * @default the name of the process * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ processName: string; /** * @default an array of the bundleNames running in the process * @since 8 - * @SysCap SystemCapability.Appexecfwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission */ bundleNames: Array; } \ No newline at end of file diff --git a/api/application/ServiceExtensionContext.d.ts b/api/application/ServiceExtensionContext.d.ts index b9ea4f76c2..41017e1042 100644 --- a/api/application/ServiceExtensionContext.d.ts +++ b/api/application/ServiceExtensionContext.d.ts @@ -24,8 +24,7 @@ import StartOptions from "../@ohos.application.StartOptions"; * serviceExtension-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A * @StageModelOnly @@ -34,9 +33,8 @@ export default class ServiceExtensionContext extends ExtensionContext { /** * Service extension uses this method to start a specific ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @systemapi hide for inner use. * @return - @@ -49,9 +47,8 @@ export default class ServiceExtensionContext extends ExtensionContext { /** * Service extension uses this method to start a specific ability with account. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @param parameter Indicates the accountId to start. * @systemapi hide for inner use. @@ -65,9 +62,8 @@ export default class ServiceExtensionContext extends ExtensionContext { /** * Destroys this service extension. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -82,9 +78,8 @@ export default class ServiceExtensionContext extends ExtensionContext { * 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 + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @param request Indicates the service extension to connect. * @systemapi hide for inner use. * @return connection id, int value. @@ -99,9 +94,8 @@ export default class ServiceExtensionContext extends ExtensionContext { * 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 + * @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. @@ -114,9 +108,8 @@ export default class ServiceExtensionContext extends ExtensionContext { * Disconnects an ability to a service extension, in contrast to * {@link connectAbility}. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Mission * @param connection the connection id returned from connectAbility api. * @systemapi hide for inner use. * @return - -- Gitee