提交 2246a4a1 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 b4a907e8
...@@ -3,91 +3,135 @@ ...@@ -3,91 +3,135 @@
- [开发说明](development-intro.md) - [开发说明](development-intro.md)
- Ability框架 - Ability框架
- Stage模型能力的接口(推荐)
- FA模型
- [@ohos.ability.ability (Ability)](js-apis-ability-ability.md)
- [@ohos.ability.featureAbility (FeatureAbility模块)](js-apis-ability-featureAbility.md)
- [@ohos.ability.particleAbility (ParticleAbility模块)](js-apis-ability-particleAbility.md)
- ability/[dataAbilityHelper (DataAbilityHelper模块)](js-apis-inner-ability-dataAbilityHelper.md)
- app/[context (Context模块)](js-apis-inner-app-context.md)
- Stage模型
- [@ohos.app.ability.Ability (Ability基类)](js-apis-app-ability-ability.md) - [@ohos.app.ability.Ability (Ability基类)](js-apis-app-ability-ability.md)
- [@ohos.app.ability.UIAbility (UIAbility)](js-apis-app-ability-uiAbility.md)
- [@ohos.app.ability.StartOptions (StartOptions)](js-apis-app-ability-startOptions.md)
- [@ohos.app.ability.AbilityConstant (AbilityConstant)](js-apis-app-ability-abilityConstant.md) - [@ohos.app.ability.AbilityConstant (AbilityConstant)](js-apis-app-ability-abilityConstant.md)
- [@ohos.app.ability.AbilityStage (AbilityStage)](js-apis-app-ability-abilityStage.md)
- [@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)](js-apis-app-ability-abilityLifecycleCallback.md) - [@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)](js-apis-app-ability-abilityLifecycleCallback.md)
- [@ohos.app.ability.AbilityStage (AbilityStage)](js-apis-app-ability-abilityStage.md)
- [@ohos.app.ability.common (应用上下文Context)](js-apis-app-ability-common.md)
- [@ohos.app.ability.contextConstant (ContextConstant)](js-apis-app-ability-contextConstant.md)
- [@ohos.app.ability.EnvironmentCallback (EnvironmentCallback)](js-apis-app-ability-environmentCallback.md) - [@ohos.app.ability.EnvironmentCallback (EnvironmentCallback)](js-apis-app-ability-environmentCallback.md)
- [@ohos.app.ability.ExtensionAbility(扩展能力基类)](js-apis-app-ability-extensionAbility.md) - [@ohos.app.ability.ExtensionAbility (扩展能力基类)](js-apis-app-ability-extensionAbility.md)
- [@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-app-ability-serviceExtensionAbility.md) - [@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-app-ability-serviceExtensionAbility.md)
- [@ohos.app.form.FormExtensionAbility(FormExtensionAbility)](js-apis-app-form-formExtensionAbility.md) - [@ohos.app.ability.StartOptions (StartOptions)](js-apis-app-ability-startOptions.md)
- [@ohos.app.ability.UIAbility (UIAbility)](js-apis-app-ability-uiAbility.md)
- [@ohos.app.form.FormExtensionAbility (FormExtensionAbility)](js-apis-app-form-formExtensionAbility.md)
- Stage模型能力的接口(待停用)
- [@ohos.application.Ability (Ability)](js-apis-application-ability.md)
- [@ohos.application.AbilityConstant (AbilityConstant)](js-apis-application-abilityConstant.md)
- [@ohos.application.AbilityLifecycleCallback (AbilityLifecycleCallback)](js-apis-application-abilityLifecycleCallback.md)
- [@ohos.application.AbilityStage (AbilityStage)](js-apis-application-abilityStage.md)
- [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-dataShareExtensionAbility.md) - [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-dataShareExtensionAbility.md)
- [@ohos.application.EnvironmentCallback (EnvironmentCallback)](js-apis-application-environmentCallback.md)
- [@ohos.application.ExtensionAbility (ExtensionAbility)](js-apis-application-extensionAbility.md)
- [@ohos.application.FormExtension (FormExtension)](js-apis-app-form-formExtensionAbility.md)
- [@ohos.application.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-application-serviceExtensionAbility.md)
- [@ohos.application.StartOptions (StartOptions)](js-apis-application-startOptions.md)
- [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md) - [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
- [@ohos.application.WindowExtensionAbility (窗口扩展能力)](js-apis-application-windowExtensionAbility.md) - [@ohos.application.context (Context)](js-apis-application-context.md)
- [@ohos.app.ability.common(应用上下文Context)](js-apis-app-ability-common.md) - FA模型能力的接口
- application/[ApplicationContext (ApplicationContext)](js-apis-inner-application-applicationContext.md) - [@ohos.ability.ability (Ability)](js-apis-ability-ability.md)
- application/[AbilityStageContext (AbilityStageContext)](js-apis-inner-application-abilityStageContext.md) - [@ohos.ability.featureAbility (FeatureAbility模块)](js-apis-ability-featureAbility.md)
- application/[Context (Context)](js-apis-inner-application-context.md) - [@ohos.ability.particleAbility (ParticleAbility模块)](js-apis-ability-particleAbility.md)
- application/[UIAbilityContext (UIAbilityContext)](js-apis-inner-application-uiAbilityContext.md) - 通用能力的接口(推荐)
- application/[ExtensionContext (ExtensionContext)](js-apis-inner-application-extensionContext.md)
- application/[FormExtensionContext (FormExtensionContext)](js-apis-inner-application-formExtensionContext.md)
- application/[ServiceExtensionContext (ServiceExtensionContext)](js-apis-inner-application-serviceExtensionContext.md)
- application/[PermissionRequestResult (PermissionRequestResult)](js-apis-inner-application-permissionRequestResult.md)
- 通用
- [@ohos.ability.dataUriUtils (DataUriUtils模块)](js-apis-ability-dataUriUtils.md)
- [@ohos.ability.errorCode (ErrorCode)](js-apis-ability-errorCode.md)
- [@ohos.app.ability.wantConstant (wantConstant)](js-apis-app-ability-wantConstant.md)
- [@ohos.ability.wantConstant (wantConstant)](js-apis-ability-wantConstant.md)
- [@ohos.app.ability.quickFixManager (quickFixManager)](js-apis-app-ability-quickFixManager.md)
- [@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-app-ability-abilityDelegatorRegistry.md) - [@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-app-ability-abilityDelegatorRegistry.md)
- [@ohos.app.ability.abilityManager (AbilityManager)](js-apis-app-ability-abilityManager.md) - [@ohos.app.ability.abilityManager (AbilityManager)](js-apis-app-ability-abilityManager.md)
- [@ohos.app.ability.appManager (appManager)](js-apis-app-ability-appManager.md)
- [@ohos.app.ability.appRecovery (appRecovery)](js-apis-app-ability-appRecovery.md) - [@ohos.app.ability.appRecovery (appRecovery)](js-apis-app-ability-appRecovery.md)
- [@ohos.app.ability.Configuration (Configuration)](js-apis-app-ability-configuration.md)
- [@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)](js-apis-app-ability-configurationConstant.md)
- [@ohos.app.ability.errorManager (ErrorManager)](js-apis-app-ability-errorManager.md)
- [@ohos.app.ability.missionManager (missionManager)](js-apis-app-ability-missionManager.md)
- [@ohos.app.ability.quickFixManager (quickFixManager)](js-apis-app-ability-quickFixManager.md)
- [@ohos.app.ability.Want (Want)](js-apis-app-ability-want.md)
- [@ohos.app.ability.wantAgent (WantAgent模块)](js-apis-app-ability-wantAgent.md)
- [@ohos.app.ability.wantConstant (wantConstant)](js-apis-app-ability-wantConstant.md)
- [@ohos.app.form.formBindingData (卡片数据绑定类)](js-apis-app-form-formBindingData.md)
- [@ohos.app.form.formHost (FormHost)](js-apis-app-form-formHost.md)
- [@ohos.app.form.formInfo (FormInfo)](js-apis-app-form-formInfo.md)
- [@ohos.app.form.formProvider (FormProvider)](js-apis-app-form-formProvider.md)
- 通用能力的接口(待停用)
- [@ohos.ability.dataUriUtils (DataUriUtils模块)](js-apis-ability-dataUriUtils.md)
- [@ohos.ability.errorCode (ErrorCode)](js-apis-ability-errorCode.md)
- [@ohos.ability.wantConstant (wantConstant)](js-apis-ability-wantConstant.md)
- [@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-application-abilityDelegatorRegistry.md) - [@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-application-abilityDelegatorRegistry.md)
- [@ohos.application.abilityManager (AbilityManager)](js-apis-application-abilityManager.md) - [@ohos.application.abilityManager (AbilityManager)](js-apis-application-abilityManager.md)
- [@ohos.app.ability.appManager (appManager)](js-apis-app-ability-appManager.md)
- [@ohos.application.appManager (appManager)](js-apis-application-appManager.md) - [@ohos.application.appManager (appManager)](js-apis-application-appManager.md)
- [@ohos.app.ability.Configuration (Configuration)](js-apis-app-ability-configuration.md)
- [@ohos.application.Configuration (Configuration)](js-apis-application-configuration.md) - [@ohos.application.Configuration (Configuration)](js-apis-application-configuration.md)
- [@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)](js-apis-app-ability-configurationConstant.md)
- [@ohos.application.ConfigurationConstant (ConfigurationConstant)](js-apis-application-configurationConstant.md) - [@ohos.application.ConfigurationConstant (ConfigurationConstant)](js-apis-application-configurationConstant.md)
- [@ohos.app.ability.errorManager (ErrorManager)](js-apis-app-ability-errorManager.md)
- [@ohos.application.errorManager (ErrorManager)](js-apis-application-errorManager.md) - [@ohos.application.errorManager (ErrorManager)](js-apis-application-errorManager.md)
- [@ohos.application.formBindingData (卡片数据绑定类)](js-apis-application-formBindingData.md) - [@ohos.application.formBindingData (卡片数据绑定类)](js-apis-application-formBindingData.md)
- [@ohos.application.formError (FormError)](js-apis-application-formError.md) - [@ohos.application.formError (FormError)](js-apis-application-formError.md)
- [@ohos.application.formHost (FormHost)](js-apis-application-formHost.md) - [@ohos.application.formHost (FormHost)](js-apis-application-formHost.md)
- [@ohos.application.formInfo (FormInfo)](js-apis-application-formInfo.md) - [@ohos.application.formInfo (FormInfo)](js-apis-application-formInfo.md)
- [@ohos.application.formProvider (FormProvider)](js-apis-application-formProvider.md) - [@ohos.application.formProvider (FormProvider)](js-apis-application-formProvider.md)
- [@ohos.app.ability.missionManager (missionManager)](js-apis-app-ability-missionManager.md)
- [@oho.app.form.formBindingData (卡片数据绑定类)](js-apis-app-form-formBindingData.md)
- [@ohos.application.formError (FormError)](js-apis-application-formError.md)
- [@ohos.app.form.formHost (FormHost)](js-apis-app-form-formHost.md)
- [@ohos.app.form.formProvider (FormProvider)](js-apis-app-form-formProvider.md)
- [@ohos.app.form.formInfo (FormInfo)](js-apis-app-form-formInfo.md)
- [@ohos.application.missionManager (missionManager)](js-apis-application-missionManager.md) - [@ohos.application.missionManager (missionManager)](js-apis-application-missionManager.md)
- [@ohos.app.ability.Want (Want)](js-apis-app-ability-want.md) - [@ohos.application.Want (Want)](js-apis-application-want.md)
- [@ohos.application.Want (Want)](js-apis-app-ability-want.md)
- [@ohos.continuation.continuationManager (continuationManager)](js-apis-continuation-continuationManager.md)
- [@ohos.app.ability.wantAgent (WantAgent模块)](js-apis-app-ability-wantAgent.md)
- [@ohos.wantAgent (WantAgent模块)](js-apis-wantAgent.md) - [@ohos.wantAgent (WantAgent模块)](js-apis-wantAgent.md)
- ability/[abilityResult (AbilityResult)](js-apis-inner-ability-abilityResult.md) - 接口依赖的元素及定义
- ability/[Want (Want)](js-apis-application-want.md) - ability
- application/[abilityDelegator (AbilityDelegator)](js-apis-inner-application-abilityDelegator.md) - [abilityResult (AbilityResult)](js-apis-inner-ability-abilityResult.md)
- application/[abilityDelegatorArgs (AbilityDelegatorArgs)](js-apis-inner-application-abilityDelegatorArgs.md) - [connectOptions(ConnectOptions)](js-apis-inner-ability-connectOptions.md)
- application/[abilityMonitor (AbilityMonitor)](js-apis-application-abilityMonitor.md) - [dataAbilityHelper (DataAbilityHelper模块)](js-apis-inner-ability-dataAbilityHelper.md)
- application/[AbilityRunningInfo (AbilityRunningInfo)](js-apis-inner-application-abilityRunningInfo.md) - [dataAbilityOperation (DataAbilityOperation)](js-apis-inner-ability-dataAbilityOperation.md)
- application/[ExtensionRunningInfo (ExtensionRunningInfo)](js-apis-inner-application-extensionRunningInfo.md) - [dataAbilityResult (DataAbilityResult)](js-apis-inner-ability-dataAbilityResult.md)
- application/[MissionSnapshot (MissionSnapshot)](js-apis-inner-application-missionSnapshot.md) - [startAbilityParameter (StartAbilityParameter)](js-apis-inner-ability-startAbilityParameter.md)
- application/[ProcessRunningInformation (ProcessRunningInformation)](js-apis-inner-application-processRunningInformation.md) - [want](js-apis-inner-ability-want.md)
- application/[shellCmdResult (ShellCmdResult)](js-apis-inner-application-shellCmdResult.md) - app
- continuation/[continuationExtraParams (ContinuationExtraParams)](js-apis-continuation-continuationExtraParams.md) - [appVersionInfo (AppVersionInfo)](js-apis-inner-app-appVersionInfo.md)
- continuation/[continuationResult (ContinuationResult)](js-apis-continuation-continuationResult.md) - [context (Context模块)](js-apis-inner-app-context.md)
- [processInfo (ProcessInfo)](js-apis-inner-app-processInfo.md)
- application
- [AbilityContext]
- [abilityDelegator (AbilityDelegator)](js-apis-inner-application-abilityDelegator.md)
- [abilityDelegatorArgs (AbilityDelegatorArgs)](js-apis-inner-application-abilityDelegatorArgs.md)
- [abilityMonitor (AbilityMonitor)](js-apis-inner-application-abilityMonitor.md)
- [AbilityRunningInfo (AbilityRunningInfo)](js-apis-inner-application-abilityRunningInfo.md)
- [AbilityStageContext (AbilityStageContext)](js-apis-inner-application-abilityStageContext.md)
- [AbilityStateData (AbilityStateData)](js-apis-inner-application-abilityStateData.md)
- [abilityStageMonitor (AbilityStageMonitor)](js-apis-inner-application-abilityStageMonitor.md)
- [ApplicationContext (ApplicationContext)](js-apis-inner-application-applicationContext.md)
- [ApplicationStateObserver (ApplicationStateObserver)](js-apis-inner-application-applicationStateObserver.md)
- [AppStateData (AppStateData)](js-apis-inner-application-appStateData.md)
- [BaseContext (BaseContext)](js-apis-inner-application-baseContext.md)
- [Context (Context)](js-apis-inner-application-context.md)
- [ContinueCallback (ContinueCallback)](js-apis-inner-application-continueCallback.md)
- [ContinueDeviceInfo (ContinueDeviceInfo)](js-apis-inner-application-continueDeviceInfo.md)
- [ErrorObserver (ErrorObserver)](js-apis-inner-application-errorObserver.md)
- [ExtensionContext (ExtensionContext)](js-apis-inner-application-extensionContext.md)
- [ExtensionRunningInfo (ExtensionRunningInfo)](js-apis-inner-application-extensionRunningInfo.md)
- [FormExtensionContext (FormExtensionContext)](js-apis-inner-application-formExtensionContext.md)
- [MissionCallbacks (MissionCallbacks)](js-apis-inner-application-missionCallbacks.md)
- [MissionDeviceInfo (MissionDeviceInfo)](js-apis-inner-application-missionDeviceInfo.md)
- [MissionInfo (MissionInfo)](js-apis-inner-application-missionInfo.md)
- [MissionListener (MissionListener)](js-apis-inner-application-missionListener.md)
- [MissionParameter (MissionParameter)](js-apis-inner-application-missionParameter.md)
- [MissionSnapshot (MissionSnapshot)](js-apis-inner-application-missionSnapshot.md)
- [PermissionRequestResult (PermissionRequestResult)](js-apis-inner-application-permissionRequestResult.md)
- [ProcessData (ProcessData)](js-apis-inner-application-processData.md)
- [ProcessRunningInfo (ProcessRunningInfo)](js-apis-inner-application-processRunningInfo.md)
- [ProcessRunningInformation (ProcessRunningInformation)](js-apis-inner-application-processRunningInformation.md)
- [ServiceExtensionContext (ServiceExtensionContext)](js-apis-inner-application-serviceExtensionContext.md)
- [UIAbilityContext (UIAbilityContext)](js-apis-inner-application-uiAbilityContext.md)
- [shellCmdResult (ShellCmdResult)](js-apis-inner-application-shellCmdResult.md)
- wantAgent
- [triggerInfo (TriggerInfo)](js-apis-inner-wantAgent-triggerInfo.md)
- [wantAgentInfo (WantAgentInfo)](js-apis-inner-wantAgent-wantAgentInfo.md)
- 流转
- [@ohos.continuation.continuationManager (continuationManager)](js-apis-continuation-continuationManager.md)
- continuation
- [continuationExtraParams (ContinuationExtraParams)](js-apis-continuation-continuationExtraParams.md)
- [continuationResult (ContinuationResult)](js-apis-continuation-continuationResult.md)
- 公共事件与通知 - 公共事件与通知
- [@ohos.commonEventManager (公共事件模块)](js-apis-commonEventManager.md) - [@ohos.commonEventManager (公共事件模块)](js-apis-commonEventManager.md)
- [@ohos.events.emitter (Emitter)](js-apis-emitter.md) - [@ohos.events.emitter (Emitter)](js-apis-emitter.md)
- [@ohos.notification (Notification模块)](js-apis-notification.md) - [@ohos.notificationManager (NotificationManager模块)(推荐)](js-apis-notificationManager.md)
- application/[EventHub (EventHub)](js-apis-inner-application-eventHub.md) - [@ohos.notificationSubscribe (NotificationSubscribe模块)(推荐)](js-apis-notificationSubscribe.md)
- [@ohos.commonEvent (公共事件模块)(待停用)](js-apis-commonEvent.md)
- [@ohos.notification (Notification模块)(待停用)](js-apis-notification.md)
- application
- [EventHub (EventHub)](js-apis-inner-application-eventHub.md)
- 包管理 - 包管理
- [@ohos.bundle.appControl(appControl模块)](js-apis-appControl.md) - [@ohos.bundle.appControl(appControl模块)](js-apis-appControl.md)
...@@ -99,19 +143,20 @@ ...@@ -99,19 +143,20 @@
- [@ohos.bundle.installer (installer模块)](js-apis-installer.md) - [@ohos.bundle.installer (installer模块)](js-apis-installer.md)
- [@ohos.bundle.launcherBundleManager (launcherBundleManager模块)](js-apis-launcherBundleManager.md) - [@ohos.bundle.launcherBundleManager (launcherBundleManager模块)](js-apis-launcherBundleManager.md)
- [@ohos.zlib (Zip模块)](js-apis-zlib.md) - [@ohos.zlib (Zip模块)](js-apis-zlib.md)
- bundleManager/[abilityInfo (AbilityInfo)](js-apis-bundleManager-abilityInfo.md) - bundleManager
- bundleManager/[applicationInfo (ApplicationInfo)](js-apis-bundleManager-applicationInfo.md) - [abilityInfo (AbilityInfo)](js-apis-bundleManager-abilityInfo.md)
- bundleManager/[bundleInfo (BundleInfo)](js-apis-bundleManager-bundleInfo.md) - [applicationInfo (ApplicationInfo)](js-apis-bundleManager-applicationInfo.md)
- bundleManager/[dispatchInfo (DispatchInfo)](js-apis-bundleManager-dispatchInfo.md) - [bundleInfo (BundleInfo)](js-apis-bundleManager-bundleInfo.md)
- bundleManager/[elementName (ElementName)](js-apis-bundleManager-elementName.md) - [dispatchInfo (DispatchInfo)](js-apis-bundleManager-dispatchInfo.md)
- bundleManager/[extensionAbilityInfo (ExtensionAbilityInfo)](js-apis-bundleManager-extensionAbilityInfo.md) - [elementName (ElementName)](js-apis-bundleManager-elementName.md)
- bundleManager/[hapModuleInfo (HapModuleInfo)](js-apis-bundleManager-hapModuleInfo.md) - [extensionAbilityInfo (ExtensionAbilityInfo)](js-apis-bundleManager-extensionAbilityInfo.md)
- bundleManager/[launcherAbilityInfo (LauncherAbilityInfo)](js-apis-bundleManager-launcherAbilityInfo.md) - [hapModuleInfo (HapModuleInfo)](js-apis-bundleManager-hapModuleInfo.md)
- bundleManager/[metadata (Metadata)](js-apis-bundleManager-metadata.md) - [launcherAbilityInfo (LauncherAbilityInfo)](js-apis-bundleManager-launcherAbilityInfo.md)
- bundleManager/[packInfo (PackInfo)](js-apis-bundleManager-packInfo.md) - [metadata (Metadata)](js-apis-bundleManager-metadata.md)
- bundleManager/[permissionDef (PermissionDef)](js-apis-bundleManager-permissionDef.md) - [packInfo (PackInfo)](js-apis-bundleManager-packInfo.md)
- bundleManager/[remoteAbilityInfo (RemoteAbilityInfo)](js-apis-bundleManager-remoteAbilityInfo.md) - [permissionDef (PermissionDef)](js-apis-bundleManager-permissionDef.md)
- bundleManager/[shortcutInfo (ShortcutInfo)](js-apis-bundleManager-shortcutInfo.md) - [remoteAbilityInfo (RemoteAbilityInfo)](js-apis-bundleManager-remoteAbilityInfo.md)
- [shortcutInfo (ShortcutInfo)](js-apis-bundleManager-shortcutInfo.md)
- UI界面 - UI界面
- [@ohos.animator (动画)](js-apis-animator.md) - [@ohos.animator (动画)](js-apis-animator.md)
...@@ -123,6 +168,7 @@ ...@@ -123,6 +168,7 @@
- 图形图像 - 图形图像
- [@ohos.animation.windowAnimationManager (窗口动画管理)](js-apis-windowAnimationManager.md) - [@ohos.animation.windowAnimationManager (窗口动画管理)](js-apis-windowAnimationManager.md)
- [@ohos.application.WindowExtensionAbility (窗口扩展能力)](js-apis-application-windowExtensionAbility.md)
- [@ohos.display (屏幕属性)](js-apis-display.md) - [@ohos.display (屏幕属性)](js-apis-display.md)
- [@ohos.effectKit (图像效果)](js-apis-effectKit.md) - [@ohos.effectKit (图像效果)](js-apis-effectKit.md)
- [@ohos.graphics.colorSpaceManager(色彩管理)](js-apis-colorSpaceManager.md) - [@ohos.graphics.colorSpaceManager(色彩管理)](js-apis-colorSpaceManager.md)
...@@ -171,7 +217,8 @@ ...@@ -171,7 +217,8 @@
- [@ohos.data.preferences (首选项)](js-apis-data-preferences.md) - [@ohos.data.preferences (首选项)](js-apis-data-preferences.md)
- [@ohos.data.rdb (关系型数据库)](js-apis-data-rdb.md) - [@ohos.data.rdb (关系型数据库)](js-apis-data-rdb.md)
- [@ohos.data.ValuesBucket (数据集)](js-apis-data-valuesBucket.md) - [@ohos.data.ValuesBucket (数据集)](js-apis-data-valuesBucket.md)
- data/rdb/[resultSet (结果集)](js-apis-data-resultset.md) - data/rdb
- [resultSet (结果集)](js-apis-data-resultset.md)
- 文件管理 - 文件管理
- [@ohos.environment (目录环境能力)](js-apis-environment.md) - [@ohos.environment (目录环境能力)](js-apis-environment.md)
...@@ -210,10 +257,13 @@ ...@@ -210,10 +257,13 @@
- [@ohos.nfc.controller (标准NFC)](js-apis-nfcController.md) - [@ohos.nfc.controller (标准NFC)](js-apis-nfcController.md)
- [@ohos.nfc.tag (标准NFC-Tag)](js-apis-nfcTag.md) - [@ohos.nfc.tag (标准NFC-Tag)](js-apis-nfcTag.md)
- [@ohos.rpc (RPC通信)](js-apis-rpc.md) - [@ohos.rpc (RPC通信)](js-apis-rpc.md)
- [@ohos.wifi (WLAN)](js-apis-wifi.md) - [@ohos.wifiManager (WLAN)(推荐)](js-apis-wifiManager.md)
- [@ohos.wifiext (WLAN扩展接口)](js-apis-wifiext.md) - [@ohos.wifiManagerExt (WLAN扩展接口)(推荐)](js-apis-wifiManagerExt.md)
- tag/[nfctech (标准NFC-Tag Nfc 技术)](js-apis-nfctech.md) - [@ohos.wifi (WLAN)(待停用)](js-apis-wifi.md)
- tag/[tagSession (标准NFC-Tag TagSession)](js-apis-tagSession.md) - [@ohos.wifiext (WLAN扩展接口)(待停用)](js-apis-wifiext.md)
- tag
- [nfctech (标准NFC-Tag Nfc 技术)](js-apis-nfctech.md)
- [tagSession (标准NFC-Tag TagSession)](js-apis-tagSession.md)
- 系统基础能力 - 系统基础能力
- [@ohos.accessibility (辅助功能)](js-apis-accessibility.md) - [@ohos.accessibility (辅助功能)](js-apis-accessibility.md)
...@@ -242,7 +292,8 @@ ...@@ -242,7 +292,8 @@
- [@ohos.web.webview(Web)](js-apis-webview.md) - [@ohos.web.webview(Web)](js-apis-webview.md)
- [console (日志打印)](js-apis-logs.md) - [console (日志打印)](js-apis-logs.md)
- [Timer (定时器)](js-apis-timer.md) - [Timer (定时器)](js-apis-timer.md)
- application/[AccessibilityExtensionContext (辅助功能扩展上下文)](js-apis-inner-application-accessibilityExtensionContext.md) - application
- [AccessibilityExtensionContext (辅助功能扩展上下文)](js-apis-inner-application-accessibilityExtensionContext.md)
- 设备管理 - 设备管理
- [@ohos.batteryInfo (电量信息)](js-apis-battery-info.md) - [@ohos.batteryInfo (电量信息)](js-apis-battery-info.md)
...@@ -314,17 +365,11 @@ ...@@ -314,17 +365,11 @@
- [@ohos.uitest (UiTest)](js-apis-uitest.md) - [@ohos.uitest (UiTest)](js-apis-uitest.md)
- 已停止维护的接口 - 已停止维护的接口
- [@ohos.application.FormExtension (FormExtension)](js-apis-app-form-formExtensionAbility.md)
- [@ohos.application.formHost (FormHost)](js-apis-application-formHost.md)
- [@ohos.application.formProvider (FormProvider)](js-apis-application-formProvider.md)
- [@ohos.application.formInfo (FormInfo)](js-apis-application-formInfo.md)
- [@ohos.application.formBindingData (卡片数据绑定类)](js-apis-application-formBindingData.md)
- [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md) - [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md)
- [@ohos.bundle (Bundle模块)](js-apis-Bundle.md) - [@ohos.bundle (Bundle模块)](js-apis-Bundle.md)
- [@ohos.bundle.innerBundleManager (innerBundleManager模块)](js-apis-Bundle-InnerBundleManager.md) - [@ohos.bundle.innerBundleManager (innerBundleManager模块)](js-apis-Bundle-InnerBundleManager.md)
- [@ohos.bundleState (设备使用信息统计)](js-apis-deviceUsageStatistics.md) - [@ohos.bundleState (设备使用信息统计)](js-apis-deviceUsageStatistics.md)
- [@ohos.bytrace (性能打点)](js-apis-bytrace.md) - [@ohos.bytrace (性能打点)](js-apis-bytrace.md)
- [@ohos.commonEvent (公共事件模块)](js-apis-commonEvent.md)
- [@ohos.data.storage (轻量级存储)](js-apis-data-storage.md) - [@ohos.data.storage (轻量级存储)](js-apis-data-storage.md)
- [@ohos.data.distributedData (分布式数据管理)](js-apis-distributed-data.md) - [@ohos.data.distributedData (分布式数据管理)](js-apis-distributed-data.md)
- [@ohos.distributedBundle (分布式包管理)](js-apis-Bundle-distributedBundle.md) - [@ohos.distributedBundle (分布式包管理)](js-apis-Bundle-distributedBundle.md)
...@@ -355,17 +400,17 @@ ...@@ -355,17 +400,17 @@
- [@system.sensor (传感器)](js-apis-system-sensor.md) - [@system.sensor (传感器)](js-apis-system-sensor.md)
- [@system.storage (数据存储)](js-apis-system-storage.md) - [@system.storage (数据存储)](js-apis-system-storage.md)
- [@system.vibrator (振动)](js-apis-system-vibrate.md) - [@system.vibrator (振动)](js-apis-system-vibrate.md)
- application/[ProcessRunningInfo (ProcessRunningInfo)](js-apis-inner-application-processRunningInfo.md) - bundle
- bundle/[abilityInfo (AbilityInfo)](js-apis-bundle-AbilityInfo.md) - [abilityInfo (AbilityInfo)](js-apis-bundle-AbilityInfo.md)
- bundle/[applicationInfo (ApplicationInfo)](js-apis-bundle-ApplicationInfo.md) - [applicationInfo (ApplicationInfo)](js-apis-bundle-ApplicationInfo.md)
- bundle/[bundleInfo (BundleInfo)](js-apis-bundle-BundleInfo.md) - [bundleInfo (BundleInfo)](js-apis-bundle-BundleInfo.md)
- bundle/[bundleInstaller (BundleInstaller)](js-apis-bundle-BundleInstaller.md) - [bundleInstaller (BundleInstaller)](js-apis-bundle-BundleInstaller.md)
- bundle/[bundleStatusCallback (BundleStatusCallback)](js-apis-Bundle-BundleStatusCallback.md) - [bundleStatusCallback (BundleStatusCallback)](js-apis-Bundle-BundleStatusCallback.md)
- bundle/[customizeData (CustomizeData)](js-apis-bundle-CustomizeData.md) - [customizeData (CustomizeData)](js-apis-bundle-CustomizeData.md)
- bundle/[elementName (ElementName)](js-apis-bundle-ElementName.md) - [elementName (ElementName)](js-apis-bundle-ElementName.md)
- bundle/[hapModuleInfo (HapModuleInfo)](js-apis-bundle-HapModuleInfo.md) - [hapModuleInfo (HapModuleInfo)](js-apis-bundle-HapModuleInfo.md)
- bundle/[launcherAbilityInfo (LauncherAbilityInfo)](js-apis-bundle-LauncherAbilityInfo.md) - [launcherAbilityInfo (LauncherAbilityInfo)](js-apis-bundle-LauncherAbilityInfo.md)
- bundle/[moduleInfo (ModuleInfo)](js-apis-bundle-ModuleInfo.md) - [moduleInfo (ModuleInfo)](js-apis-bundle-ModuleInfo.md)
- bundle/[PermissionDef (PermissionDef)](js-apis-bundle-PermissionDef.md) - [PermissionDef (PermissionDef)](js-apis-bundle-PermissionDef.md)
- bundle/[remoteAbilityInfo (RemoteAbilityInfo)](js-apis-bundle-remoteAbilityInfo.md) - [remoteAbilityInfo (RemoteAbilityInfo)](js-apis-bundle-remoteAbilityInfo.md)
- bundle/[shortcutInfo (shortcutInfo)](js-apis-bundle-ShortcutInfo.md) - [shortcutInfo (shortcutInfo)](js-apis-bundle-ShortcutInfo.md)
# Configuration
Configuration模块提供环境变化信息的能力。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import Configuration from '@ohos.application.Configuration';
```
## 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-application-configurationConstant.md) | 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 |
| direction<sup>9+</sup> | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
| screenDensity<sup>9+</sup> | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
| displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice<sup>9+</sup> | boolean | 是 | 否 | 指示指针类型设备是否已连接,如键鼠、触控板等。 |
# 网络共享管理
网络共享管理分享设备已有网络给其他连接设备,支持Wi-Fi热点共享和蓝牙共享,同时提供网络共享状态、共享流量查询功能。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import sharing from '@ohos.net.sharing'
```
## sharing.isSharingSupported
isSharingSupported(callback: AsyncCallback\<boolean>): void
判断是否支持网络共享,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数,返回true代表支持网络共享。 |
**示例:**
```js
sharing.isSharingSupported((error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.isSharingSupported
isSharingSupported(): Promise\<boolean>
判断是否支持网络共享,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<boolean> | 以Promise形式返回是否支持共享结果。 |
**示例:**
```js
sharing.isSharingSupported().then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.isSharing
isSharing(callback: AsyncCallback\<boolean>): void
获取当前网络共享状态,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数,返回true代表网络共享中。 |
**示例:**
```js
sharing.isSharing((error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.isSharing
isSharing(): Promise\<boolean>
获取当前网络共享状态,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<boolean> | 以Promise形式返回网络共享状态结果,返回true代表网络共享中。 |
**示例:**
```js
sharing.isSharing().then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.startSharing
startSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void
开启指定类型共享,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
| callback | AsyncCallback\<void> | 是 | 回调函数,返回开启网络共享结果。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.startSharing(SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
```
## sharing.startSharing
startSharing(type: SharingIfaceType): Promise\<void>
开启指定类型共享,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回开启共享执行结果。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.startSharing(SharingIfaceType.SHARING_WIFI).then(() => {
console.log("start wifi sharing successful");
}).catch(error => {
console.log("start wifi sharing failed");
});
```
## sharing.stopSharing
stopSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void
关闭指定类型共享,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
| callback | AsyncCallback\<void> | 是 | 回调函数,返回停止网络共享结果。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.stopSharing(SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
```
## sharing.stopSharing
stopSharing(type: SharingIfaceType): Promise\<void>
关闭指定类型共享,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回关闭共享执行结果。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.stopSharing(SharingIfaceType.SHARING_WIFI).then(() => {
console.log("stop wifi sharing successful");
}).catch(error => {
console.log("stop wifi sharing failed");
});
```
## sharing.getStatsRxBytes
getStatsRxBytes(callback: AsyncCallback\<number>): void
获取共享网络接收数据量,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<number> | 是 | 回调函数,number代表数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsRxBytes((error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getStatsRxBytes
getStatsRxBytes(): Promise\<number>
获取共享网络接收数据量,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<number> | 以Promise形式返回共享网络接收数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsRxBytes().then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.getStatsTxBytes
getStatsTxBytes(callback: AsyncCallback\<number>): void
获取共享网络发送数据量,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<number> | 是 | 回调函数,number代表数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsTxBytes((error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getStatsTxBytes
getStatsTxBytes(): Promise\<number>
获取共享网络发送数据量,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<number> | 以Promise形式返回共享网络发送数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsTxBytes().then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.getStatsTotalBytes
getStatsTotalBytes(callback: AsyncCallback\<number>): void
获取共享网络总数据量,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<number> | 是 | 回调函数,number代表数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsTotalBytes((error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getStatsTotalBytes
getStatsTotalBytes(): Promise\<number>
获取共享网络总数据量,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<number> | 以Promise形式返回共享网络总数据量,单位:KB。 |
**示例:**
```js
sharing.getStatsTotalBytes().then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.getSharingIfaces
getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback\<Array\<string>>): void
获取指定状态的网卡名称列表,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| state | [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调函数,返回指定状态的网卡名称列表。 |
**示例:**
```js
import SharingIfaceState from '@ohos.net.sharing'
sharing.getSharingIfaces(SharingIfaceState.SHARING_NIC_CAN_SERVER, (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getSharingIfaces
getSharingIfaces(state: SharingIfaceState): Promise\<Array\<string>>
获取指定状态的网卡名称列表,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| state | [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<string>> | 以Promise形式返回指定状态网卡名称列表。 |
**示例:**
```js
import SharingIfaceState from '@ohos.net.sharing'
sharing.getSharingIfaces(SharingIfaceState.SHARING_NIC_CAN_SERVER).then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.getSharingState
getSharingState(type: SharingIfaceType, callback: AsyncCallback\<SharingIfaceState>): void
获取指定类型网络共享状态,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
| callback | AsyncCallback\<[SharingIfaceState](#sharingifacestate)> | 是 | 回调函数,返回指定类型网络共享状态。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.getSharingState(SharingIfaceType.SHARING_WIFI, (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getSharingState
getSharingState(type: SharingIfaceType): Promise\<SharingIfaceState>
获取指定类型网络共享状态,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<[SharingIfaceState](#sharingifacestate)> | 以Promise形式返回定类型网络共共享状态。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.getSharingState(SharingIfaceType.SHARING_WIFI).then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.getSharableRegexes
getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback\<Array\<string>>): void
获取指定类型网卡名称正则表达式列表,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调函数,返回指定类型网卡名称正则表达式列表。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.getSharableRegexes(SharingIfaceType.SHARING_WIFI, (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.getSharableRegexes
getSharableRegexes(type: SharingIfaceType): Promise\<Array\<string>>
获取指定类型网卡名称正则表达式列表,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | [SharingIfaceType](#sharingifacetype) | 是 | 共享类型,0:Wi-Fi 1:USB 2:BLUETOOTH。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<string>> | 以Promise形式返回正则表达式列表。 |
**示例:**
```js
import SharingIfaceType from '@ohos.net.sharing'
sharing.getSharableRegexes(SharingIfaceType.SHARING_WIFI).then(data => {
console.log(JSON.stringify(data));
}).catch(error => {
console.log(JSON.stringify(error));
});
```
## sharing.on('sharingStateChange')
on(type: 'sharingStateChange', callback: Callback\<boolean>): void
注册网络共享状态变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数,返回网络共享状态。 |
**示例:**
```js
sharing.on('sharingStateChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.off('sharingStateChange')
off(type: 'sharingStateChange', callback?: Callback\<boolean>): void
注销网络共享状态变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<boolean> | 否 | 回调函数,返回网络共享状态。 |
**示例:**
```js
sharing.off('sharingStateChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.on('interfaceSharingStateChange')
on(type: 'interfaceSharingStateChange', callback: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void
注册网卡网络共享状态变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<{ type: [SharingIfaceType](#sharingifacetype), iface: string, state: SharingIfaceState(#sharingifacestate) }> | 是 | 回调函数,指定网卡共享状态变化时调用。 |
**示例:**
```js
sharing.on('interfaceSharingStateChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.off('interfaceSharingStateChange')
off(type: 'interfaceSharingStateChange', callback?: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void
注销网卡网络共享状态变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<{ type: [SharingIfaceType](#sharingifacetype), iface: string, state: SharingIfaceState(#sharingifacestate) }> | 否 | 回调函数,注销指定网卡共享状态变化通知。 |
**示例:**
```js
sharing.off('interfaceSharingStateChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.on('sharingUpstreamChange')
on(type: 'sharingUpstreamChange', callback: Callback\<NetHandle>): void
注册上行网络变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<NetHandle> | 是 | 回调函数,上行网络变化时调用。 |
**示例:**
```js
sharing.on('sharingUpstreamChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## sharing.off('sharingUpstreamChange')
off(type: 'sharingUpstreamChange', callback?: Callback\<NetHandle>): void
注销上行网络变化事件,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<NetHandle> | 否 | 回调函数,注销上行网络变化事件。 |
**示例:**
```js
sharing.off('sharingUpstreamChange', (error, data) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## SharingIfaceState
网络共享状态。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| SHARING_NIC_SERVING | 1 | 正在网络共享。 |
| SHARING_NIC_CAN_SERVER | 2 | 可提供网络共享。 |
| SHARING_NIC_ERROR | 3 | 网络共享错误。 |
## SharingIfaceType
网络共享类型(暂不支持USB共享)。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.NetSharing
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| SHARING_WIFI | 0 | 网络共享类型Wi-Fi。 |
| SHARING_USB | 1 | 网络共享类型USB。 |
| SHARING_BLUETOOTH | 2 | 网络共享类型蓝牙。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册