当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
.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.CompletionHandlerForAbilityStartCallback.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.verticalPanelManager.d.ts
@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.cloudDiskManager.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.FaultLogExtensionAbility.d.ts
@ohos.hiviewdfx.FaultLogExtensionContext.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.identifySensitiveContent.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
克隆/下载
@ohos.data.preferences.d.ts 96.68 KB
一键复制 编辑 原始数据 按行查看 历史
BrainL 提交于 3个月前 . 标签修改
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028
/*
* Copyright (c) 2022-2025 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 ArkData
*/
import { AsyncCallback, Callback } from './@ohos.base';
import Context from './application/BaseContext';
/**
* Provides interfaces to obtain and modify preferences data.
*
* @namespace preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
* @name preferences
*/
/**
* Provides interfaces to obtain and modify preferences data.
*
* @namespace preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
* @name preferences
*/
/**
* Provides interfaces to obtain and modify preferences data.
*
* @namespace preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
* @name preferences
*/
declare namespace preferences {
/**
* Indicates possible value types
*
* @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean>}
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Indicates possible value types
*
* @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean>}
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 10
*/
/**
* Indicates possible value types
*
* @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean> | Uint8Array}
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 11
*/
/**
* Indicates possible value types
*
* @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean> | Uint8Array | object |
* bigint}
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
type ValueType = number | string | boolean | Array<number> | Array<string> | Array<boolean> | Uint8Array | object | bigint;
/**
* Indicates the maximum length of a key (80 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Indicates the maximum length of a key (80 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Indicates the maximum length of a key (80 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Maximum length of a key.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 12
*/
const MAX_KEY_LENGTH: number;
/**
* Indicates the maximum length of a string (8192 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Indicates the maximum length of a string (8192 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Indicates the maximum length of a string (8192 characters).
*
* @constant
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Maximum length of a value.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 12
*/
const MAX_VALUE_LENGTH: number;
/**
* the storage type
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 18
*/
enum StorageType {
/**
* XML storage type
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 18
*/
XML = 0,
/**
* GSKV storage type
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 18
*/
GSKV
}
/**
* Manages preferences file configurations.
*
* @interface Options
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Manages preferences file configurations.
*
* @interface Options
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
interface Options {
/**
* The preferences file name.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* The preferences file name.
*
* @type { string }
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Application Group Id.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @StageModelOnly
* @since 10
*/
/**
* Application Group Id.
*
* @type { ?(string | null | undefined) }
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @StageModelOnly
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
dataGroupId?: string | null | undefined;
/**
* The preferences storage type.
*
* @type { ?(StorageType | null | undefined) }
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 18
*/
storageType?: StorageType | null | undefined;
}
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<Preferences> } callback - The {@link Preferences} instance matching the specified
* preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<Preferences> } callback - The {@link Preferences} instance matching the specified
* preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<Preferences> } callback - The {@link Preferences} instance matching the specified
* preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getPreferences(context: Context, name: string, callback: AsyncCallback<Preferences>): void;
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<Preferences> } callback - The {@link Preferences} instance matching the specified
* preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<Preferences> } callback - The {@link Preferences} instance matching the specified
* preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getPreferences(context: Context, options: Options, callback: AsyncCallback<Preferences>): void;
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<Preferences> } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<Preferences> } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<Preferences> } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getPreferences(context: Context, name: string): Promise<Preferences>;
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<Preferences> } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<Preferences> } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getPreferences(context: Context, options: Options): Promise<Preferences>;
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* This interface is executed synchronously.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Preferences } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* This interface is executed synchronously.
* <p>The {@link references} instance loads all data of the preferences file and
* resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Preferences } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getPreferencesSync(context: Context, options: Options): Preferences;
/**
* check the {@link StorageType} type is supported or not on current system.
* @param { StorageType } type - Indicates storage type which want to check.
* @returns { boolean } a boolean value indicates this system support the type or not.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 18
*/
function isStorageTypeSupported(type: StorageType): boolean;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function deletePreferences(context: Context, name: string, callback: AsyncCallback<void>): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function deletePreferences(context: Context, name: string): Promise<void>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15500010 - Failed to delete the user preferences persistence file.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function deletePreferences(context: Context, options: Options): Promise<void>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback<void>): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCache(context: Context, options: Options, callback: AsyncCallback<void>): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCache(context: Context, name: string): Promise<void>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCache(context: Context, options: Options): Promise<void>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache. This interface is executed synchronously.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache. This interface is executed synchronously.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { string } name - Indicates the preferences file name.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCacheSync(context: Context, name: string): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache. This interface is executed synchronously.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache. This interface is executed synchronously.
* <p>When deleting the {@link Preferences} instance, you must release all references
* of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
* will occur.
*
* @param { Context } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15501001 - The operations is supported in stage mode only.
* @throws { BusinessError } 15501002 - Invalid dataGroupId.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removePreferencesFromCacheSync(context: Context, options: Options): void;
/**
* Provides interfaces to obtain and modify preferences data.
* <p>The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory.
* You can use getPreferences to obtain the {@link Preferences} instance matching
* the file that stores preferences data, and use movePreferencesFromCache
* to remove the {@link Preferences} instance from the memory.
*
* @interface Preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Provides interfaces to obtain and modify preferences data.
* <p>The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory.
* You can use getPreferences to obtain the {@link Preferences} instance matching
* the file that stores preferences data, and use movePreferencesFromCache
* to remove the {@link Preferences} instance from the memory.
*
* @interface Preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Provides interfaces to obtain and modify preferences data.
* <p>The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory.
* You can use getPreferences to obtain the {@link Preferences} instance matching
* the file that stores preferences data, and use movePreferencesFromCache
* to remove the {@link Preferences} instance from the memory.
*
* @interface Preferences
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
interface Preferences {
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @param { AsyncCallback<ValueType> } callback - The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @param { AsyncCallback<ValueType> } callback - The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @param { AsyncCallback<ValueType> } callback - The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void;
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @returns { Promise<ValueType> } The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @returns { Promise<ValueType> } The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains the value of a preferences in the ValueType format.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @returns { Promise<ValueType> } The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
get(key: string, defValue: ValueType): Promise<ValueType>;
/**
* Obtains the value of a preferences in the ValueType format. This interface is executed synchronously.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @returns { ValueType } The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains the value of a preferences in the ValueType format. This interface is executed synchronously.
* <p>If the value is {@code null} or not in the ValueType format, the default value is returned.
*
* @param { string } key - Indicates the key of the preferences. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } defValue - Indicates the default value to return.
* @returns { ValueType } The value matching the specified key if it is found;
* returns the default value otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getSync(key: string, defValue: ValueType): ValueType;
/**
* Obtains all the keys and values of a preferences in an object.
*
* @param { AsyncCallback<Object> } callback - The values and keys in an object.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains all the keys and values of a preferences in an object.
*
* @param { AsyncCallback<Object> } callback - The values and keys in an object.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains all the keys and values of a preferences in an object.
*
* @param { AsyncCallback<Object> } callback - The values and keys in an object.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAll(callback: AsyncCallback<Object>): void;
/**
* Obtains all the keys and values of a preferences in an object.
*
* @returns { Promise<Object> } The values and keys in an object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Obtains all the keys and values of a preferences in an object.
*
* @returns { Promise<Object> } The values and keys in an object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains all the keys and values of a preferences in an object.
*
* @returns { Promise<Object> } The values and keys in an object.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAll(): Promise<Object>;
/**
* Obtains all the keys and values of a preferences in an object. This interface
* is executed synchronously.
*
* @returns { Object } The values and keys in an object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Obtains all the keys and values of a preferences in an object. This interface
* is executed synchronously.
*
* @returns { Object } The values and keys in an object.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAllSync(): Object;
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<boolean> } callback - {@code true} if the {@link Preferences} object contains a
* preferences with the specified key;returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<boolean> } callback - {@code true} if the {@link Preferences} object contains a
* preferences with the specified key;returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<boolean> } callback - {@code true} if the {@link Preferences} object contains a
* preferences with the specified key;returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
has(key: string, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<boolean> } {@code true} if the {@link Preferences} object contains
* a preferences with the specified key; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<boolean> } {@code true} if the {@link Preferences} object contains
* a preferences with the specified key; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<boolean> } {@code true} if the {@link Preferences} object contains
* a preferences with the specified key; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
has(key: string): Promise<boolean>;
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key. This interface
* is executed synchronously.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { boolean } {@code true} if the {@link Preferences} object contains
* a preferences with the specified key; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Checks whether the {@link Preferences} object contains a preferences matching a specified key. This interface
* is executed synchronously.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { boolean } {@code true} if the {@link Preferences} object contains
* a preferences with the specified key; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
hasSync(key: string): boolean;
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
put(key: string, value: ValueType, callback: AsyncCallback<void>): void;
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Sets an int value for the key in the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
put(key: string, value: ValueType): Promise<void>;
/**
* Sets an int value for the key in the {@link Preferences} object. This interface is executed synchronously.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Sets an int value for the key in the {@link Preferences} object. This interface is executed synchronously.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the
* file.
* <p>When the value contains strings in a non-UTF-8 format, use the Uint8Array type for storage.
* Otherwise, the format of the persistent file is incorrect and the file is damaged.
* <p>If the corresponding key already exists, the {@link put} method will overwrite its value.
* You can use the {@link #hasSync} method to check whether the corresponding key-value pair exists.
*
* @param { string } key - Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { ValueType } value - Indicates the value of the preferences.
* <tt>MAX_VALUE_LENGTH</tt>.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
putSync(key: string, value: ValueType): void;
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
delete(key: string, callback: AsyncCallback<void>): void;
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
delete(key: string): Promise<void>;
/**
* Deletes the preferences with a specified key from the {@link Preferences} object. This interface is
* executed synchronously. <p>You can call the {@link #flush} method to save the {@link Preferences}
* object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Deletes the preferences with a specified key from the {@link Preferences} object. This interface is
* executed synchronously. <p>You can call the {@link #flush} method to save the {@link Preferences}
* object to the file.
*
* @param { string } key - Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
* <tt>MAX_KEY_LENGTH</tt>.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
deleteSync(key: string): void;
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
clear(callback: AsyncCallback<void>): void;
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Clears all preferences from the {@link Preferences} object.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
clear(): Promise<void>;
/**
* Clears all preferences from the {@link Preferences} object. This interface is executed synchronously.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Clears all preferences from the {@link Preferences} object. This interface is executed synchronously.
* <p>You can call the {@link #flush} method to save the {@link Preferences} object to the file.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
clearSync(): void;
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified;
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified;
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @param { AsyncCallback<void> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Mandatory parameters are left unspecified.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
flush(callback: AsyncCallback<void>): void;
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @returns { Promise<void> } A promise object.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
flush(): Promise<void>;
/**
* Saves the {@link Preferences} object to the file.
*
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 14
*/
flushSync(): void;
/**
* Registers an observer to listen for the change of a {@link Preferences} object.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Callback<{ key: string }> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Registers an observer to listen for the change of a {@link Preferences} object.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Function } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Registers an observer to listen for the change of a {@link Preferences} object.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Callback<string> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 11
*/
on(type: 'change', callback: Callback<string>): void;
/**
* Registers an observer to listen for the change of a {@link Preferences} object.
*
* @param { 'multiProcessChange' } type - Indicates the callback when preferences changed in multiple processes.
* @param { Function } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500019 - Failed to obtain the subscription service.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 10
*/
/**
* Registers an observer to listen for the change of a {@link Preferences} object.
*
* @param { 'multiProcessChange' } type - Indicates the callback when preferences changed in multiple processes.
* @param { Callback<string> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @throws { BusinessError } 15500019 - Failed to obtain the subscription service.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 11
*/
on(type: 'multiProcessChange', callback: Callback<string>): void;
/**
* Registers an observer to listen for changes to the {@ link Preferences} object.
*
* @param { 'dataChange' } type - Indicates the type of the event to observe.
* @param { Array<string> } keys - Indicates one or more keys to listen for.
* @param { Callback<Record<string, ValueType>> } callback - Indicates the callback used to return the data change.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 12
*/
/**
* Registers an observer to listen for changes to the {@ link Preferences} object.
*
* @param { 'dataChange' } type - Indicates the type of the event to observe.
* @param { Array<string> } keys - Indicates one or more keys to listen for.
* @param { Callback<Record<string, ValueType>> } callback - Indicates the callback used to return the data change.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 20
*/
on(type: 'dataChange', keys: Array<string>, callback: Callback<Record<string, ValueType>>): void;
/**
* Unregisters an existing observer.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Callback<{ key: string }> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 9
*/
/**
* Unregisters an existing observer.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Function } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
/**
* Unregisters an existing observer.
*
* @param { 'change' } type - Indicates the callback when preferences changes.
* @param { Callback<string> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 11
*/
off(type: 'change', callback?: Callback<string>): void;
/**
* Unregisters an existing observer.
*
* @param { 'multiProcessChange' } type - Indicates the callback when preferences changed in multiple processes.
* @param { Function } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @since 10
*/
/**
* Unregisters an existing observer.
*
* @param { 'multiProcessChange' } type - Indicates the callback when preferences changed in multiple processes.
* @param { Callback<string> } callback - Indicates the callback function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 11
*/
off(type: 'multiProcessChange', callback?: Callback<string>): void;
/**
* Unregisters an observer for changes to the {@ link Preferences} object.
*
* @param { 'dataChange' } type - Indicates the event type.
* @param { Array<string> } keys - Indicates the data whose changes are not observed.
* @param { Callback<Record<string, ValueType>> } callback - Indicates the callback to unregister.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @atomicservice
* @since 12
*/
/**
* Unregisters an observer for changes to the {@ link Preferences} object.
*
* @param { 'dataChange' } type - Indicates the event type.
* @param { Array<string> } keys - Indicates the data whose changes are not observed.
* @param { Callback<Record<string, ValueType>> } callback - Indicates the callback to unregister.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br>1. Mandatory parameters are left unspecified; <br>2. Incorrect parameter types;
* <br>3. Parameter verification failed.
* @throws { BusinessError } 15500000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @atomicservice
* @since 20
*/
off(type: 'dataChange', keys: Array<string>, callback?: Callback<Record<string, ValueType>>): void;
}
}
export default preferences;
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

搜索帮助