46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

Create your Gitee Account
Explore and code with more than 13.5 million developers,Free private repositories !:)
Sign up
文件
.gitee
api
@internal
ability
advertising
app
application
arkui
bundle
bundleManager
common
commonEvent
config
continuation
data/rdb
device-define
form
global
graphics3d
multimedia
notification
security
syscapCheck
tag
wantAgent
@ohos.InputMethodExtensionAbility.d.ts
@ohos.InputMethodExtensionContext.d.ts
@ohos.InputMethodSubtype.d.ts
@ohos.PiPWindow.d.ts
@ohos.UiTest.d.ts
@ohos.WallpaperExtensionAbility.d.ts
@ohos.WorkSchedulerExtensionAbility.d.ts
@ohos.ability.ability.d.ts
@ohos.ability.dataUriUtils.d.ts
@ohos.ability.errorCode.d.ts
@ohos.ability.featureAbility.d.ts
@ohos.ability.particleAbility.d.ts
@ohos.ability.screenLockFileManager.d.ts
@ohos.ability.wantConstant.d.ts
@ohos.abilityAccessCtrl.d.ts
@ohos.accessibility.GesturePath.d.ts
@ohos.accessibility.GesturePoint.d.ts
@ohos.accessibility.config.d.ts
@ohos.accessibility.d.ts
@ohos.account.appAccount.d.ts
@ohos.account.distributedAccount.d.ts
@ohos.account.osAccount.d.ts
@ohos.advertising.AdComponent.d.ets
@ohos.advertising.AdsServiceExtensionAbility.d.ts
@ohos.advertising.AutoAdComponent.d.ets
@ohos.advertising.d.ts
@ohos.ai.intelligentVoice.d.ts
@ohos.ai.mindSporeLite.d.ts
@ohos.animation.windowAnimationManager.d.ts
@ohos.animator.d.ts
@ohos.app.ability.Ability.d.ts
@ohos.app.ability.AbilityConstant.d.ts
@ohos.app.ability.AbilityLifecycleCallback.d.ts
@ohos.app.ability.AbilityStage.d.ts
@ohos.app.ability.ActionExtensionAbility.d.ts
@ohos.app.ability.AppServiceExtensionAbility.d.ts
@ohos.app.ability.ApplicationStateChangeCallback.d.ts
@ohos.app.ability.AtomicServiceOptions.d.ts
@ohos.app.ability.AutoFillExtensionAbility.d.ts
@ohos.app.ability.ChildProcess.d.ts
@ohos.app.ability.ChildProcessArgs.d.ts
@ohos.app.ability.ChildProcessOptions.d.ts
@ohos.app.ability.CompletionHandler.d.ts
@ohos.app.ability.CompletionHandlerForAtomicService.d.ts
@ohos.app.ability.Configuration.d.ts
@ohos.app.ability.ConfigurationConstant.d.ts
@ohos.app.ability.DriverExtensionAbility.d.ts
@ohos.app.ability.EmbeddableUIAbility.d.ts
@ohos.app.ability.EmbeddedUIExtensionAbility.d.ts
@ohos.app.ability.EnvironmentCallback.d.ts
@ohos.app.ability.ExtensionAbility.d.ts
@ohos.app.ability.FenceExtensionAbility.d.ts
@ohos.app.ability.FenceExtensionContext.d.ts
@ohos.app.ability.InsightIntentContext.d.ts
@ohos.app.ability.InsightIntentDecorator.d.ts
@ohos.app.ability.InsightIntentEntryExecutor.d.ts
@ohos.app.ability.InsightIntentExecutor.d.ts
@ohos.app.ability.MediaControlExtensionAbility.d.ts
@ohos.app.ability.OpenLinkOptions.d.ts
@ohos.app.ability.PhotoEditorExtensionAbility.d.ts
@ohos.app.ability.PrintExtensionAbility.d.ts
@ohos.app.ability.ServiceExtensionAbility.d.ts
@ohos.app.ability.ShareExtensionAbility.d.ts
@ohos.app.ability.StartOptions.d.ts
@ohos.app.ability.UIAbility.d.ts
@ohos.app.ability.UIExtensionAbility.d.ts
@ohos.app.ability.UIExtensionContentSession.d.ts
@ohos.app.ability.UIServiceExtensionAbility.d.ts
@ohos.app.ability.UserAuthExtensionAbility.d.ts
@ohos.app.ability.VpnExtensionAbility.d.ts
@ohos.app.ability.Want.d.ts
@ohos.app.ability.abilityDelegatorRegistry.d.ts
@ohos.app.ability.abilityManager.d.ts
@ohos.app.ability.appManager.d.ts
@ohos.app.ability.appRecovery.d.ts
@ohos.app.ability.application.d.ts
@ohos.app.ability.autoFillManager.d.ts
@ohos.app.ability.autoStartupManager.d.ts
@ohos.app.ability.childProcessManager.d.ts
@ohos.app.ability.common.d.ts
@ohos.app.ability.contextConstant.d.ts
@ohos.app.ability.continueManager.d.ts
@ohos.app.ability.dataUriUtils.d.ts
@ohos.app.ability.dialogRequest.d.ts
@ohos.app.ability.dialogSession.d.ts
@ohos.app.ability.errorManager.d.ts
@ohos.app.ability.insightIntent.d.ts
@ohos.app.ability.insightIntentDriver.d.ts
@ohos.app.ability.kioskManager.d.ts
@ohos.app.ability.missionManager.d.ts
@ohos.app.ability.quickFixManager.d.ts
@ohos.app.ability.sendableContextManager.d.ets
@ohos.app.ability.wantAgent.d.ts
@ohos.app.ability.wantConstant.d.ts
@ohos.app.appstartup.StartupConfig.d.ts
@ohos.app.appstartup.StartupConfigEntry.d.ts
@ohos.app.appstartup.StartupListener.d.ts
@ohos.app.appstartup.StartupTask.d.ets
@ohos.app.appstartup.startupManager.d.ts
@ohos.app.businessAbilityRouter.d.ts
@ohos.app.form.FormEditExtensionAbility.d.ts
@ohos.app.form.FormExtensionAbility.d.ts
@ohos.app.form.LiveFormExtensionAbility.d.ts
@ohos.app.form.formAgent.d.ts
@ohos.app.form.formBindingData.d.ts
@ohos.app.form.formHost.d.ts
@ohos.app.form.formInfo.d.ts
@ohos.app.form.formObserver.d.ts
@ohos.app.form.formProvider.d.ts
@ohos.application.AccessibilityExtensionAbility.d.ts
@ohos.application.BackupExtensionAbility.d.ts
@ohos.application.Configuration.d.ts
@ohos.application.ConfigurationConstant.d.ts
@ohos.application.DataShareExtensionAbility.d.ts
@ohos.application.DistributedExtensionAbility.d.ts
@ohos.application.DistributedExtensionContext.d.ts
@ohos.application.StaticSubscriberExtensionAbility.d.ts
@ohos.application.StaticSubscriberExtensionContext.d.ts
@ohos.application.Want.d.ts
@ohos.application.WindowExtensionAbility.d.ts
@ohos.application.abilityDelegatorRegistry.d.ts
@ohos.application.abilityManager.d.ts
@ohos.application.appManager.d.ts
@ohos.application.formBindingData.d.ts
@ohos.application.formError.d.ts
@ohos.application.formHost.d.ts
@ohos.application.formInfo.d.ts
@ohos.application.formProvider.d.ts
@ohos.application.missionManager.d.ts
@ohos.application.testRunner.d.ts
@ohos.application.uriPermissionManager.d.ts
@ohos.arkui.ArcAlphabetIndexer.d.ts
@ohos.arkui.ArcList.d.ts
@ohos.arkui.ArcScrollBar.d.ts
@ohos.arkui.ArcSwiper.d.ts
@ohos.arkui.Prefetcher.d.ts
@ohos.arkui.StateManagement.d.ts
@ohos.arkui.UIContext.d.ts
@ohos.arkui.advanced.ArcButton.d.ets
@ohos.arkui.advanced.ArcSlider.d.ets
@ohos.arkui.advanced.Chip.d.ets
@ohos.arkui.advanced.ChipGroup.d.ets
@ohos.arkui.advanced.ComposeListItem.d.ets
@ohos.arkui.advanced.ComposeTitleBar.d.ets
@ohos.arkui.advanced.Counter.d.ets
@ohos.arkui.advanced.Dialog.d.ets
@ohos.arkui.advanced.DialogV2.d.ets
@ohos.arkui.advanced.DownloadFileButton.d.ets
@ohos.arkui.advanced.EditableTitleBar.d.ets
@ohos.arkui.advanced.ExceptionPrompt.d.ets
@ohos.arkui.advanced.Filter.d.ets
@ohos.arkui.advanced.FoldSplitContainer.d.ets
@ohos.arkui.advanced.FormMenu.d.ets
@ohos.arkui.advanced.FullScreenLaunchComponent.d.ets
@ohos.arkui.advanced.GridObjectSortComponent.d.ets
@ohos.arkui.advanced.InnerFullScreenLaunchComponent.d.ets
@ohos.arkui.advanced.MultiNavigation.d.ets
@ohos.arkui.advanced.Popup.d.ets
@ohos.arkui.advanced.ProgressButton.d.ets
@ohos.arkui.advanced.ProgressButtonV2.d.ets
@ohos.arkui.advanced.SegmentButton.d.ets
@ohos.arkui.advanced.SegmentButtonV2.d.ets
@ohos.arkui.advanced.SelectTitleBar.d.ets
@ohos.arkui.advanced.SelectionMenu.d.ets
@ohos.arkui.advanced.SplitLayout.d.ets
@ohos.arkui.advanced.SubHeader.d.ets
@ohos.arkui.advanced.SubHeaderV2.d.ets
@ohos.arkui.advanced.SwipeRefresher.d.ets
@ohos.arkui.advanced.TabTitleBar.d.ets
@ohos.arkui.advanced.ToolBar.d.ets
@ohos.arkui.advanced.ToolBarV2.d.ets
@ohos.arkui.advanced.TreeView.d.ets
@ohos.arkui.component.d.ets
@ohos.arkui.componentSnapshot.d.ts
@ohos.arkui.componentUtils.d.ts
@ohos.arkui.dragController.d.ts
@ohos.arkui.drawableDescriptor.d.ts
@ohos.arkui.inspector.d.ts
@ohos.arkui.modifier.d.ts
@ohos.arkui.node.d.ts
@ohos.arkui.observer.d.ts
@ohos.arkui.performanceMonitor.d.ts
@ohos.arkui.shape.d.ts
@ohos.arkui.stateManagement.d.ets
@ohos.arkui.theme.d.ts
@ohos.arkui.uiExtension.d.ts
@ohos.atomicservice.AtomicServiceNavigation.d.ets
@ohos.atomicservice.AtomicServiceSearch.d.ets
@ohos.atomicservice.AtomicServiceTabs.d.ets
@ohos.atomicservice.AtomicServiceWeb.d.ets
@ohos.atomicservice.HalfScreenLaunchComponent.d.ets
@ohos.atomicservice.InterstitialDialogAction.d.ets
@ohos.atomicservice.NavPushPathHelper.d.ets
@ohos.backgroundTaskManager.d.ts
@ohos.base.d.ets
@ohos.base.d.ts
@ohos.batteryInfo.d.ets
@ohos.batteryInfo.d.ts
@ohos.batteryStatistics.d.ts
@ohos.bluetooth.a2dp.d.ts
@ohos.bluetooth.access.d.ts
@ohos.bluetooth.baseProfile.d.ts
@ohos.bluetooth.ble.d.ts
@ohos.bluetooth.connection.d.ts
@ohos.bluetooth.constant.d.ts
@ohos.bluetooth.d.ts
@ohos.bluetooth.hfp.d.ts
@ohos.bluetooth.hid.d.ts
@ohos.bluetooth.map.d.ts
@ohos.bluetooth.opp.d.ts
@ohos.bluetooth.pan.d.ts
@ohos.bluetooth.pbap.d.ts
@ohos.bluetooth.socket.d.ts
@ohos.bluetooth.wearDetection.d.ts
@ohos.bluetoothManager.d.ts
@ohos.brightness.d.ts
@ohos.buffer.d.ts
@ohos.bundle.appControl.d.ts
@ohos.bundle.appDomainVerify.d.ts
@ohos.bundle.bundleManager.d.ts
@ohos.bundle.bundleMonitor.d.ts
@ohos.bundle.bundleResourceManager.d.ts
@ohos.bundle.d.ts
@ohos.bundle.defaultAppManager.d.ts
@ohos.bundle.distributedBundleManager.d.ts
@ohos.bundle.freeInstall.d.ts
@ohos.bundle.innerBundleManager.d.ts
@ohos.bundle.installer.d.ts
@ohos.bundle.launcherBundleManager.d.ts
@ohos.bundle.overlay.d.ts
@ohos.bundle.shortcutManager.d.ts
@ohos.bundleState.d.ts
@ohos.bytrace.d.ts
@ohos.calendarManager.d.ts
@ohos.charger.d.ts
@ohos.commonEvent.d.ts
@ohos.commonEventManager.d.ts
@ohos.configPolicy.d.ts
@ohos.connectedTag.d.ts
@ohos.contact.d.ts
@ohos.continuation.continuationManager.d.ts
@ohos.convertxml.d.ts
@ohos.cooperate.d.ts
@ohos.curves.d.ts
@ohos.customization.customConfig.d.ts
@ohos.data.DataShareResultSet.d.ts
@ohos.data.UdmfComponents.d.ets
@ohos.data.ValuesBucket.d.ts
@ohos.data.cloudData.d.ts
@ohos.data.cloudExtension.d.ts
@ohos.data.commonType.d.ts
@ohos.data.dataAbility.d.ts
@ohos.data.dataShare.d.ts
@ohos.data.dataSharePredicates.d.ts
@ohos.data.distributedData.d.ts
@ohos.data.distributedDataObject.d.ts
@ohos.data.distributedKVStore.d.ts
@ohos.data.intelligence.d.ts
@ohos.data.preferences.d.ts
@ohos.data.rdb.d.ts
@ohos.data.relationalStore.d.ts
@ohos.data.sendablePreferences.d.ets
@ohos.data.sendableRelationalStore.d.ets
@ohos.data.storage.d.ts
@ohos.data.unifiedDataChannel.d.ts
@ohos.data.uniformDataStruct.d.ts
@ohos.data.uniformTypeDescriptor.d.ts
@ohos.deviceAttest.d.ts
@ohos.deviceInfo.d.ets
@ohos.deviceInfo.d.ts
@ohos.deviceStatus.dragInteraction.d.ts
@ohos.display.d.ts
@ohos.distributedBundle.d.ts
@ohos.distributedDeviceManager.d.ts
@ohos.distributedHardware.deviceManager.d.ts
@ohos.distributedHardware.hardwareManager.d.ts
@ohos.distributedHardware.mechanicManager.d.ts
@ohos.distributedMissionManager.d.ts
@ohos.distributedsched.abilityConnectionManager.d.ts
@ohos.distributedsched.linkEnhance.d.ts
@ohos.distributedsched.proxyChannelManager.d.ts
@ohos.dlpPermission.d.ts
@ohos.document.d.ts
@ohos.driver.deviceManager.d.ts
@ohos.effectKit.d.ts
@ohos.enterprise.EnterpriseAdminExtensionAbility.d.ts
@ohos.enterprise.accountManager.d.ts
@ohos.enterprise.adminManager.d.ts
@ohos.enterprise.applicationManager.d.ts
@ohos.enterprise.bluetoothManager.d.ts
@ohos.enterprise.browser.d.ts
@ohos.enterprise.bundleManager.d.ts
@ohos.enterprise.dateTimeManager.d.ts
@ohos.enterprise.deviceControl.d.ts
@ohos.enterprise.deviceInfo.d.ts
@ohos.enterprise.deviceSettings.d.ts
@ohos.enterprise.locationManager.d.ts
@ohos.enterprise.networkManager.d.ts
@ohos.enterprise.restrictions.d.ts
@ohos.enterprise.securityManager.d.ts
@ohos.enterprise.systemManager.d.ts
@ohos.enterprise.telephonyManager.d.ts
@ohos.enterprise.usbManager.d.ts
@ohos.enterprise.wifiManager.d.ts
@ohos.events.emitter.d.ts
@ohos.fastbuffer.d.ts
@ohos.faultLogger.d.ts
@ohos.file.AlbumPickerComponent.d.ets
@ohos.file.BackupExtensionContext.d.ts
@ohos.file.PhotoPickerComponent.d.ets
@ohos.file.RecentPhotoComponent.d.ets
@ohos.file.backup.d.ts
@ohos.file.cloudSync.d.ts
@ohos.file.cloudSyncManager.d.ts
@ohos.file.environment.d.ts
@ohos.file.fileAccess.d.ts
@ohos.file.fileExtensionInfo.d.ts
@ohos.file.fileuri.d.ts
@ohos.file.fs.d.ets
@ohos.file.fs.d.ts
@ohos.file.hash.d.ts
@ohos.file.keyManager.d.ts
@ohos.file.photoAccessHelper.d.ts
@ohos.file.picker.d.ts
@ohos.file.recent.d.ts
@ohos.file.securityLabel.d.ts
@ohos.file.sendablePhotoAccessHelper.d.ets
@ohos.file.statvfs.d.ts
@ohos.file.storageStatistics.d.ts
@ohos.file.trash.d.ts
@ohos.file.volumeManager.d.ts
@ohos.fileio.d.ts
@ohos.filemanagement.userFileManager.d.ts
@ohos.fileshare.d.ts
@ohos.font.d.ts
@ohos.fontManager.d.ts
@ohos.geoLocationManager.d.ts
@ohos.geolocation.d.ts
@ohos.graphics.colorSpaceManager.d.ts
@ohos.graphics.common2D.d.ts
@ohos.graphics.displaySync.d.ts
@ohos.graphics.drawing.d.ts
@ohos.graphics.hdrCapability.d.ts
@ohos.graphics.scene.d.ts
@ohos.graphics.sendableColorSpaceManager.d.ets
@ohos.graphics.text.d.ts
@ohos.graphics.uiEffect.d.ts
@ohos.hiAppEvent.d.ts
@ohos.hiSysEvent.d.ts
@ohos.hiTraceChain.d.ts
@ohos.hiTraceMeter.d.ts
@ohos.hichecker.d.ts
@ohos.hidebug.d.ts
@ohos.hilog.d.ts
@ohos.hiviewdfx.hiAppEvent.d.ts
@ohos.hiviewdfx.jsLeakWatcher.d.ts
@ohos.i18n.d.ts
@ohos.identifier.oaid.d.ts
@ohos.inputMethod.Panel.d.ts
@ohos.inputMethod.d.ts
@ohos.inputMethodEngine.d.ts
@ohos.inputMethodList.d.ets
@ohos.intl.d.ts
@ohos.logLibrary.d.ts
@ohos.matrix4.d.ets
@ohos.matrix4.d.ts
@ohos.measure.d.ts
@ohos.mediaquery.d.ets
@ohos.mediaquery.d.ts
@ohos.multimedia.audio.d.ts
@ohos.multimedia.audioHaptic.d.ts
@ohos.multimedia.avCastPicker.d.ets
@ohos.multimedia.avCastPickerParam.d.ts
@ohos.multimedia.avInputCastPicker.d.ets
@ohos.multimedia.avVolumePanel.d.ets
@ohos.multimedia.avsession.d.ts
@ohos.multimedia.camera.d.ts
@ohos.multimedia.cameraPicker.d.ts
@ohos.multimedia.drm.d.ts
@ohos.multimedia.image.d.ts
@ohos.multimedia.media.d.ts
@ohos.multimedia.movingphotoview.d.ts
@ohos.multimedia.sendableImage.d.ets
@ohos.multimedia.systemSoundManager.d.ts
@ohos.multimedia.videoProcessingEngine.d.ts
@ohos.multimodalAwareness.deviceStatus.d.ts
@ohos.multimodalAwareness.metadataBinding.d.ts
@ohos.multimodalAwareness.motion.d.ts
@ohos.multimodalAwareness.onScreen.d.ts
@ohos.multimodalAwareness.userStatus.d.ts
@ohos.multimodalInput.gestureEvent.d.ts
@ohos.multimodalInput.infraredEmitter.d.ts
@ohos.multimodalInput.inputConsumer.d.ts
@ohos.multimodalInput.inputDevice.d.ts
@ohos.multimodalInput.inputDeviceCooperate.d.ts
@ohos.multimodalInput.inputEvent.d.ts
@ohos.multimodalInput.inputEventClient.d.ts
@ohos.multimodalInput.inputMonitor.d.ts
@ohos.multimodalInput.intentionCode.d.ts
@ohos.multimodalInput.keyCode.d.ts
@ohos.multimodalInput.keyEvent.d.ts
@ohos.multimodalInput.mouseEvent.d.ts
@ohos.multimodalInput.pointer.d.ts
@ohos.multimodalInput.shortKey.d.ts
@ohos.multimodalInput.touchEvent.d.ts
@ohos.net.connection.d.ts
@ohos.net.eap.d.ts
@ohos.net.ethernet.d.ts
@ohos.net.http.d.ts
@ohos.net.mdns.d.ts
@ohos.net.netFirewall.d.ts
@ohos.net.networkSecurity.d.ts
@ohos.net.policy.d.ts
@ohos.net.sharing.d.ts
@ohos.net.socket.d.ts
@ohos.net.statistics.d.ts
@ohos.net.vpn.d.ts
@ohos.net.vpnExtension.d.ts
@ohos.net.webSocket.d.ts
@ohos.nfc.cardEmulation.d.ts
@ohos.nfc.controller.d.ts
@ohos.nfc.tag.d.ts
@ohos.notification.d.ts
@ohos.notificationManager.d.ts
@ohos.notificationSubscribe.d.ts
@ohos.pasteboard.d.ts
@ohos.pluginComponent.d.ts
@ohos.power.d.ts
@ohos.print.d.ts
@ohos.privacyManager.d.ts
@ohos.process.d.ts
@ohos.prompt.d.ets
@ohos.prompt.d.ts
@ohos.promptAction.d.ts
@ohos.reminderAgent.d.ts
@ohos.reminderAgentManager.d.ts
@ohos.request.cacheDownload.d.ts
@ohos.request.d.ts
@ohos.resourceManager.d.ts
@ohos.resourceschedule.backgroundProcessManager.d.ts
@ohos.resourceschedule.backgroundTaskManager.d.ts
@ohos.resourceschedule.deviceStandby.d.ts
@ohos.resourceschedule.systemload.d.ts
@ohos.resourceschedule.usageStatistics.d.ts
@ohos.resourceschedule.workScheduler.d.ts
@ohos.router.d.ets
@ohos.router.d.ts
@ohos.rpc.d.ts
@ohos.runningLock.d.ts
@ohos.scan.d.ets
@ohos.screen.d.ts
@ohos.screenLock.d.ts
@ohos.screenshot.d.ts
@ohos.secureElement.d.ts
@ohos.security.asset.d.ts
@ohos.security.cert.d.ts
@ohos.security.certManager.d.ts
@ohos.security.certManagerDialog.d.ts
@ohos.security.cryptoFramework.d.ts
@ohos.security.huks.d.ts
@ohos.security.securityGuard.d.ts
@ohos.selectionInput.SelectionExtensionAbility.d.ts
@ohos.selectionInput.SelectionExtensionContext.d.ts
@ohos.selectionInput.SelectionPanel.d.ts
@ohos.selectionInput.selectionManager.d.ts
@ohos.sendableResourceManager.d.ets
@ohos.sensor.d.ts
@ohos.settings.d.ts
@ohos.statfs.d.ts
@ohos.stationary.d.ts
@ohos.systemCapability.d.ts
@ohos.systemDateTime.d.ts
@ohos.systemParameterEnhance.d.ts
@ohos.systemTime.d.ts
@ohos.systemTimer.d.ts
@ohos.systemparameter.d.ts
@ohos.taskpool.d.ts
@ohos.telephony.call.d.ts
@ohos.telephony.data.d.ts
@ohos.telephony.esim.d.ts
@ohos.telephony.observer.d.ts
@ohos.telephony.radio.d.ts
@ohos.telephony.sim.d.ts
@ohos.telephony.sms.d.ts
@ohos.telephony.vcard.d.ts
@ohos.test.PerfTest.d.ts
@ohos.thermal.d.ts
@ohos.transfer.d.ets
@ohos.uiAppearance.d.ts
@ohos.uiExtensionHost.d.ets
@ohos.uiExtensionHost.d.ts
@ohos.update.d.ts
@ohos.uri.d.ts
@ohos.url.d.ts
@ohos.usb.d.ts
@ohos.usbManager.d.ts
@ohos.usbManager.serial.d.ts
@ohos.userIAM.faceAuth.d.ts
@ohos.userIAM.userAccessCtrl.d.ts
@ohos.userIAM.userAuth.d.ts
@ohos.userIAM.userAuthIcon.d.ets
@ohos.util.ArrayList.d.ts
@ohos.util.Deque.d.ts
@ohos.util.HashMap.d.ts
@ohos.util.HashSet.d.ts
@ohos.util.LightWeightMap.d.ts
@ohos.util.LightWeightSet.d.ts
@ohos.util.LinkedList.d.ts
@ohos.util.List.d.ts
@ohos.util.PlainArray.d.ts
@ohos.util.Queue.d.ts
@ohos.util.Stack.d.ts
@ohos.util.TreeMap.d.ts
@ohos.util.TreeSet.d.ts
@ohos.util.Vector.d.ts
@ohos.util.d.ets
@ohos.util.d.ts
@ohos.util.json.d.ts
@ohos.util.stream.d.ts
@ohos.vibrator.d.ts
@ohos.wallpaper.d.ts
@ohos.wantAgent.d.ts
@ohos.web.netErrorList.d.ts
@ohos.web.webview.d.ts
@ohos.wifi.d.ts
@ohos.wifiManager.d.ts
@ohos.wifiManagerExt.d.ts
@ohos.wifiext.d.ts
@ohos.window.d.ts
@ohos.window.floatingBall.d.ts
@ohos.worker.d.ts
@ohos.xml.d.ts
@ohos.zlib.d.ts
@system.app.d.ets
@system.app.d.ts
@system.battery.d.ts
@system.bluetooth.d.ts
@system.brightness.d.ts
@system.cipher.d.ts
@system.configuration.d.ts
@system.device.d.ts
@system.fetch.d.ts
@system.file.d.ts
@system.geolocation.d.ts
@system.mediaquery.d.ets
@system.mediaquery.d.ts
@system.network.d.ts
@system.notification.d.ts
@system.package.d.ts
@system.prompt.d.ets
@system.prompt.d.ts
@system.request.d.ts
@system.router.d.ets
@system.router.d.ts
@system.sensor.d.ts
@system.storage.d.ts
@system.vibrator.d.ts
permissions.d.ts
arkts
build-tools
kits
CODEOWNERS
.gitattributes
.gitignore
BUILD.gn
LICENCE.md
LICENSE
OAT.xml
README.md
README_zh.md
arkui_transformer.py
bundle.json
exists_path.py
interface_config.gni
ohos_copy_ets.py
process_internal.py
process_internal.pydeps
remove_internal.py
remove_internal.pydeps
remove_list.json
Clone or Download
@ohos.resourceschedule.backgroundTaskManager.d.ts 54.27 KB
Copy Edit Raw Blame History
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit BackgroundTasksKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
import { WantAgent } from './@ohos.wantAgent';
import Context from './application/BaseContext';
import type notificationManager from './@ohos.notificationManager';
/**
* Manages background tasks.
*
* @namespace backgroundTaskManager
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.Core
* @since 9
*/
/**
* Manages background tasks.
*
* @namespace backgroundTaskManager
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.Core
* @atomicservice
* @since 12
*/
declare namespace backgroundTaskManager {
/**
* The info of delay suspend.
*
* @interface DelaySuspendInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
interface DelaySuspendInfo {
/**
* The unique identifier of the delay request.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
requestId: number;
/**
* The actual delay duration (ms).
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
actualDelayTime: number;
}
/**
* The callback info of transient task.
*
* @interface TransientTaskInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 20
*/
interface TransientTaskInfo {
/**
* Total remaining quota of an application in one day.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 20
*/
remainingQuota: number;
/**
* The info list of delay suspend.
*
* @type { DelaySuspendInfo[] }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 20
*/
transientTasks: DelaySuspendInfo[];
}
/**
* The info of continuous task notification.
*
* @interface ContinuousTaskNotification
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
interface ContinuousTaskNotification {
/**
* The notification slot type.
*
* @type { notificationManager.SlotType }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
slotType: notificationManager.SlotType;
/**
* The notification content type.
*
* @type { notificationManager.ContentType }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
contentType: notificationManager.ContentType;
/**
* The notification id.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
notificationId: number;
/**
* The continuous task id.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
continuousTaskId?: number;
}
/**
* The continuous task cancel info.
*
* @interface ContinuousTaskCancelInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
interface ContinuousTaskCancelInfo {
/**
* The cancel reason of continuous task.
*
* @type { ContinuousTaskCancelReason }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
reason: ContinuousTaskCancelReason;
/**
* The id of cancelled continuous task.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
id: number;
}
/**
* The continuous task active info.
*
* @interface ContinuousTaskActiveInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
interface ContinuousTaskActiveInfo {
/**
* The id of active continuous task.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
id: number;
}
/**
* The continuous task info.
*
* @interface ContinuousTaskInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
interface ContinuousTaskInfo {
/**
* The ability name of apply continuous task.
*
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
abilityName: string;
/**
* The uid of apply continuous task.
*
* @type { number}
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
uid: number;
/**
* The pid of apply continuous task.
*
* @type { number}
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
pid: number;
/**
* Is apply continuous task from webview.
*
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
isFromWebView: boolean;
/**
* Background modes of apply continuous task.
*
* @type { string[] }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
backgroundModes: string[];
/**
* Background sub modes of apply continuous task.
*
* @type { string[] }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
backgroundSubModes: string[];
/**
* The notification id of apply continuous task.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
notificationId: number;
/**
* The continuous task id of apply continuous task.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
continuousTaskId: number;
/**
* The ability id of apply continuous task.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
abilityId: number;
/**
* The wantAgent bundle name of apply continuous task.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
wantAgentBundleName: string;
/**
* The wantAgent ability name of apply continuous task.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
wantAgentAbilityName: string;
/**
* The suspend state of apply continuous task.
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
suspendState: boolean;
}
/**
* The continuous task suspend info.
*
* @interface ContinuousTaskSuspendInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
interface ContinuousTaskSuspendInfo {
/**
* The id of suspended continuous task.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
continuousTaskId: number;
/**
* The suspend state of continuous task.
*
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
suspendState: boolean;
/**
* The suspend reason of continuous task.
*
* @type { ContinuousTaskSuspendReason }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
suspendReason: ContinuousTaskSuspendReason;
}
/**
* Efficiency Resources information.
*
* @interface EfficiencyResourcesInfo
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
interface EfficiencyResourcesInfo {
/**
* The set of resource types that app wants to apply.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
resourceTypes: number;
/**
* The duration that the resource can be used most.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
timeout: number;
/**
* True if the apply action is persistent, else false. Default value is false.
*
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
isPersistent: boolean;
/**
* True if apply action is for process, false is for package. Default value is false.
*
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
isForProcess: boolean;
/**
* The apply reason.
*
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
reason: string;
/**
* The uid of apply efficiency resources.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
uid: number;
/**
* The pid of apply efficiency resources.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 20
*/
pid: number;
}
/**
* Cancels delayed transition to the suspended state.
*
* @param { number } requestId - The identifier of the delay request.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9900001 - Caller information verification failed for a transient task.
* @throws { BusinessError } 9900002 - Transient task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
function cancelSuspendDelay(requestId: number): void;
/**
* Obtains the remaining time before an application enters the suspended state.
*
* @param { number } requestId - The identifier of the delay request.
* @param { AsyncCallback<number> } callback - The callback of the remaining delay time.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9900001 - Caller information verification failed for a transient task.
* @throws { BusinessError } 9900002 - Transient task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
function getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): void;
/**
* Obtains the remaining time before an application enters the suspended state.
*
* @param { number } requestId - The identifier of the delay request.
* @returns { Promise<number> } The promise returns the remaining delay time.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9900001 - Caller information verification failed for a transient task.
* @throws { BusinessError } 9900002 - Transient task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
function getRemainingDelayTime(requestId: number): Promise<number>;
/**
* Requests 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.
* @returns { DelaySuspendInfo } Info of delay request.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9900001 - Caller information verification failed for a transient task.
* @throws { BusinessError } 9900002 - Transient task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 9
*/
function requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspendInfo;
/**
* Obtains transient task info before an application enters the suspended state.
*
* @returns { Promise<TransientTaskInfo> } The promise returns the transient task info.
* @throws { BusinessError } 9900001 - Caller information verification failed for a transient task.
* @throws { BusinessError } 9900003 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9900004 - System service operation failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
* @since 20
*/
function getTransientTaskInfo(): Promise<TransientTaskInfo>;
/**
* Service ability uses this method to request start running in background.
* <p> System will publish a notification related to the this service. </p>
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { BackgroundMode } bgMode - Indicates which background mode to request.
* @param { WantAgent } wantAgent - Indicates which ability to start when user click the notification bar.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* Service ability uses this method to request start running in background.
* <p> System will publish a notification related to the this service. </p>
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { BackgroundMode } bgMode - Indicates which background mode to request.
* @param { WantAgent } wantAgent - Indicates which ability to start when user click the notification bar.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
function startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback<void>): void;
/**
* Service ability uses this method to request start running in background.
* <p> System will publish a notification related to the this service. </p>
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { BackgroundMode } bgMode - Indicates which background mode to request.
* @param { WantAgent } wantAgent - Indicates which ability to start when user click the notification bar.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* Service ability uses this method to request start running in background.
* <p> System will publish a notification related to the this service. </p>
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { BackgroundMode } bgMode - Indicates which background mode to request.
* @param { WantAgent } wantAgent - Indicates which ability to start when user click the notification bar.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
function startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise<void>;
/**
* UIAbility uses this method to request start running in background.
* <p> System will publish a notification related to the UIAbility. </p>
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { string[] } bgModes - Indicates which background mode to request.
* @param { WantAgent } wantAgent - Indicates which ability to start when user click the notification bar.
* @returns { Promise<ContinuousTaskNotification> } The The continuous task notification.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
function startBackgroundRunning(context: Context, bgModes: string[], wantAgent: WantAgent): Promise<ContinuousTaskNotification>;
/**
* UIAbility uses this method to update background mode.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { string[] } bgModes - Indicates which background mode to request.
* @returns { Promise<ContinuousTaskNotification> } The continuous task notification.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
function updateBackgroundRunning(context: Context, bgModes: string[]): Promise<ContinuousTaskNotification>;
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @param { AsyncCallback<void> } callback - The callback of the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 19
*/
function stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): void;
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Parcel operation failed.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
/**
* Service ability uses this method to request stop running in background.
*
* @param { Context } context - App running context.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @throws { BusinessError } 9800006 - Notification verification failed for a continuous task.
* @throws { BusinessError } 9800007 - Continuous task storage failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 19
*/
function stopBackgroundRunning(context: Context): Promise<void>;
/**
* Obtains all the continuous tasks before an application enters the suspended state,
* including continuous tasks in suspended state.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @returns { Promise<ContinuousTaskInfo[]> } The promise returns the continuous task info.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function getAllContinuousTasks(context: Context): Promise<ContinuousTaskInfo[]>;
/**
* Obtains all the continuous tasks before an application enters the suspended state.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { Context } context - App running context.
* @param { boolean } includeSuspended - Return the suspended continuous tasks.
* @returns { Promise<ContinuousTaskInfo[]> } The promise returns the continuous task info.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function getAllContinuousTasks(context: Context, includeSuspended: boolean): Promise<ContinuousTaskInfo[]>;
/**
* Apply or unapply efficiency resources.
*
* @param { EfficiencyResourcesRequest } request - The request of apply or unapply efficiency resources.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 18700001 - Caller information verification failed for an energy resource request.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
function applyEfficiencyResources(request: EfficiencyResourcesRequest): void;
/**
* Reset all efficiency resources apply.
*
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed.
* @throws { BusinessError } 9800001 - Memory operation failed.
* @throws { BusinessError } 9800002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 9800003 - Internal transaction failed.
* @throws { BusinessError } 9800004 - System service operation failed.
* @throws { BusinessError } 18700001 - Caller information verification failed for an energy resource request.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
function resetAllEfficiencyResources(): void;
/**
* Obtains all the efficiency resources of current application.
*
* @returns { Promise<EfficiencyResourcesInfo[]> } The promise returns the efficiency resources info.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 18700001 - Caller information verification failed for an energy resource request.
* @throws { BusinessError } 18700002 - Failed to write data into parcel. Possible reasons: 1. Invalid parameters;
* <br> 2. Failed to apply for memory.
* @throws { BusinessError } 18700004 - System service operation failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi
* @since 20
*/
function getAllEfficiencyResources(): Promise<EfficiencyResourcesInfo[]>;
/**
* Register continuous task cancel callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskCancel' } type - The type of continuous task cancel.
* @param { Callback<ContinuousTaskCancelInfo> } callback - the callback of continuous task cancel.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error;
* <br> 2. Register a exist callback type; 3. Parameter verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
function on(type: 'continuousTaskCancel', callback: Callback<ContinuousTaskCancelInfo>): void;
/**
* Unregister continuous task cancel callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskCancel' } type - The type of continuous task cancel.
* @param { Callback<ContinuousTaskCancelInfo> } callback - the callback of continuous task cancel.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error;
* <br> 2. Unregister type has not register; 3. Parameter verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
function off(type: 'continuousTaskCancel', callback?: Callback<ContinuousTaskCancelInfo>): void;
/**
* Register continuous task suspend callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskSuspend' } type - The type of continuous task suspend.
* @param { Callback<ContinuousTaskSuspendInfo> } callback - the callback of continuous task suspend.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function on(type: 'continuousTaskSuspend', callback: Callback<ContinuousTaskSuspendInfo>): void;
/**
* Unregister continuous task suspend callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskSuspend' } type - The type of continuous task suspend.
* @param { Callback<ContinuousTaskSuspendInfo> } callback - the callback of continuous task suspend.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function off(type: 'continuousTaskSuspend', callback?: Callback<ContinuousTaskSuspendInfo>): void;
/**
* Register continuous task active callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskActive' } type - The type of continuous task active.
* @param { Callback<ContinuousTaskActiveInfo> } callback - the callback of continuous task active.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function on(type: 'continuousTaskActive', callback: Callback<ContinuousTaskActiveInfo>): void;
/**
* Unregister continuous task suspend callback.
*
* @permission ohos.permission.KEEP_BACKGROUND_RUNNING
* @param { 'continuousTaskActive' } type - The type of continuous task active.
* @param { Callback<ContinuousTaskActiveInfo> } callback - the callback of continuous task active.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 9800005 - Continuous task verification failed.
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
function off(type: 'continuousTaskActive', callback?: Callback<ContinuousTaskActiveInfo>): void;
/**
* Supported background mode.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* Supported background mode.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
export enum BackgroundMode {
/**
* data transfer mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
DATA_TRANSFER = 1,
/**
* audio playback mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* audio playback mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
AUDIO_PLAYBACK = 2,
/**
* audio recording mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
AUDIO_RECORDING = 3,
/**
* location mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
LOCATION = 4,
/**
* bluetooth interaction mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
BLUETOOTH_INTERACTION = 5,
/**
* multi-device connection mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
/**
* multi-device connection mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @atomicservice
* @since 12
*/
MULTI_DEVICE_CONNECTION = 6,
/**
* wifi interaction mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @systemapi Hide this for inner system use.
* @since 9
*/
WIFI_INTERACTION = 7,
/**
* Voice over Internet Phone mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 13
*/
VOIP = 8,
/**
* background continuous calculate mode, for example 3D render.
* only supported in particular device
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 9
*/
TASK_KEEPING = 9,
}
/**
* The type of resource.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
export enum ResourceType {
/**
* The cpu resource for not being suspended.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
CPU = 1,
/**
* The resource for not being proxyed common_event.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
COMMON_EVENT = 1 << 1,
/**
* The resource for not being proxyed timer.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
TIMER = 1 << 2,
/**
* The resource for not being proxyed workscheduler.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
WORK_SCHEDULER = 1 << 3,
/**
* The resource for not being proxyed bluetooth.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
BLUETOOTH = 1 << 4,
/**
* The resource for not being proxyed gps.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
GPS = 1 << 5,
/**
* The resource for not being proxyed audio.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
AUDIO = 1 << 6,
/**
* The resource for not being proxyed running lock.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 10
*/
RUNNING_LOCK = 1 << 7,
/**
* The resource for not being proxyed sensor.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 10
*/
SENSOR = 1 << 8
}
/**
* The request of efficiency resources.
*
* @interface EfficiencyResourcesRequest
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
export interface EfficiencyResourcesRequest {
/**
* The set of resource types that app wants to apply.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
resourceTypes: number;
/**
* True if the app begin to use, else false.
*
* @type { boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
isApply: boolean;
/**
* The duration that the resource can be used most.
*
* @type { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
timeOut: number;
/**
* True if the apply action is persist, else false. Default value is false.
*
* @type { ?boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
isPersist?: boolean;
/**
* True if apply action is for process, false is for package. Default value is false.
*
* @type { ?boolean }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
isProcess?: boolean;
/**
* The apply reason.
*
* @type { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
* @systemapi Hide this for inner system use.
* @since 9
*/
reason: string;
}
/**
* The type of continuous task cancel reason.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
export enum ContinuousTaskCancelReason {
/**
* User cancel.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
USER_CANCEL = 1,
/**
* System cancel.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL = 2,
/**
* User remove notification.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
USER_CANCEL_REMOVE_NOTIFICATION = 3,
/**
* Low network speed when request data transfer mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_DATA_TRANSFER_LOW_SPEED = 4,
/**
* Not use avsession when request audio playback mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_AUDIO_PLAYBACK_NOT_USE_AVSESSION = 5,
/**
* Audio is not running when request audio playback mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_AUDIO_PLAYBACK_NOT_RUNNING = 6,
/**
* Audio is not running when request audio recording mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_AUDIO_RECORDING_NOT_RUNNING = 7,
/**
* Not use location when request location mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_NOT_USE_LOCATION = 8,
/**
* Not use bluetooth when request bluetooth interaction mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_NOT_USE_BLUETOOTH = 9,
/**
* Not use multi device when request multi-device connection mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_NOT_USE_MULTI_DEVICE = 10,
/**
* Use some mode illegally.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 15
*/
SYSTEM_CANCEL_USE_ILLEGALLY = 11,
}
/**
* Supported background submode.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 16
*/
export enum BackgroundSubMode {
/**
* bluetooth car key mode
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 16
*/
CAR_KEY = 1
}
/**
* Supported background mode type.
*
* @enum { string }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 16
*/
export enum BackgroundModeType {
/**
* subMode type
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 16
*/
SUB_MODE = 'subMode'
}
/**
* Type of continuous task suspend reason.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
export enum ContinuousTaskSuspendReason {
/**
* Low network speed when request data transfer mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_DATA_TRANSFER_LOW_SPEED = 4,
/**
* Not use avsession when request audio playback mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_AUDIO_PLAYBACK_NOT_USE_AVSESSION = 5,
/**
* Audio is not running when request audio playback mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_AUDIO_PLAYBACK_NOT_RUNNING = 6,
/**
* Audio is not running when request audio recording mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_AUDIO_RECORDING_NOT_RUNNING = 7,
/**
* Not use location when request location mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_LOCATION_NOT_USED = 8,
/**
* Not use bluetooth when request bluetooth interaction mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_BLUETOOTH_NOT_USED = 9,
/**
* Not use multi device when request multi-device connection mode.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_MULTI_DEVICE_NOT_USED = 10,
/**
* Use some mode illegally.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_USED_ILLEGALLY = 11,
/**
* System load warning.
*
* @syscap SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
* @since 20
*/
SYSTEM_SUSPEND_SYSTEM_LOAD_WARNING = 12,
}
}
export default backgroundTaskManager;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

Search