api lint 告警清除

Signed-off-by: anchi <anchi1@huawei.com>
This commit is contained in:
anchi 2024-07-05 10:04:35 +08:00
parent 24e31ee6cd
commit 5139285c70
4 changed files with 55 additions and 17 deletions

View File

@ -25,6 +25,7 @@ import _WorkSchedulerExtensionContext from './application/WorkSchedulerExtension
* The context of work scheduler extension. It allows access to * The context of work scheduler extension. It allows access to
* WorkSchedulerExtensionContext-specific resources. * WorkSchedulerExtensionContext-specific resources.
* *
* @typedef { _WorkSchedulerExtensionContext }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 10 * @since 10
@ -42,6 +43,7 @@ export default class WorkSchedulerExtensionAbility {
/** /**
* Indicates work scheduler extension ability context. * Indicates work scheduler extension ability context.
* *
* @type { WorkSchedulerExtensionContext }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 10 * @since 10

View File

@ -36,8 +36,8 @@ declare namespace backgroundTaskManager {
* *
* @name DelaySuspendInfo * @name DelaySuspendInfo
* @interface DelaySuspendInfo * @interface DelaySuspendInfo
* @since 7
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 7
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo * @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo
*/ */
@ -45,8 +45,9 @@ declare namespace backgroundTaskManager {
/** /**
* The unique identifier of the delay request. * The unique identifier of the delay request.
* *
* @since 7 * @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 7
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo * @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo
*/ */
@ -54,8 +55,9 @@ declare namespace backgroundTaskManager {
/** /**
* The actual delay duration (ms). * The actual delay duration (ms).
* *
* @since 7 * @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 7
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo * @useinstead ohos.resourceschedule.backgroundTaskManager.DelaySuspendInfo
*/ */
@ -65,9 +67,9 @@ declare namespace backgroundTaskManager {
/** /**
* Cancels delayed transition to the suspended state. * Cancels delayed transition to the suspended state.
* *
* @since 7
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @param { number } requestId Indicates the identifier of the delay request. * @param { number } requestId Indicates the identifier of the delay request.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 7
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.cancelSuspendDelay * @useinstead ohos.resourceschedule.backgroundTaskManager.cancelSuspendDelay
*/ */
@ -99,11 +101,11 @@ declare namespace backgroundTaskManager {
/** /**
* Requests delayed transition to the suspended state. * Requests delayed transition to the suspended state.
* *
* @since 7
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @param { string } reason Indicates the reason for delayed transition to the suspended state. * @param { string } reason Indicates the reason for delayed transition to the suspended state.
* @param { Callback<void> } callback The callback delay time expired. * @param { Callback<void> } callback The callback delay time expired.
* @returns { DelaySuspendInfo } Info of delay request * @returns { DelaySuspendInfo } Info of delay request
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 7
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.requestSuspendDelay * @useinstead ohos.resourceschedule.backgroundTaskManager.requestSuspendDelay
*/ */
@ -167,8 +169,8 @@ declare namespace backgroundTaskManager {
* Supported background mode. * Supported background mode.
* *
* @enum { number } * @enum { number }
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9 * @deprecated since 9
* @useinstead ohos.resourceschedule.backgroundTaskManager.BackgroundMode * @useinstead ohos.resourceschedule.backgroundTaskManager.BackgroundMode
*/ */
@ -176,66 +178,74 @@ declare namespace backgroundTaskManager {
/** /**
* data transfer mode * data transfer mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
DATA_TRANSFER = 1, DATA_TRANSFER = 1,
/** /**
* audio playback mode * audio playback mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
AUDIO_PLAYBACK = 2, AUDIO_PLAYBACK = 2,
/** /**
* audio recording mode * audio recording mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
AUDIO_RECORDING = 3, AUDIO_RECORDING = 3,
/** /**
* location mode * location mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
LOCATION = 4, LOCATION = 4,
/** /**
* bluetooth interaction mode * bluetooth interaction mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
BLUETOOTH_INTERACTION = 5, BLUETOOTH_INTERACTION = 5,
/** /**
* multi-device connection mode * multi-device connection mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
MULTI_DEVICE_CONNECTION = 6, MULTI_DEVICE_CONNECTION = 6,
/** /**
* wifi interaction mode * wifi interaction mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 8
* @deprecated since 9
*/ */
WIFI_INTERACTION = 7, WIFI_INTERACTION = 7,
/** /**
* Voice over Internet Phone mode * Voice over Internet Phone mode
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 8
* @deprecated since 9
*/ */
VOIP = 8, VOIP = 8,
@ -243,8 +253,9 @@ declare namespace backgroundTaskManager {
* background continuous calculate mode, for example 3D render. * background continuous calculate mode, for example 3D render.
* only supported in particular device * only supported in particular device
* *
* @since 8
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 8
* @deprecated since 9
*/ */
TASK_KEEPING = 9, TASK_KEEPING = 9,
} }

View File

@ -27,6 +27,7 @@ import type notificationManager from './@ohos.notificationManager';
* Manages background tasks. * Manages background tasks.
* *
* @namespace backgroundTaskManager * @namespace backgroundTaskManager
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.Core
* @since 9 * @since 9
*/ */
declare namespace backgroundTaskManager { declare namespace backgroundTaskManager {
@ -41,6 +42,7 @@ declare namespace backgroundTaskManager {
/** /**
* The unique identifier of the delay request. * The unique identifier of the delay request.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9 * @since 9
*/ */
@ -48,6 +50,7 @@ declare namespace backgroundTaskManager {
/** /**
* The actual delay duration (ms). * The actual delay duration (ms).
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9 * @since 9
*/ */
@ -517,6 +520,7 @@ declare namespace backgroundTaskManager {
/** /**
* The set of resource types that app wants to apply. * The set of resource types that app wants to apply.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9
@ -526,6 +530,7 @@ declare namespace backgroundTaskManager {
/** /**
* True if the app begin to use, else false. * True if the app begin to use, else false.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9
@ -535,6 +540,7 @@ declare namespace backgroundTaskManager {
/** /**
* The duration that the resource can be used most. * The duration that the resource can be used most.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9
@ -544,6 +550,7 @@ declare namespace backgroundTaskManager {
/** /**
* True if the apply action is persist, else false. Default value is false. * True if the apply action is persist, else false. Default value is false.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9
@ -553,6 +560,7 @@ declare namespace backgroundTaskManager {
/** /**
* True if apply action is for process, false is for package. Default value is false. * True if apply action is for process, false is for package. Default value is false.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9
@ -562,6 +570,7 @@ declare namespace backgroundTaskManager {
/** /**
* The apply reason. * The apply reason.
* *
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply * @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use. * @systemapi Hide this for inner system use.
* @since 9 * @since 9

View File

@ -41,6 +41,7 @@ declare namespace workScheduler {
/** /**
* The id of the current work. * The id of the current work.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -49,6 +50,7 @@ declare namespace workScheduler {
/** /**
* The bundle name of the current work. * The bundle name of the current work.
* *
* @type { string }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -57,6 +59,7 @@ declare namespace workScheduler {
/** /**
* The ability name of the current work. * The ability name of the current work.
* *
* @type { string }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -65,6 +68,7 @@ declare namespace workScheduler {
/** /**
* Whether the current work will be saved. * Whether the current work will be saved.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -73,6 +77,7 @@ declare namespace workScheduler {
/** /**
* The network type of the current work. * The network type of the current work.
* *
* @type { NetworkType }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -81,6 +86,7 @@ declare namespace workScheduler {
/** /**
* Whether a charging state has been set for triggering the work. * Whether a charging state has been set for triggering the work.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -89,6 +95,7 @@ declare namespace workScheduler {
/** /**
* The charger type based on which the work is triggered. * The charger type based on which the work is triggered.
* *
* @type { ChargingType }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -97,6 +104,7 @@ declare namespace workScheduler {
/** /**
* The battery level for triggering a work. * The battery level for triggering a work.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -105,6 +113,7 @@ declare namespace workScheduler {
/** /**
* The battery status for triggering a work. * The battery status for triggering a work.
* *
* @type { BatteryStatus }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -113,6 +122,7 @@ declare namespace workScheduler {
/** /**
* Whether a storage state has been set for triggering the work. * Whether a storage state has been set for triggering the work.
* *
* @type { StorageRequest }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -121,6 +131,7 @@ declare namespace workScheduler {
/** /**
* The interval at which the work is repeated. * The interval at which the work is repeated.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -129,6 +140,7 @@ declare namespace workScheduler {
/** /**
* Whether the work has been set to repeat at the specified interval. * Whether the work has been set to repeat at the specified interval.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -137,6 +149,7 @@ declare namespace workScheduler {
/** /**
* The repeat of the current work. * The repeat of the current work.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -145,6 +158,7 @@ declare namespace workScheduler {
/** /**
* Whether the device deep idle state has been set for triggering the work. * Whether the device deep idle state has been set for triggering the work.
* *
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -153,6 +167,7 @@ declare namespace workScheduler {
/** /**
* The idle wait time based on which the work is triggered. * The idle wait time based on which the work is triggered.
* *
* @type { number }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9
@ -161,6 +176,7 @@ declare namespace workScheduler {
/** /**
* The parameters of the work. The value is only supported basic type(Number, String, Boolean). * The parameters of the work. The value is only supported basic type(Number, String, Boolean).
* *
* @type { Record<string, number | string | boolean> }
* @syscap SystemCapability.ResourceSchedule.WorkScheduler * @syscap SystemCapability.ResourceSchedule.WorkScheduler
* @StageModelOnly * @StageModelOnly
* @since 9 * @since 9