46 Star 176 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.cloudSync.d.ts
@ohos.file.cloudSyncManager.d.ts
@ohos.file.environment.d.ts
@ohos.file.fileAccess.d.ts
@ohos.file.fileExtensionInfo.d.ts
@ohos.file.fileuri.d.ts
@ohos.file.fs.d.ets
@ohos.file.fs.d.ts
@ohos.file.hash.d.ts
@ohos.file.keyManager.d.ts
@ohos.file.photoAccessHelper.d.ts
@ohos.file.picker.d.ts
@ohos.file.recent.d.ts
@ohos.file.securityLabel.d.ts
@ohos.file.sendablePhotoAccessHelper.d.ets
@ohos.file.statvfs.d.ts
@ohos.file.storageStatistics.d.ts
@ohos.file.trash.d.ts
@ohos.file.volumeManager.d.ts
@ohos.fileio.d.ts
@ohos.filemanagement.userFileManager.d.ts
@ohos.fileshare.d.ts
@ohos.font.d.ts
@ohos.fontManager.d.ts
@ohos.geoLocationManager.d.ts
@ohos.geolocation.d.ts
@ohos.graphics.colorSpaceManager.d.ts
@ohos.graphics.common2D.d.ts
@ohos.graphics.displaySync.d.ts
@ohos.graphics.drawing.d.ts
@ohos.graphics.hdrCapability.d.ts
@ohos.graphics.scene.d.ts
@ohos.graphics.sendableColorSpaceManager.d.ets
@ohos.graphics.text.d.ts
@ohos.graphics.uiEffect.d.ts
@ohos.hiAppEvent.d.ts
@ohos.hiSysEvent.d.ts
@ohos.hiTraceChain.d.ts
@ohos.hiTraceMeter.d.ts
@ohos.hichecker.d.ts
@ohos.hidebug.d.ts
@ohos.hilog.d.ts
@ohos.hiviewdfx.hiAppEvent.d.ts
@ohos.hiviewdfx.jsLeakWatcher.d.ts
@ohos.i18n.d.ts
@ohos.identifier.oaid.d.ts
@ohos.inputMethod.Panel.d.ts
@ohos.inputMethod.d.ts
@ohos.inputMethodEngine.d.ts
@ohos.inputMethodList.d.ets
@ohos.intl.d.ts
@ohos.logLibrary.d.ts
@ohos.matrix4.d.ets
@ohos.matrix4.d.ts
@ohos.measure.d.ts
@ohos.mediaquery.d.ets
@ohos.mediaquery.d.ts
@ohos.multimedia.audio.d.ts
@ohos.multimedia.audioHaptic.d.ts
@ohos.multimedia.avCastPicker.d.ets
@ohos.multimedia.avCastPickerParam.d.ts
@ohos.multimedia.avInputCastPicker.d.ets
@ohos.multimedia.avVolumePanel.d.ets
@ohos.multimedia.avsession.d.ts
@ohos.multimedia.camera.d.ts
@ohos.multimedia.cameraPicker.d.ts
@ohos.multimedia.drm.d.ts
@ohos.multimedia.image.d.ts
@ohos.multimedia.media.d.ts
@ohos.multimedia.movingphotoview.d.ts
@ohos.multimedia.sendableImage.d.ets
@ohos.multimedia.systemSoundManager.d.ts
@ohos.multimedia.videoProcessingEngine.d.ts
@ohos.multimodalAwareness.deviceStatus.d.ts
@ohos.multimodalAwareness.metadataBinding.d.ts
@ohos.multimodalAwareness.motion.d.ts
@ohos.multimodalAwareness.onScreen.d.ts
@ohos.multimodalAwareness.userStatus.d.ts
@ohos.multimodalInput.gestureEvent.d.ts
@ohos.multimodalInput.infraredEmitter.d.ts
@ohos.multimodalInput.inputConsumer.d.ts
@ohos.multimodalInput.inputDevice.d.ts
@ohos.multimodalInput.inputDeviceCooperate.d.ts
@ohos.multimodalInput.inputEvent.d.ts
@ohos.multimodalInput.inputEventClient.d.ts
@ohos.multimodalInput.inputMonitor.d.ts
@ohos.multimodalInput.intentionCode.d.ts
@ohos.multimodalInput.keyCode.d.ts
@ohos.multimodalInput.keyEvent.d.ts
@ohos.multimodalInput.mouseEvent.d.ts
@ohos.multimodalInput.pointer.d.ts
@ohos.multimodalInput.shortKey.d.ts
@ohos.multimodalInput.touchEvent.d.ts
@ohos.net.connection.d.ts
@ohos.net.eap.d.ts
@ohos.net.ethernet.d.ts
@ohos.net.http.d.ts
@ohos.net.mdns.d.ts
@ohos.net.netFirewall.d.ts
@ohos.net.networkSecurity.d.ts
@ohos.net.policy.d.ts
@ohos.net.sharing.d.ts
@ohos.net.socket.d.ts
@ohos.net.statistics.d.ts
@ohos.net.vpn.d.ts
@ohos.net.vpnExtension.d.ts
@ohos.net.webSocket.d.ts
@ohos.nfc.cardEmulation.d.ts
@ohos.nfc.controller.d.ts
@ohos.nfc.tag.d.ts
@ohos.notification.d.ts
@ohos.notificationManager.d.ts
@ohos.notificationSubscribe.d.ts
@ohos.pasteboard.d.ts
@ohos.pluginComponent.d.ts
@ohos.power.d.ts
@ohos.print.d.ts
@ohos.privacyManager.d.ts
@ohos.process.d.ts
@ohos.prompt.d.ets
@ohos.prompt.d.ts
@ohos.promptAction.d.ts
@ohos.reminderAgent.d.ts
@ohos.reminderAgentManager.d.ts
@ohos.request.cacheDownload.d.ts
@ohos.request.d.ts
@ohos.resourceManager.d.ts
@ohos.resourceschedule.backgroundProcessManager.d.ts
@ohos.resourceschedule.backgroundTaskManager.d.ts
@ohos.resourceschedule.deviceStandby.d.ts
@ohos.resourceschedule.systemload.d.ts
@ohos.resourceschedule.usageStatistics.d.ts
@ohos.resourceschedule.workScheduler.d.ts
@ohos.router.d.ets
@ohos.router.d.ts
@ohos.rpc.d.ts
@ohos.runningLock.d.ts
@ohos.scan.d.ets
@ohos.screen.d.ts
@ohos.screenLock.d.ts
@ohos.screenshot.d.ts
@ohos.secureElement.d.ts
@ohos.security.asset.d.ts
@ohos.security.cert.d.ts
@ohos.security.certManager.d.ts
@ohos.security.certManagerDialog.d.ts
@ohos.security.cryptoFramework.d.ts
@ohos.security.huks.d.ts
@ohos.security.securityGuard.d.ts
@ohos.selectionInput.SelectionExtensionAbility.d.ts
@ohos.selectionInput.SelectionExtensionContext.d.ts
@ohos.selectionInput.SelectionPanel.d.ts
@ohos.selectionInput.selectionManager.d.ts
@ohos.sendableResourceManager.d.ets
@ohos.sensor.d.ts
@ohos.settings.d.ts
@ohos.statfs.d.ts
@ohos.stationary.d.ts
@ohos.systemCapability.d.ts
@ohos.systemDateTime.d.ts
@ohos.systemParameterEnhance.d.ts
@ohos.systemTime.d.ts
@ohos.systemTimer.d.ts
@ohos.systemparameter.d.ts
@ohos.taskpool.d.ts
@ohos.telephony.call.d.ts
@ohos.telephony.data.d.ts
@ohos.telephony.esim.d.ts
@ohos.telephony.observer.d.ts
@ohos.telephony.radio.d.ts
@ohos.telephony.sim.d.ts
@ohos.telephony.sms.d.ts
@ohos.telephony.vcard.d.ts
@ohos.test.PerfTest.d.ts
@ohos.thermal.d.ts
@ohos.transfer.d.ets
@ohos.uiAppearance.d.ts
@ohos.uiExtensionHost.d.ets
@ohos.uiExtensionHost.d.ts
@ohos.update.d.ts
@ohos.uri.d.ts
@ohos.url.d.ts
@ohos.usb.d.ts
@ohos.usbManager.d.ts
@ohos.usbManager.serial.d.ts
@ohos.userIAM.faceAuth.d.ts
@ohos.userIAM.userAccessCtrl.d.ts
@ohos.userIAM.userAuth.d.ts
@ohos.userIAM.userAuthIcon.d.ets
@ohos.util.ArrayList.d.ts
@ohos.util.Deque.d.ts
@ohos.util.HashMap.d.ts
@ohos.util.HashSet.d.ts
@ohos.util.LightWeightMap.d.ts
@ohos.util.LightWeightSet.d.ts
@ohos.util.LinkedList.d.ts
@ohos.util.List.d.ts
@ohos.util.PlainArray.d.ts
@ohos.util.Queue.d.ts
@ohos.util.Stack.d.ts
@ohos.util.TreeMap.d.ts
@ohos.util.TreeSet.d.ts
@ohos.util.Vector.d.ts
@ohos.util.d.ets
@ohos.util.d.ts
@ohos.util.json.d.ts
@ohos.util.stream.d.ts
@ohos.vibrator.d.ts
@ohos.wallpaper.d.ts
@ohos.wantAgent.d.ts
@ohos.web.netErrorList.d.ts
@ohos.web.webview.d.ts
@ohos.wifi.d.ts
@ohos.wifiManager.d.ts
@ohos.wifiManagerExt.d.ts
@ohos.wifiext.d.ts
@ohos.window.d.ts
@ohos.window.floatingBall.d.ts
@ohos.worker.d.ts
@ohos.xml.d.ts
@ohos.zlib.d.ts
@system.app.d.ets
@system.app.d.ts
@system.battery.d.ts
@system.bluetooth.d.ts
@system.brightness.d.ts
@system.cipher.d.ts
@system.configuration.d.ts
@system.device.d.ts
@system.fetch.d.ts
@system.file.d.ts
@system.geolocation.d.ts
@system.mediaquery.d.ets
@system.mediaquery.d.ts
@system.network.d.ts
@system.notification.d.ts
@system.package.d.ts
@system.prompt.d.ets
@system.prompt.d.ts
@system.request.d.ts
@system.router.d.ets
@system.router.d.ts
@system.sensor.d.ts
@system.storage.d.ts
@system.vibrator.d.ts
permissions.d.ts
arkts
build-tools
kits
CODEOWNERS
.gitattributes
.gitignore
BUILD.gn
LICENCE.md
LICENSE
OAT.xml
README.md
README_zh.md
arkui_transformer.py
bundle.json
exists_path.py
interface_config.gni
ohos_copy_ets.py
process_internal.py
process_internal.pydeps
remove_internal.py
remove_internal.pydeps
remove_list.json
克隆/下载
@ohos.promptAction.d.ts 66.47 KB
一键复制 编辑 原始数据 按行查看 历史
屠吉人 提交于 27天前 . Merge branch 'pr_24149'
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528
/*
* Copyright (c) 2021-2023 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 ArkUI
*/
/*** if arkts 1.1 */
import { AsyncCallback } from './@ohos.base';
/*** endif */
/*** if arkts 1.2 */
import { ResourceColor, Offset, Dimension, EdgeStyles, EdgeColors,EdgeWidths, BorderRadiuses } from './arkui/component/units';
import { AsyncCallback, Callback } from './@ohos.base';
import { BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, Rectangle, TransitionEffect, KeyboardAvoidMode, DismissReason,
BackgroundBlurStyleOptions, BackgroundEffectOptions } from './arkui/component/common';
import { CustomBuilder } from './arkui/component/builder';
import { DialogAlignment } from './arkui/component/alertDialog';
import { BorderStyle,Alignment } from './arkui/component/enums';
import { Resource } from './global/resource';
import { LengthMetrics } from './arkui/Graphics';
/*** endif */
/**
* Define the display mode of all kind of dialog
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LevelMode {
/**
* Display above all page levels.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
OVERLAY = 0,
/**
* Display within the current page.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
EMBEDDED = 1,
}
/**
* Define the immersive mode of all kind of dialog
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum ImmersiveMode {
/**
* Mask covering the parent node.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
DEFAULT = 0,
/**
* Mask extend safe area includes status bar and navigation bar.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
EXTEND = 1,
}
/**
* Defines level order.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export declare class LevelOrder {
/**
* Generate valid level order.
*
* @param { number } order - Clamp order with mininum number -100000 and maximum number 100000.
* @returns { LevelOrder } the order object.
* @static
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
static clamp(order: number): LevelOrder;
/**
* Get the order from LevelOrder object.
*
* @returns { number } the order number.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
getOrder(): number;
}
/**
* @namespace promptAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @namespace promptAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @namespace promptAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace promptAction {
/**
* @typedef ShowToastOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef ShowToastOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef ShowToastOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ShowToastOptions {
/**
* Text to display.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Text to display.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Text to display.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
message: string | Resource;
/**
* Duration of toast dialog box. The default value is 1500.
* The recommended value ranges from 1500ms to 10000ms.
* NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Duration of toast dialog box. The default value is 1500.
* The recommended value ranges from 1500ms to 10000ms.
* NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Duration of toast dialog box. The default value is 1500.
* The recommended value ranges from 1500ms to 10000ms.
* NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
duration?: number;
/**
* The distance between toast dialog box and the bottom of screen.
*
* @type { ?(string | number) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* The distance between toast dialog box and the bottom of screen.
*
* @type { ?(string | number) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The distance between toast dialog box and the bottom of screen.
*
* @type { ?(string | number) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
bottom?: string | number;
/**
* Determine the show mode of the toast.
*
* @type { ?ToastShowMode }
* @default ToastShowMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Determine the show mode of the toast.
*
* @type { ?ToastShowMode }
* @default ToastShowMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
showMode?: ToastShowMode;
/**
* Defines the toast alignment of the screen.
*
* @type { ?Alignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
alignment?: Alignment;
/**
* Defines the toast offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
offset?: Offset;
/**
* Background color of toast.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundColor?: ResourceColor;
/**
* Text color of toast.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
textColor?: ResourceColor;
/**
* Background blur Style of toast.
*
* @type { ?BlurStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyle?: BlurStyle;
/**
* Shadow of toast.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
shadow?: ShadowOptions | ShadowStyle;
/**
* Define whether to respond to the hover mode.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
enableHoverMode?: boolean;
/**
* Defines the toast's display area in hover mode.
*
* @type { ?HoverModeAreaType }
* @default HoverModeAreaType.BOTTOM_SCREEN
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
hoverModeArea?: HoverModeAreaType;
}
/**
* Enum for the toast showMode.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Enum for the toast showMode.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum ToastShowMode {
/**
* Toast shows in app.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Toast shows in app.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
DEFAULT = 0,
/**
* Toast shows at the top.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Toast shows at the top.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
TOP_MOST = 1,
/**
* Toast shows in SYSTEM_TOAST window.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SYSTEM_TOP_MOST = 2
}
/**
* @typedef Button
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef Button
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef Button
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface Button {
/**
* The text displayed in the button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* The text displayed in the button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The text displayed in the button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
text: string | Resource;
/**
* The foreground color of button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* The foreground color of button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The foreground color of button.
*
* @type { string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
color: string | Resource;
/**
* Define whether the button responds to Enter/Space key by default.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
primary?: boolean;
}
/**
* Defines the one-button array.
*
* @typedef { [Button] } PromptActionSingleButton
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionSingleButton = [Button];
/**
* Defines the two-buttons array.
*
* @typedef { [Button, Button | undefined] } PromptActionDoubleButtons
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionDoubleButtons = [Button, Button | undefined];
/**
* Defines the three-buttons array.
*
* @typedef { [Button, Button | undefined, Button | undefined] } PromptActionTripleButtons
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionTripleButtons = [Button, Button | undefined, Button | undefined];
/**
* Defines the four-buttons array.
*
* @typedef { [Button, Button | undefined, Button | undefined, Button | undefined] } PromptActionQuadrupleButtons
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionQuadrupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined];
/**
* Defines the five-buttons array.
*
* @typedef { [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined] } PromptActionQuintupleButtons
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionQuintupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined];
/**
* Defines the six-buttons array.
*
* @typedef { [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined, Button | undefined] } PromptActionSextupleButtons
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
export type PromptActionSextupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined, Button | undefined];
/**
* Defines success response of show dialog.
*
* @typedef ShowDialogSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef ShowDialogSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef ShowDialogSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ShowDialogSuccessResponse {
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
index: number;
}
/**
* @typedef ShowDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef ShowDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef ShowDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ShowDialogOptions {
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
title?: string | Resource;
/**
* Text body.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Text body.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Text body.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
message?: string | Resource;
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* One to three buttons are supported.
* The first button is of the positiveButton type, the second is of the negativeButton type, and the third is of the neutralButton type.
*
* @type { ?Array<Button> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* More than one buttons are supported.
*
* @type { ?Array<Button> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* More than one buttons are supported.
*
* @type { ?Array<Button> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
buttons?: Array<Button>;
/**
* Mask Region of dialog. The size can't exceed the main window.
*
* @type { ?Rectangle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Mask Region of dialog. The size can't exceed the main window.
*
* @type { ?Rectangle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
maskRect?: Rectangle;
/**
* Defines the dialog alignment of the screen.
*
* @type { ?DialogAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines the dialog alignment of the screen.
*
* @type { ?DialogAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
alignment?: DialogAlignment;
/**
* Defines the dialog offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines the dialog offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
offset?: Offset;
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
showInSubWindow?: boolean;
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
isModal?: boolean;
/**
* Defines the dialog's background color.
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundColor?: ResourceColor;
/**
* Defines the dialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyle?: BlurStyle;
/**
* Defines the dialog's background blur style with options
*
* @type { ?BackgroundBlurStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyleOptions?: BackgroundBlurStyleOptions;
/**
* Defines the dialog's background effect with options
*
* @type { ?BackgroundEffectOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundEffect?: BackgroundEffectOptions;
/**
* Defines the dialog's shadow.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
shadow?: ShadowOptions | ShadowStyle;
/**
* Defines whether to respond to the hover mode.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
enableHoverMode?: boolean;
/**
* Defines the dialog's display area in hover mode.
*
* @type { ?HoverModeAreaType }
* @default HoverModeAreaType.BOTTOM_SCREEN
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
hoverModeArea?: HoverModeAreaType;
/**
* Callback function when the dialog appears.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onDidAppear?: Callback<void>;
/**
* Callback function when the dialog disappears.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onDidDisappear?: Callback<void>;
/**
* Callback function before the dialog openAnimation starts.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onWillAppear?: Callback<void>;
/**
* Callback function before the dialog closeAnimation starts.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onWillDisappear?: Callback<void>;
/**
* Determine the display level of the dialog.
*
* @type { ?LevelMode }
* @default LevelMode.OVERLAY
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelMode?: LevelMode;
/**
* The uniqueId of any node in the router or navigation page.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelUniqueId?: number;
/**
* Determine the immersive mode of the dialog.
*
* @type { ?ImmersiveMode }
* @default ImmersiveMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
immersiveMode?: ImmersiveMode;
/**
* Determine the display order of the dialog.
*
* @type { ?LevelOrder }
* @default The value returns by LevelOrder.clamp(0)
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
levelOrder?: LevelOrder;
}
/**
* Enum for state.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
enum CommonState {
/**
* Indicates it is uninitialized.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
UNINITIALIZED = 0,
/**
* Indicates it is initialized.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
INITIALIZED = 1,
/**
* Indicates it is appearig.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
APPEARING = 2,
/**
* Indicates it is appeared.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
APPEARED = 3,
/**
* Indicates it is disappearing.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
DISAPPEARING = 4,
/**
* Indicates it is disappeared.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
DISAPPEARED = 5,
}
/**
* The class used to control common dialog.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export class CommonController {
/**
* The constructor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
constructor();
/**
* Close the corresponding common dialog.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
close(): void;
/**
* Get the state.
*
* @returns { CommonState } return the state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
getState(): CommonState;
}
/**
* The class used to control dialog.
*
* @extends CommonController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export class DialogController extends CommonController {}
/**
* Dialog base options
*
* @typedef BaseDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Dialog base options
*
* @typedef BaseDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface BaseDialogOptions {
/**
* Mask Region of dialog. The size can't exceed the main window.
*
* @type { ?Rectangle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Mask Region of dialog. The size can't exceed the main window.
*
* @type { ?Rectangle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
maskRect?: Rectangle;
/**
* Defines the dialog alignment of the screen.
*
* @type { ?DialogAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Defines the dialog alignment of the screen.
*
* @type { ?DialogAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
alignment?: DialogAlignment;
/**
* Defines the dialog offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Defines the dialog offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
offset?: Offset;
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
showInSubWindow?: boolean;
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
isModal?: boolean;
/**
* Allows users to click the mask layer to exit.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
autoCancel?: boolean;
/**
* Transition parameters of opening/closing custom dialog.
*
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
transition?: TransitionEffect;
/**
* Dialog transition parameters of opening/closing custom dialog.
*
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
dialogTransition?: TransitionEffect;
/**
* Mask transition parameters of opening/closing custom dialog.
*
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
maskTransition?: TransitionEffect;
/**
* Defines custom dialog maskColor
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
maskColor?: ResourceColor;
/**
* Callback function when the CustomDialog interactive dismiss.
*
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
onWillDismiss?: Callback<DismissDialogAction>;
/**
* Callback function when the dialog appears.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
onDidAppear?: () => void;
/**
* Callback function when the dialog disappears.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
onDidDisappear?: () => void;
/**
* Callback function before the dialog openAnimation starts.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
onWillAppear?: () => void;
/**
* Callback function before the dialog closeAnimation starts.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
onWillDisappear?: () => void;
/**
* Defines the customDialog's keyboard avoid mode
*
* @type { ?KeyboardAvoidMode }
* @default KeyboardAvoidMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
keyboardAvoidMode?: KeyboardAvoidMode;
/**
* Defines whether to respond to the hover mode.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
enableHoverMode?: boolean;
/**
* Defines the dialog's display area in hover mode.
*
* @type { ?HoverModeAreaType }
* @default HoverModeAreaType.BOTTOM_SCREEN
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
hoverModeArea?: HoverModeAreaType;
/**
* Defines the customDialog's background blur style with options
*
* @type { ?BackgroundBlurStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyleOptions?: BackgroundBlurStyleOptions;
/**
* Defines the customDialog's background effect with options
*
* @type { ?BackgroundEffectOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundEffect?: BackgroundEffectOptions;
/**
* Defines the distance between the customDialog and system keyboard.
*
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
keyboardAvoidDistance?: LengthMetrics;
/**
* Determine the display level of the dialog.
*
* @type { ?LevelMode }
* @default LevelMode.OVERLAY
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelMode?: LevelMode;
/**
* The uniqueId of any node in the router or navigation page.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelUniqueId?: number;
/**
* Determine the immersive mode of the dialog.
*
* @type { ?ImmersiveMode }
* @default ImmersiveMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
immersiveMode?: ImmersiveMode;
/**
* Determine the display order of the dialog.
*
* @type { ?LevelOrder }
* @default The value returns by LevelOrder.clamp(0)
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
levelOrder?: LevelOrder;
/**
* Specifies whether to get focus when the custom dialog is displayed.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
focusable?: boolean;
}
/**
* Dialog's custom content options
*
* @extends BaseDialogOptions
* @interface CustomDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Dialog's custom content options
*
* @extends BaseDialogOptions
* @interface CustomDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface CustomDialogOptions extends BaseDialogOptions {
/**
* Allow developer custom dialog's content.
*
* @type { CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Allow developer custom dialog's content.
*
* @type { CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
builder: CustomBuilder;
/**
* Defines the custom dialog's background color.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundColor?: ResourceColor;
/**
* Defines the custom dialog's corner radius.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
cornerRadius?: Dimension | BorderRadiuses;
/**
* Defines the custom dialog's width.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
width?: Dimension;
/**
* Defines the custom dialog's height.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
height?: Dimension;
/**
* Defines the custom dialog's border width.
*
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
borderWidth?: Dimension | EdgeWidths;
/**
* Defines the custom dialog's border color.
*
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
borderColor?: ResourceColor | EdgeColors;
/**
* Defines the custom dialog's border style.
*
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
borderStyle?: BorderStyle | EdgeStyles;
/**
* Defines the custom dialog's shadow.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
shadow?: ShadowOptions | ShadowStyle;
/**
* Defines the customDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyle?: BlurStyle;
}
/**
* Corner radius type of DialogOptions.
*
* @typedef { Dimension | BorderRadiuses } DialogOptionsCornerRadius
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export type DialogOptionsCornerRadius = Dimension | BorderRadiuses;
/**
* Border width type of DialogOptions.
*
* @typedef { Dimension | EdgeWidths } DialogOptionsBorderWidth
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export type DialogOptionsBorderWidth = Dimension | EdgeWidths;
/**
* Border color type of DialogOptions.
*
* @typedef { ResourceColor | EdgeColors } DialogOptionsBorderColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export type DialogOptionsBorderColor = ResourceColor | EdgeColors;
/**
* Border style type of DialogOptions.
*
* @typedef { BorderStyle | EdgeStyles } DialogOptionsBorderStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export type DialogOptionsBorderStyle = BorderStyle | EdgeStyles;
/**
* Shadow type of DialogOptions.
*
* @typedef { ShadowOptions | ShadowStyle } DialogOptionsShadow
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export type DialogOptionsShadow = ShadowOptions | ShadowStyle;
/**
* Dialog options
*
* @extends BaseDialogOptions
* @typedef DialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface DialogOptions extends BaseDialogOptions {
/**
* Defines the dialog's background color.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundColor?: ResourceColor;
/**
* Defines the dialog's corner radius.
*
* @type { ?DialogOptionsCornerRadius }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
cornerRadius?: DialogOptionsCornerRadius;
/**
* Defines the dialog's width.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
width?: Dimension;
/**
* Defines the dialog's height.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
height?: Dimension;
/**
* Defines the dialog's border width.
*
* @type { ?DialogOptionsBorderWidth }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
borderWidth?: DialogOptionsBorderWidth;
/**
* Defines the dialog's border color.
*
* @type { ?DialogOptionsBorderColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
borderColor?: DialogOptionsBorderColor;
/**
* Defines the dialog's border style.
*
* @type { ?DialogOptionsBorderStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
borderStyle?: DialogOptionsBorderStyle;
/**
* Defines the dialog's shadow.
*
* @type { ?DialogOptionsShadow }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
shadow?: DialogOptionsShadow;
/**
* Defines the dialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
backgroundBlurStyle?: BlurStyle;
}
/**
* @typedef ActionMenuSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef ActionMenuSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef ActionMenuSuccessResponse
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ActionMenuSuccessResponse {
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Index of the selected button, starting from 0.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
index: number;
}
/**
* @typedef ActionMenuOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* @typedef ActionMenuOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef ActionMenuOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ActionMenuOptions {
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Title of the text to display.
*
* @type { ?(string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
title?: string | Resource;
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* One to six buttons are supported.
*
* @type { [Button, Button?, Button?, Button?, Button?, Button?] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* One to six buttons are supported.
*
* @type { [Button, Button?, Button?, Button?, Button?, Button?] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* One to six buttons are supported.
*
* @type { [Button, Button?, Button?, Button?, Button?, Button?] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
buttons: [Button, Button?, Button?, Button?, Button?, Button?];
/**
* Array of buttons in the dialog box.
* The array structure is {text:'button', color: '#666666'}.
* One to six buttons are supported.
*
* @type { PromptActionSingleButton | PromptActionDoubleButtons | PromptActionTripleButtons | PromptActionQuadrupleButtons | PromptActionQuintupleButtons | PromptActionSextupleButtons }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
buttons: PromptActionSingleButton | PromptActionDoubleButtons | PromptActionTripleButtons | PromptActionQuadrupleButtons | PromptActionQuintupleButtons | PromptActionSextupleButtons;
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
showInSubWindow?: boolean;
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
isModal?: boolean;
/**
* Determine the display level of the dialog.
*
* @type { ?LevelMode }
* @default LevelMode.OVERLAY
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelMode?: LevelMode;
/**
* The uniqueId of any node in the router or navigation page.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
levelUniqueId?: number;
/**
* Determine the immersive mode of the dialog.
*
* @type { ?ImmersiveMode }
* @default ImmersiveMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
immersiveMode?: ImmersiveMode;
/**
* Callback function when the menu appears.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
onDidAppear?: Callback<void>;
/**
* Callback function when the menu disappears.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
onDidDisappear?: Callback<void>;
/**
* Callback function before the menu openAnimation starts.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
onWillAppear?: Callback<void>;
/**
* Callback function before the menu closeAnimation starts.
*
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
onWillDisappear?: Callback<void>;
}
/**
* Displays the notification text.
*
* @param { ShowToastOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Displays the notification text.
*
* @param { ShowToastOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Displays the notification text.
*
* @param { ShowToastOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#showToast
*/
function showToast(options: ShowToastOptions): void;
/**
* Displays the notification text.
*
* @param { ShowToastOptions } options - Options.
* @returns { Promise<number> } return the toast id that will be used by closeToast.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export function openToast(options: ShowToastOptions): Promise<number>;
/**
* Close the notification text.
*
* @param { number } toastId - the toast id that returned by openToast.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 103401 - Cannot find the toast.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export function closeToast(toastId: number): void;
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @param { AsyncCallback<ShowDialogSuccessResponse> } callback - the callback of showDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @param { AsyncCallback<ShowDialogSuccessResponse> } callback - the callback of showDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @param { AsyncCallback<ShowDialogSuccessResponse> } callback - the callback of showDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#showDialog
*/
function showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse>): void;
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @returns { Promise<ShowDialogSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @returns { Promise<ShowDialogSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Displays the dialog box.
*
* @param { ShowDialogOptions } options - Options.
* @returns { Promise<ShowDialogSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#showDialog
*/
function showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>;
/**
* Open the custom dialog.
*
* @param { CustomDialogOptions } options - Options.
* @returns { Promise<number> } return the dialog id that will be used by closeCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Open the custom dialog.
*
* @param { CustomDialogOptions } options - Options.
* @returns { Promise<number> } return the dialog id that will be used by closeCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#openCustomDialog
*/
function openCustomDialog(options: CustomDialogOptions): Promise<number>;
/**
* Close the custom dialog.
*
* @param { number } dialogId - the dialog id that returned by openCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Close the custom dialog.
*
* @param { number } dialogId - the dialog id that returned by openCustomDialog.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#closeCustomDialog
*/
function closeCustomDialog(dialogId: number): void;
/**
* Displays the menu.
*
* @param { ActionMenuOptions } options - Options.
* @param { AsyncCallback<ActionMenuSuccessResponse> } callback - the callback of showActionMenu.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Displays the menu.
*
* @param { ActionMenuOptions } options - Options.
* @param { AsyncCallback<ActionMenuSuccessResponse> } callback - the callback of showActionMenu.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Displays the menu.
*
* @param { ActionMenuOptions } options - Options.
* @param { AsyncCallback<ActionMenuSuccessResponse> } callback - the callback of showActionMenu.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#showActionMenu
*/
function showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenuSuccessResponse>): void;
/**
* Displays the dialog box.
*
* @param { ActionMenuOptions } options - Options.
* @returns { Promise<ActionMenuSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Displays the dialog box.
*
* @param { ActionMenuOptions } options - Options.
* @returns { Promise<ActionMenuSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Displays the dialog box.
*
* @param { ActionMenuOptions } options - Options.
* @returns { Promise<ActionMenuSuccessResponse> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.PromptAction#showActionMenu
*/
function showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse>;
}
/**
* Component dialog dismiss action.
*
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
declare interface DismissDialogAction {
/**
* Defines dialog dismiss function.
*
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
dismiss: Callback<void>;
/**
* Dismiss reason type.
*
* @type { DismissReason }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
reason: DismissReason;
}
export default promptAction;
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

搜索帮助