From c1a357362d12ce950175d27266c985c482722a44 Mon Sep 17 00:00:00 2001 From: donglin Date: Wed, 16 Nov 2022 14:56:41 +0800 Subject: [PATCH] JsDoc Signed-off-by: donglin Change-Id: I12104efc3db6cd0d26b9495bd6305df1178f7ad2 --- api/@ohos.ability.featureAbility.d.ts | 22 +++-- api/@ohos.ability.particleAbility.d.ts | 14 ++-- api/@ohos.app.ability.Ability.d.ts | 8 +- api/@ohos.app.ability.AbilityConstant.d.ts | 22 ++--- ....app.ability.AbilityLifecycleCallback.d.ts | 20 ++--- api/@ohos.app.ability.AbilityStage.d.ts | 12 +-- ...@ohos.app.ability.EnvironmentCallback.d.ts | 2 +- api/@ohos.app.ability.ExtensionAbility.d.ts | 2 +- ...s.app.ability.ServiceExtensionAbility.d.ts | 20 ++--- api/@ohos.app.ability.StartOptions.d.ts | 6 +- api/@ohos.app.ability.UIAbility.d.ts | 56 ++++++------- api/@ohos.app.ability.appRecovery.d.ts | 6 +- api/@ohos.app.ability.common.d.ts | 26 +++--- api/@ohos.app.form.FormExtensionAbility.d.ts | 22 ++--- ...application.DataShareExtensionAbility.d.ts | 19 ++--- ....application.abilityDelegatorRegistry.d.ts | 9 +- api/@ohos.application.abilityManager.d.ts | 8 +- api/@ohos.application.appManager.d.ts | 21 +++-- api/@ohos.application.errorManager.d.ts | 5 +- ...ohos.continuation.continuationManager.d.ts | 10 ++- api/@ohos.enterpriseDeviceManager.d.ts | 18 ++-- api/@ohos.wantAgent.d.ts | 15 ++-- api/app/context.d.ts | 12 +-- api/application/AbilityContext.d.ts | 82 +++++++++---------- api/application/ApplicationContext.d.ts | 30 +++---- api/application/ApplicationStateObserver.d.ts | 10 +-- api/application/Context.d.ts | 34 ++++---- api/application/ErrorObserver.d.ts | 2 +- api/application/EventHub.d.ts | 8 +- api/application/FormExtensionContext.d.ts | 4 +- api/application/MissionListener.d.ts | 14 ++-- api/application/ServiceExtensionContext.d.ts | 50 +++++------ api/application/UIAbilityContext.d.ts | 82 +++++++++---------- api/application/abilityDelegator.d.ts | 2 +- api/application/abilityDelegatorArgs.d.ts | 1 - api/application/abilityMonitor.d.ts | 1 - api/application/abilityStageMonitor.d.ts | 1 - api/common/full/featureability.d.ts | 5 +- api/common/lite/featureability.d.ts | 1 + 39 files changed, 338 insertions(+), 344 deletions(-) diff --git a/api/@ohos.ability.featureAbility.d.ts b/api/@ohos.ability.featureAbility.d.ts index 944d6d321b..a8f5d17060 100644 --- a/api/@ohos.ability.featureAbility.d.ts +++ b/api/@ohos.ability.featureAbility.d.ts @@ -40,7 +40,7 @@ declare namespace featureAbility { * @since 6 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. - * @return - + * @returns - * @FAModelOnly */ function getWant(callback: AsyncCallback): void; @@ -52,7 +52,7 @@ declare namespace featureAbility { * @since 6 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. - * @return - + * @returns - * @FAModelOnly */ function startAbility(parameter: StartAbilityParameter, callback: AsyncCallback): void; @@ -62,7 +62,7 @@ declare namespace featureAbility { * Obtains the application context. * * @syscap SystemCapability.Ability.AbilityRuntime.FAModel - * @return Returns the application context. + * @returns Returns the application context. * @since 6 * @FAModelOnly */ @@ -74,7 +74,7 @@ declare namespace featureAbility { * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. - * @return Returns the {@link AbilityResult}. + * @returns Returns the {@link AbilityResult}. * @FAModelOnly */ function startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback): void; @@ -87,7 +87,7 @@ declare namespace featureAbility { * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the result to return. - * @return - + * @returns - * @FAModelOnly */ function terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; @@ -98,7 +98,7 @@ declare namespace featureAbility { * * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel - * @return - + * @returns - * @FAModelOnly */ function terminateSelf(callback: AsyncCallback): void; @@ -110,7 +110,7 @@ declare namespace featureAbility { * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. - * @return Returns the dataAbilityHelper. + * @returns Returns the dataAbilityHelper. * @FAModelOnly */ function acquireDataAbilityHelper(uri: string): DataAbilityHelper; @@ -120,7 +120,7 @@ declare namespace featureAbility { * * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel - * @return Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise. + * @returns Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise. * @FAModelOnly */ function hasWindowFocus(callback: AsyncCallback): void; @@ -133,7 +133,7 @@ declare namespace featureAbility { * @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 + * @returns Returns the number code of the ability connected * @FAModelOnly */ function connectAbility(request: Want, options:ConnectOptions ): number; @@ -154,7 +154,7 @@ declare namespace featureAbility { * * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel - * @return Returns the window corresponding to the current ability. + * @returns Returns the window corresponding to the current ability. * @FAModelOnly */ function getWindow(callback: AsyncCallback): void; @@ -223,7 +223,6 @@ declare namespace featureAbility { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import abilityManager from 'app/context' * @FAModelOnly */ export type Context = _Context @@ -239,7 +238,6 @@ declare namespace featureAbility { * @name This class saves process information about an application * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import ProcessInfo from 'app/processInfo' */ export type ProcessInfo = _ProcessInfo } diff --git a/api/@ohos.ability.particleAbility.d.ts b/api/@ohos.ability.particleAbility.d.ts index 04321ffcd7..9c02954c62 100644 --- a/api/@ohos.ability.particleAbility.d.ts +++ b/api/@ohos.ability.particleAbility.d.ts @@ -35,7 +35,7 @@ declare namespace particleAbility { * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. - * @return - + * @returns - * @FAModelOnly */ function startAbility(parameter: StartAbilityParameter, callback: AsyncCallback): void; @@ -46,7 +46,7 @@ declare namespace particleAbility { * * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel - * @return - + * @returns - * @FAModelOnly */ function terminateSelf(callback: AsyncCallback): void; @@ -58,7 +58,7 @@ declare namespace particleAbility { * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. - * @return Returns the dataAbilityHelper. + * @returns Returns the dataAbilityHelper. * @FAModelOnly */ function acquireDataAbilityHelper(uri: string): DataAbilityHelper; @@ -72,7 +72,8 @@ declare namespace particleAbility { * @param id Identifies the notification bar information. * @param request Indicates the notificationRequest instance containing information for displaying a notification bar. * @FAModelOnly - * @deprecated + * @deprecated since 9 + * @useinstead ohos.resourceschedule.backgroundTaskManager.startBackgroundRunning */ function startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback): void; function startBackgroundRunning(id: number, request: NotificationRequest): Promise; @@ -83,7 +84,8 @@ declare namespace particleAbility { * @since 7 * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @FAModelOnly - * @deprecated + * @deprecated since 9 + * @useinstead ohos.resourceschedule.backgroundTaskManager.stopBackgroundRunning */ function cancelBackgroundRunning(callback: AsyncCallback): void; function cancelBackgroundRunning(): Promise; @@ -95,7 +97,7 @@ declare namespace particleAbility { * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param request Indicates the Service ability to connect. * @param options Callback object for the client. If this parameter is null, an exception is thrown. - * @return unique identifier of the connection between the client and the service side. + * @returns unique identifier of the connection between the client and the service side. * @FAModelOnly */ function connectAbility(request: Want, options:ConnectOptions): number; diff --git a/api/@ohos.app.ability.Ability.d.ts b/api/@ohos.app.ability.Ability.d.ts index a29250be37..4c0485909b 100644 --- a/api/@ohos.app.ability.Ability.d.ts +++ b/api/@ohos.app.ability.Ability.d.ts @@ -19,7 +19,7 @@ import { Configuration } from './@ohos.app.ability.Configuration'; /** * The class of an ability. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class Ability { @@ -27,7 +27,7 @@ export default class Ability { * Called when the system configuration is updated. * @param { Configuration } newConfig - Indicates the updated configuration. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -38,7 +38,7 @@ export default class Ability { * @param { AbilityConstant.MemoryLevel } level - Indicates the memory trim level, which shows the current memory * usage status. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; @@ -49,7 +49,7 @@ export default class Ability { * @param wantParam Indicates the want parameter. * @return 0 if ability agrees to save data successfully, otherwise errcode. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult; diff --git a/api/@ohos.app.ability.AbilityConstant.d.ts b/api/@ohos.app.ability.AbilityConstant.d.ts index 3709949ca5..4237bb892a 100644 --- a/api/@ohos.app.ability.AbilityConstant.d.ts +++ b/api/@ohos.app.ability.AbilityConstant.d.ts @@ -17,7 +17,7 @@ * The definition of AbilityConstant. * @namespace AbilityConstant * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ declare namespace AbilityConstant { @@ -25,14 +25,14 @@ declare namespace AbilityConstant { * Interface of launch param. * @typedef LaunchParam * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export interface LaunchParam { /** * Indicates launch reason. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ launchReason: LaunchReason; @@ -40,7 +40,7 @@ declare namespace AbilityConstant { /** * Indicates last exit reason. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ lastExitReason: LastExitReason; @@ -50,7 +50,7 @@ declare namespace AbilityConstant { * Type of launch reason. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum LaunchReason { @@ -65,7 +65,7 @@ declare namespace AbilityConstant { * Type of last exit reason. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum LastExitReason { @@ -78,7 +78,7 @@ declare namespace AbilityConstant { * Type of onContinue result. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum OnContinueResult { @@ -91,7 +91,7 @@ declare namespace AbilityConstant { * Type of memory level. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum MemoryLevel { @@ -104,7 +104,7 @@ declare namespace AbilityConstant { * Type of window mode. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum WindowMode { @@ -119,7 +119,7 @@ declare namespace AbilityConstant { * Type of onSave result. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum OnSaveResult { @@ -135,7 +135,7 @@ declare namespace AbilityConstant { * Type of save state. * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum StateType { diff --git a/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts b/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts index 7f62e30fea..0ef4951073 100644 --- a/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts +++ b/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts @@ -20,7 +20,7 @@ import window from './@ohos.window'; /** * The ability lifecycle callback. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class AbilityLifecycleCallback { @@ -28,7 +28,7 @@ export default class AbilityLifecycleCallback { * Called back when an ability is started for initialization. * @param { Ability } ability - Indicates the ability to register for listening. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAbilityCreate(ability: UIAbility): void; @@ -38,7 +38,7 @@ export default class AbilityLifecycleCallback { * @param { Ability } ability - Indicates the ability to register for listening. * @param { window.WindowStage } windowStage - window stage to create * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void; @@ -48,7 +48,7 @@ export default class AbilityLifecycleCallback { * @param { Ability } ability - Indicates the ability to register for listening. * @param { window.WindowStage } windowStage - window stage to active * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void; @@ -58,7 +58,7 @@ export default class AbilityLifecycleCallback { * @param { Ability } ability - Indicates the ability to register for listening. * @param { window.WindowStage } windowStage - window stage to inactive * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void; @@ -68,7 +68,7 @@ export default class AbilityLifecycleCallback { * @param { Ability } ability - Indicates the ability to register for listening. * @param { window.WindowStage } windowStage - window stage to destroy * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void; @@ -77,7 +77,7 @@ export default class AbilityLifecycleCallback { * Called back when an ability is destroyed. * @param { Ability } ability - Indicates the ability to register for listening. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAbilityDestroy(ability: UIAbility): void; @@ -86,7 +86,7 @@ export default class AbilityLifecycleCallback { * Called back when the state of an ability changes to foreground. * @param { Ability } ability - Indicates the ability to register for listening. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAbilityForeground(ability: UIAbility): void; @@ -95,7 +95,7 @@ export default class AbilityLifecycleCallback { * Called back when the state of an ability changes to background. * @param { Ability } ability - Indicates the ability to register for listening. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAbilityBackground(ability: UIAbility): void; @@ -104,7 +104,7 @@ export default class AbilityLifecycleCallback { * Called back when an ability prepares to continue. * @param { Ability } ability - Indicates the ability to register for listening. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAbilityContinue(ability: UIAbility): void; diff --git a/api/@ohos.app.ability.AbilityStage.d.ts b/api/@ohos.app.ability.AbilityStage.d.ts index 8aa0201a3f..8831378926 100644 --- a/api/@ohos.app.ability.AbilityStage.d.ts +++ b/api/@ohos.app.ability.AbilityStage.d.ts @@ -21,7 +21,7 @@ import { Configuration } from './@ohos.app.ability.Configuration'; /** * The class of an ability stage. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class AbilityStage { @@ -29,7 +29,7 @@ export default class AbilityStage { * Indicates configuration information about context. * @type { AbilityStageContext } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ context: AbilityStageContext; @@ -37,7 +37,7 @@ export default class AbilityStage { /** * Called back when an ability stage is started for initialization. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ onCreate(): void; @@ -49,7 +49,7 @@ export default class AbilityStage { * do not create a new instance and pull it back to the top of the stack. * Otherwise, create a new instance and start it. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAcceptWant(want: Want): string; @@ -58,7 +58,7 @@ export default class AbilityStage { * Called when the system configuration is updated. * @param { Configuration } newConfig - Indicates the updated configuration. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -68,7 +68,7 @@ export default class AbilityStage { * background and there is no enough memory for running as many background processes as possible. * @param { AbilityConstant.MemoryLevel } level - Indicates the memory trim level, which shows the current memory usage status. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; diff --git a/api/@ohos.app.ability.EnvironmentCallback.d.ts b/api/@ohos.app.ability.EnvironmentCallback.d.ts index 03ccc013c3..8490a059ac 100755 --- a/api/@ohos.app.ability.EnvironmentCallback.d.ts +++ b/api/@ohos.app.ability.EnvironmentCallback.d.ts @@ -25,7 +25,7 @@ export default class EnvironmentCallback { * Called when the system configuration is updated. * @param { Configuration } config - Indicates the updated configuration. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConfigurationUpdated(config: Configuration): void; diff --git a/api/@ohos.app.ability.ExtensionAbility.d.ts b/api/@ohos.app.ability.ExtensionAbility.d.ts index a64ecb161e..13d3d3e7ed 100644 --- a/api/@ohos.app.ability.ExtensionAbility.d.ts +++ b/api/@ohos.app.ability.ExtensionAbility.d.ts @@ -18,7 +18,7 @@ import Ability from "./@ohos.app.ability.Ability"; /** * class of extension. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class ExtensionAbility extends Ability { diff --git a/api/@ohos.app.ability.ServiceExtensionAbility.d.ts b/api/@ohos.app.ability.ServiceExtensionAbility.d.ts index d4eaab2f12..18241e6abd 100644 --- a/api/@ohos.app.ability.ServiceExtensionAbility.d.ts +++ b/api/@ohos.app.ability.ServiceExtensionAbility.d.ts @@ -22,7 +22,7 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * class of service extension ability. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class ServiceExtensionAbility { @@ -30,7 +30,7 @@ export default class ServiceExtensionAbility { * Indicates service extension ability context. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ context: ServiceExtensionContext; @@ -40,7 +40,7 @@ export default class ServiceExtensionAbility { * @param { Want } want - Indicates the want of created service extension. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onCreate(want: Want): void; @@ -49,7 +49,7 @@ export default class ServiceExtensionAbility { * Called back before a service extension is destroyed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onDestroy(): void; @@ -62,7 +62,7 @@ export default class ServiceExtensionAbility { * For example, if the service extension has been started for six times. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onRequest(want: Want, startId: number): void; @@ -72,7 +72,7 @@ export default class ServiceExtensionAbility { * @param { Want } want - Indicates connection information about the Service ability. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConnect(want: Want): rpc.RemoteObject; @@ -82,7 +82,7 @@ export default class ServiceExtensionAbility { * @param { Want } want - Indicates disconnection information about the service extension. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onDisconnect(want: Want): void; @@ -93,7 +93,7 @@ export default class ServiceExtensionAbility { * @param { Want } want - Indicates the want of the service extension being connected. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onReconnect(want: Want): void; @@ -103,7 +103,7 @@ export default class ServiceExtensionAbility { * @param { Configuration } newConfig - Indicates the updated configuration. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -115,7 +115,7 @@ export default class ServiceExtensionAbility { * @return { Array } The dump info array. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onDump(params: Array): Array; diff --git a/api/@ohos.app.ability.StartOptions.d.ts b/api/@ohos.app.ability.StartOptions.d.ts index 2650fce27a..e89e431242 100644 --- a/api/@ohos.app.ability.StartOptions.d.ts +++ b/api/@ohos.app.ability.StartOptions.d.ts @@ -16,14 +16,14 @@ /** * StartOptions is the basic communication component of the system. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class StartOptions { /** * windowMode * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ windowMode?: number; @@ -31,7 +31,7 @@ export default class StartOptions { /** * displayId * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ displayId?: number; diff --git a/api/@ohos.app.ability.UIAbility.d.ts b/api/@ohos.app.ability.UIAbility.d.ts index 2f1612dc5c..0d3e8f9bd1 100755 --- a/api/@ohos.app.ability.UIAbility.d.ts +++ b/api/@ohos.app.ability.UIAbility.d.ts @@ -24,7 +24,7 @@ import window from './@ohos.window'; * The prototype of the listener function interface registered by the Caller. * @typedef OnReleaseCallback * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export interface OnReleaseCallback { @@ -35,7 +35,7 @@ export interface OnReleaseCallback { * The prototype of the message listener function interface registered by the Callee. * @typedef CalleeCallback * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export interface CalleeCallback { @@ -46,7 +46,7 @@ export interface CalleeCallback { * The interface of a Caller. * @interface * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export interface Caller { @@ -57,7 +57,7 @@ export interface Caller { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ call(method: string, data: rpc.Sequenceable): Promise; @@ -69,7 +69,7 @@ export interface Caller { * @returns { Promise } Returns the callee's notification result data. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ callWithResult(method: string, data: rpc.Sequenceable): Promise; @@ -77,7 +77,7 @@ export interface Caller { /** * Clear service records. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ release(): void; @@ -87,7 +87,7 @@ export interface Caller { * @param { OnReleaseCallback } callback - Register a callback function for listening for notifications. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onRelease(callback: OnReleaseCallback): void; @@ -98,7 +98,7 @@ export interface Caller { * @param { OnReleaseCallback } callback - Register a callback function for listening for notifications. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ on(type: "release", callback: OnReleaseCallback): void; @@ -109,7 +109,7 @@ export interface Caller { * @param { OnReleaseCallback } callback - Unregister a callback function for listening for notifications. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "release", callback: OnReleaseCallback): void; @@ -119,7 +119,7 @@ export interface Caller { * @param { string } type - release. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "release"): void; @@ -129,7 +129,7 @@ export interface Caller { * The interface of a Callee. * @interface * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export interface Callee { @@ -139,7 +139,7 @@ export interface Callee { * @param { CalleeCallback } callback - Register a callback function that listens for notification events. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ on(method: string, callback: CalleeCallback): void; @@ -149,7 +149,7 @@ export interface Callee { * @param { string } method - A string registered to listen for notification events. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(method: string): void; @@ -158,7 +158,7 @@ export interface Callee { /** * The class of a UI ability. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class UIAbility extends Ability { @@ -166,7 +166,7 @@ export default class UIAbility extends Ability { * Indicates configuration information about an ability context. * @type { UIAbilityContext } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ context: UIAbilityContext; @@ -175,7 +175,7 @@ export default class UIAbility extends Ability { * Indicates ability launch want. * @type { Want } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ launchWant: Want; @@ -184,7 +184,7 @@ export default class UIAbility extends Ability { * Indicates ability last request want. * @type { Want } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ lastRequestWant: Want; @@ -193,7 +193,7 @@ export default class UIAbility extends Ability { * Call Service Stub Object. * @type { Callee } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ callee: Callee; @@ -203,7 +203,7 @@ export default class UIAbility extends Ability { * @param { Want } want - Indicates the want info of the created ability. * @param { AbilityConstant.LaunchParam } param - Indicates the launch param. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onCreate(want: Want, param: AbilityConstant.LaunchParam): void; @@ -212,7 +212,7 @@ export default class UIAbility extends Ability { * Called back when an ability window stage is created. * @param { window.WindowStage } windowStage - Indicates the created WindowStage. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageCreate(windowStage: window.WindowStage): void; @@ -220,7 +220,7 @@ export default class UIAbility extends Ability { /** * Called back when an ability window stage is destroyed. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageDestroy(): void; @@ -229,7 +229,7 @@ export default class UIAbility extends Ability { * Called back when an ability window stage is restored. * @param { window.WindowStage } windowStage - window stage to restore * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onWindowStageRestore(windowStage: window.WindowStage): void; @@ -237,7 +237,7 @@ export default class UIAbility extends Ability { /** * Called back before an ability is destroyed. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onDestroy(): void; @@ -245,7 +245,7 @@ export default class UIAbility extends Ability { /** * Called back when the state of an ability changes to foreground. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onForeground(): void; @@ -253,7 +253,7 @@ export default class UIAbility extends Ability { /** * Called back when the state of an ability changes to background. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onBackground(): void; @@ -263,7 +263,7 @@ export default class UIAbility extends Ability { * @param { {[key: string]: any} } wantParam - Indicates the want parameter. * @returns { AbilityConstant.OnContinueResult } Return the result of onContinue. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onContinue(wantParam: { [key: string]: any }): AbilityConstant.OnContinueResult; @@ -274,7 +274,7 @@ export default class UIAbility extends Ability { * @param { Want } want - Indicates the want info of ability. * @param { AbilityConstant.LaunchParam } launchParams - Indicates the launch parameters. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; @@ -285,7 +285,7 @@ export default class UIAbility extends Ability { * @param { Array } params - Indicates the params from command. * @returns { Array } Return the dump info array. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @stagemodelonly + * @StageModelOnly * @since 9 */ onDump(params: Array): Array; diff --git a/api/@ohos.app.ability.appRecovery.d.ts b/api/@ohos.app.ability.appRecovery.d.ts index a9c1cad363..3b63225259 100644 --- a/api/@ohos.app.ability.appRecovery.d.ts +++ b/api/@ohos.app.ability.appRecovery.d.ts @@ -95,7 +95,7 @@ declare namespace appReceovery { * @param saveOccasion The type of When to save * @param saveMode The type of where to save * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ function enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMode?: SaveModeFlag) : void; @@ -103,7 +103,7 @@ declare namespace appReceovery { /** * Restart App when called * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ function restartApp(): void; @@ -112,7 +112,7 @@ declare namespace appReceovery { * Save App state data when called * @return true if save data successfully, otherwise false * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ function saveAppState(): boolean; diff --git a/api/@ohos.app.ability.common.d.ts b/api/@ohos.app.ability.common.d.ts index cd0a1046cb..0661aafb08 100755 --- a/api/@ohos.app.ability.common.d.ts +++ b/api/@ohos.app.ability.common.d.ts @@ -29,7 +29,7 @@ import { ConnectOptions as _ConnectOptions } from "./ability/connectOptions"; /** * The context of an application. It allows access to application-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ declare namespace common { @@ -37,7 +37,7 @@ declare namespace common { /** * The context of an ability. It allows access to ability-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type UIAbilityContext = _UIAbilityContext.default @@ -45,7 +45,7 @@ declare namespace common { /** * The context of an abilityStage. It allows access to abilityStage-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type AbilityStageContext = _AbilityStageContext.default @@ -53,7 +53,7 @@ declare namespace common { /** * The context of an application. It allows access to application-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type ApplicationContext = _ApplicationContext.default @@ -69,7 +69,7 @@ declare namespace common { * The base context of an ability or an application. It allows access to * application-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type Context = _Context.default @@ -77,7 +77,7 @@ declare namespace common { /** * The context of an extension. It allows access to extension-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type ExtensionContext = _ExtensionContext.default @@ -86,7 +86,7 @@ declare namespace common { * The context of form extension. It allows access to * formExtension-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type FormExtensionContext = _FormExtensionContext.default @@ -94,7 +94,7 @@ declare namespace common { /** * File area mode * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum AreaMode { @@ -111,7 +111,7 @@ declare namespace common { /** * The event center of a context, support the subscription and publication of events. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type EventHub = _EventHub.default @@ -119,7 +119,7 @@ declare namespace common { /** * The result of requestPermissionsFromUser with asynchronous callback. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type PermissionRequestResult = _PermissionRequestResult.default @@ -127,7 +127,7 @@ declare namespace common { /** * Defines a PacMap object for storing a series of values. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type PacMap = _PacMap @@ -135,7 +135,7 @@ declare namespace common { /** * Indicates the result of startAbility. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type AbilityResult = _AbilityResult @@ -143,7 +143,7 @@ declare namespace common { /** * Indicates the callback of connection * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export type ConnectOptions = _ConnectOptions diff --git a/api/@ohos.app.form.FormExtensionAbility.d.ts b/api/@ohos.app.form.FormExtensionAbility.d.ts index aeed2002d1..a767413cb7 100644 --- a/api/@ohos.app.form.FormExtensionAbility.d.ts +++ b/api/@ohos.app.form.FormExtensionAbility.d.ts @@ -22,7 +22,7 @@ import { Configuration } from './@ohos.app.ability.Configuration'; /** * class of form extension. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class FormExtensionAbility { @@ -30,7 +30,7 @@ export default class FormExtensionAbility { * Indicates form extension context. * @type { FormExtensionContext } * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ context: FormExtensionContext; @@ -43,7 +43,7 @@ export default class FormExtensionAbility { * acquisition, update, and deletion. * @return { formBindingData.FormBindingData } Returns the created {@link formBindingData#FormBindingData} object. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAddForm(want: Want): formBindingData.FormBindingData; @@ -52,7 +52,7 @@ export default class FormExtensionAbility { * Called when the form provider is notified that a temporary form is successfully converted to a normal form. * @param { string } formId - Indicates the ID of the form. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onCastToNormalForm(formId: string): void; @@ -61,7 +61,7 @@ export default class FormExtensionAbility { * Called to notify the form provider to update a specified form. * @param { string } formId - Indicates the ID of the form to update. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onUpdateForm(formId: string): void; @@ -74,7 +74,7 @@ export default class FormExtensionAbility { * {@link formInfo#VisibilityType#FORM_VISIBLE} means that the form becomes visible, and * {@link formInfo#VisibilityType#FORM_INVISIBLE} means that the form becomes invisible. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onChangeFormVisibility(newStatus: { [key: string]: number }): void; @@ -87,7 +87,7 @@ export default class FormExtensionAbility { * @param { string } message - Indicates the value of the {@code params} field of the message event. This parameter * is used to identify the specific component on which the event is triggered. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onFormEvent(formId: string, message: string): void; @@ -97,7 +97,7 @@ export default class FormExtensionAbility { * you want your application, as the form provider, to be notified of form deletion. * @param { string } formId - Indicates the ID of the destroyed form. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onRemoveForm(formId: string): void; @@ -106,7 +106,7 @@ export default class FormExtensionAbility { * Called when the system configuration is updated. * @param { Configuration } newConfig - Indicates the system configuration, such as language and color mode. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -120,7 +120,7 @@ export default class FormExtensionAbility { * form name, and form dimensions. * @return { formInfo.FormState } Returns the {@link formInfo#FormState} object. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ onAcquireFormState?(want: Want): formInfo.FormState; @@ -131,7 +131,7 @@ export default class FormExtensionAbility { * @return { { [key: string]: any } } Returns the wantParams object. * @syscap SystemCapability.Ability.Form * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ onShareForm?(formId: string): { [key: string]: any }; diff --git a/api/@ohos.application.DataShareExtensionAbility.d.ts b/api/@ohos.application.DataShareExtensionAbility.d.ts index c56abbdeb8..5af2f87aa3 100644 --- a/api/@ohos.application.DataShareExtensionAbility.d.ts +++ b/api/@ohos.application.DataShareExtensionAbility.d.ts @@ -45,7 +45,7 @@ export default class DataShareExtensionAbility { * @syscap SystemCapability.DistributedDataManager.DataShare.Provider * @param want Indicates connection information about the datashare extension ability. * @systemapi Hide this for inner system use. - * @return - + * @returns - * @StageModelOnly */ onCreate?(want: Want, callback: AsyncCallback): void; @@ -58,7 +58,7 @@ export default class DataShareExtensionAbility { * @param uri Indicates the position where the data is to insert. * @param valueBucket Indicates the data to insert. * @systemapi Hide this for inner system use. - * @return Returns the index of the newly inserted data record. + * @returns Returns the index of the newly inserted data record. * @StageModelOnly */ insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback): void; @@ -73,7 +73,7 @@ export default class DataShareExtensionAbility { * default. * @param valueBucket Indicates the data to update. This parameter can be null. * @systemapi Hide this for inner system use. - * @return Returns the number of data records updated. + * @returns Returns the number of data records updated. * @StageModelOnly */ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBucket: ValuesBucket, @@ -88,15 +88,14 @@ export default class DataShareExtensionAbility { * @param predicates Indicates filter criteria. If this parameter is null, all data records will be deleted by * default. * @systemapi Hide this for inner system use. - * @return Returns the number of data records deleted. + * @returns Returns the number of data records deleted. * @StageModelOnly */ delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback): void; /** * Queries one or more data records in the database. This method should be implemented by a data share. - * - * @note Only RDB and distributed KVDB resultsets are supported. The current version does not support custom resultsets. + * Only RDB and distributed KVDB resultsets are supported. The current version does not support custom resultsets. * @since 9 * @syscap SystemCapability.DistributedDataManager.DataShare.Provider * @param uri Indicates the database table storing the data to query. @@ -105,7 +104,7 @@ export default class DataShareExtensionAbility { * @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. * @systemapi Hide this for inner system use. - * @return Returns the queried data, only support result set of rdb or kvstore. + * @returns Returns the queried data, only support result set of rdb or kvstore. * @StageModelOnly */ query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array, @@ -119,7 +118,7 @@ export default class DataShareExtensionAbility { * @param uri Indicates the position where the data is to insert. * @param valueBuckets Indicates the data to insert. * @systemapi Hide this for inner system use. - * @return Returns the number of data records inserted. + * @returns Returns the number of data records inserted. * @StageModelOnly */ batchInsert?(uri: string, valueBuckets: Array, callback: AsyncCallback): void; @@ -133,7 +132,7 @@ export default class DataShareExtensionAbility { * @syscap SystemCapability.DistributedDataManager.DataShare.Provider * @param uri Indicates the uri to normalize. * @systemapi Hide this for inner system use. - * @return Returns the normalized uri if the data share supports URI normalization; + * @returns Returns the normalized uri if the data share supports URI normalization; * @StageModelOnly */ normalizeUri?(uri: string, callback: AsyncCallback): void; @@ -146,7 +145,7 @@ export default class DataShareExtensionAbility { * @syscap SystemCapability.DistributedDataManager.DataShare.Provider * @param uri Indicates the uri to denormalize. * @systemapi Hide this for inner system use. - * @return Returns the denormalized {@code uri} object if the denormalization is successful; returns the original + * @returns 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 * the original {@code uri} cannot be found in the current environment. * @StageModelOnly diff --git a/api/@ohos.application.abilityDelegatorRegistry.d.ts b/api/@ohos.application.abilityDelegatorRegistry.d.ts index d8d7a51a5b..b5912a8143 100644 --- a/api/@ohos.application.abilityDelegatorRegistry.d.ts +++ b/api/@ohos.application.abilityDelegatorRegistry.d.ts @@ -24,7 +24,6 @@ import { ShellCmdResult as _ShellCmdResult } from './application/shellCmdResult' * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' * @permission N/A * @deprecated since 9 * @useinstead ohos.app.ability.abilityDelegatorRegistry @@ -35,7 +34,7 @@ declare namespace abilityDelegatorRegistry { * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return the AbilityDelegator object initialized when the application is started. + * @returns the AbilityDelegator object initialized when the application is started. */ function getAbilityDelegator(): AbilityDelegator; @@ -44,7 +43,7 @@ declare namespace abilityDelegatorRegistry { * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return the previously registered AbilityDelegatorArgs object. + * @returns the previously registered AbilityDelegatorArgs object. */ function getArguments(): AbilityDelegatorArgs; @@ -67,7 +66,6 @@ declare namespace abilityDelegatorRegistry { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityDelegator from 'application/abilityDelegator.d' */ export type AbilityDelegator = _AbilityDelegator @@ -76,7 +74,6 @@ declare namespace abilityDelegatorRegistry { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityDelegatorArgs from 'application/abilityDelegatorArgs.d' */ export type AbilityDelegatorArgs = _AbilityDelegatorArgs @@ -86,7 +83,6 @@ declare namespace abilityDelegatorRegistry { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityMonitor from 'application/abilityMonitor.d' */ export type AbilityMonitor = _AbilityMonitor @@ -95,7 +91,6 @@ declare namespace abilityDelegatorRegistry { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import ShellCmdResult from 'application/shellCmdResult.d' */ export type ShellCmdResult = _ShellCmdResult } diff --git a/api/@ohos.application.abilityManager.d.ts b/api/@ohos.application.abilityManager.d.ts index dfa26ab42b..af7747a0ef 100644 --- a/api/@ohos.application.abilityManager.d.ts +++ b/api/@ohos.application.abilityManager.d.ts @@ -52,7 +52,7 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @systemapi Hide this for inner system use. - * @return - + * @returns - * @permission ohos.permission.UPDATE_CONFIGURATION */ function updateConfiguration(config: Configuration, callback: AsyncCallback): void; @@ -64,7 +64,7 @@ declare namespace abilityManager { * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. - * @return Returns the array of {@link AbilityRunningInfo}. + * @returns Returns the array of {@link AbilityRunningInfo}. * @permission ohos.permission.GET_RUNNING_INFO */ function getAbilityRunningInfos(): Promise>; @@ -77,7 +77,7 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit Get the maximum limit of the number of messages * @systemapi Hide this for inner system use. - * @return Returns the array of {@link ExtensionRunningInfo}. + * @returns Returns the array of {@link ExtensionRunningInfo}. * @permission ohos.permission.GET_RUNNING_INFO */ function getExtensionRunningInfos(upperLimit: number): Promise>; @@ -89,7 +89,7 @@ declare namespace abilityManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. - * @return Returns the {@link ElementName} info of the top ability. + * @returns Returns the {@link ElementName} info of the top ability. */ function getTopAbility(): Promise; function getTopAbility(callback: AsyncCallback): void; diff --git a/api/@ohos.application.appManager.d.ts b/api/@ohos.application.appManager.d.ts index 3be17cb201..55a7bfcf71 100644 --- a/api/@ohos.application.appManager.d.ts +++ b/api/@ohos.application.appManager.d.ts @@ -25,7 +25,6 @@ import { ProcessRunningInformation as _ProcessRunningInformation } from './appli * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import appManager from '@ohos.application.appManager' * @permission N/A * @deprecated since 9 * @useinstead ohos.app.ability.appManager @@ -70,7 +69,7 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observer The application state observer. * @systemapi hide this for inner system use - * @return Returns the number code of the observer. + * @returns Returns the number code of the observer. * @permission ohos.permission.RUNNING_STATE_OBSERVER */ function registerApplicationStateObserver(observer: ApplicationStateObserver): number; @@ -84,7 +83,7 @@ declare namespace appManager { * @param observer The application state observer. * @param bundleNameList The list of bundleName. The max length is 128. * @systemapi - * @return Returns the number code of the observer. + * @returns Returns the number code of the observer. * @permission ohos.permission.RUNNING_STATE_OBSERVER */ function registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array): number; @@ -96,7 +95,7 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observerId Indicates the number code of the observer. * @systemapi hide this for inner system use - * @return - + * @returns - * @permission ohos.permission.RUNNING_STATE_OBSERVER */ function unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback): void; @@ -108,7 +107,7 @@ declare namespace appManager { * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use - * @return Returns the list of AppStateData. + * @returns Returns the list of AppStateData. * @permission ohos.permission.GET_RUNNING_INFO */ function getForegroundApplications(callback: AsyncCallback>): void; @@ -122,7 +121,7 @@ declare namespace appManager { * @param bundleName The process bundle name. * @param accountId The account id. * @systemapi hide this for inner system use - * @return - + * @returns - * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES */ function killProcessWithAccount(bundleName: string, accountId: number): Promise; @@ -133,7 +132,7 @@ declare namespace appManager { * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return Returns true if user is running stability test. + * @returns Returns true if user is running stability test. */ function isRunningInStabilityTest(callback: AsyncCallback): void; function isRunningInStabilityTest(): Promise; @@ -143,7 +142,7 @@ declare namespace appManager { * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return Returns the array of {@link ProcessRunningInfo}. + * @returns Returns the array of {@link ProcessRunningInfo}. * @permission ohos.permission.GET_RUNNING_INFO * @deprecated since 9 * @useinstead getProcessRunningInformation @@ -177,7 +176,7 @@ declare namespace appManager { * Is it a ram-constrained device * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return whether a ram-constrained device. + * @returns whether a ram-constrained device. */ function isRamConstrainedDevice(): Promise; function isRamConstrainedDevice(callback: AsyncCallback): void; @@ -186,7 +185,7 @@ declare namespace appManager { * Get the memory size of the application * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return application memory size. + * @returns application memory size. */ function getAppMemorySize(): Promise; function getAppMemorySize(callback: AsyncCallback): void; @@ -196,7 +195,7 @@ declare namespace appManager { * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return Returns the array of {@link ProcessRunningInformation}. + * @returns Returns the array of {@link ProcessRunningInformation}. * @permission ohos.permission.GET_RUNNING_INFO */ function getProcessRunningInformation(): Promise>; diff --git a/api/@ohos.application.errorManager.d.ts b/api/@ohos.application.errorManager.d.ts index 1709d8e029..57a490dc8b 100644 --- a/api/@ohos.application.errorManager.d.ts +++ b/api/@ohos.application.errorManager.d.ts @@ -21,7 +21,6 @@ import * as _ErrorObserver from './application/ErrorObserver'; * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import errorManager from '@ohos.application.errorManager' * @permission N/A * @deprecated since 9 * @useinstead ohos.app.ability.errorManager @@ -34,7 +33,7 @@ declare namespace errorManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observer The error observer. - * @return Returns the number code of the observer. + * @returns Returns the number code of the observer. */ function registerErrorObserver(observer: ErrorObserver): number; @@ -44,7 +43,7 @@ declare namespace errorManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observerId Indicates the number code of the observer. - * @return - + * @returns - */ function unregisterErrorObserver(observerId: number, callback: AsyncCallback): void; function unregisterErrorObserver(observerId: number): Promise; diff --git a/api/@ohos.continuation.continuationManager.d.ts b/api/@ohos.continuation.continuationManager.d.ts index 9b9cbe3304..4187bdd5d7 100644 --- a/api/@ohos.continuation.continuationManager.d.ts +++ b/api/@ohos.continuation.continuationManager.d.ts @@ -67,6 +67,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 + * @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceSelected") */ function on(type: "deviceConnect", callback: Callback): void; function off(type: "deviceConnect", callback?: Callback): void; @@ -80,6 +81,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 + * @useinstead ohos.continuation.continuationManager.continuationManager#on/off(type: "deviceUnSelected") */ function on(type: "deviceDisconnect", callback: Callback): void; function off(type: "deviceDisconnect", callback?: Callback): void; @@ -94,7 +96,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 - * @useinstead ohos.continuation.continuationManager.registerContinuation + * @useinstead ohos.continuation.continuationManager.continuationManager#registerContinuation */ function register(callback: AsyncCallback): void; function register(options: ContinuationExtraParams, callback: AsyncCallback): void; @@ -109,7 +111,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 - * @useinstead ohos.continuation.continuationManager.unregisterContinuation + * @useinstead ohos.continuation.continuationManager.continuationManager#unregisterContinuation */ function unregister(token: number, callback: AsyncCallback): void; function unregister(token: number): Promise; @@ -124,7 +126,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 - * @useinstead ohos.continuation.continuationManager.updateContinuationState + * @useinstead ohos.continuation.continuationManager.continuationManager#updateContinuationState */ function updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState, callback: AsyncCallback): void; function updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState): Promise; @@ -139,7 +141,7 @@ declare namespace continuationManager { * @syscap SystemCapability.Ability.DistributedAbilityManager * @since 8 * @deprecated since 9 - * @useinstead ohos.continuation.continuationManager.startContinuationDeviceManager + * @useinstead ohos.continuation.continuationManager.continuationManager#startContinuationDeviceManager */ function startDeviceManager(token: number, callback: AsyncCallback): void; function startDeviceManager(token: number, options: ContinuationExtraParams, callback: AsyncCallback): void; diff --git a/api/@ohos.enterpriseDeviceManager.d.ts b/api/@ohos.enterpriseDeviceManager.d.ts index 08f6c2cb53..050419401c 100644 --- a/api/@ohos.enterpriseDeviceManager.d.ts +++ b/api/@ohos.enterpriseDeviceManager.d.ts @@ -84,7 +84,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback): void; @@ -105,7 +105,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback): void; @@ -126,7 +126,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise; @@ -142,7 +142,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function disableAdmin(admin: Want, callback: AsyncCallback): void; @@ -159,7 +159,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function disableAdmin(admin: Want, userId: number, callback: AsyncCallback): void; @@ -176,7 +176,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function disableAdmin(admin: Want, userId?: number): Promise; @@ -192,7 +192,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function disableSuperAdmin(bundleName: String, callback: AsyncCallback): void; @@ -208,7 +208,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function disableSuperAdmin(bundleName: String): Promise; @@ -220,7 +220,7 @@ declare namespace enterpriseDeviceManager { * @throws { BusinessError } 401 - invalid input parameter. * @syscap SystemCapability.Customization.EnterpriseDeviceManager * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ function isAdminEnabled(admin: Want, callback: AsyncCallback): void; diff --git a/api/@ohos.wantAgent.d.ts b/api/@ohos.wantAgent.d.ts index 9863e89de4..bd03a29f6a 100644 --- a/api/@ohos.wantAgent.d.ts +++ b/api/@ohos.wantAgent.d.ts @@ -25,7 +25,6 @@ import { TriggerInfo as _TriggerInfo } from './wantAgent/triggerInfo'; * @name wantAgent * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import wantAgent from '@ohos.wantAgent'; * @permission N/A * @deprecated since 9 * @useinstead ohos.app.ability.wantAgent @@ -35,7 +34,7 @@ declare namespace wantAgent { * Obtains the bundle name of a WantAgent. * * @param WantAgent whose bundle name to obtain. - * @return Returns the bundle name of the {@link WantAgent} if any. + * @returns Returns the bundle name of the {@link WantAgent} if any. */ function getBundleName(agent: WantAgent, callback: AsyncCallback): void; function getBundleName(agent: WantAgent): Promise; @@ -44,7 +43,7 @@ declare namespace wantAgent { * Obtains the UID of a WantAgent. * * @param WantAgent whose UID to obtain. - * @return Returns the UID of the {@link WantAgent} if any; returns {@code -1} otherwise. + * @returns Returns the UID of the {@link WantAgent} if any; returns {@code -1} otherwise. */ function getUid(agent: WantAgent, callback: AsyncCallback): void; function getUid(agent: WantAgent): Promise; @@ -53,7 +52,7 @@ declare namespace wantAgent { * Obtains the {@link Want} of an {@link WantAgent}. * * @param agent Indicates the {@link WantAgent} whose UID is to be obtained. - * @return Returns the {@link Want} of the {@link WantAgent}. + * @returns Returns the {@link Want} of the {@link WantAgent}. * @systemapi Hide this for inner system use. */ function getWant(agent: WantAgent, callback: AsyncCallback): void; @@ -62,7 +61,7 @@ declare namespace wantAgent { * Obtains the {@link Want} of an {@link WantAgent}. * * @param agent Indicates the {@link WantAgent} whose UID is to be obtained. - * @return Returns the {@link Want} of the {@link WantAgent}. + * @returns Returns the {@link Want} of the {@link WantAgent}. * @systemapi Hide this for inner system use. */ function getWant(agent: WantAgent): Promise; @@ -99,7 +98,7 @@ declare namespace wantAgent { * * @param WantAgent to compare. * @param WantAgent to compare. - * @return Returns {@code true} If the two objects are the same; returns {@code false} otherwise. + * @returns Returns {@code true} If the two objects are the same; returns {@code false} otherwise. */ function equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback): void; function equal(agent: WantAgent, otherAgent: WantAgent): Promise; @@ -108,7 +107,7 @@ declare namespace wantAgent { * Obtains a WantAgent object. * * @param Information about the WantAgent object to obtain. - * @return Returns the created {@link WantAgent} object. + * @returns Returns the created {@link WantAgent} object. */ function getWantAgent(info: WantAgentInfo, callback: AsyncCallback): void; function getWantAgent(info: WantAgentInfo): Promise; @@ -118,7 +117,7 @@ declare namespace wantAgent { * * @since 9 * @param agent Indicates the {@link WantAgent} whose {@link OperationType} is to be obtained. - * @return Returns the {@link OperationType} of the {@link WantAgent}. + * @returns Returns the {@link OperationType} of the {@link WantAgent}. */ function getOperationType(agent: WantAgent, callback: AsyncCallback): void; function getOperationType(agent: WantAgent): Promise; diff --git a/api/app/context.d.ts b/api/app/context.d.ts index e24a3dd24b..2b013c7799 100644 --- a/api/app/context.d.ts +++ b/api/app/context.d.ts @@ -40,12 +40,12 @@ export interface Context extends BaseContext { /** * Get the local root dir of an app. If it is the first call, the dir * will be created. - * @note If in the context of the ability, return the root dir of + * If in the context of the ability, return the root dir of * the ability; if in the context of the application, return the * root dir of the application. * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return the root dir + * @returns the root dir * @FAModelOnly */ getOrCreateLocalDir(): Promise; @@ -53,14 +53,14 @@ export interface Context extends BaseContext { /** * Verify whether the specified permission is allowed for a particular * pid and uid running in the system. + * Pid and uid are optional. If you do not pass in pid and uid, + * it will check your own permission. * @param permission The name of the specified permission * @param pid process id * @param uid user id - * @note Pid and uid are optional. If you do not pass in pid and uid, - * it will check your own permission. * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return asynchronous callback with {@code 0} if the PID + * @returns asynchronous callback with {@code 0} if the PID * and UID have the permission; callback with {@code -1} otherwise. * @FAModelOnly */ @@ -253,7 +253,7 @@ export interface Context extends BaseContext { * Checks whether the configuration of this ability is changing. * @since 7 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @return true if the configuration of this ability is changing and false otherwise. + * @returns true if the configuration of this ability is changing and false otherwise. * @FAModelOnly */ isUpdatingConfigurations(callback: AsyncCallback): void; diff --git a/api/application/AbilityContext.d.ts b/api/application/AbilityContext.d.ts index 64c9ea8ba9..ae63cabcb6 100755 --- a/api/application/AbilityContext.d.ts +++ b/api/application/AbilityContext.d.ts @@ -32,7 +32,7 @@ import image from '../@ohos.multimedia.image'; /** * The context of an ability. It allows access to ability-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class AbilityContext extends Context { @@ -40,7 +40,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an ability. * @type { AbilityInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ abilityInfo: AbilityInfo; @@ -49,7 +49,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about the module. * @type { HapModuleInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ currentHapModuleInfo: HapModuleInfo; @@ -58,7 +58,7 @@ export default class AbilityContext extends Context { * Indicates configuration information. * @type { Configuration } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ config: Configuration; @@ -69,7 +69,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -81,7 +81,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -93,7 +93,7 @@ export default class AbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options?: StartOptions): Promise; @@ -105,7 +105,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityByCall(want: Want): Promise; @@ -119,7 +119,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -134,7 +134,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; @@ -149,7 +149,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; @@ -160,7 +160,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, callback: AsyncCallback): void; @@ -172,7 +172,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -184,7 +184,7 @@ export default class AbilityContext extends Context { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, options?: StartOptions): Promise; @@ -198,7 +198,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -213,7 +213,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; @@ -228,7 +228,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; @@ -240,7 +240,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -252,7 +252,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want): Promise; @@ -266,7 +266,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -280,7 +280,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -292,7 +292,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -304,7 +304,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want): Promise; @@ -318,7 +318,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -332,7 +332,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -342,7 +342,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of terminateSelf. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(callback: AsyncCallback): void; @@ -352,7 +352,7 @@ export default class AbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(): Promise; @@ -364,7 +364,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; @@ -376,7 +376,7 @@ export default class AbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelfWithResult(parameter: AbilityResult): Promise; @@ -434,7 +434,7 @@ export default class AbilityContext extends Context { * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; @@ -449,7 +449,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; @@ -460,7 +460,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of disconnectAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number, callback: AsyncCallback): void; @@ -471,7 +471,7 @@ export default class AbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number): Promise; @@ -482,7 +482,7 @@ export default class AbilityContext extends Context { * @param { AsyncCallback } callback - The callback of setMissionLabel. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionLabel(label: string, callback: AsyncCallback): void; @@ -493,7 +493,7 @@ export default class AbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionLabel(label: string): Promise; @@ -505,7 +505,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionIcon(icon: image.PixelMap, callback: AsyncCallback): void; @@ -517,7 +517,7 @@ export default class AbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionIcon(icon: image.PixelMap): Promise; @@ -530,7 +530,7 @@ export default class AbilityContext extends Context { * request result. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ requestPermissionsFromUser(permissions: Array, requestCallback: AsyncCallback): void; @@ -542,7 +542,7 @@ export default class AbilityContext extends Context { * @returns { Promise } Returns the permission request result. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ requestPermissionsFromUser(permissions: Array): Promise; @@ -552,7 +552,7 @@ export default class AbilityContext extends Context { * @param { LocalStorage } localStorage - the storage data used to restore window stage * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ restoreWindowStage(localStorage: LocalStorage): void; @@ -561,7 +561,7 @@ export default class AbilityContext extends Context { * check to see ability is in terminating state. * @returns { boolean } Returns true when ability is in terminating state, else returns false. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ isTerminating(): boolean; diff --git a/api/application/ApplicationContext.d.ts b/api/application/ApplicationContext.d.ts index 8fc1e3b46f..891d661146 100755 --- a/api/application/ApplicationContext.d.ts +++ b/api/application/ApplicationContext.d.ts @@ -22,7 +22,7 @@ import { ProcessRunningInformation } from "./ProcessRunningInformation"; /** * The context of an application. It allows access to application-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class ApplicationContext extends Context { @@ -32,7 +32,7 @@ export default class ApplicationContext extends Context { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param callback The ability lifecycle callback. - * @return Returns the number code of the callback. + * @returns Returns the number code of the callback. * @StageModelOnly * @deprecated since 9 * @useinstead on @@ -45,7 +45,7 @@ export default class ApplicationContext extends Context { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param callbackId Indicates the number code of the callback. - * @return - + * @returns - * @StageModelOnly * @deprecated since 9 * @useinstead off @@ -59,7 +59,7 @@ export default class ApplicationContext extends Context { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param callback The environment callback. - * @return Returns the number code of the callback. + * @returns Returns the number code of the callback. * @StageModelOnly * @deprecated since 9 * @useinstead on @@ -72,7 +72,7 @@ export default class ApplicationContext extends Context { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param callbackId Indicates the number code of the callback. - * @return - + * @returns - * @StageModelOnly * @deprecated since 9 * @useinstead off @@ -87,7 +87,7 @@ export default class ApplicationContext extends Context { * @returns { number } Returns the number code of the callback. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ on(type: "abilityLifecycle", callback: AbilityLifecycleCallback): number; @@ -99,7 +99,7 @@ export default class ApplicationContext extends Context { * @param { AsyncCallback } callback - The callback of off. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "abilityLifecycle", callbackId: number, callback: AsyncCallback): void; @@ -111,7 +111,7 @@ export default class ApplicationContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "abilityLifecycle", callbackId: number): Promise; @@ -123,7 +123,7 @@ export default class ApplicationContext extends Context { * @returns { number } Returns the number code of the callback. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ on(type: "environment", callback: EnvironmentCallback): number; @@ -135,7 +135,7 @@ export default class ApplicationContext extends Context { * @param { AsyncCallback } callback - The callback of unregisterEnvironmentCallback. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "environment", callbackId: number, callback: AsyncCallback): void; @@ -147,7 +147,7 @@ export default class ApplicationContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(type: "environment", callbackId: number): Promise; @@ -157,7 +157,7 @@ export default class ApplicationContext extends Context { * @returns { Promise> } Returns the array of {@link ProcessRunningInformation}. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ getProcessRunningInformation(): Promise>; @@ -167,7 +167,7 @@ export default class ApplicationContext extends Context { * @param { AsyncCallback> } callback - The callback is used to return the array of {@link ProcessRunningInformation}. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ getProcessRunningInformation(callback: AsyncCallback>): void; @@ -177,7 +177,7 @@ export default class ApplicationContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ killProcessesBySelf(): Promise; @@ -187,7 +187,7 @@ export default class ApplicationContext extends Context { * @param { AsyncCallback } callback - The callback of killProcessesBySelf. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ killProcessesBySelf(callback: AsyncCallback); diff --git a/api/application/ApplicationStateObserver.d.ts b/api/application/ApplicationStateObserver.d.ts index 71cab9a6b3..3833740a53 100644 --- a/api/application/ApplicationStateObserver.d.ts +++ b/api/application/ApplicationStateObserver.d.ts @@ -33,7 +33,7 @@ export default class ApplicationStateObserver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param appStateData State changed Application info. * @systemapi hide for inner use. - * @return - + * @returns - */ onForegroundApplicationChanged(appStateData: AppStateData): void; @@ -44,7 +44,7 @@ export default class ApplicationStateObserver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param abilityStateData State changed ability info. * @systemapi hide for inner use. - * @return - + * @returns - */ onAbilityStateChanged(abilityStateData: AbilityStateData): void; @@ -55,7 +55,7 @@ export default class ApplicationStateObserver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. - * @return - + * @returns - */ onProcessCreated(processData: ProcessData): void; @@ -66,7 +66,7 @@ export default class ApplicationStateObserver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. - * @return - + * @returns - */ onProcessDied(processData: ProcessData): void; @@ -77,7 +77,7 @@ export default class ApplicationStateObserver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. - * @return - + * @returns - */ onProcessStateChanged(processData: ProcessData): void; } diff --git a/api/application/Context.d.ts b/api/application/Context.d.ts index 67b1316ac0..20f40a64a0 100755 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -23,7 +23,7 @@ import ApplicationContext from "./ApplicationContext"; * The base context of an ability or an application. It allows access to * application-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class Context extends BaseContext { @@ -31,7 +31,7 @@ export default class Context extends BaseContext { * Indicates the capability of accessing application resources. * @type { resmgr.ResourceManager } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ resourceManager: resmgr.ResourceManager; @@ -40,7 +40,7 @@ export default class Context extends BaseContext { * Indicates configuration information about an application. * @type { ApplicationInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ applicationInfo: ApplicationInfo; @@ -49,7 +49,7 @@ export default class Context extends BaseContext { * Indicates app cache dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ cacheDir: string; @@ -58,7 +58,7 @@ export default class Context extends BaseContext { * Indicates app temp dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ tempDir: string; @@ -67,7 +67,7 @@ export default class Context extends BaseContext { * Indicates app files dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ filesDir: string; @@ -76,7 +76,7 @@ export default class Context extends BaseContext { * Indicates app database dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ databaseDir: string; @@ -85,7 +85,7 @@ export default class Context extends BaseContext { * Indicates app preferences dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ preferencesDir: string; @@ -94,7 +94,7 @@ export default class Context extends BaseContext { * Indicates app bundle code dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ bundleCodeDir: string; @@ -103,7 +103,7 @@ export default class Context extends BaseContext { * Indicates app distributed files dir. * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ distributedFilesDir: string; @@ -112,7 +112,7 @@ export default class Context extends BaseContext { * Indicates event hub. * @type { EventHub } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ eventHub: EventHub; @@ -121,7 +121,7 @@ export default class Context extends BaseContext { * Indicates file area. * @type { AreaMode } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ area: AreaMode; @@ -134,7 +134,7 @@ export default class Context extends BaseContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ createBundleContext(bundleName: string): Context; @@ -145,7 +145,7 @@ export default class Context extends BaseContext { * @returns { Context } Returns the application context. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ createModuleContext(moduleName: string): Context; @@ -158,7 +158,7 @@ export default class Context extends BaseContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ createModuleContext(bundleName: string, moduleName: string): Context; @@ -167,7 +167,7 @@ export default class Context extends BaseContext { * Get application context * @returns { ApplicationContext } Returns the application context. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ getApplicationContext(): ApplicationContext; @@ -177,7 +177,7 @@ export default class Context extends BaseContext { * Enum for the file area mode * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export enum AreaMode { diff --git a/api/application/ErrorObserver.d.ts b/api/application/ErrorObserver.d.ts index 4765185428..0e6912defe 100644 --- a/api/application/ErrorObserver.d.ts +++ b/api/application/ErrorObserver.d.ts @@ -27,7 +27,7 @@ export default class ErrorObserver { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param errMsg the message and error stacktrace about the exception. - * @return - + * @returns - */ onUnhandledException(errMsg: string): void; } \ No newline at end of file diff --git a/api/application/EventHub.d.ts b/api/application/EventHub.d.ts index 6947fca11f..5c94424b9f 100644 --- a/api/application/EventHub.d.ts +++ b/api/application/EventHub.d.ts @@ -18,7 +18,7 @@ import { BusinessError } from '../basic'; /** * The event center of a context, support the subscription and publication of events. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class EventHub { @@ -28,7 +28,7 @@ export default class EventHub { * @param { Function } callback - Indicates the callback. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ on(event: string, callback: Function): void @@ -39,7 +39,7 @@ export default class EventHub { * @param { Function } callback - Indicates the callback. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ off(event: string, callback?: Function): void @@ -50,7 +50,7 @@ export default class EventHub { * @param { Object[] } args - Indicates the callback arguments. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ emit(event: string, ...args: Object[]): void diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index 95952a3bb0..062c5033ba 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -22,7 +22,7 @@ import Want from '../@ohos.application.Want'; * The context of form extension. It allows access to * formExtension-specific resources. * @syscap SystemCapability.Ability.Form - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class FormExtensionContext extends ExtensionContext { @@ -33,7 +33,7 @@ export default class FormExtensionContext extends ExtensionContext { * @returns { Promise } The promise returned by the function. * @syscap SystemCapability.Ability.Form * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, callback: AsyncCallback): void; diff --git a/api/application/MissionListener.d.ts b/api/application/MissionListener.d.ts index e80aaa7d62..c40968b279 100644 --- a/api/application/MissionListener.d.ts +++ b/api/application/MissionListener.d.ts @@ -31,7 +31,7 @@ import image from "../@ohos.multimedia.image"; * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of created mission. - * @return - + * @returns - */ onMissionCreated(mission: number): void; @@ -41,7 +41,7 @@ import image from "../@ohos.multimedia.image"; * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of destroyed mission. - * @return - + * @returns - */ onMissionDestroyed(mission: number): void; @@ -51,7 +51,7 @@ import image from "../@ohos.multimedia.image"; * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of the mission which the snapshot changes - * @return - + * @returns - */ onMissionSnapshotChanged(mission: number): void; @@ -61,7 +61,7 @@ import image from "../@ohos.multimedia.image"; * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of the mission being moved to the foreground. - * @return - + * @returns - */ onMissionMovedToFront(mission: number): void; @@ -71,7 +71,7 @@ import image from "../@ohos.multimedia.image"; * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of the mission whose label has changed. - * @return - + * @returns - */ onMissionLabelUpdated(mission: number): void; @@ -82,7 +82,7 @@ import image from "../@ohos.multimedia.image"; * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of the mission whose icon has changed. * @param icon Indicates the icon of the mission whose icon has changed. - * @return - + * @returns - */ onMissionIconUpdated(mission: number, icon: image.PixelMap): void; @@ -92,7 +92,7 @@ import image from "../@ohos.multimedia.image"; * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param mission Indicates the id of the mission whose ability instance is destroyed. - * @return - + * @returns - */ onMissionClosed(mission: number): void; } \ No newline at end of file diff --git a/api/application/ServiceExtensionContext.d.ts b/api/application/ServiceExtensionContext.d.ts index acc02d4176..f2a68b6f2b 100644 --- a/api/application/ServiceExtensionContext.d.ts +++ b/api/application/ServiceExtensionContext.d.ts @@ -25,7 +25,7 @@ import StartOptions from "../@ohos.app.ability.StartOptions"; * serviceExtension-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class ServiceExtensionContext extends ExtensionContext { @@ -36,7 +36,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -49,7 +49,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -62,7 +62,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options?: StartOptions): Promise; @@ -75,7 +75,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -89,7 +89,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; @@ -103,7 +103,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; @@ -115,7 +115,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -127,7 +127,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want): Promise; @@ -141,7 +141,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -155,7 +155,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -167,7 +167,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -179,7 +179,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want): Promise; @@ -193,7 +193,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -207,7 +207,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -218,7 +218,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(callback: AsyncCallback): void; @@ -229,7 +229,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(): Promise; @@ -246,7 +246,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @param want Indicates the service extension to connect. * @param options Indicates the callback of connection. * @systemapi hide for inner use. - * @return connection id, int value. + * @returns connection id, int value. * @StageModelOnly * @deprecated since 9 * @useinstead connectServiceExtensionAbility @@ -266,7 +266,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @param accountId Indicates the account to connect. * @param options Indicates the callback of connection. * @systemapi hide for inner use. - * @return connection id, int value. + * @returns connection id, int value. * @StageModelOnly * @deprecated since 9 * @useinstead connectServiceExtensionAbilityWithAccount @@ -281,7 +281,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param connection the connection id returned from connectAbility api. * @systemapi hide for inner use. - * @return - + * @returns - * @StageModelOnly * @deprecated since 9 * @useinstead disconnectServiceExtensionAbility @@ -299,7 +299,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @returns { number } Returns the connection id. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; @@ -316,7 +316,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; @@ -327,7 +327,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @param { AsyncCallback } callback - The callback of disconnectAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number, callback: AsyncCallback): void; @@ -338,7 +338,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number): Promise; @@ -350,7 +350,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityByCall(want: Want): Promise; diff --git a/api/application/UIAbilityContext.d.ts b/api/application/UIAbilityContext.d.ts index 0c5e2e0f64..0d81c7dc1c 100755 --- a/api/application/UIAbilityContext.d.ts +++ b/api/application/UIAbilityContext.d.ts @@ -32,7 +32,7 @@ import image from '../@ohos.multimedia.image'; /** * The context of an ability. It allows access to ability-specific resources. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ export default class UIAbilityContext extends Context { @@ -40,7 +40,7 @@ export default class UIAbilityContext extends Context { * Indicates configuration information about an ability. * @type { AbilityInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ abilityInfo: AbilityInfo; @@ -49,7 +49,7 @@ export default class UIAbilityContext extends Context { * Indicates configuration information about the module. * @type { HapModuleInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ currentHapModuleInfo: HapModuleInfo; @@ -58,7 +58,7 @@ export default class UIAbilityContext extends Context { * Indicates configuration information. * @type { Configuration } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ config: Configuration; @@ -69,7 +69,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -81,7 +81,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -93,7 +93,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbility(want: Want, options?: StartOptions): Promise; @@ -105,7 +105,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityByCall(want: Want): Promise; @@ -119,7 +119,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -134,7 +134,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; @@ -149,7 +149,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; @@ -160,7 +160,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, callback: AsyncCallback): void; @@ -172,7 +172,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback is used to return the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback): void; @@ -184,7 +184,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the result of startAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResult(want: Want, options?: StartOptions): Promise; @@ -198,7 +198,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -213,7 +213,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void; @@ -228,7 +228,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise; @@ -240,7 +240,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -252,7 +252,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbility(want: Want): Promise; @@ -266,7 +266,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -280,7 +280,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -292,7 +292,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want, callback: AsyncCallback): void; @@ -304,7 +304,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbility(want: Want): Promise; @@ -318,7 +318,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void; @@ -332,7 +332,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise; @@ -342,7 +342,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of terminateSelf. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(callback: AsyncCallback): void; @@ -352,7 +352,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelf(): Promise; @@ -364,7 +364,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of terminateSelfWithResult. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; @@ -376,7 +376,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ terminateSelfWithResult(parameter: AbilityResult): Promise; @@ -388,7 +388,7 @@ export default class UIAbilityContext extends Context { * @returns { number } Returns the number code of the ability connected * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; @@ -403,7 +403,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number; @@ -414,7 +414,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of disconnectAbility. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number, callback: AsyncCallback): void; @@ -425,7 +425,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ disconnectServiceExtensionAbility(connection: number): Promise; @@ -436,7 +436,7 @@ export default class UIAbilityContext extends Context { * @param { AsyncCallback } callback - The callback of setMissionLabel. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionLabel(label: string, callback: AsyncCallback): void; @@ -447,7 +447,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionLabel(label: string): Promise; @@ -459,7 +459,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionIcon(icon: image.PixelMap, callback: AsyncCallback): void; @@ -471,7 +471,7 @@ export default class UIAbilityContext extends Context { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @stagemodelonly + * @StageModelOnly * @since 9 */ setMissionIcon(icon: image.PixelMap): Promise; @@ -484,7 +484,7 @@ export default class UIAbilityContext extends Context { * request result. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ requestPermissionsFromUser(permissions: Array, requestCallback: AsyncCallback): void; @@ -496,7 +496,7 @@ export default class UIAbilityContext extends Context { * @returns { Promise } Returns the permission request result. * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ requestPermissionsFromUser(permissions: Array): Promise; @@ -506,7 +506,7 @@ export default class UIAbilityContext extends Context { * @param { LocalStorage } localStorage - the storage data used to restore window stage * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ restoreWindowStage(localStorage: LocalStorage): void; @@ -515,7 +515,7 @@ export default class UIAbilityContext extends Context { * Check to see ability is in terminating state. * @returns { boolean } Returns true when ability is in terminating state, else returns false. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @stagemodelonly + * @StageModelOnly * @since 9 */ isTerminating(): boolean; diff --git a/api/application/abilityDelegator.d.ts b/api/application/abilityDelegator.d.ts index 0cabc49f03..7057c64bff 100644 --- a/api/application/abilityDelegator.d.ts +++ b/api/application/abilityDelegator.d.ts @@ -296,7 +296,7 @@ export interface AbilityDelegator { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param cmd Shell command * @param timeoutSecs Timeout, in seconds - * @return ShellCmdResult object + * @returns ShellCmdResult object */ executeShellCommand(cmd: string, callback: AsyncCallback): void; executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback): void; diff --git a/api/application/abilityDelegatorArgs.d.ts b/api/application/abilityDelegatorArgs.d.ts index f140bc13d8..b61dadb149 100644 --- a/api/application/abilityDelegatorArgs.d.ts +++ b/api/application/abilityDelegatorArgs.d.ts @@ -19,7 +19,6 @@ * * @since 8 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityDelegatorArgs from 'application/abilityDelegatorArgs.d' * @permission N/A */ export interface AbilityDelegatorArgs { diff --git a/api/application/abilityMonitor.d.ts b/api/application/abilityMonitor.d.ts index 0e37ca308d..d613f964db 100644 --- a/api/application/abilityMonitor.d.ts +++ b/api/application/abilityMonitor.d.ts @@ -21,7 +21,6 @@ import UIAbility from '../@ohos.app.ability.UIAbility'; * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityMonitor from 'application/abilityMonitor.d' * @permission N/A */ export interface AbilityMonitor { diff --git a/api/application/abilityStageMonitor.d.ts b/api/application/abilityStageMonitor.d.ts index 6ca989090d..cbe57c44db 100644 --- a/api/application/abilityStageMonitor.d.ts +++ b/api/application/abilityStageMonitor.d.ts @@ -19,7 +19,6 @@ * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @import import AbilityStageMonitor from 'application/AbilityStageMonitor.d' * @permission N/A */ export interface AbilityStageMonitor { diff --git a/api/common/full/featureability.d.ts b/api/common/full/featureability.d.ts index 308fe6727f..bca1c29fe1 100644 --- a/api/common/full/featureability.d.ts +++ b/api/common/full/featureability.d.ts @@ -295,6 +295,7 @@ export interface FinishWithResultParams { /** * @since 5 * @deprecated since 8 + * @useinstead ohos.ability.featureAbility.FeatureAbility */ export declare class FeatureAbility { /** @@ -303,6 +304,7 @@ export declare class FeatureAbility { * @returns A Promise object is returned, which contains the result of whether to call Ability's interface successfully. * @since 5 * @deprecated since 8 + * @useinstead ohos.ability.featureAbility.FeatureAbility#startAbility */ static startAbility(request: RequestParams): Promise; @@ -312,6 +314,7 @@ export declare class FeatureAbility { * @returns A Promise object is returned, which contains the result of the data FA returned. * @since 5 * @deprecated since 8 + * @useinstead ohos.ability.featureAbility.FeatureAbility#startAbilityForResult */ static startAbilityForResult(request: RequestParams): Promise; @@ -321,11 +324,11 @@ export declare class FeatureAbility { * @returns A Promise object is returned, which contains the result whether to callback successfully. * @since 5 * @deprecated since 8 + * @useinstead ohos.ability.featureAbility.FeatureAbility#terminateSlefWithResult */ static finishWithResult(param: FinishWithResultParams): Promise; /** - * Get device information list. * @param flag Default 0, get the information list of all devices in the network. * @returns A Promise object is returned, which contains the result whether the device information list is obtained successfully. diff --git a/api/common/lite/featureability.d.ts b/api/common/lite/featureability.d.ts index 3b1d820d99..ebfe0fa4b0 100644 --- a/api/common/lite/featureability.d.ts +++ b/api/common/lite/featureability.d.ts @@ -118,6 +118,7 @@ export interface SubscribeMessageOptions { * @since 5 * @systemapi * @deprecated since 8 + * @useinstead ohos.ability.featureAbility.FeatureAbility */ export declare class FeatureAbility { /** -- Gitee